help('signal') incomplete (e.g: signal.signal not visible)

[GabrielPettierTshirtman]

BPO	27718
Nosy	@giampaolo, @bitdancer, @ethanfurman, @serhiy-storchaka, @miss-islington, @nanjekyejoannah
PRs	bpo-27718: Fix help for the signal module #30063 [3.10] bpo-27718: Fix help for the signal module (GH-30063) #30080 [3.9] [3.10] bpo-27718: Fix help for the signal module (GH-30063) (GH-30080) #30084

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2021-12-13.11:12:53.260>
created_at = <Date 2016-08-09.12:41:19.857>
labels = ['3.11', 'type-bug', '3.9', '3.10', 'docs']
title = "help('signal') incomplete (e.g: signal.signal not visible)"
updated_at = <Date 2021-12-13.11:12:53.260>
user = 'https://bugs.python.org/GabrielPettierTshirtman'

bugs.python.org fields:

activity = <Date 2021-12-13.11:12:53.260>
actor = 'serhiy.storchaka'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-12-13.11:12:53.260>
closer = 'serhiy.storchaka'
components = ['Documentation']
creation = <Date 2016-08-09.12:41:19.857>
creator = 'Gabriel Pettier (Tshirtman)'
dependencies = []
files = []
hgrepos = []
issue_num = 27718
keywords = ['patch']
message_count = 6.0
messages = ['272240', '272248', '408342', '408430', '408436', '408438']
nosy_count = 8.0
nosy_names = ['giampaolo.rodola', 'r.david.murray', 'docs@python', 'ethan.furman', 'serhiy.storchaka', 'Gabriel Pettier (Tshirtman)', 'miss-islington', 'nanjekyejoannah']
pr_nums = ['30063', '30080', '30084']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue27718'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

[GabrielPettierTshirtman]

Up to apparently python 3.5, using help('signal') used to show the 'signal.signal' function among others, now it's not in the list, while of course help('signal.signal') does work, it was reported to me to still be the case in 3.6a1.

[bitdancer]

The conversion of the module from a pure python module to a mixed module apparently caused a number of changes to the pydoc output. This should be addressed to make the pydoc output complete, even if it still different in detail.

[serhiy-storchaka]

This is due to use functools.wraps(). If __all__ is not defined all non-builtin functions should have correct __module__ to be displayed by pydoc. functools.wraps() assigns __module__, __name__, __qualname__, __doc__ and __annotations__. __module__ should be preserved ('signal', not '_signal'), __name__ and __qualname__ are already correct, __annotations__ does not exist. So only __doc__ should be copied.

[serhiy-storchaka]

New changeset e08c0d8 by Serhiy Storchaka in branch 'main':
bpo-27718: Fix help for the signal module (GH-30063)
e08c0d8

[serhiy-storchaka]

New changeset e55deaa by Serhiy Storchaka in branch '3.10':
[3.10] bpo-27718: Fix help for the signal module (GH-30063) (GH-30080)
e55deaa

[miss-islington]

New changeset 80f98b1 by Miss Islington (bot) in branch '3.9':
[3.10] bpo-27718: Fix help for the signal module (GH-30063) (GH-30080)
80f98b1