Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

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.

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

Open
Viicos wants to merge 4 commits into python:main
base: main
Choose a base branch
Loading
from Viicos:document-get-type-hints-format

Conversation

@Viicos
Copy link
Contributor

@Viicos Viicos commented Jan 12, 2026 •
edited
Loading

I'm wondering if we should also update this section:

cpython/Doc/library/typing.rst

Lines 3336 to 3337 in 66e1399

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

This gives some sense that accessing __annotations__ is safe, which is no longer the case.

📚 Documentation preview 📚: https://cpython-previews--143758.org.readthedocs.build/

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Jan 12, 2026
@Viicos Viicos changed the title (削除) gh-119180: Document get type hints format (削除ここまで) (追記) gh-119180: Document the format parameter in typing.get_type_hints() (追記ここまで) Jan 12, 2026 
Do not mention `__annotations__` dictionaries, as this is slightly
outdated since 3.14.
Rewrite the note about possible exceptions for clarity. Also do not
mention imported type aliases, as since 3.12 aliases with the `type`
statement do not suffer from this limitation anymore.
@Viicos Viicos force-pushed the document-get-type-hints-format branch from f0779d2 to 9dd2b19 Compare January 12, 2026 21:12
Copy link
Member

This gives some sense that accessing __annotations__ is safe, which is no longer the case.

Yes, would you mind changing that line to reference annotationlib.get_annotations instead?

@AlexWaygood AlexWaygood removed their request for review January 13, 2026 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland left review comments

@JelleZijlstra JelleZijlstra Awaiting requested review from JelleZijlstra JelleZijlstra is a code owner

Assignees

No one assigned

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /