https://github.com/python/cpython/commit/1e75fe146857b5e6624bd3281675cf20cc356273
commit: 1e75fe146857b5e6624bd3281675cf20cc356273
branch: 3.12
author: Serhiy Storchaka <[email protected]>
committer: serhiy-storchaka <[email protected]>
date: 2024-03-07T08:21:25Z
summary:
[3.12] gh-115664: Fix ordering of more versionadded and versionchanged
directives (GH-116298) (GH-116450)
(cherry picked from commit 808a77612fb89b125d25efac2788522a100e8a6d)
files:
M Doc/c-api/contextvars.rst
M Doc/c-api/import.rst
M Doc/c-api/init.rst
M Doc/c-api/refcounting.rst
M Doc/library/asyncio-eventloop.rst
M Doc/library/bz2.rst
M Doc/library/collections.rst
M Doc/library/faulthandler.rst
M Doc/library/functools.rst
M Doc/library/hashlib.rst
M Doc/library/importlib.metadata.rst
M Doc/library/os.rst
M Doc/library/pdb.rst
M Doc/library/stdtypes.rst
M Doc/library/threading.rst
M Doc/library/time.rst
M Doc/library/turtle.rst
M Doc/library/urllib.request.rst
M Doc/reference/lexical_analysis.rst
M Doc/reference/simple_stmts.rst
M Doc/using/cmdline.rst
diff --git a/Doc/c-api/contextvars.rst b/Doc/c-api/contextvars.rst
index d970f5443b1df5..fe7b8f93f2c6cf 100644
--- a/Doc/c-api/contextvars.rst
+++ b/Doc/c-api/contextvars.rst
@@ -6,6 +6,8 @@ Context Variables Objects
-------------------------
.. _contextvarsobjects_pointertype_change:
+.. versionadded:: 3.7
+
.. versionchanged:: 3.7.1
.. note::
@@ -24,8 +26,6 @@ Context Variables Objects
See :issue:`34762` for more details.
-.. versionadded:: 3.7
-
This section details the public C API for the :mod:`contextvars` module.
.. c:type:: PyContext
diff --git a/Doc/c-api/import.rst b/Doc/c-api/import.rst
index 5b24ba1dbb70a8..380465b817d44a 100644
--- a/Doc/c-api/import.rst
+++ b/Doc/c-api/import.rst
@@ -292,7 +292,7 @@ Importing Modules
The module name, as an ASCII encoded string.
- .. c: member:: PyObject* (*initfunc)(void)
+ .. c:member:: PyObject* (*initfunc)(void)
Initialization function for a module built into the interpreter.
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index f7f7dc6dc903c4..db1f41ee1295f6 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -1822,14 +1822,14 @@ pointer and a void pointer argument.
function is generally **not** suitable for calling Python code from
arbitrary C threads. Instead, use the :ref:`PyGILState API<gilstate>`.
+ .. versionadded:: 3.1
+
.. versionchanged:: 3.9
If this function is called in a subinterpreter, the function *func* is
now scheduled to be called from the subinterpreter, rather than being
called from the main interpreter. Each subinterpreter now has its own
list of scheduled calls.
- .. versionadded:: 3.1
-
.. _profiling:
Profiling and Tracing
diff --git a/Doc/c-api/refcounting.rst b/Doc/c-api/refcounting.rst
index 4ea0378d02a655..a484fa4469a184 100644
--- a/Doc/c-api/refcounting.rst
+++ b/Doc/c-api/refcounting.rst
@@ -23,12 +23,12 @@ of Python objects.
Use the :c:func:`Py_SET_REFCNT()` function to set an object reference count.
- .. versionchanged:: 3.11
- The parameter type is no longer :c:expr:`const PyObject*`.
-
.. versionchanged:: 3.10
:c:func:`Py_REFCNT()` is changed to the inline static function.
+ .. versionchanged:: 3.11
+ The parameter type is no longer :c:expr:`const PyObject*`.
+
.. c:function:: void Py_SET_REFCNT(PyObject *o, Py_ssize_t refcnt)
diff --git a/Doc/library/asyncio-eventloop.rst
b/Doc/library/asyncio-eventloop.rst
index 1becee8ef63dd4..ba0ee1b6c2c528 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -605,6 +605,9 @@ Opening network connections
The *family*, *proto*, *flags*, *reuse_address*, *reuse_port*,
*allow_broadcast*, and *sock* parameters were added.
+ .. versionchanged:: 3.8
+ Added support for Windows.
+
.. versionchanged:: 3.8.1
The *reuse_address* parameter is no longer supported, as using
:ref:`socket.SO_REUSEADDR <socket-unix-constants>`
@@ -622,9 +625,6 @@ Opening network connections
prevents processes with differing UIDs from assigning sockets to the same
socket address.
- .. versionchanged:: 3.8
- Added support for Windows.
-
.. versionchanged:: 3.11
The *reuse_address* parameter, disabled since Python 3.8.1,
3.7.6 and 3.6.10, has been entirely removed.
diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst
index 6a95a4a6e8d183..5e0aa3e493f224 100644
--- a/Doc/library/bz2.rst
+++ b/Doc/library/bz2.rst
@@ -156,7 +156,6 @@ The :mod:`bz2` module contains:
Support was added for *filename* being a :term:`file object` instead of
an
actual filename.
- .. versionchanged:: 3.3
The ``'a'`` (append) mode was added, along with support for reading
multi-stream files.
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index 1a3084ef107c88..6ed2ebb4098475 100644
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -343,7 +343,7 @@ superset relationships: ``==``, ``!=``, ``<``, ``<=``,
``>``, ``>=``.
All of those tests treat missing elements as having zero counts so that
``Counter(a=1) == Counter(a=1, b=0)`` returns true.
-.. versionadded:: 3.10
+.. versionchanged:: 3.10
Rich comparison operations were added.
.. versionchanged:: 3.10
diff --git a/Doc/library/faulthandler.rst b/Doc/library/faulthandler.rst
index f64dfeb5e081c7..96593ee97a139d 100644
--- a/Doc/library/faulthandler.rst
+++ b/Doc/library/faulthandler.rst
@@ -118,12 +118,12 @@ Dumping the tracebacks after a timeout
This function is implemented using a watchdog thread.
- .. versionchanged:: 3.7
- This function is now always available.
-
.. versionchanged:: 3.5
Added support for passing file descriptor to this function.
+ .. versionchanged:: 3.7
+ This function is now always available.
+
.. function:: cancel_dump_traceback_later()
Cancel the last call to :func:`dump_traceback_later`.
diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index 724caa68dd7fc6..7e8ef4663e114c 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -665,13 +665,9 @@ The :mod:`functools` module defines the following
functions:
on the wrapper function). :exc:`AttributeError` is still raised if the
wrapper function itself is missing any attributes named in *updated*.
- .. versionadded:: 3.2
- Automatic addition of the ``__wrapped__`` attribute.
-
- .. versionadded:: 3.2
- Copying of the ``__annotations__`` attribute by default.
-
.. versionchanged:: 3.2
+ The ``__wrapped__`` attribute is now automatically added.
+ The ``__annotations__`` attribute is now copied by default.
Missing attributes no longer trigger an :exc:`AttributeError`.
.. versionchanged:: 3.4
diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst
index 8785bb7d4b643a..34f0dbdfab07c1 100644
--- a/Doc/library/hashlib.rst
+++ b/Doc/library/hashlib.rst
@@ -77,8 +77,6 @@ accessible by name via :func:`new`. See
:data:`algorithms_available`.
SHA3 (Keccak) and SHAKE constructors :func:`sha3_224`, :func:`sha3_256`,
:func:`sha3_384`, :func:`sha3_512`, :func:`shake_128`, :func:`shake_256`
were added.
-
-.. versionadded:: 3.6
:func:`blake2b` and :func:`blake2s` were added.
.. _hashlib-usedforsecurity:
diff --git a/Doc/library/importlib.metadata.rst
b/Doc/library/importlib.metadata.rst
index d2cc769e2c8400..9abd516239cf01 100644
--- a/Doc/library/importlib.metadata.rst
+++ b/Doc/library/importlib.metadata.rst
@@ -217,7 +217,6 @@ all the metadata in a JSON-compatible form per :PEP:`566`::
The ``Description`` is now included in the metadata when presented
through the payload. Line continuation characters have been removed.
-.. versionadded:: 3.10
The ``json`` attribute was added.
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index c3e7e1f66d9346..870e110b6c49bc 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -2544,7 +2544,6 @@ features:
.. versionchanged:: 3.8
Accepts a :term:`path-like object` and a bytes object on Windows.
- .. versionchanged:: 3.8
Added support for directory junctions, and changed to return the
substitution path (which typically includes ``\\?\`` prefix) rather
than the optional "print name" field that was previously returned.
@@ -3045,21 +3044,21 @@ features:
Time of most recent access expressed in nanoseconds as an integer.
- .. versionadded: 3.3
+ .. versionadded:: 3.3
.. attribute:: st_mtime_ns
Time of most recent content modification expressed in nanoseconds as an
integer.
- .. versionadded: 3.3
+ .. versionadded:: 3.3
.. attribute:: st_ctime_ns
Time of most recent metadata change expressed in nanoseconds as an
integer.
- .. versionadded: 3.3
+ .. versionadded:: 3.3
.. versionchanged:: 3.12
``st_ctime_ns`` is deprecated on Windows. Use ``st_birthtime_ns``
@@ -3187,10 +3186,10 @@ features:
Windows now returns the file index as :attr:`st_ino` when
available.
- .. versionadded:: 3.7
+ .. versionchanged:: 3.7
Added the :attr:`st_fstype` member to Solaris/derivatives.
- .. versionadded:: 3.8
+ .. versionchanged:: 3.8
Added the :attr:`st_reparse_tag` member on Windows.
.. versionchanged:: 3.8
@@ -3204,16 +3203,13 @@ features:
platforms, but for now still contains creation time.
Use :attr:`st_birthtime` for the creation time.
- .. versionchanged:: 3.12
On Windows, :attr:`st_ino` may now be up to 128 bits, depending
on the file system. Previously it would not be above 64 bits, and
larger file identifiers would be arbitrarily packed.
- .. versionchanged:: 3.12
On Windows, :attr:`st_rdev` no longer returns a value. Previously
it would contain the same as :attr:`st_dev`, which was incorrect.
- .. versionadded:: 3.12
Added the :attr:`st_birthtime` member on Windows.
@@ -4215,15 +4211,15 @@ written in Python, such as a mail server's external
command delivery program.
On macOS the use of this function is unsafe when mixed with using
higher-level system APIs, and that includes using :mod:`urllib.request`.
+ .. versionchanged:: 3.8
+ Calling ``forkpty()`` in a subinterpreter is no longer supported
+ (:exc:`RuntimeError` is raised).
+
.. versionchanged:: 3.12
If Python is able to detect that your process has multiple
threads, this now raises a :exc:`DeprecationWarning`. See the
longer explanation on :func:`os.fork`.
- .. versionchanged:: 3.8
- Calling ``forkpty()`` in a subinterpreter is no longer supported
- (:exc:`RuntimeError` is raised).
-
.. availability:: Unix, not Emscripten, not WASI.
@@ -5390,20 +5386,20 @@ Random numbers
easy-to-use interface to the random number generator provided by your
platform, please see :class:`random.SystemRandom`.
- .. versionchanged:: 3.6.0
- On Linux, ``getrandom()`` is now used in blocking mode to increase the
- security.
-
- .. versionchanged:: 3.5.2
- On Linux, if the ``getrandom()`` syscall blocks (the urandom entropy pool
- is not initialized yet), fall back on reading ``/dev/urandom``.
-
.. versionchanged:: 3.5
On Linux 3.17 and newer, the ``getrandom()`` syscall is now used
when available. On OpenBSD 5.6 and newer, the C ``getentropy()``
function is now used. These functions avoid the usage of an internal file
descriptor.
+ .. versionchanged:: 3.5.2
+ On Linux, if the ``getrandom()`` syscall blocks (the urandom entropy pool
+ is not initialized yet), fall back on reading ``/dev/urandom``.
+
+ .. versionchanged:: 3.6
+ On Linux, ``getrandom()`` is now used in blocking mode to increase the
+ security.
+
.. versionchanged:: 3.11
On Windows, ``BCryptGenRandom()`` is used instead of ``CryptGenRandom()``
which is deprecated.
diff --git a/Doc/library/pdb.rst b/Doc/library/pdb.rst
index 785a8ab0c8a8c9..d9cb9a4ecb1b3c 100644
--- a/Doc/library/pdb.rst
+++ b/Doc/library/pdb.rst
@@ -288,15 +288,15 @@ typed at the debugger prompt. This is particularly
useful for aliases. If both
files exist, the one in the home directory is read first and aliases defined
there
can be overridden by the local file.
-.. versionchanged:: 3.11
- :file:`.pdbrc` is now read with ``'utf-8'`` encoding. Previously, it was
read
- with the system locale encoding.
-
.. versionchanged:: 3.2
:file:`.pdbrc` can now contain commands that continue debugging, such as
:pdbcmd:`continue` or :pdbcmd:`next`. Previously, these commands had no
effect.
+.. versionchanged:: 3.11
+ :file:`.pdbrc` is now read with ``'utf-8'`` encoding. Previously, it was
read
+ with the system locale encoding.
+
.. pdbcommand:: h(elp) [command]
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 3b42bb0843adab..249a1c58d04e72 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -1491,8 +1491,7 @@ objects that compare equal might have different
:attr:`~range.start`,
sequence of values they define (instead of comparing based on
object identity).
-.. versionadded:: 3.3
- The :attr:`~range.start`, :attr:`~range.stop` and :attr:`~range.step`
+ Added the :attr:`~range.start`, :attr:`~range.stop` and :attr:`~range.step`
attributes.
.. seealso::
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
index 25a738fc2e62fe..719ee159685a43 100644
--- a/Doc/library/threading.rst
+++ b/Doc/library/threading.rst
@@ -360,12 +360,12 @@ since it is impossible to detect the termination of alien
threads.
base class constructor (``Thread.__init__()``) before doing anything else to
the thread.
+ .. versionchanged:: 3.3
+ Added the *daemon* parameter.
+
.. versionchanged:: 3.10
Use the *target* name if *name* argument is omitted.
- .. versionchanged:: 3.3
- Added the *daemon* argument.
-
.. method:: start()
Start the thread's activity.
diff --git a/Doc/library/time.rst b/Doc/library/time.rst
index da6383ed505d07..ab99314683626b 100644
--- a/Doc/library/time.rst
+++ b/Doc/library/time.rst
@@ -381,15 +381,14 @@ Functions
* Or use ``nanosleep()`` if available (resolution: 1 nanosecond);
* Or use ``select()`` (resolution: 1 microsecond).
- .. versionchanged:: 3.11
- On Unix, the ``clock_nanosleep()`` and ``nanosleep()`` functions are now
- used if available. On Windows, a waitable timer is now used.
-
.. versionchanged:: 3.5
The function now sleeps at least *secs* even if the sleep is interrupted
by a signal, except if the signal handler raises an exception (see
:pep:`475` for the rationale).
+ .. versionchanged:: 3.11
+ On Unix, the ``clock_nanosleep()`` and ``nanosleep()`` functions are now
+ used if available. On Windows, a waitable timer is now used.
.. index::
single: % (percent); datetime format
diff --git a/Doc/library/turtle.rst b/Doc/library/turtle.rst
index 4e1a0948b0f678..ae05b2059a98c2 100644
--- a/Doc/library/turtle.rst
+++ b/Doc/library/turtle.rst
@@ -598,7 +598,7 @@ Turtle motion
>>> turtle.pos()
(20.00,30.00)
- .. versionadded: 3.12
+ .. versionadded:: 3.12
.. function:: setx(x)
diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst
index 3751e81ecfcc81..c6fc325cfd92cf 100644
--- a/Doc/library/urllib.request.rst
+++ b/Doc/library/urllib.request.rst
@@ -105,11 +105,9 @@ The :mod:`urllib.request` module defines the following
functions:
.. versionchanged:: 3.2
*cafile* and *capath* were added.
- .. versionchanged:: 3.2
HTTPS virtual hosts are now supported if possible (that is, if
:const:`ssl.HAS_SNI` is true).
- .. versionadded:: 3.2
*data* can be an iterable object.
.. versionchanged:: 3.3
diff --git a/Doc/reference/lexical_analysis.rst
b/Doc/reference/lexical_analysis.rst
index 73542cfe5004c8..94b13a0e2e616a 100644
--- a/Doc/reference/lexical_analysis.rst
+++ b/Doc/reference/lexical_analysis.rst
@@ -514,7 +514,6 @@ is not supported.
The ``'rb'`` prefix of raw bytes literals has been added as a synonym
of ``'br'``.
-.. versionadded:: 3.3
Support for the unicode legacy literal (``u'value'``) was reintroduced
to simplify the maintenance of dual Python 2.x and 3.x codebases.
See :pep:`414` for more information.
diff --git a/Doc/reference/simple_stmts.rst b/Doc/reference/simple_stmts.rst
index 04132c78ce77a6..810232e09dc5fa 100644
--- a/Doc/reference/simple_stmts.rst
+++ b/Doc/reference/simple_stmts.rst
@@ -664,8 +664,7 @@ and information about handling exceptions is in section
:ref:`try`.
.. versionchanged:: 3.3
:const:`None` is now permitted as ``Y`` in ``raise X from Y``.
-.. versionadded:: 3.3
- The :attr:`~BaseException.__suppress_context__` attribute to suppress
+ Added the :attr:`~BaseException.__suppress_context__` attribute to suppress
automatic display of the exception context.
.. versionchanged:: 3.11
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index 9da28dafdd772c..6ca3e16caa4037 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -375,11 +375,11 @@ Miscellaneous options
:envvar:`PYTHONHASHSEED` allows you to set a fixed value for the hash
seed secret.
+ .. versionadded:: 3.2.3
+
.. versionchanged:: 3.7
The option is no longer ignored.
- .. versionadded:: 3.2.3
-
.. option:: -s
@@ -550,23 +550,22 @@ Miscellaneous options
It also allows passing arbitrary values and retrieving them through the
:data:`sys._xoptions` dictionary.
- .. versionchanged:: 3.2
- The :option:`-X` option was added.
+ .. versionadded:: 3.2
- .. versionadded:: 3.3
- The ``-X faulthandler`` option.
+ .. versionchanged:: 3.3
+ Added the ``-X faulthandler`` option.
- .. versionadded:: 3.4
- The ``-X showrefcount`` and ``-X tracemalloc`` options.
+ .. versionchanged:: 3.4
+ Added the ``-X showrefcount`` and ``-X tracemalloc`` options.
- .. versionadded:: 3.6
- The ``-X showalloccount`` option.
+ .. versionchanged:: 3.6
+ Added the ``-X showalloccount`` option.
- .. versionadded:: 3.7
- The ``-X importtime``, ``-X dev`` and ``-X utf8`` options.
+ .. versionchanged:: 3.7
+ Added the ``-X importtime``, ``-X dev`` and ``-X utf8`` options.
- .. versionadded:: 3.8
- The ``-X pycache_prefix`` option. The ``-X dev`` option now logs
+ .. versionchanged:: 3.8
+ Added the ``-X pycache_prefix`` option. The ``-X dev`` option now logs
``close()`` exceptions in :class:`io.IOBase` destructor.
.. versionchanged:: 3.9
@@ -575,21 +574,16 @@ Miscellaneous options
The ``-X showalloccount`` option has been removed.
- .. versionadded:: 3.10
- The ``-X warn_default_encoding`` option.
+ .. versionchanged:: 3.10
+ Added the ``-X warn_default_encoding`` option.
Removed the ``-X oldparser`` option.
- .. versionadded:: 3.11
- The ``-X no_debug_ranges`` option.
-
- .. versionadded:: 3.11
- The ``-X frozen_modules`` option.
-
- .. versionadded:: 3.11
- The ``-X int_max_str_digits`` option.
+ .. versionchanged:: 3.11
+ Added the ``-X no_debug_ranges``, ``-X frozen_modules`` and
+ ``-X int_max_str_digits`` options.
- .. versionadded:: 3.12
- The ``-X perf`` option.
+ .. versionchanged:: 3.12
+ Added the ``-X perf`` option.
Options you shouldn't use
@@ -909,11 +903,11 @@ conflict.
* ``malloc_debug``: same as ``malloc`` but also install debug hooks.
* ``pymalloc_debug``: same as ``pymalloc`` but also install debug hooks.
+ .. versionadded:: 3.6
+
.. versionchanged:: 3.7
Added the ``"default"`` allocator.
- .. versionadded:: 3.6
-
.. envvar:: PYTHONMALLOCSTATS
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]