Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII macros #143494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
encukou merged 10 commits into from
Jan 12, 2026
Merged

gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII macros #143494

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c8d2cee
unicode doc 1
Yashp002 Jan 6, 2026
26e9725
fix 1 unicode
Yashp002 Jan 6, 2026
6815686
fix 2 unicode
Yashp002 Jan 7, 2026
c0429a1
unicode fix 3
Yashp002 Jan 7, 2026
a934404
unicode fix 4
Yashp002 Jan 8, 2026
03589fc
unicode fix 5
Yashp002 Jan 8, 2026
a5cf326
Merge branch 'main' into doc-unicode-compact
ZeroIntensity Jan 9, 2026
bf035ba
Merge remote-tracking branch 'upstream/main' into doc-unicode-compact
Yashp002 Jan 12, 2026
d292143
Merge branch 'doc-unicode-compact' of https://github.com/Yashp002/cpy…
Yashp002 Jan 12, 2026
037f4b5
unicode c_api_txt fix 6
Yashp002 Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
unicode doc 1
  • Loading branch information
@Yashp002
Yashp002 committed Jan 6, 2026
commit c8d2ceeaa46aaf7e1282de0d23514739da8ad1f2
14 changes: 14 additions & 0 deletions Doc/c-api/unicode.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,20 @@ access to internal read-only data of Unicode objects:
.. versionadded:: 3.3


.. c:macro:: PyUnicode_IS_COMPACT(o)

Return true if the Unicode object *o* is a compact string.
Copy link
Copy Markdown
Member

@ZeroIntensity ZeroIntensity Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you provide a small definition of what a "compact" string is? Same goes for IS_COMPACT_ASCII below.

Copy link
Copy Markdown
Contributor Author

@Yashp002 Yashp002 Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, coming right up.

Copy link
Copy Markdown
Member

@encukou encukou Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather say they use the PyCompactUnicodeObject struct (and PyASCIIObject for COMPACT_ASCII). The docs for the structs discourage using them directly, which is a good thing. I don't think we should provide any details on the storage layouts.

Ideally, document these together with the struct.

Copy link
Copy Markdown
Member

@encukou encukou Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also move the docs to the structs they refer to?

Copy link
Copy Markdown
Contributor Author

@Yashp002 Yashp002 Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also move the docs to the structs they refer to?

I've moved them, please verify if its satisfactory placement. it groups the "Type" and "How to check for that Type" logic imo.


.. versionadded:: 3.3


.. c:macro:: PyUnicode_IS_COMPACT_ASCII(o)

Return true if the Unicode object *o* is a compact ASCII string.

.. versionadded:: 3.3


.. c:function:: void PyUnicode_WRITE(int kind, void *data, \
Py_ssize_t index, Py_UCS4 value)

Expand Down
Loading