mirror of https://github.com/python/cpython
bpo-27718: Fix help for the signal module (GH-30063)
Functions signal(), getsignal(), pthread_sigmask(), sigpending(), sigwait() and valid_signals() were omitted. If __all__ is not defined all non-builtin functions should have correct __module__.
This commit is contained in:
parent
d0669c5e69
commit
e08c0d8eec
|
@ -1,6 +1,5 @@
|
||||||
import _signal
|
import _signal
|
||||||
from _signal import *
|
from _signal import *
|
||||||
from functools import wraps as _wraps
|
|
||||||
from enum import IntEnum as _IntEnum
|
from enum import IntEnum as _IntEnum
|
||||||
|
|
||||||
_globals = globals()
|
_globals = globals()
|
||||||
|
@ -42,6 +41,16 @@ def _enum_to_int(value):
|
||||||
return value
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
# Similar to functools.wraps(), but only assign __doc__.
|
||||||
|
# __module__ should be preserved,
|
||||||
|
# __name__ and __qualname__ are already fine,
|
||||||
|
# __annotations__ is not set.
|
||||||
|
def _wraps(wrapped):
|
||||||
|
def decorator(wrapper):
|
||||||
|
wrapper.__doc__ = wrapped.__doc__
|
||||||
|
return wrapper
|
||||||
|
return decorator
|
||||||
|
|
||||||
@_wraps(_signal.signal)
|
@_wraps(_signal.signal)
|
||||||
def signal(signalnum, handler):
|
def signal(signalnum, handler):
|
||||||
handler = _signal.signal(_enum_to_int(signalnum), _enum_to_int(handler))
|
handler = _signal.signal(_enum_to_int(signalnum), _enum_to_int(handler))
|
||||||
|
@ -59,7 +68,6 @@ if 'pthread_sigmask' in _globals:
|
||||||
def pthread_sigmask(how, mask):
|
def pthread_sigmask(how, mask):
|
||||||
sigs_set = _signal.pthread_sigmask(how, mask)
|
sigs_set = _signal.pthread_sigmask(how, mask)
|
||||||
return set(_int_to_enum(x, Signals) for x in sigs_set)
|
return set(_int_to_enum(x, Signals) for x in sigs_set)
|
||||||
pthread_sigmask.__doc__ = _signal.pthread_sigmask.__doc__
|
|
||||||
|
|
||||||
|
|
||||||
if 'sigpending' in _globals:
|
if 'sigpending' in _globals:
|
||||||
|
@ -73,7 +81,6 @@ if 'sigwait' in _globals:
|
||||||
def sigwait(sigset):
|
def sigwait(sigset):
|
||||||
retsig = _signal.sigwait(sigset)
|
retsig = _signal.sigwait(sigset)
|
||||||
return _int_to_enum(retsig, Signals)
|
return _int_to_enum(retsig, Signals)
|
||||||
sigwait.__doc__ = _signal.sigwait
|
|
||||||
|
|
||||||
|
|
||||||
if 'valid_signals' in _globals:
|
if 'valid_signals' in _globals:
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
import enum
|
import enum
|
||||||
import errno
|
import errno
|
||||||
|
import inspect
|
||||||
import os
|
import os
|
||||||
import random
|
import random
|
||||||
import signal
|
import signal
|
||||||
|
@ -60,6 +61,14 @@ class GenericTests(unittest.TestCase):
|
||||||
)
|
)
|
||||||
enum._test_simple_enum(CheckedSigmasks, Sigmasks)
|
enum._test_simple_enum(CheckedSigmasks, Sigmasks)
|
||||||
|
|
||||||
|
def test_functions_module_attr(self):
|
||||||
|
# Issue #27718: If __all__ is not defined all non-builtin functions
|
||||||
|
# should have correct __module__ to be displayed by pydoc.
|
||||||
|
for name in dir(signal):
|
||||||
|
value = getattr(signal, name)
|
||||||
|
if inspect.isroutine(value) and not inspect.isbuiltin(value):
|
||||||
|
self.assertEqual(value.__module__, 'signal')
|
||||||
|
|
||||||
|
|
||||||
@unittest.skipIf(sys.platform == "win32", "Not valid on Windows")
|
@unittest.skipIf(sys.platform == "win32", "Not valid on Windows")
|
||||||
class PosixTests(unittest.TestCase):
|
class PosixTests(unittest.TestCase):
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
Fix help for the :mod:`signal` module. Some functions (e.g. ``signal()`` and
|
||||||
|
``getsignal()``) were omitted.
|
Loading…
Reference in New Issue