Thanks to visit codestin.com
Credit goes to github.com

Skip to content

inspect.getmember docs do not mention __type_params__ for functions and classes #116782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
sobolevn opened this issue Mar 14, 2024 · 1 comment
Closed

inspect.getmember docs do not mention __type_params__ for functions and classes #116782

sobolevn opened this issue Mar 14, 2024 · 1 comment
Assignees
@sobolevn
Labels
docs Documentation in the Doc dir stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error

Comments

@sobolevn
Copy link
Member

sobolevn commented Mar 14, 2024 •
edited by bedevere-app bot
Loading

Bug report

Docs do not mention __type_params__ key returned value for classes and functions:

cpython/Doc/library/inspect.rst

Lines 47 to 58 in a18c985

+===========+===================+===========================+
| class | __doc__ | documentation string |
+-----------+-------------------+---------------------------+
| | __name__ | name with which this |
| | | class was defined |
+-----------+-------------------+---------------------------+
| | __qualname__ | qualified name |
+-----------+-------------------+---------------------------+
| | __module__ | name of module in which |
| | | this class was defined |
+-----------+-------------------+---------------------------+
| method | __doc__ | documentation string |

cpython/Doc/library/inspect.rst

Lines 75 to 109 in a18c985

+-----------+-------------------+---------------------------+
| function | __doc__ | documentation string |
+-----------+-------------------+---------------------------+
| | __name__ | name with which this |
| | | function was defined |
+-----------+-------------------+---------------------------+
| | __qualname__ | qualified name |
+-----------+-------------------+---------------------------+
| | __code__ | code object containing |
| | | compiled function |
| | | :term:`bytecode` |
+-----------+-------------------+---------------------------+
| | __defaults__ | tuple of any default |
| | | values for positional or |
| | | keyword parameters |
+-----------+-------------------+---------------------------+
| | __kwdefaults__ | mapping of any default |
| | | values for keyword-only |
| | | parameters |
+-----------+-------------------+---------------------------+
| | __globals__ | global namespace in which |
| | | this function was defined |
+-----------+-------------------+---------------------------+
| | __builtins__ | builtins namespace |
+-----------+-------------------+---------------------------+
| | __annotations__ | mapping of parameters |
| | | names to annotations; |
| | | ``"return"`` key is |
| | | reserved for return |
| | | annotations. |
+-----------+-------------------+---------------------------+
| | __module__ | name of module in which |
| | | this function was defined |
+-----------+-------------------+---------------------------+
| traceback | tb_frame | frame object at this |

But, they are returned:

>>> class A[T]: ...
... 
>>> import inspect
>>> dict(inspect.getmembers(A))['__type_params__']
(T,)

I will send a PR for that.

Linked PRs
@sobolevn sobolevn added type-bug An unexpected behavior, bug, or error docs Documentation in the Doc dir stdlib Python modules in the Lib dir labels Mar 14, 2024
@sobolevn sobolevn self-assigned this Mar 14, 2024
sobolevn added a commit to sobolevn/cpython that referenced this issue Mar 14, 2024
@sobolevn
pythongh-116782: Mention __type_params__ in inspect.getmembers docs
4e17d97
@bedevere-app bedevere-app bot mentioned this issue Mar 14, 2024
Merged
sobolevn added a commit that referenced this issue Mar 15, 2024
@sobolevn @JelleZijlstra
gh-116782: Mention __type_params__ in inspect.getmembers docs (#1…
1634986 
…16783)

Co-authored-by: Jelle Zijlstra <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 15, 2024
@sobolevn @JelleZijlstra @miss-islington
pythongh-116782: Mention __type_params__ in inspect.getmembers do…
3aa918c 
…cs (pythonGH-116783)

(cherry picked from commit 1634986)

Co-authored-by: Nikita Sobolev <[email protected]>
Co-authored-by: Jelle Zijlstra <[email protected]>
@bedevere-app bedevere-app bot mentioned this issue Mar 15, 2024
Merged
sobolevn added a commit that referenced this issue Mar 15, 2024
@miss-islington @sobolevn @JelleZijlstra
[3.12] gh-116782: Mention __type_params__ in inspect.getmembers d…
ccea6e8 
…ocs (GH-116783) (#116870)

gh-116782: Mention `__type_params__` in `inspect.getmembers` docs (GH-116783)
(cherry picked from commit 1634986)

Co-authored-by: Nikita Sobolev <[email protected]>
Co-authored-by: Jelle Zijlstra <[email protected]>
@hugovk
Copy link
Member

hugovk commented Mar 15, 2024

Triage: can this issue be closed?

vstinner pushed a commit to vstinner/cpython that referenced this issue Mar 20, 2024
@sobolevn @JelleZijlstra @vstinner
pythongh-116782: Mention __type_params__ in inspect.getmembers do…
bc218c6 
…cs (python#116783)

Co-authored-by: Jelle Zijlstra <[email protected]>
adorilson pushed a commit to adorilson/cpython that referenced this issue Mar 25, 2024
@sobolevn @JelleZijlstra @adorilson
pythongh-116782: Mention __type_params__ in inspect.getmembers do…
7cd6268 
…cs (python#116783)

Co-authored-by: Jelle Zijlstra <[email protected]>
diegorusso pushed a commit to diegorusso/cpython that referenced this issue Apr 17, 2024
@sobolevn @JelleZijlstra @diegorusso
pythongh-116782: Mention __type_params__ in inspect.getmembers do…
49c0692 
…cs (python#116783)

Co-authored-by: Jelle Zijlstra <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sobolevn sobolevn

Labels
docs Documentation in the Doc dir stdlib Python modules in the Lib dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hugovk @sobolevn