Skip to content

gh-119180: Document the format parameter in typing.get_type_hints() #143758

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
JelleZijlstra merged 5 commits into from
Apr 23, 2026
+17 −14
Merged

gh-119180: Document the format parameter in typing.get_type_hints() #143758

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8896a25
gh-119180: Document the `format` parameter in `typing.get_type_hints()`
Viicos Jan 12, 2026
9dd2b19
Rewrite some sections
Viicos Jan 12, 2026
f5fc943
Wrap lines
Viicos Jan 13, 2026
8cc9875
Mention `get_annotations()` early
Viicos Jan 13, 2026
b4533fe
Merge branch 'main' into document-get-type-hints-format
JelleZijlstra Apr 23, 2026
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
Mention get_annotations() early
  • Loading branch information
@Viicos
Viicos committed Jan 13, 2026
commit 8cc9875d1ca15aed972b0805cea9adaace7b7126
7 changes: 2 additions & 5 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3333,8 +3333,8 @@ Introspection helpers
Return a dictionary containing type hints for a function, method, module
or class object.

This is often the same as ``obj.__annotations__``, but this function makes
the following changes to the annotations dictionary:
This is often the same as :func:`annotationlib.get_annotations`, but this
function makes the following changes to the annotations dictionary:

* Forward references encoded as string literals or :class:`ForwardRef`
objects are handled by evaluating them in *globalns*, *localns*, and
Expand All @@ -3357,9 +3357,6 @@ Introspection helpers
with ``T``, unless *include_extras* is set to ``True`` (see
:class:`Annotated` for more information).

See also :func:`annotationlib.get_annotations`, a lower-level function that
returns annotations more directly.

.. caution::

This function may execute arbitrary code contained in annotations.
Expand Down
Loading