[3.14] gh-46236: Document PyUnicode_BuildEncodingMap (GH-133270) (#133769)

gh-46236: Document PyUnicode_BuildEncodingMap (GH-133270)
(cherry picked from commit f34ec09ba51070b0693d7ced8e57e77d71beb48d)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index 95987e872ce639df42d93c935d4cef52117f267d..cdd90d05b70b36df33b6337fba66b7d946b12bc3 100644 (file)
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -645,6 +645,17 @@ APIs:
    difference being that it decrements the reference count of *right* by one.
 
 
+.. c:function:: PyObject* PyUnicode_BuildEncodingMap(PyObject* string)
+
+   Return a mapping suitable for decoding a custom single-byte encoding.
+   Given a Unicode string *string* of up to 256 characters representing an encoding
+   table, returns either a compact internal mapping object or a dictionary
+   mapping character ordinals to byte values. Raises a :exc:`TypeError` and
+   return ``NULL`` on invalid input.
+
+   .. versionadded:: 3.2
+
+
 .. c:function:: const char* PyUnicode_GetDefaultEncoding(void)
 
    Return the name of the default string encoding, ``"utf-8"``.

diff --git a/Doc/data/refcounts.dat b/Doc/data/refcounts.dat
index ca99b9e6d371418e20d5a67a6cd68414e2721a2b..c97cd2b8d1e3cb9d61913fd2cccf2aa37a476919 100644 (file)
--- a/Doc/data/refcounts.dat
+++ b/Doc/data/refcounts.dat
@@ -2781,6 +2781,9 @@ PyUnicode_AppendAndDel:void:::
 PyUnicode_AppendAndDel:PyObject**:p_left:0:
 PyUnicode_AppendAndDel:PyObject*:right:-1:
 
+PyUnicode_BuildEncodingMap:PyObject*::+1:
+PyUnicode_BuildEncodingMap:PyObject*:string:::
+
 PyUnicode_GetDefaultEncoding:const char*:::
 PyUnicode_GetDefaultEncoding::void::