Skip to content

Conversation

@Viicos
Copy link
Contributor

@Viicos Viicos commented Jan 12, 2026

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/

is done by traversing :attr:`C.__mro__ <type.__mro__>` and iteratively
combining
``__annotations__`` dictionaries. Annotations on classes appearing
:term:`annotations <variable annotation>` of each base class. Annotations on classes appearing
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Please wrap the line.

@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
@JelleZijlstra
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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants