Skip to content

Commit 9c834b4

Browse files
encukouYashp002
andauthored
[3.14] gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII macros (GH-143494) (GH-143785)
(cherry picked from commit 42f7c2d) Co-authored-by: Yashraj <yashrajpala8@gmail.com>
1 parent 57d0e21 commit 9c834b4

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed

Doc/c-api/unicode.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,27 @@ Python:
6565
.. versionadded:: 3.3
6666

6767

68+
The structure of a particular object can be determined using the following
69+
macros.
70+
The macros cannot fail; their behavior is undefined if their argument
71+
is not a Python Unicode object.
72+
73+
.. c:namespace:: NULL
74+
75+
.. c:macro:: PyUnicode_IS_COMPACT(o)
76+
77+
True if *o* uses the :c:struct:`PyCompactUnicodeObject` structure.
78+
79+
.. versionadded:: 3.3
80+
81+
82+
.. c:macro:: PyUnicode_IS_COMPACT_ASCII(o)
83+
84+
True if *o* uses the :c:struct:`PyASCIIObject` structure.
85+
86+
.. versionadded:: 3.3
87+
88+
6889
The following APIs are C macros and static inlined functions for fast checks and
6990
access to internal read-only data of Unicode objects:
7091

Tools/check-c-api-docs/ignored_c_api.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,6 @@ PyUnstable_EXECUTABLE_KIND_PY_FUNCTION
109109
PyUnstable_EXECUTABLE_KIND_SKIP
110110
# cpython/pylifecycle.h
111111
Py_FrozenMain
112-
# cpython/unicodeobject.h
113-
PyUnicode_IS_COMPACT
114-
PyUnicode_IS_COMPACT_ASCII
115112
# pythonrun.h
116113
PyErr_Display
117114
# cpython/objimpl.h

0 commit comments

Comments
 (0)