From: Berker Peksag <berker.peksag@gmail.com>
Date: Sat, 23 Apr 2016 23:59:16 +0000 (+0300)
Subject: Issue #21382: Clarify signal.signal() documentation on Windows
X-Git-Tag: v3.6.0a1~142^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=77e543c6cdd40debd215fa6e913fcc64c0748eb0;p=python

Issue #21382: Clarify signal.signal() documentation on Windows

All signal.SIG* constants may not be defined on Windows so a call like

    signal.signal(signal.SIGPIPE, lambda signum, frame: sys.exit(1))

will raise an AttributeError.
---

diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst
index 98eb7fdf20..d02a0a8e3c 100644
--- a/Doc/library/signal.rst
+++ b/Doc/library/signal.rst
@@ -351,6 +351,9 @@ The :mod:`signal` module defines the following functions:
    On Windows, :func:`signal` can only be called with :const:`SIGABRT`,
    :const:`SIGFPE`, :const:`SIGILL`, :const:`SIGINT`, :const:`SIGSEGV`, or
    :const:`SIGTERM`. A :exc:`ValueError` will be raised in any other case.
+   Note that not all systems define the same set of signal names; an
+   :exc:`AttributeError` will be raised if a signal name is not defined as
+   ``SIG*`` module level constant.
 
 
 .. function:: sigpending()