summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorInada Naoki <songofacandy@gmail.com>2020-08-07 07:31:53 (GMT)
committerGitHub <noreply@github.com>2020-08-07 07:31:53 (GMT)
commit46e19b61d31ba99f049258efa4ff1334856a3643 (patch)
treea7518191a35da0c804a41cf07435dd9e541c2f52
parent54636355805dd2877bb54fbad8d967e1ddd8b553 (diff)
downloadcpython-46e19b61d31ba99f049258efa4ff1334856a3643.zip
cpython-46e19b61d31ba99f049258efa4ff1334856a3643.tar.gz
cpython-46e19b61d31ba99f049258efa4ff1334856a3643.tar.bz2
bpo-41098: Doc: Add missing deprecated directives (GH-21162)
PyUnicodeEncodeError_Create has been deprecated with `Py_DEPRECATED` macro. But it was not documented.
-rw-r--r--Doc/c-api/exceptions.rst10
-rw-r--r--Include/cpython/pyerrors.h10
2 files changed, 18 insertions, 2 deletions
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index e7805ba..b4722ff 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -637,11 +637,21 @@ The following functions are used to create and modify Unicode exceptions from C.
*object*, *length*, *start*, *end* and *reason*. *encoding* and *reason* are
UTF-8 encoded strings.
+ .. deprecated:: 3.3 3.11
+
+ ``Py_UNICODE`` is deprecated since Python 3.3. Please migrate to
+ ``PyObject_CallFunction(PyExc_UnicodeEncodeError, "sOnns", ...)``.
+
.. c:function:: PyObject* PyUnicodeTranslateError_Create(const Py_UNICODE *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)
Create a :class:`UnicodeTranslateError` object with the attributes *object*,
*length*, *start*, *end* and *reason*. *reason* is a UTF-8 encoded string.
+ .. deprecated:: 3.3 3.11
+
+ ``Py_UNICODE`` is deprecated since Python 3.3. Please migrate to
+ ``PyObject_CallFunction(PyExc_UnicodeTranslateError, "Onns", ...)``.
+
.. c:function:: PyObject* PyUnicodeDecodeError_GetEncoding(PyObject *exc)
PyObject* PyUnicodeEncodeError_GetEncoding(PyObject *exc)
diff --git a/Include/cpython/pyerrors.h b/Include/cpython/pyerrors.h
index 3f347dc..c2500d9 100644
--- a/Include/cpython/pyerrors.h
+++ b/Include/cpython/pyerrors.h
@@ -145,7 +145,10 @@ PyAPI_FUNC(PyObject *) PyErr_ProgramTextObject(
PyObject *filename,
int lineno);
-/* Create a UnicodeEncodeError object */
+/* Create a UnicodeEncodeError object.
+ *
+ * TODO: This API will be removed in Python 3.11.
+ */
Py_DEPRECATED(3.3) PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_Create(
const char *encoding, /* UTF-8 encoded string */
const Py_UNICODE *object,
@@ -155,7 +158,10 @@ Py_DEPRECATED(3.3) PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_Create(
const char *reason /* UTF-8 encoded string */
);
-/* Create a UnicodeTranslateError object */
+/* Create a UnicodeTranslateError object.
+ *
+ * TODO: This API will be removed in Python 3.11.
+ */
Py_DEPRECATED(3.3) PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_Create(
const Py_UNICODE *object,
Py_ssize_t length,