mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-20 19:06:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

bpo-28206: Document signals Handlers, Sigmasks and Signals enums (GH-28628)

Browse source 
Co-authored-by: desbma <desbma@users.noreply.github.com>
This commit is contained in:
Bibo-Joshi 2021-10-04 13:09:40 +02:00 • committed by GitHub
parent e6d1aa1ac6
commit 9be930f9b1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

35
Doc/library/signal.rst
View file

@ -68,10 +68,34 @@ Module contents
signal (SIG*), handler (:const:`SIG_DFL`, :const:`SIG_IGN`) and sigmask signal (SIG*), handler (:const:`SIG_DFL`, :const:`SIG_IGN`) and sigmask
(:const:`SIG_BLOCK`, :const:`SIG_UNBLOCK`, :const:`SIG_SETMASK`) (:const:`SIG_BLOCK`, :const:`SIG_UNBLOCK`, :const:`SIG_SETMASK`)
related constants listed below were turned into related constants listed below were turned into
:class:`enums <enum.IntEnum>`. :class:`enums <enum.IntEnum>` (:class:`Signals`, :class:`Handlers` and :class:`Sigmasks` respectively).
:func:`getsignal`, :func:`pthread_sigmask`, :func:`sigpending` and :func:`getsignal`, :func:`pthread_sigmask`, :func:`sigpending` and
:func:`sigwait` functions return human-readable :func:`sigwait` functions return human-readable
:class:`enums <enum.IntEnum>`. :class:`enums <enum.IntEnum>` as :class:`Signals` objects.
The signal module defines three enums:
.. class:: Signals
:class:`enum.IntEnum` collection of SIG* constants and the CTRL_* constants.
.. versionadded:: 3.5
.. class:: Handlers
:class:`enum.IntEnum` collection the constants :const:`SIG_DFL` and :const:`SIG_IGN`.
.. versionadded:: 3.5
.. class:: Sigmasks
:class:`enum.IntEnum` collection the constants :const:`SIG_BLOCK`, :const:`SIG_UNBLOCK` and :const:`SIG_SETMASK`.
Availability: Unix. See the man page :manpage:`sigprocmask(3)` and
:manpage:`pthread_sigmask(3)` for further information.
.. versionadded:: 3.5
The variables defined in the :mod:`signal` module are: The variables defined in the :mod:`signal` module are:
@ -618,8 +642,8 @@ The :mod:`signal` module defines the following functions:
.. _signal-example: .. _signal-example:
Example Examples
------- --------
Here is a minimal example program. It uses the :func:`alarm` function to limit Here is a minimal example program. It uses the :func:`alarm` function to limit
the time spent waiting to open a file; this is useful if the file is for a the time spent waiting to open a file; this is useful if the file is for a
@ -631,7 +655,8 @@ be sent, and the handler raises an exception. ::
import signal, os import signal, os
def handler(signum, frame): def handler(signum, frame):
print('Signal handler called with signal', signum) signame = signal.Signals(signum).name
print(f'Signal handler called with signal {signame} ({signum})')
raise OSError("Couldn't open device!") raise OSError("Couldn't open device!")
# Set the signal handler and a 5-second alarm # Set the signal handler and a 5-second alarm