gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII macros by Yashp002 · Pull Request #143494 · python/cpython

Yashp002 · 2026-01-06T19:46:33Z

This PR documents PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII, which were identified as undocumented public macros in issue #141004.

Issue: Document the entire C API #141004

📚 Documentation preview 📚: https://cpython-previews--143494.org.readthedocs.build/

ZeroIntensity · 2026-01-06T19:50:39Z


+.. c:macro:: PyUnicode_IS_COMPACT(o)
+
+ Return true if the Unicode object *o* is a compact string.


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

Sure, coming right up.

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.

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

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.

encukou · 2026-01-07T07:54:09Z

(FWIW, I want to deprecate these, but they have a use case that'll need a PEP with better API: https://discuss.python.org/t/82543.) [edit: link fixed)

encukou · 2026-01-07T07:58:00Z

Could you also remove these from Tools/check-c-api-docs/ignored_c_api.txt?

Yashp002 · 2026-01-07T10:32:09Z

I'll update the wording.

And yes, I'll remove them from ignored_c_api.txt to ensure they are properly checked going forward.
also the link u've sent is a "Page not found".

ZeroIntensity · 2026-01-08T13:15:43Z

@@ -89,5 +89,4 @@ PyUnstable_EXECUTABLE_KIND_SKIP
 # cpython/pylifecycle.h
 Py_FrozenMain
 # cpython/unicodeobject.h


Please remove this comment as well.

Co-authored-by: Petr Viktorin <encukou@gmail.com>

Yashp002 · 2026-01-08T18:27:04Z

Test failure unrelated to my docs change - multiprocessing timeout issue.
@ZeroIntensity , @encukou

ZeroIntensity · 2026-01-09T13:21:15Z

ignored_c_api.txt has some conflicts now.

Yashp002 · 2026-01-09T17:09:17Z

ignored_c_api.txt has some conflicts now.

Wait I'm sorry, do we go with the incoming change or the current change here?
@ZeroIntensity

ZeroIntensity · 2026-01-09T18:52:03Z

We needed to merge the two. I fixed it for you.

Yashp002 · 2026-01-09T19:06:39Z

@ZeroIntensity Yeah my bad, i was a little confused there. Thanks for the help

Edit: I also think we need to remove some more lines from the ignore_c_api.txt as it claims some things to be documented but still existing in the file.

Yashp002 · 2026-01-11T11:22:07Z

@ZeroIntensity Could you update me on this PR?
It still seems to be failing one test after the ignorecapi.txt fix

ZeroIntensity · 2026-01-11T14:11:11Z

It's complaining that some C APIs are documented but also listed in ignored_c_api.txt. Just remove those.

…thon into doc-unicode-compact

Yashp002 · 2026-01-12T10:33:25Z

@ZeroIntensity I think i fixed the test problem yeah

miss-islington-app · 2026-01-12T13:00:03Z

Thanks @Yashp002 for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington-app · 2026-01-12T13:00:06Z

Sorry, @Yashp002 and @encukou, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 42f7c2dfba58a8a8f31aba727d0fc51dd3ce2fce 3.14

miss-islington-app · 2026-01-12T13:00:10Z

Sorry, @Yashp002 and @encukou, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 42f7c2dfba58a8a8f31aba727d0fc51dd3ce2fce 3.13

…CT_ASCII macros (pythonGH-143494)

…CT_ASCII macros (pythonGH-143494) (cherry picked from commit 42f7c2d)

bedevere-app · 2026-01-13T12:12:14Z

GH-143785 is a backport of this pull request to the 3.14 branch.

…ACT_ASCII macros (GH-143494) (GH-143785) (cherry picked from commit 42f7c2d) Co-authored-by: Yashraj <yashrajpala8@gmail.com>

…CT_ASCII macros (pythonGH-143494)

unicode doc 1
c8d2cee

bedevere-appBot added docs Documentation in the Doc dir skip news labels Jan 6, 2026

github-project-automationBot added this to Docs PRs Jan 6, 2026

github-project-automationBot moved this to Todo in Docs PRs Jan 6, 2026

bedevere-appBot added the awaiting review label Jan 6, 2026

bedevere-appBot mentioned this pull request Jan 6, 2026
Document the entire C API #141004
Open

ZeroIntensity reviewed Jan 6, 2026
View reviewed changes

fix 1 unicode
26e9725

Yashp002 added 2 commits January 7, 2026 16:05

fix 2 unicode
6815686

unicode fix 3
c0429a1

encukou reviewed Jan 8, 2026
View reviewed changes

Comment threadDoc/c-api/unicode.rst Outdated

ZeroIntensity reviewed Jan 8, 2026
View reviewed changes

Yashp002and others added 2 commits January 8, 2026 22:28

unicode fix 4
a934404
Co-authored-by: Petr Viktorin <encukou@gmail.com>

unicode fix 5
03589fc

Yashp002 mentioned this pull request Jan 8, 2026
gh-141004: Document unstable executable kind macros in pyframe.h#143490
Merged

encukou added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jan 9, 2026

Merge branch 'main' into doc-unicode-compact
a5cf326

Merge remote-tracking branch 'upstream/main' into doc-unicode-compact
bf035ba

Yashp002 added 2 commits January 12, 2026 15:12

Merge branch 'doc-unicode-compact' ofhttps://github.com/Yashp002/cpy…
d292143
…thon into doc-unicode-compact

unicode c_api_txt fix 6
037f4b5

vstinner approved these changes Jan 12, 2026
View reviewed changes

bedevere-appBot added awaiting merge and removed awaiting review labels Jan 12, 2026

encukou merged commit 42f7c2d into python:mainJan 12, 2026
59 checks passed

bedevere-appBot removed the awaiting merge label Jan 12, 2026

github-project-automationBot moved this from Todo to Done in Docs PRs Jan 12, 2026

miss-islington-appBot assigned encukou Jan 12, 2026

reidenong pushed a commit to reidenong/cpython that referenced this pull request Jan 12, 2026
pythongh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPA…
940704d
…CT_ASCII macros (pythonGH-143494)

encukou pushed a commit to encukou/cpython that referenced this pull request Jan 13, 2026
pythongh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPA…
19121c0
…CT_ASCII macros (pythonGH-143494) (cherry picked from commit 42f7c2d)

bedevere-appBot removed the needs backport to 3.14 bugs and security fixes label Jan 13, 2026

encukou removed the needs backport to 3.13 bugs and security fixes label Jan 13, 2026

encukou added a commit that referenced this pull request Jan 13, 2026
[3.14]gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMP…
9c834b4
…ACT_ASCII macros (GH-143494) (GH-143785) (cherry picked from commit 42f7c2d) Co-authored-by: Yashraj <yashrajpala8@gmail.com>

thunder-coding pushed a commit to thunder-coding/cpython that referenced this pull request Feb 15, 2026
pythongh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPA…
8aaaf52
…CT_ASCII macros (pythonGH-143494)


		.. c:macro:: PyUnicode_IS_COMPACT(o)

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

Uh oh!

Uh oh!

Conversation

Yashp002 commented Jan 6, 2026• edited by github-actions BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ZeroIntensityJan 6, 2026

Choose a reason for hiding this comment

Uh oh!

Yashp002Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

encukouJan 7, 2026

Choose a reason for hiding this comment

Uh oh!

encukouJan 7, 2026

Choose a reason for hiding this comment

Uh oh!

Yashp002Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

encukou commented Jan 7, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

encukou commented Jan 7, 2026

Uh oh!

Yashp002 commented Jan 7, 2026

Uh oh!

Uh oh!

ZeroIntensityJan 8, 2026

Choose a reason for hiding this comment

Uh oh!

Yashp002 commented Jan 8, 2026

Uh oh!

ZeroIntensity commented Jan 9, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Yashp002 commented Jan 9, 2026

Uh oh!

ZeroIntensity commented Jan 9, 2026

Uh oh!

Yashp002 commented Jan 9, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Yashp002 commented Jan 11, 2026

Uh oh!

ZeroIntensity commented Jan 11, 2026

Uh oh!

Yashp002 commented Jan 12, 2026

Uh oh!

Uh oh!

miss-islington-appBot commented Jan 12, 2026

Uh oh!

miss-islington-appBot commented Jan 12, 2026

Uh oh!

miss-islington-appBot commented Jan 12, 2026

Uh oh!

bedevere-appBot commented Jan 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Yashp002 commented Jan 6, 2026•
edited by github-actions Bot
Loading

encukou commented Jan 7, 2026•
edited
Loading

ZeroIntensity commented Jan 9, 2026•
edited
Loading

Yashp002 commented Jan 9, 2026•
edited
Loading