◐ Shell
reader mode source ↗
Skip to content

gh-141004: Add a CI job ensuring that new C APIs include documentation#142102

Merged
ZeroIntensity merged 14 commits into
python:mainfrom
ZeroIntensity:c-api-docs-check
Dec 4, 2025
Merged

gh-141004: Add a CI job ensuring that new C APIs include documentation#142102
ZeroIntensity merged 14 commits into
python:mainfrom
ZeroIntensity:c-api-docs-check

Conversation

@ZeroIntensity

@ZeroIntensity ZeroIntensity commented Nov 30, 2025 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Member

This adds a simple job requiring that any new public C APIs come with documentation, which should prevent things from slipping through the cracks each release.

@bedevere-app bedevere-app Bot mentioned this pull request Nov 30, 2025
Open
ZeroIntensity and others added 2 commits November 30, 2025 19:26
@ZeroIntensity @hugovk
Update .github/workflows/build.yml …
f487d6e 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@ZeroIntensity @hugovk
Update Tools/check-c-api-docs/main.py …
02d2f07 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@ZeroIntensity ZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Dec 1, 2025
@ZeroIntensity

ZeroIntensity commented Dec 1, 2025

Copy link
Copy Markdown
Member Author

I plan on backporting this to prevent conflicts when things are removed from ignored_c_api.txt. Any objections?

@hugovk

hugovk commented Dec 1, 2025

Copy link
Copy Markdown
Member

No objection to backporting.

StanFromIreland
StanFromIreland requested changes Dec 1, 2025
View reviewed changes

@StanFromIreland StanFromIreland left a comment •
edited
Loading

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.

Hide comment

This currently picks up decelerations in comments, e.g. Py_OldFunction which is an example. This currently passes as the same example is used in the docs.

Edit: I wrote: ZeroIntensity#6

10 hidden items Load more…
@ZeroIntensity

ZeroIntensity commented Dec 1, 2025

Copy link
Copy Markdown
Member Author

I assume that this is broken in strings too, for example: puts("PyAPI_FUNC(int) PySomething(void);"). There are plenty of ways to break the regular expressions.

We can't really get this to work perfectly without using an actual C parser. If those comments aren't causing problems for us, why bother?

@ZeroIntensity

ZeroIntensity commented Dec 2, 2025

Copy link
Copy Markdown
Member Author

To clarify: I agree with eventually adding better handling, I just don't think it should be done here. I'd like this script to be as close as possible to the script used to generate the list in #141004. We can expand on this in a later iteration.

@ZeroIntensity

ZeroIntensity commented Dec 4, 2025

Copy link
Copy Markdown
Member Author

I'm going to merge this. For changes regarding the mock C parsing here, please open a new issue and/or PR.

@ZeroIntensity ZeroIntensity enabled auto-merge (squash) December 4, 2025 02:49
Hide details View details @ZeroIntensity ZeroIntensity merged commit 1a7824a into python:main Dec 4, 2025
44 checks passed
@miss-islington-app

miss-islington-app Bot commented Dec 4, 2025

Copy link
Copy Markdown

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

@miss-islington-app

miss-islington-app Bot commented Dec 4, 2025

Copy link
Copy Markdown

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

cherry_picker 1a7824a927f0706300af7bfc182884a43e2f587a 3.14

@miss-islington-app

miss-islington-app Bot commented Dec 4, 2025

Copy link
Copy Markdown

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

cherry_picker 1a7824a927f0706300af7bfc182884a43e2f587a 3.13

@bedevere-app

bedevere-app Bot commented Dec 4, 2025

Copy link
Copy Markdown

GH-142247 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 Dec 4, 2025
ZeroIntensity added a commit to ZeroIntensity/cpython that referenced this pull request Dec 4, 2025
@ZeroIntensity @hugovk
pythongh-141004: Add a CI job ensuring that new C APIs include docume… …
be706b1 
…ntation (pythonGH-142102)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
(cherry picked from commit 1a7824a)
ZeroIntensity added a commit to ZeroIntensity/cpython that referenced this pull request Dec 4, 2025
@ZeroIntensity @hugovk
[3.14] pythongh-141004: Add a CI job ensuring that new C APIs include… …
82878b8 
… documentation (pythonGH-142102)

(cherry picked from commit 1a7824a)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Dec 4, 2025

Copy link
Copy Markdown

GH-142248 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 Dec 4, 2025
ZeroIntensity added a commit to ZeroIntensity/cpython that referenced this pull request Dec 4, 2025
@ZeroIntensity @hugovk
pythongh-141004: Add a CI job ensuring that new C APIs include docume… …
aa0d658 
…ntation (pythonGH-142102)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
(cherry picked from commit 1a7824a)
ZeroIntensity added a commit to ZeroIntensity/cpython that referenced this pull request Dec 4, 2025
@ZeroIntensity @hugovk
[3.13] pythongh-141004: Add a CI job ensuring that new C APIs include… …
9345940 
… documentation (pythonGH-142102)

(cherry picked from commit 1a7824a)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
ZeroIntensity added a commit that referenced this pull request Dec 4, 2025
@ZeroIntensity @hugovk
[3.14] gh-141004: Add a CI job ensuring that new C APIs include docum… …
d069edc 
…entation (GH-142102) (GH-142247)

* gh-141004: Add a CI job ensuring that new C APIs include documentation (GH-142102)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
(cherry picked from commit 1a7824a)

---------

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
StanFromIreland pushed a commit to StanFromIreland/cpython that referenced this pull request Dec 6, 2025
@ZeroIntensity @hugovk @StanFromIreland
pythongh-141004: Add a CI job ensuring that new C APIs include docume… …
dac341f 
…ntation (pythonGH-142102)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@ZeroIntensity ZeroIntensity mentioned this pull request Dec 7, 2025
Open
ZeroIntensity added a commit that referenced this pull request Dec 15, 2025
@ZeroIntensity @hugovk
[3.13] gh-141004: Add a CI job ensuring that new C APIs include docum… …
5569ffe 
…entation (GH-142102) (GH-142248)

* gh-141004: Add a CI job ensuring that new C APIs include documentation (GH-142102)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
(cherry picked from commit 1a7824a)

* [3.13] gh-141004: Add a CI job ensuring that new C APIs include documentation (GH-142102)
(cherry picked from commit 1a7824a)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

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

---------

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@sobolevn sobolevn mentioned this pull request Dec 17, 2025
Merged
@encukou encukou mentioned this pull request May 11, 2026
Closed
39 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland requested changes

@hugovk hugovk hugovk approved these changes

@erlend-aasland erlend-aasland Awaiting requested review from erlend-aasland erlend-aasland is a code owner

@AA-Turner AA-Turner

@emmatyping emmatyping Awaiting requested review from emmatyping emmatyping is a code owner

@ezio-melotti ezio-melotti Awaiting requested review from ezio-melotti ezio-melotti is a code owner

Assignees

@ZeroIntensity ZeroIntensity

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ZeroIntensity @hugovk @StanFromIreland