Skip to content

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

Merged
JelleZijlstra merged 5 commits into
python:mainfrom
Viicos:document-get-type-hints-format
Apr 23, 2026
Merged

gh-119180: Document the format parameter in typing.get_type_hints()#143758
JelleZijlstra merged 5 commits into
python:mainfrom
Viicos:document-get-type-hints-format

Conversation

@Viicos

@ViicosViicos commented Jan 12, 2026

Copy link
Copy Markdown
Contributor

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

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/

Comment threadDoc/library/typing.rst Outdated
@ViicosViicos changed the title gh-119180: Document get type hints formatgh-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
Viicosforce-pushed the document-get-type-hints-format branch from f0779d2 to 9dd2b19CompareJanuary 12, 2026 21:12
@JelleZijlstra

Copy link
Copy Markdown
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
@JelleZijlstra

Copy link
Copy Markdown
Member

@copilot resolve the merge conflicts in this pull request

@JelleZijlstraJelleZijlstra added the needs backport to 3.14 bugs and security fixes label Apr 23, 2026
@JelleZijlstra
JelleZijlstra enabled auto-merge (squash) April 23, 2026 02:44
@JelleZijlstra
JelleZijlstra merged commit 8bf99ae into python:mainApr 23, 2026
36 checks passed
@github-project-automationgithub-project-automationBot moved this from Todo to Done in Docs PRsApr 23, 2026
@miss-islington-app

Copy link
Copy Markdown

Thanks @Viicos for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

@bedevere-app

Copy link
Copy Markdown

GH-148901 is a backport of this pull request to the 3.14 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.14 bugs and security fixes label Apr 23, 2026
JelleZijlstra pushed a commit that referenced this pull request Apr 23, 2026
…_hints()` (GH-143758) (#148901)
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.
(cherry picked from commit 8bf99ae)
Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
ljfp pushed a commit to ljfp/cpython that referenced this pull request Apr 25, 2026
…hints()` (python#143758)
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.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants

@Viicos@JelleZijlstra@StanFromIreland