[Python-checkins] gh-103883: Doc: Move PyUnicode_FromObject doc (GH-103913)
methane
webhook-mailer at python.org
Thu Apr 27 02:05:43 EDT 2023
https://github.com/python/cpython/commit/4041251a3620877e840a5c996473f12f2bdf249c
commit: 4041251a3620877e840a5c996473f12f2bdf249c
branch: 3.11
author: Inada Naoki <songofacandy at gmail.com>
committer: methane <songofacandy at gmail.com>
date: 2023-04-27T15:05:35+09:00
summary:
gh-103883: Doc: Move PyUnicode_FromObject doc (GH-103913)
This API is one of Unicode creator APIs.
This APIs should not be placed in PEP 393 deprecated APIs.
Fixes: gh-103883
(cherry picked from commit ce2383ec6665850a1bdffad388876481b6f3205f)
files:
M Doc/c-api/unicode.rst
diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index e72f151510cb..12f95a2e8a39 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -572,6 +572,15 @@ APIs:
arguments.
+.. c:function:: PyObject* PyUnicode_FromObject(PyObject *obj)
+
+ Copy an instance of a Unicode subtype to a new true Unicode object if
+ necessary. If *obj* is already a true Unicode object (not a subtype),
+ return the reference with incremented refcount.
+
+ Objects other than Unicode or its subtypes will cause a :exc:`TypeError`.
+
+
.. c:function:: PyObject* PyUnicode_FromEncodedObject(PyObject *obj, \
const char *encoding, const char *errors)
@@ -752,15 +761,6 @@ Extension modules can continue using them, as they will not be removed in Python
:c:func:`PyUnicode_GET_LENGTH`.
-.. c:function:: PyObject* PyUnicode_FromObject(PyObject *obj)
-
- Copy an instance of a Unicode subtype to a new true Unicode object if
- necessary. If *obj* is already a true Unicode object (not a subtype),
- return the reference with incremented refcount.
-
- Objects other than Unicode or its subtypes will cause a :exc:`TypeError`.
-
-
Locale Encoding
"""""""""""""""
More information about the Python-checkins
mailing list