Skip to content

[3.14] gh-119180: annotationlib: Fix values of Format members in docs (GH-133841) #133903

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 1 commit into from
May 11, 2025
Merged

[3.14] gh-119180: annotationlib: Fix values of Format members in docs (GH-133841) #133903

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
gh-119180: annotationlib: Fix values of Format members in docs (GH-13… 
…3841)

(cherry picked from commit 0eb448c)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
gh-119180: Fix values of Format members in docs
  • Loading branch information
@JelleZijlstra @miss-islington
JelleZijlstra authored and miss-islington committed May 11, 2025
commit 67c2a093403a67a344c0696fbd211de10d12b2e6
26 changes: 13 additions & 13 deletions Doc/library/annotationlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,34 +127,34 @@ Classes

Values are the result of evaluating the annotation expressions.

.. attribute:: FORWARDREF
.. attribute:: VALUE_WITH_FAKE_GLOBALS
:value: 2

Special value used to signal that an annotate function is being
evaluated in a special environment with fake globals. When passed this
value, annotate functions should either return the same value as for
the :attr:`Format.VALUE` format, or raise :exc:`NotImplementedError`
to signal that they do not support execution in this environment.
This format is only used internally and should not be passed to
the functions in this module.

.. attribute:: FORWARDREF
:value: 3

Values are real annotation values (as per :attr:`Format.VALUE` format)
for defined values, and :class:`ForwardRef` proxies for undefined
values. Real objects may contain references to :class:`ForwardRef`
proxy objects.

.. attribute:: STRING
:value: 3
:value: 4

Values are the text string of the annotation as it appears in the
source code, up to modifications including, but not restricted to,
whitespace normalizations and constant values optimizations.

The exact values of these strings may change in future versions of Python.

.. attribute:: VALUE_WITH_FAKE_GLOBALS
:value: 4

Special value used to signal that an annotate function is being
evaluated in a special environment with fake globals. When passed this
value, annotate functions should either return the same value as for
the :attr:`Format.VALUE` format, or raise :exc:`NotImplementedError`
to signal that they do not support execution in this environment.
This format is only used internally and should not be passed to
the functions in this module.

.. versionadded:: 3.14

.. class:: ForwardRef
Expand Down