From e08c0d8eec528f1d7a282ee19bcadb9aae9ec123 Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Mon, 13 Dec 2021 11:21:55 +0200 Subject: [PATCH] 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__. --- Lib/signal.py | 13 ++++++++++--- Lib/test/test_signal.py | 9 +++++++++ .../2021-12-11-22-51-30.bpo-27718.MgQiGl.rst | 2 ++ 3 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 Misc/NEWS.d/next/Library/2021-12-11-22-51-30.bpo-27718.MgQiGl.rst diff --git a/Lib/signal.py b/Lib/signal.py index d4a6d6fe2ad..50b215b29d2 100644 --- a/Lib/signal.py +++ b/Lib/signal.py @@ -1,6 +1,5 @@ import _signal from _signal import * -from functools import wraps as _wraps from enum import IntEnum as _IntEnum _globals = globals() @@ -42,6 +41,16 @@ def _enum_to_int(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) def signal(signalnum, handler): handler = _signal.signal(_enum_to_int(signalnum), _enum_to_int(handler)) @@ -59,7 +68,6 @@ def getsignal(signalnum): def pthread_sigmask(how, mask): sigs_set = _signal.pthread_sigmask(how, mask) return set(_int_to_enum(x, Signals) for x in sigs_set) - pthread_sigmask.__doc__ = _signal.pthread_sigmask.__doc__ if 'sigpending' in _globals: @@ -73,7 +81,6 @@ def sigpending(): def sigwait(sigset): retsig = _signal.sigwait(sigset) return _int_to_enum(retsig, Signals) - sigwait.__doc__ = _signal.sigwait if 'valid_signals' in _globals: diff --git a/Lib/test/test_signal.py b/Lib/test/test_signal.py index daecf196fa1..3f0e7270eb2 100644 --- a/Lib/test/test_signal.py +++ b/Lib/test/test_signal.py @@ -1,5 +1,6 @@ import enum import errno +import inspect import os import random import signal @@ -60,6 +61,14 @@ def test_enums(self): ) 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") class PosixTests(unittest.TestCase): diff --git a/Misc/NEWS.d/next/Library/2021-12-11-22-51-30.bpo-27718.MgQiGl.rst b/Misc/NEWS.d/next/Library/2021-12-11-22-51-30.bpo-27718.MgQiGl.rst new file mode 100644 index 00000000000..c68e98ff063 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2021-12-11-22-51-30.bpo-27718.MgQiGl.rst @@ -0,0 +1,2 @@ +Fix help for the :mod:`signal` module. Some functions (e.g. ``signal()`` and +``getsignal()``) were omitted.