Skip to content

gh-104010: Separate and improve docs for typing.get_origin and typing.get_args #104013

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

Merged
merged 6 commits into from
May 10, 2023
Merged

gh-104010: Separate and improve docs for typing.get_origin and typing.get_args #104013

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f6a2736
typing: separate and improve docs for `get_origin` and `get_args`
chgnrdv Apr 30, 2023
6009b6b
documented return value of `get_origin` for `ParamSpecArgs` and `Para…
chgnrdv Apr 30, 2023
e3a1b63
Update Doc/library/typing.rst
JelleZijlstra Apr 30, 2023
83dd082
removed doubleticks
chgnrdv Apr 30, 2023
e733947
Merge branch 'typing-separate-and-improve-get_args-get_origin-docs' o…
chgnrdv Apr 30, 2023
d53b595
swapped `get_args` and `get_origin` docs, changed "objects" to "types…
chgnrdv Apr 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
documented return value of get_origin for ParamSpecArgs and `Para… 
…mSpecKwargs` instances
  • Loading branch information
@chgnrdv
chgnrdv committed Apr 30, 2023
commit 6009b6be76c709b8904b227d176f0b538977b997
5 changes: 5 additions & 0 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2902,12 +2902,17 @@ Introspection helpers
Get the unsubscripted version of a type: for a typing object of the form
``X[Y, Z, ...]`` return ``X``. If ``X`` is a generic alias for a builtin or
:mod:`collections` class, it gets normalized to the original class.
Copy link
Member

@JelleZijlstra JelleZijlstra Apr 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add that for ParamSpecArgs and Kwargs, it returns the underlying ParamSpec.

Copy link
Contributor Author

@chgnrdv chgnrdv Apr 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Member

@JelleZijlstra JelleZijlstra Apr 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

If ``X`` is an instance of :class:``ParamSpecArgs`` or :class:``ParamSpecKwargs``,
return the underlying :class:``ParamSpec``.
Return ``None`` for unsupported types.
Examples::

assert get_origin(str) is None
assert get_origin(Dict[str, int]) is dict
assert get_origin(Union[int, str]) is Union
P = ParamSpec('P')
assert get_origin(P.args) is P
assert get_origin(P.kwargs) is P

.. versionadded:: 3.8

Expand Down