From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Sun, 11 May 2025 15:49:21 +0000 (+0200) Subject: [3.14] gh-119180: annotationlib: Fix values of Format members in docs (GH-133841... X-Git-Tag: v3.14.0b2~173 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=94938caf35348a15d230a4a92dfe28752386aa1b;p=thirdparty%2FPython%2Fcpython.git [3.14] gh-119180: annotationlib: Fix values of Format members in docs (GH-133841) (#133903) gh-119180: annotationlib: Fix values of Format members in docs (GH-133841) (cherry picked from commit 0eb448cae5e9008f815204d8b46bfd7cd641a152) Co-authored-by: Jelle Zijlstra --- diff --git a/Doc/library/annotationlib.rst b/Doc/library/annotationlib.rst index a96f5167c026..41c9ce479ff0 100644 --- a/Doc/library/annotationlib.rst +++ b/Doc/library/annotationlib.rst @@ -127,16 +127,27 @@ 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, @@ -144,17 +155,6 @@ Classes 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