mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 10:50:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

[3.12] gh-101100: Fix Sphinx warnings in whatsnew/3.11.rst and related (GH-114531) (#114649)

Browse source
This commit is contained in:
Hugo van Kemenade 2024-01-27 16:57:28 +02:00 • committed by GitHub
parent 5c21f3d9e5
commit 045663f992
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
14 changed files with 61 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Doc/whatsnew/2.7.rst
View file

@ -2130,7 +2130,7 @@ Changes to Python's build process and to the C API include:
only the filename, function name, and first line number are required. only the filename, function name, and first line number are required.
This is useful for extension modules that are attempting to This is useful for extension modules that are attempting to
construct a more useful traceback stack. Previously such construct a more useful traceback stack. Previously such
extensions needed to call :c:func:`PyCode_New`, which had many extensions needed to call :c:func:`!PyCode_New`, which had many
more arguments. (Added by Jeffrey Yasskin.) more arguments. (Added by Jeffrey Yasskin.)
* New function: :c:func:`PyErr_NewExceptionWithDoc` creates a new * New function: :c:func:`PyErr_NewExceptionWithDoc` creates a new

80
Doc/whatsnew/3.11.rst
View file

@ -672,7 +672,7 @@ enum
* Changed :meth:`Enum.__format__() <enum.Enum.__format__>` (the default for * Changed :meth:`Enum.__format__() <enum.Enum.__format__>` (the default for
:func:`format`, :meth:`str.format` and :term:`f-string`\s) to always produce :func:`format`, :meth:`str.format` and :term:`f-string`\s) to always produce
the same result as :meth:`Enum.__str__()`: for enums inheriting from the same result as :meth:`Enum.__str__() <enum.Enum.__str__>`: for enums inheriting from
:class:`~enum.ReprEnum` it will be the member's value; for all other enums :class:`~enum.ReprEnum` it will be the member's value; for all other enums
it will be the enum and member name (e.g. ``Color.RED``). it will be the enum and member name (e.g. ``Color.RED``).
@ -1604,7 +1604,7 @@ raw, adaptive bytecode containing quickened data.
New opcodes New opcodes
----------- -----------
* :opcode:`ASYNC_GEN_WRAP`, :opcode:`RETURN_GENERATOR` and :opcode:`SEND`, * :opcode:`!ASYNC_GEN_WRAP`, :opcode:`RETURN_GENERATOR` and :opcode:`SEND`,
used in generators and co-routines. used in generators and co-routines.
* :opcode:`COPY_FREE_VARS`, * :opcode:`COPY_FREE_VARS`,
@ -1615,7 +1615,7 @@ New opcodes
* :opcode:`MAKE_CELL`, to create :ref:`cell-objects`. * :opcode:`MAKE_CELL`, to create :ref:`cell-objects`.
* :opcode:`CHECK_EG_MATCH` and :opcode:`PREP_RERAISE_STAR`, * :opcode:`CHECK_EG_MATCH` and :opcode:`!PREP_RERAISE_STAR`,
to handle the :ref:`new exception groups and except* <whatsnew311-pep654>` to handle the :ref:`new exception groups and except* <whatsnew311-pep654>`
added in :pep:`654`. added in :pep:`654`.
@ -1630,38 +1630,38 @@ New opcodes
Replaced opcodes Replaced opcodes
---------------- ----------------
+------------------------------------+-----------------------------------+-----------------------------------------+ +------------------------------------+------------------------------------+-----------------------------------------+
| Replaced Opcode(s) | New Opcode(s) | Notes | | Replaced Opcode(s) | New Opcode(s) | Notes |
+====================================+===================================+=========================================+ +====================================+====================================+=========================================+
| | :opcode:`!BINARY_*` | :opcode:`BINARY_OP` | Replaced all numeric binary/in-place | | | :opcode:`!BINARY_*` | :opcode:`BINARY_OP` | Replaced all numeric binary/in-place |
| | :opcode:`!INPLACE_*` | | opcodes with a single opcode | | | :opcode:`!INPLACE_*` | | opcodes with a single opcode |
+------------------------------------+-----------------------------------+-----------------------------------------+ +------------------------------------+------------------------------------+-----------------------------------------+
| | :opcode:`!CALL_FUNCTION` | | :opcode:`CALL` | Decouples argument shifting for methods | | | :opcode:`!CALL_FUNCTION` | | :opcode:`CALL` | Decouples argument shifting for methods |
| | :opcode:`!CALL_FUNCTION_KW` | | :opcode:`KW_NAMES` | from handling of keyword arguments; | | | :opcode:`!CALL_FUNCTION_KW` | | :opcode:`!KW_NAMES` | from handling of keyword arguments; |
| | :opcode:`!CALL_METHOD` | | :opcode:`PRECALL` | allows better specialization of calls | | | :opcode:`!CALL_METHOD` | | :opcode:`!PRECALL` | allows better specialization of calls |
| | | :opcode:`PUSH_NULL` | | | | | :opcode:`PUSH_NULL` | |
+------------------------------------+-----------------------------------+-----------------------------------------+ +------------------------------------+------------------------------------+-----------------------------------------+
| | :opcode:`!DUP_TOP` | | :opcode:`COPY` | Stack manipulation instructions | | | :opcode:`!DUP_TOP` | | :opcode:`COPY` | Stack manipulation instructions |
| | :opcode:`!DUP_TOP_TWO` | | :opcode:`SWAP` | | | | :opcode:`!DUP_TOP_TWO` | | :opcode:`SWAP` | |
| | :opcode:`!ROT_TWO` | | | | | :opcode:`!ROT_TWO` | | |
| | :opcode:`!ROT_THREE` | | | | | :opcode:`!ROT_THREE` | | |
| | :opcode:`!ROT_FOUR` | | | | | :opcode:`!ROT_FOUR` | | |
| | :opcode:`!ROT_N` | | | | | :opcode:`!ROT_N` | | |
+------------------------------------+-----------------------------------+-----------------------------------------+ +------------------------------------+------------------------------------+-----------------------------------------+
| | :opcode:`!JUMP_IF_NOT_EXC_MATCH` | | :opcode:`CHECK_EXC_MATCH` | Now performs check but doesn't jump | | | :opcode:`!JUMP_IF_NOT_EXC_MATCH` | | :opcode:`CHECK_EXC_MATCH` | Now performs check but doesn't jump |
+------------------------------------+-----------------------------------+-----------------------------------------+ +------------------------------------+------------------------------------+-----------------------------------------+
| | :opcode:`!JUMP_ABSOLUTE` | | :opcode:`JUMP_BACKWARD` | See [#bytecode-jump]_; | | | :opcode:`!JUMP_ABSOLUTE` | | :opcode:`JUMP_BACKWARD` | See [#bytecode-jump]_; |
| | :opcode:`!POP_JUMP_IF_FALSE` | | :opcode:`POP_JUMP_BACKWARD_IF_* | ``TRUE``, ``FALSE``, | | | :opcode:`!POP_JUMP_IF_FALSE` | | :opcode:`!POP_JUMP_BACKWARD_IF_*`| ``TRUE``, ``FALSE``, |
| | :opcode:`!POP_JUMP_IF_TRUE` | <POP_JUMP_BACKWARD_IF_TRUE>` | ``NONE`` and ``NOT_NONE`` variants | | | :opcode:`!POP_JUMP_IF_TRUE` | | :opcode:`!POP_JUMP_FORWARD_IF_*` | ``NONE`` and ``NOT_NONE`` variants |
| | | :opcode:`POP_JUMP_FORWARD_IF_* | for each direction | | | | for each direction |
| | <POP_JUMP_FORWARD_IF_TRUE>` | | | | | |
+------------------------------------+-----------------------------------+-----------------------------------------+ +------------------------------------+------------------------------------+-----------------------------------------+
| | :opcode:`!SETUP_WITH` | :opcode:`BEFORE_WITH` | :keyword:`with` block setup | | | :opcode:`!SETUP_WITH` | :opcode:`BEFORE_WITH` | :keyword:`with` block setup |
| | :opcode:`!SETUP_ASYNC_WITH` | | | | | :opcode:`!SETUP_ASYNC_WITH` | | |
+------------------------------------+-----------------------------------+-----------------------------------------+ +------------------------------------+------------------------------------+-----------------------------------------+
.. [#bytecode-jump] All jump opcodes are now relative, including the .. [#bytecode-jump] All jump opcodes are now relative, including the
existing :opcode:`JUMP_IF_TRUE_OR_POP` and :opcode:`JUMP_IF_FALSE_OR_POP`. existing :opcode:`!JUMP_IF_TRUE_OR_POP` and :opcode:`!JUMP_IF_FALSE_OR_POP`.
The argument is now an offset from the current instruction The argument is now an offset from the current instruction
rather than an absolute location. rather than an absolute location.
@ -1967,7 +1967,7 @@ Removed C APIs are :ref:`listed separately <whatsnew311-c-api-removed>`.
(Contributed by Victor Stinner in :issue:`45085`.) (Contributed by Victor Stinner in :issue:`45085`.)
* Removed the :mod:`distutils` ``bdist_msi`` command deprecated in Python 3.9. * Removed the :mod:`!distutils` ``bdist_msi`` command deprecated in Python 3.9.
Use ``bdist_wheel`` (wheel packages) instead. Use ``bdist_wheel`` (wheel packages) instead.
(Contributed by Hugo van Kemenade in :issue:`45124`.) (Contributed by Hugo van Kemenade in :issue:`45124`.)
@ -2295,7 +2295,7 @@ Porting to Python 3.11
as its second parameter, instead of ``PyFrameObject*``. as its second parameter, instead of ``PyFrameObject*``.
See :pep:`523` for more details of how to use this function pointer type. See :pep:`523` for more details of how to use this function pointer type.
* :c:func:`PyCode_New` and :c:func:`PyCode_NewWithPosOnlyArgs` now take * :c:func:`!PyCode_New` and :c:func:`!PyCode_NewWithPosOnlyArgs` now take
an additional ``exception_table`` argument. an additional ``exception_table`` argument.
Using these functions should be avoided, if at all possible. Using these functions should be avoided, if at all possible.
To get a custom code object: create a code object using the compiler, To get a custom code object: create a code object using the compiler,
@ -2402,7 +2402,7 @@ Porting to Python 3.11
been included directly, consider including ``Python.h`` instead. been included directly, consider including ``Python.h`` instead.
(Contributed by Victor Stinner in :issue:`35134`.) (Contributed by Victor Stinner in :issue:`35134`.)
* The :c:func:`PyUnicode_CHECK_INTERNED` macro has been excluded from the * The :c:func:`!PyUnicode_CHECK_INTERNED` macro has been excluded from the
limited C API. It was never usable there, because it used internal structures limited C API. It was never usable there, because it used internal structures
which are not available in the limited C API. which are not available in the limited C API.
(Contributed by Victor Stinner in :issue:`46007`.) (Contributed by Victor Stinner in :issue:`46007`.)
@ -2465,7 +2465,7 @@ Porting to Python 3.11
Debuggers that accessed the :attr:`~frame.f_locals` directly *must* call Debuggers that accessed the :attr:`~frame.f_locals` directly *must* call
:c:func:`PyFrame_GetLocals` instead. They no longer need to call :c:func:`PyFrame_GetLocals` instead. They no longer need to call
:c:func:`PyFrame_FastToLocalsWithError` or :c:func:`PyFrame_LocalsToFast`, :c:func:`!PyFrame_FastToLocalsWithError` or :c:func:`!PyFrame_LocalsToFast`,
in fact they should not call those functions. The necessary updating of the in fact they should not call those functions. The necessary updating of the
frame is now managed by the virtual machine. frame is now managed by the virtual machine.
@ -2604,8 +2604,8 @@ and will be removed in Python 3.12.
* :c:func:`!PyUnicode_GET_DATA_SIZE` * :c:func:`!PyUnicode_GET_DATA_SIZE`
* :c:func:`!PyUnicode_GET_SIZE` * :c:func:`!PyUnicode_GET_SIZE`
* :c:func:`!PyUnicode_GetSize` * :c:func:`!PyUnicode_GetSize`
* :c:func:`PyUnicode_IS_COMPACT` * :c:func:`!PyUnicode_IS_COMPACT`
* :c:func:`PyUnicode_IS_READY` * :c:func:`!PyUnicode_IS_READY`
* :c:func:`PyUnicode_READY` * :c:func:`PyUnicode_READY`
* :c:func:`!PyUnicode_WSTR_LENGTH` * :c:func:`!PyUnicode_WSTR_LENGTH`
* :c:func:`!_PyUnicode_AsUnicode` * :c:func:`!_PyUnicode_AsUnicode`
@ -2660,7 +2660,7 @@ Removed
(Contributed by Victor Stinner in :issue:`45474`.) (Contributed by Victor Stinner in :issue:`45474`.)
* Exclude :c:func:`PyWeakref_GET_OBJECT` from the limited C API. It never * Exclude :c:func:`PyWeakref_GET_OBJECT` from the limited C API. It never
worked since the :c:type:`PyWeakReference` structure is opaque in the worked since the :c:type:`!PyWeakReference` structure is opaque in the
limited C API. limited C API.
(Contributed by Victor Stinner in :issue:`35134`.) (Contributed by Victor Stinner in :issue:`35134`.)

4
Doc/whatsnew/3.8.rst
View file

@ -1623,8 +1623,8 @@ Build and C API Changes
allocation or deallocation may need to be adjusted. allocation or deallocation may need to be adjusted.
(Contributed by Eddie Elizondo in :issue:`35810`.) (Contributed by Eddie Elizondo in :issue:`35810`.)
* The new function :c:func:`PyCode_NewWithPosOnlyArgs` allows to create * The new function :c:func:`!PyCode_NewWithPosOnlyArgs` allows to create
code objects like :c:func:`PyCode_New`, but with an extra *posonlyargcount* code objects like :c:func:`!PyCode_New`, but with an extra *posonlyargcount*
parameter for indicating the number of positional-only arguments. parameter for indicating the number of positional-only arguments.
(Contributed by Pablo Galindo in :issue:`37221`.) (Contributed by Pablo Galindo in :issue:`37221`.)

2
Misc/NEWS.d/3.11.0a2.rst
View file

@ -1189,7 +1189,7 @@ context objects can now be disabled.
.. section: C API .. section: C API
Exclude :c:func:`PyWeakref_GET_OBJECT` from the limited C API. It never Exclude :c:func:`PyWeakref_GET_OBJECT` from the limited C API. It never
worked since the :c:type:`PyWeakReference` structure is opaque in the worked since the :c:type:`!PyWeakReference` structure is opaque in the
limited C API. limited C API.
.. ..

6
Misc/NEWS.d/3.11.0a4.rst
View file

@ -161,7 +161,7 @@ faster due to reference-counting optimizations. Patch by Dennis Sweeney.
.. nonce: 7oGp-I .. nonce: 7oGp-I
.. section: Core and Builtins .. section: Core and Builtins
:opcode:`PREP_RERAISE_STAR` no longer pushes ``lasti`` to the stack. :opcode:`!PREP_RERAISE_STAR` no longer pushes ``lasti`` to the stack.
.. ..
@ -170,7 +170,7 @@ faster due to reference-counting optimizations. Patch by Dennis Sweeney.
.. nonce: IKx4v6 .. nonce: IKx4v6
.. section: Core and Builtins .. section: Core and Builtins
Remove :opcode:`POP_EXCEPT_AND_RERAISE` and replace it by an equivalent Remove :opcode:`!POP_EXCEPT_AND_RERAISE` and replace it by an equivalent
sequence of other opcodes. sequence of other opcodes.
.. ..
@ -1171,7 +1171,7 @@ Replaced deprecated usage of :c:func:`PyImport_ImportModuleNoBlock` with
.. nonce: sMgDLz .. nonce: sMgDLz
.. section: C API .. section: C API
The :c:func:`PyUnicode_CHECK_INTERNED` macro has been excluded from the The :c:func:`!PyUnicode_CHECK_INTERNED` macro has been excluded from the
limited C API. It was never usable there, because it used internal limited C API. It was never usable there, because it used internal
structures which are not available in the limited C API. Patch by Victor structures which are not available in the limited C API. Patch by Victor
Stinner. Stinner.

2
Misc/NEWS.d/3.11.0a6.rst
View file

@ -248,7 +248,7 @@ Don't un-adapt :opcode:`COMPARE_OP` when collecting specialization stats.
.. nonce: RX_AzJ .. nonce: RX_AzJ
.. section: Core and Builtins .. section: Core and Builtins
Fix specialization stats gathering for :opcode:`PRECALL` instructions. Fix specialization stats gathering for :opcode:`!PRECALL` instructions.
.. ..

4
Misc/NEWS.d/3.11.0a7.rst
View file

@ -138,7 +138,7 @@ Replaced :opcode:`JUMP_ABSOLUTE` by the relative jump
.. nonce: SwrrFO .. nonce: SwrrFO
.. section: Core and Builtins .. section: Core and Builtins
:c:func:`PyFrame_FastToLocalsWithError` and :c:func:`PyFrame_LocalsToFast` :c:func:`!PyFrame_FastToLocalsWithError` and :c:func:`!PyFrame_LocalsToFast`
are no longer called during profiling nor tracing. C code can access the are no longer called during profiling nor tracing. C code can access the
``f_locals`` attribute of :c:type:`PyFrameObject` by calling ``f_locals`` attribute of :c:type:`PyFrameObject` by calling
:c:func:`PyFrame_GetLocals`. :c:func:`PyFrame_GetLocals`.
@ -295,7 +295,7 @@ oparg) as an adaptive counter.
.. nonce: O12Pba .. nonce: O12Pba
.. section: Core and Builtins .. section: Core and Builtins
Use inline caching for :opcode:`PRECALL` and :opcode:`CALL`, and remove the Use inline caching for :opcode:`!PRECALL` and :opcode:`CALL`, and remove the
internal machinery for managing the (now unused) non-inline caches. internal machinery for managing the (now unused) non-inline caches.
.. ..

4
Misc/NEWS.d/3.11.0b1.rst
View file

@ -403,8 +403,8 @@ so this led to crashes. The problem is now fixed.
.. nonce: 6S_uoU .. nonce: 6S_uoU
.. section: Core and Builtins .. section: Core and Builtins
Make opcodes :opcode:`JUMP_IF_TRUE_OR_POP` and Make opcodes :opcode:`!JUMP_IF_TRUE_OR_POP` and
:opcode:`JUMP_IF_FALSE_OR_POP` relative rather than absolute. :opcode:`!JUMP_IF_FALSE_OR_POP` relative rather than absolute.
.. ..

4
Misc/NEWS.d/3.12.0a4.rst
View file

@ -13,8 +13,8 @@ Fix misleading default value in :func:`input`'s ``__text_signature__``.
.. nonce: cmGwxv .. nonce: cmGwxv
.. section: Core and Builtins .. section: Core and Builtins
Remove :opcode:`UNARY_POSITIVE`, :opcode:`ASYNC_GEN_WRAP` and Remove :opcode:`!UNARY_POSITIVE`, :opcode:`!ASYNC_GEN_WRAP` and
:opcode:`LIST_TO_TUPLE`, replacing them with intrinsics. :opcode:`!LIST_TO_TUPLE`, replacing them with intrinsics.
.. ..

2
Misc/NEWS.d/3.12.0a6.rst
View file

@ -170,7 +170,7 @@ all as not all platform C libraries generate an error.
.. section: Core and Builtins .. section: Core and Builtins
Add :opcode:`CALL_INTRINSIC_2` and use it instead of Add :opcode:`CALL_INTRINSIC_2` and use it instead of
:opcode:`PREP_RERAISE_STAR`. :opcode:`!PREP_RERAISE_STAR`.
.. ..

2
Misc/NEWS.d/3.12.0a7.rst
View file

@ -24,7 +24,7 @@ Reduce the number of inline :opcode:`CACHE` entries for
.. nonce: PRkGca .. nonce: PRkGca
.. section: Core and Builtins .. section: Core and Builtins
Removed :opcode:`JUMP_IF_FALSE_OR_POP` and :opcode:`JUMP_IF_TRUE_OR_POP` Removed :opcode:`!JUMP_IF_FALSE_OR_POP` and :opcode:`!JUMP_IF_TRUE_OR_POP`
instructions. instructions.
.. ..

4
Misc/NEWS.d/3.8.0a1.rst
View file

@ -3395,8 +3395,8 @@ Zackery Spytz.
.. nonce: S0Irst .. nonce: S0Irst
.. section: Library .. section: Library
Fix parsing non-ASCII identifiers in :mod:`lib2to3.pgen2.tokenize` (PEP Fix parsing non-ASCII identifiers in :mod:`!lib2to3.pgen2.tokenize`
3131). (:pep:`3131`).
.. ..

4
Misc/NEWS.d/3.9.0a1.rst
View file

@ -5715,8 +5715,8 @@ The :c:macro:`METH_FASTCALL` calling convention has been documented.
.. nonce: 4tClQT .. nonce: 4tClQT
.. section: C API .. section: C API
The new function :c:func:`PyCode_NewWithPosOnlyArgs` allows to create code The new function :c:func:`!PyCode_NewWithPosOnlyArgs` allows to create code
objects like :c:func:`PyCode_New`, but with an extra *posonlyargcount* objects like :c:func:`!PyCode_New`, but with an extra *posonlyargcount*
parameter for indicating the number of positonal-only arguments. parameter for indicating the number of positonal-only arguments.
.. ..

2
Misc/NEWS.d/3.9.0a5.rst
View file

@ -1122,7 +1122,7 @@ a different condition than the GIL.
.. nonce: Nbl7lF .. nonce: Nbl7lF
.. section: Tools/Demos .. section: Tools/Demos
Added support to fix ``getproxies`` in the :mod:`lib2to3.fixes.fix_urllib` Added support to fix ``getproxies`` in the :mod:`!lib2to3.fixes.fix_urllib`
module. Patch by José Roberto Meza Cabrera. module. Patch by José Roberto Meza Cabrera.
.. ..