https://github.com/python/cpython/commit/3fd61b74de97b152ed424aaea1295292dcb181fd
commit: 3fd61b74de97b152ed424aaea1295292dcb181fd
branch: main
author: Stan Ulbrych <[email protected]>
committer: StanFromIreland <[email protected]>
date: 2026-04-20T17:00:35+01:00
summary:
Use `soft-deprecated` in more places (#148769)
files:
M Doc/c-api/buffer.rst
M Doc/c-api/code.rst
M Doc/c-api/descriptor.rst
M Doc/c-api/exceptions.rst
M Doc/c-api/gen.rst
M Doc/c-api/intro.rst
M Doc/c-api/set.rst
M Doc/c-api/typeobj.rst
M Doc/library/ctypes.rst
M Doc/library/mimetypes.rst
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index fe950196297a24..dc3e0f37c36c5b 100644
--- a/Doc/c-api/buffer.rst
+++ b/Doc/c-api/buffer.rst
@@ -258,7 +258,9 @@ readonly, format
.. c:macro:: PyBUF_WRITEABLE
- This is a :term:`soft deprecated` alias to :c:macro:`PyBUF_WRITABLE`.
+ This is an alias to :c:macro:`PyBUF_WRITABLE`.
+
+ .. soft-deprecated:: 3.13
.. c:macro:: PyBUF_FORMAT
diff --git a/Doc/c-api/code.rst b/Doc/c-api/code.rst
index be2c85ec97489e..57b77f92a7d2e6 100644
--- a/Doc/c-api/code.rst
+++ b/Doc/c-api/code.rst
@@ -212,7 +212,7 @@ bound into a function.
.. c:function:: PyObject *PyCode_Optimize(PyObject *code, PyObject *consts,
PyObject *names, PyObject *lnotab_obj)
- This is a :term:`soft deprecated` function that does nothing.
+ This is a function that does nothing.
Prior to Python 3.10, this function would perform basic optimizations to a
code object.
@@ -220,6 +220,8 @@ bound into a function.
.. versionchanged:: 3.10
This function now does nothing.
+ .. soft-deprecated:: 3.13
+
.. _c_codeobject_flags:
diff --git a/Doc/c-api/descriptor.rst b/Doc/c-api/descriptor.rst
index b913e24b3c7cc8..539c4610ce4f5b 100644
--- a/Doc/c-api/descriptor.rst
+++ b/Doc/c-api/descriptor.rst
@@ -140,7 +140,7 @@ found in the dictionary of type objects.
.. c:macro:: PyDescr_COMMON
- This is a :term:`soft deprecated` macro including the common fields for a
+ This is a macro including the common fields for a
descriptor object.
This was included in Python's C API by mistake; do not use it in extensions.
@@ -148,6 +148,8 @@ found in the dictionary of type objects.
descriptor protocol (:c:member:`~PyTypeObject.tp_descr_get` and
:c:member:`~PyTypeObject.tp_descr_set`).
+ .. soft-deprecated:: 3.15
+
Built-in descriptors
^^^^^^^^^^^^^^^^^^^^
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index 8ecd7c62517104..7a07818b7b4d1a 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -818,7 +818,7 @@ Exception Classes
.. c:macro:: PyException_HEAD
- This is a :term:`soft deprecated` macro including the base fields for an
+ This is a macro including the base fields for an
exception object.
This was included in Python's C API by mistake and is not designed for use
@@ -826,6 +826,8 @@ Exception Classes
:c:func:`PyErr_NewException` or otherwise create a class inheriting from
:c:data:`PyExc_BaseException`.
+ .. soft-deprecated:: 3.15
+
Exception Objects
=================
diff --git a/Doc/c-api/gen.rst b/Doc/c-api/gen.rst
index 74db49a6814800..ed121726b89620 100644
--- a/Doc/c-api/gen.rst
+++ b/Doc/c-api/gen.rst
@@ -90,7 +90,9 @@ Deprecated API
.. c:macro:: PyAsyncGenASend_CheckExact(op)
- This is a :term:`soft deprecated` API that was included in Python's C API
+ This is an API that was included in Python's C API
by mistake.
It is solely here for completeness; do not use this API.
+
+ .. soft-deprecated:: 3.14
diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst
index 0e6fd3421f2b3e..500f2818e2e40a 100644
--- a/Doc/c-api/intro.rst
+++ b/Doc/c-api/intro.rst
@@ -587,10 +587,10 @@ have been standardized in C11 (or previous standards).
.. c:macro:: Py_MEMCPY(dest, src, n)
- This is a :term:`soft deprecated` alias to :c:func:`!memcpy`.
- Use :c:func:`!memcpy` directly instead.
+ This is an alias to :c:func:`!memcpy`.
.. soft-deprecated:: 3.14
+ Use :c:func:`!memcpy` directly instead.
.. c:macro:: Py_UNICODE_SIZE
@@ -611,8 +611,7 @@ have been standardized in C11 (or previous standards).
.. c:macro:: Py_VA_COPY
- This is a :term:`soft deprecated` alias to the C99-standard ``va_copy``
- function.
+ This is an alias to the C99-standard ``va_copy`` function.
Historically, this would use a compiler-specific method to copy a
``va_list``.
diff --git a/Doc/c-api/set.rst b/Doc/c-api/set.rst
index 53febd0c4c116c..db537aff2e6ce5 100644
--- a/Doc/c-api/set.rst
+++ b/Doc/c-api/set.rst
@@ -201,7 +201,7 @@ Deprecated API
.. c:macro:: PySet_MINSIZE
- A :term:`soft deprecated` constant representing the size of an internal
+ A constant representing the size of an internal
preallocated table inside :c:type:`PySetObject` instances.
This is documented solely for completeness, as there are no guarantees
@@ -211,3 +211,5 @@ Deprecated API
:c:macro:`!PySet_MINSIZE` can be replaced with a small constant like ``8``.
If looking for the size of a set, use :c:func:`PySet_Size` instead.
+
+ .. soft-deprecated:: 3.14
diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
index c3960d6ff87ec8..d3d8239365f9bf 100644
--- a/Doc/c-api/typeobj.rst
+++ b/Doc/c-api/typeobj.rst
@@ -1391,8 +1391,8 @@ and :c:data:`PyType_Type` effectively act as defaults.)
.. versionchanged:: 3.9
- Renamed to the current name, without the leading underscore.
- The old provisional name is :term:`soft deprecated`.
+ Renamed to the current name, without the leading underscore.
+ The old provisional name is :term:`soft deprecated`.
.. versionchanged:: 3.12
@@ -1501,11 +1501,13 @@ and :c:data:`PyType_Type` effectively act as defaults.)
.. c:macro:: Py_TPFLAGS_HAVE_VERSION_TAG
- This is a :term:`soft deprecated` macro that does nothing.
+ This macro does nothing.
Historically, this would indicate that the
:c:member:`~PyTypeObject.tp_version_tag` field was available and
initialized.
+ .. soft-deprecated:: 3.13
+
.. c:macro:: Py_TPFLAGS_INLINE_VALUES
diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst
index ff09bb8d884ab6..e71d1d06d49b96 100644
--- a/Doc/library/ctypes.rst
+++ b/Doc/library/ctypes.rst
@@ -3190,8 +3190,8 @@ Arrays and pointers
Equivalent to ``type * length``, where *type* is a
:mod:`!ctypes` data type and *length* an integer.
- This function is :term:`soft deprecated` in favor of multiplication.
- There are no plans to remove it.
+ .. soft-deprecated:: 3.14
+ In favor of multiplication.
.. class:: _Pointer
diff --git a/Doc/library/mimetypes.rst b/Doc/library/mimetypes.rst
index af9098c4970805..0facacd50fd389 100644
--- a/Doc/library/mimetypes.rst
+++ b/Doc/library/mimetypes.rst
@@ -55,7 +55,7 @@ the information :func:`init` sets up.
Added support for *url* being a :term:`path-like object`.
.. soft-deprecated:: 3.13
- Passing a file path instead of URL is :term:`soft deprecated`.
+ Passing a file path instead of URL.
Use :func:`guess_file_type` for this.
_______________________________________________
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]
