summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-03-01 02:14:33 (GMT)
committerGitHub <noreply@github.com>2021-03-01 02:14:33 (GMT)
commit346afeb159a5a8b2e260d3de740019b64352660e (patch)
tree56dd70e0a4d787f62a5b1f456863905b2acfc468
parent07ab490a7a966ce00a61bf56ccd0604434b143a5 (diff)
downloadcpython-346afeb159a5a8b2e260d3de740019b64352660e.zip
cpython-346afeb159a5a8b2e260d3de740019b64352660e.tar.gz
cpython-346afeb159a5a8b2e260d3de740019b64352660e.tar.bz2
bpo-36346: Document removal schedule of deprecate APIs (GH-20879) (#24626)
We will remove wstr cache in Python 3.12. See PEP 623. (cherry picked from commit 2d6f2eed14ff5d89155b52771cc8ef957e8145b4) Co-authored-by: Inada Naoki <songofacandy@gmail.com> Co-authored-by: Inada Naoki <songofacandy@gmail.com>
-rw-r--r--Doc/c-api/arg.rst8
-rw-r--r--Doc/c-api/unicode.rst7
-rw-r--r--Misc/NEWS.d/next/Documentation/2020-06-15-10-45-45.bpo-36346.H0sS_i.rst2
3 files changed, 9 insertions, 8 deletions
diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst
index a187a8f..7a31880 100644
--- a/Doc/c-api/arg.rst
+++ b/Doc/c-api/arg.rst
@@ -151,7 +151,7 @@ which disallows mutable objects such as :class:`bytearray`.
Previously, :exc:`TypeError` was raised when embedded null code points
were encountered in the Python string.
- .. deprecated-removed:: 3.3 4.0
+ .. deprecated-removed:: 3.3 3.12
Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using
:c:func:`PyUnicode_AsWideCharString`.
@@ -160,7 +160,7 @@ which disallows mutable objects such as :class:`bytearray`.
Unicode data buffer, the second one its length. This variant allows
null code points.
- .. deprecated-removed:: 3.3 4.0
+ .. deprecated-removed:: 3.3 3.12
Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using
:c:func:`PyUnicode_AsWideCharString`.
@@ -168,7 +168,7 @@ which disallows mutable objects such as :class:`bytearray`.
Like ``u``, but the Python object may also be ``None``, in which case the
:c:type:`Py_UNICODE` pointer is set to ``NULL``.
- .. deprecated-removed:: 3.3 4.0
+ .. deprecated-removed:: 3.3 3.12
Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using
:c:func:`PyUnicode_AsWideCharString`.
@@ -176,7 +176,7 @@ which disallows mutable objects such as :class:`bytearray`.
Like ``u#``, but the Python object may also be ``None``, in which case the
:c:type:`Py_UNICODE` pointer is set to ``NULL``.
- .. deprecated-removed:: 3.3 4.0
+ .. deprecated-removed:: 3.3 3.12
Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using
:c:func:`PyUnicode_AsWideCharString`.
diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index 9b68c31..bb5091c 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -19,8 +19,7 @@ points must be below 1114112 (which is the full Unicode range).
:c:type:`Py_UNICODE*` and UTF-8 representations are created on demand and cached
in the Unicode object. The :c:type:`Py_UNICODE*` representation is deprecated
-and inefficient; it should be avoided in performance- or memory-sensitive
-situations.
+and inefficient.
Due to the transition between the old APIs and the new APIs, Unicode objects
can internally be in two states depending on how they were created:
@@ -429,7 +428,7 @@ APIs:
If *u* is ``NULL``, this function behaves like :c:func:`PyUnicode_FromUnicode`
with the buffer set to ``NULL``. This usage is deprecated in favor of
- :c:func:`PyUnicode_New`.
+ :c:func:`PyUnicode_New`, and will be removed in Python 3.12.
.. c:function:: PyObject *PyUnicode_FromString(const char *u)
@@ -671,7 +670,7 @@ APIs:
Deprecated Py_UNICODE APIs
""""""""""""""""""""""""""
-.. deprecated-removed:: 3.3 4.0
+.. deprecated-removed:: 3.3 3.12
These API functions are deprecated with the implementation of :pep:`393`.
Extension modules can continue using them, as they will not be removed in Python
diff --git a/Misc/NEWS.d/next/Documentation/2020-06-15-10-45-45.bpo-36346.H0sS_i.rst b/Misc/NEWS.d/next/Documentation/2020-06-15-10-45-45.bpo-36346.H0sS_i.rst
new file mode 100644
index 0000000..b737e12
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2020-06-15-10-45-45.bpo-36346.H0sS_i.rst
@@ -0,0 +1,2 @@
+Update some deprecated unicode APIs which are documented as "will be removed
+in 4.0" to "3.12". See :pep:`623` for detail.