bpo-36346: Document removal schedule of deprecate APIs (GH-20879)

We will remove wstr cache in Python 3.12. See PEP 623.
This commit is contained in:
Inada Naoki 2021-02-23 08:06:51 +09:00 committed by GitHub
parent 91a639a094
commit 2d6f2eed14
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 8 deletions

View file

@ -149,7 +149,7 @@ which disallows mutable objects such as :class:`bytearray`.
Previously, :exc:`TypeError` was raised when embedded null code points Previously, :exc:`TypeError` was raised when embedded null code points
were encountered in the Python string. 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 Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using
:c:func:`PyUnicode_AsWideCharString`. :c:func:`PyUnicode_AsWideCharString`.
@ -158,7 +158,7 @@ which disallows mutable objects such as :class:`bytearray`.
Unicode data buffer, the second one its length. This variant allows Unicode data buffer, the second one its length. This variant allows
null code points. 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 Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using
:c:func:`PyUnicode_AsWideCharString`. :c:func:`PyUnicode_AsWideCharString`.
@ -166,7 +166,7 @@ which disallows mutable objects such as :class:`bytearray`.
Like ``u``, but the Python object may also be ``None``, in which case the Like ``u``, but the Python object may also be ``None``, in which case the
:c:type:`Py_UNICODE` pointer is set to ``NULL``. :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 Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using
:c:func:`PyUnicode_AsWideCharString`. :c:func:`PyUnicode_AsWideCharString`.
@ -174,7 +174,7 @@ which disallows mutable objects such as :class:`bytearray`.
Like ``u#``, but the Python object may also be ``None``, in which case the Like ``u#``, but the Python object may also be ``None``, in which case the
:c:type:`Py_UNICODE` pointer is set to ``NULL``. :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 Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using
:c:func:`PyUnicode_AsWideCharString`. :c:func:`PyUnicode_AsWideCharString`.

View file

@ -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 :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 in the Unicode object. The :c:type:`Py_UNICODE*` representation is deprecated
and inefficient; it should be avoided in performance- or memory-sensitive and inefficient.
situations.
Due to the transition between the old APIs and the new APIs, Unicode objects 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: can internally be in two states depending on how they were created:
@ -434,7 +433,7 @@ APIs:
If *u* is ``NULL``, this function behaves like :c:func:`PyUnicode_FromUnicode` 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 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) .. c:function:: PyObject *PyUnicode_FromString(const char *u)
@ -676,7 +675,7 @@ APIs:
Deprecated Py_UNICODE 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`. 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 Extension modules can continue using them, as they will not be removed in Python

View file

@ -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.