From: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Date: Tue, 13 May 2025 23:23:43 +0000 (+0100)
Subject: [3.13] gh-46236: Document PyUnicode_BuildEncodingMap (#133770)
X-Git-Tag: v3.13.4~117
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=78a04b33005252ba9b4626e2b119da962aac2b3b;p=thirdparty%2FPython%2Fcpython.git

[3.13] gh-46236: Document PyUnicode_BuildEncodingMap (#133770)
---

diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index 7baf8de10c81..9e679d080fb5 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -621,6 +621,16 @@ APIs:
    decref'ing the returned objects.
 
 
+.. 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 964914aa714f..042cae5f18ab 100644
--- a/Doc/data/refcounts.dat
+++ b/Doc/data/refcounts.dat
@@ -2759,6 +2759,9 @@ PyUnicode_FromFormatV:va_list:args::
 PyUnicode_FromOrdinal:PyObject*::+1:
 PyUnicode_FromOrdinal:int:ordinal::
 
+PyUnicode_BuildEncodingMap:PyObject*::+1:
+PyUnicode_BuildEncodingMap:PyObject*:string:::
+
 PyUnicode_GetDefaultEncoding:const char*:::
 PyUnicode_GetDefaultEncoding::void::