https://github.com/python/cpython/commit/9c834b4f8404f85cb824e2f66a4a5b6eec3068d1 commit: 9c834b4f8404f85cb824e2f66a4a5b6eec3068d1 branch: 3.14 author: Petr Viktorin <[email protected]> committer: encukou <[email protected]> date: 2026-01-13T19:06:23+01:00 summary:
[3.14] gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII macros (GH-143494) (GH-143785) (cherry picked from commit 42f7c2dfba58a8a8f31aba727d0fc51dd3ce2fce) Co-authored-by: Yashraj <[email protected]> files: M Doc/c-api/unicode.rst M Tools/check-c-api-docs/ignored_c_api.txt diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst index 9fa88915c3c023..b7d3aaf3227bf0 100644 --- a/Doc/c-api/unicode.rst +++ b/Doc/c-api/unicode.rst @@ -65,6 +65,27 @@ Python: .. versionadded:: 3.3 + The structure of a particular object can be determined using the following + macros. + The macros cannot fail; their behavior is undefined if their argument + is not a Python Unicode object. + + .. c:namespace:: NULL + + .. c:macro:: PyUnicode_IS_COMPACT(o) + + True if *o* uses the :c:struct:`PyCompactUnicodeObject` structure. + + .. versionadded:: 3.3 + + + .. c:macro:: PyUnicode_IS_COMPACT_ASCII(o) + + True if *o* uses the :c:struct:`PyASCIIObject` structure. + + .. versionadded:: 3.3 + + The following APIs are C macros and static inlined functions for fast checks and access to internal read-only data of Unicode objects: diff --git a/Tools/check-c-api-docs/ignored_c_api.txt b/Tools/check-c-api-docs/ignored_c_api.txt index 5c96e34b0b2187..e73e235d6c6d6f 100644 --- a/Tools/check-c-api-docs/ignored_c_api.txt +++ b/Tools/check-c-api-docs/ignored_c_api.txt @@ -109,9 +109,6 @@ PyUnstable_EXECUTABLE_KIND_PY_FUNCTION PyUnstable_EXECUTABLE_KIND_SKIP # cpython/pylifecycle.h Py_FrozenMain -# cpython/unicodeobject.h -PyUnicode_IS_COMPACT -PyUnicode_IS_COMPACT_ASCII # pythonrun.h PyErr_Display # cpython/objimpl.h _______________________________________________ Python-checkins mailing list -- [email protected] To unsubscribe send an email to [email protected] https://mail.python.org/mailman3//lists/python-checkins.python.org Member address: [email protected]
