Skip to content

gh-141004: Document remaining PyCF compiler flag macros#153958

Merged
ZeroIntensity merged 7 commits into
python:mainfrom
johnslavik:gh-141004-document-compile-flags
Jul 18, 2026
Merged

gh-141004: Document remaining PyCF compiler flag macros#153958
ZeroIntensity merged 7 commits into
python:mainfrom
johnslavik:gh-141004-document-compile-flags

Conversation

@johnslavik

@johnslavik johnslavik commented Jul 18, 2026 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Member

Document PyCF_DONT_IMPLY_DEDENT, PyCF_IGNORE_COOKIE, PyCF_SOURCE_IS_UTF8, PyCF_MASK and PyCF_COMPILE_MASK in the PyCompilerFlags section, with examples.

@johnslavik
Document remaining PyCF compiler flag macros
1145afa 
Document PyCF_DONT_IMPLY_DEDENT, PyCF_IGNORE_COOKIE,
PyCF_SOURCE_IS_UTF8, PyCF_MASK and PyCF_COMPILE_MASK in the
PyCompilerFlags section, with examples.
@johnslavik
johnslavik requested a review from ZeroIntensity July 18, 2026 13:25
@github-project-automation github-project-automation Bot moved this to Todo in Sprint Jul 18, 2026
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jul 18, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jul 18, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Jul 18, 2026
Open
@read-the-docs-community

read-the-docs-community Bot commented Jul 18, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33646794 | 📁 Comparing 4551189 against main (0e81ef9)

  🔍 Preview build  

7 files changed · ± 7 modified

± Modified

ZeroIntensity
ZeroIntensity reviewed Jul 18, 2026
View reviewed changes

@ZeroIntensity ZeroIntensity left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We should say somewhere in here that users should generally avoid these.

Comment thread Doc/c-api/veryhigh.rst
Comment thread Tools/check-c-api-docs/ignored_c_api.txt Outdated
PyCF_DONT_IMPLY_DEDENT
PyCF_IGNORE_COOKIE
PyCF_MASK
PyCF_MASK_OBSOLETE

@ZeroIntensity ZeroIntensity Jul 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can we also document this one?

@johnslavik johnslavik Jul 18, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Clauding on that, yes

@johnslavik johnslavik Jul 18, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

As asked, I documented PyCF_ALLOW_INCOMPLETE_INPUT (cc @pablogsal) and PyCF_MASK_OBSOLETE.

@johnslavik
Document PyCF_ALLOW_INCOMPLETE_INPUT and PyCF_MASK_OBSOLETE
240487c 
Both entries lead with a caution against using the flag. Remove the
two names from the C API docs ignore list.
@johnslavik
Group low-level compiler flags under a rubric
943ba4e 
Introduce them with a note that code outside the standard library
rarely needs them, and title the masks group for symmetry.
@johnslavik
Trim PyCF_MASK_OBSOLETE description
ef8fae2
@johnslavik
Cover the flag masks by the low-level flags rubric
4020463 
The masks serve the same narrow needs as the flags, so drop their
separate rubric and let the low-level introduction apply to both.
@johnslavik
johnslavik requested a review from ZeroIntensity July 18, 2026 14:11
@ZeroIntensity ZeroIntensity mentioned this pull request Jul 18, 2026
Closed
ZeroIntensity
ZeroIntensity approved these changes Jul 18, 2026
View reviewed changes

@ZeroIntensity ZeroIntensity left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@github-project-automation github-project-automation Bot moved this from Todo to In Progress in Sprint Jul 18, 2026
@ZeroIntensity ZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Jul 18, 2026
@ZeroIntensity
ZeroIntensity enabled auto-merge (squash) July 18, 2026 14:35
@ZeroIntensity
ZeroIntensity merged commit 0a772f2 into python:main Jul 18, 2026
49 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 18, 2026
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Sprint Jul 18, 2026
@miss-islington-app

miss-islington-app Bot commented Jul 18, 2026

Copy link
Copy Markdown

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

@bedevere-app

bedevere-app Bot commented Jul 18, 2026

Copy link
Copy Markdown

GH-153984 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Jul 18, 2026
@bedevere-app

bedevere-app Bot commented Jul 18, 2026

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jul 18, 2026
@bedevere-app

bedevere-app Bot commented Jul 18, 2026

Copy link
Copy Markdown

GH-153986 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Jul 18, 2026
ZeroIntensity pushed a commit that referenced this pull request Jul 18, 2026
@miss-islington @johnslavik
[3.13] gh-141004: Document remaining PyCF_* compiler flag macros (G…
0bb879c 
…H-153958) (GH-153986)

(cherry picked from commit 0a772f2)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
ZeroIntensity pushed a commit that referenced this pull request Jul 18, 2026
@miss-islington @johnslavik
[3.14] gh-141004: Document remaining PyCF_* compiler flag macros (G…
7ba67bf 
…H-153958) (GH-153985)

(cherry picked from commit 0a772f2)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
ZeroIntensity pushed a commit that referenced this pull request Jul 18, 2026
@miss-islington @johnslavik
[3.15] gh-141004: Document remaining PyCF_* compiler flag macros (G…
57a8629 
…H-153958) (GH-153984)

(cherry picked from commit 0a772f2)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ZeroIntensity ZeroIntensity ZeroIntensity approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news sprint

Projects

Docs PRs
Status: Done
Sprint
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@johnslavik @ZeroIntensity