diff options
| author | Berker Peksag <berker.peksag@gmail.com> | 2016-04-24 02:59:43 +0300 |
|---|---|---|
| committer | Berker Peksag <berker.peksag@gmail.com> | 2016-04-24 02:59:43 +0300 |
| commit | ae7e8c44ac158d25bb5e88070a5db3fd68e60255 (patch) | |
| tree | 94bbf374dffc2ed23cebcd06918bde11a4d42601 | |
| parent | ce18d8c2f4ea8bbdc51ab4512d73f1ffe5b5901a (diff) | |
| parent | 77e543c6cdd40debd215fa6e913fcc64c0748eb0 (diff) | |
| download | cpython-git-ae7e8c44ac158d25bb5e88070a5db3fd68e60255.tar.gz | |
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.
| -rw-r--r-- | Doc/library/signal.rst | 3 |
1 files changed, 3 insertions, 0 deletions
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() |