Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

gh-141004: Improvemake check-c-api-docs#143564

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.

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

Already on GitHub?Sign in to your account

Merged
encukou merged 2 commits intopython:mainfromencukou:doccheck-glob-findall
Jan 9, 2026

Conversation

@encukou
Copy link
Member

@encukouencukou commentedJan 8, 2026•
edited by bedevere-appbot
Loading

  • Gather all documented names into a set in a single pass. This makes the check much faster.

  • Do not match substrings (e.g. documentingPyErr_WarnEx doesn't mean thatPyErr_Warn is documented)

  • ConsiderPY-prefixed names (a lot of old macros use this)

This makes the check much faster.It also found 4 additional undocumented APIs, as it does notmatch substrings (e.g. documenting `PyErr_WarnEx` doesn'tmean that `PyErr_Warn` is documented)
Copy link
Member

@ZeroIntensityZeroIntensity left a comment

Choose a reason for hiding this comment

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

Thanks, this looks pretty good as-is.

One extra thing I would like to do is run the script on docs PRs, since a name being documented while also being inignored_c_api.txt will cause it to fail. So, if someone merges new documentation without updatingignored_c_api.txt, we'll see blocking failures on all C code PRs until we fix it. I haven't looked too closely at the GHA for change detection, but if you see an easy way to do that, would you mind doing it in this PR?

@encukou
Copy link
MemberAuthor

I'm not much of a GHA expert, so I'd leave changes to that to a separate PR.
(If we do that, we should take the names from the newly-built Intersphinx inventory, rather than parse the.rst. I can do the parsing; the GHA integration is intimidating.)

Copy link
Member

@ZeroIntensityZeroIntensity left a comment

Choose a reason for hiding this comment

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

Ok, let's just merge this as-is.

@StanFromIreland
Copy link
Member

One extra thing I would like to do is run the script on docs PRs, since a name being documented while also being inignored_c_api.txt will cause it to fail. So, if someone merges new documentation without updatingignored_c_api.txt, we'll see blocking failures on all C code PRs until we fix it. I haven't looked too closely at the GHA for change detection, but if you see an easy way to do that, would you mind doing it in this PR?

See#143573.

@encukouencukou merged commit234a15d intopython:mainJan 9, 2026
65 checks passed
@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

Sorry,@encukou, I could not cleanly backport this to3.14 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker 234a15dc4ec2d8f8ababea91532ebe896a96387a 3.14

@encukouencukou deleted the doccheck-glob-findall branchJanuary 9, 2026 10:16
@miss-islington-app
Copy link

Sorry,@encukou, I could not cleanly backport this to3.13 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker 234a15dc4ec2d8f8ababea91532ebe896a96387a 3.13

encukou added a commit to encukou/cpython that referenced this pull requestJan 9, 2026
)- Gather all documented names into a set in a single pass.  This makes the check much faster.- Do not match substrings (e.g. documenting `PyErr_WarnEx`  doesn't mean that `PyErr_Warn` is documented)- Consider `PY`-prefixed names (a lot of old macros use this)(cherry picked from commit234a15d)
@bedevere-app
Copy link

GH-143593 is a backport of this pull request to the3.14 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.14bugs and security fixes labelJan 9, 2026
encukou added a commit to encukou/cpython that referenced this pull requestJan 9, 2026
- Gather all documented names into a set in a single pass.  This makes the check much faster.- Do not match substrings (e.g. documenting `PyErr_WarnEx`  doesn't mean that `PyErr_Warn` is documented)- Consider `PY`-prefixed names (a lot of old macros use this)(cherry picked from commit234a15d)
@bedevere-app
Copy link

GH-143594 is a backport of this pull request to the3.13 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.13bugs and security fixes labelJan 9, 2026
encukou added a commit that referenced this pull requestJan 12, 2026
)- Gather all documented names into a set in a single pass.  This makes the check much faster.- Do not match substrings (e.g. documenting `PyErr_WarnEx`  doesn't mean that `PyErr_Warn` is documented)- Consider `PY`-prefixed names (a lot of old macros use this)(cherry picked from commit234a15d)
encukou added a commit that referenced this pull requestJan 12, 2026
)- Gather all documented names into a set in a single pass.  This makes the check much faster.- Do not match substrings (e.g. documenting `PyErr_WarnEx`  doesn't mean that `PyErr_Warn` is documented)- Consider `PY`-prefixed names (a lot of old macros use this)(cherry picked from commit234a15d)
@bedevere-bot
Copy link

⚠️⚠️⚠️ Buildbot failure⚠️⚠️⚠️

Hi! The buildbotx86-64 MacOS Intel NoGIL 3.13 (tier-2) has failed when building commitb06ef5b.

What do you need to do:

  1. Don't panic.
  2. Checkthe buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1449/builds/1695) and take a look at the build logs.
  4. Check if the failure is related to this commit (b06ef5b) or if it is a false positive.
  5. If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1449/builds/1695

Failed tests:

  • test.test_multiprocessing_forkserver.test_processes

Failed subtests:

  • test_repr_rlock - test.test_multiprocessing_forkserver.test_processes.WithProcessesTestLock.test_repr_rlock

Summary of the results of the build (if available):

==

Click to see traceback logs
Traceback (most recent call last):  File"/Users/buildbot/buildarea/3.13.itamaro-macos-intel-aws.nogil/build/Lib/test/_test_multiprocessing.py", line1493, intest_repr_rlockself.assertEqual('<RLock(SomeOtherThread, nonzero)>',repr(lock))~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^AssertionError:'<RLock(SomeOtherThread, nonzero)>' != '<RLock(None, 0)>'- <RLock(SomeOtherThread, nonzero)>+ <RLock(None, 0)>

reidenong pushed a commit to reidenong/cpython that referenced this pull requestJan 12, 2026
- Gather all documented names into a set in a single pass.  This makes the check much faster.- Do not match substrings (e.g. documenting `PyErr_WarnEx`  doesn't mean that `PyErr_Warn` is documented)- Consider `PY`-prefixed names (a lot of old macros use this)
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@ZeroIntensityZeroIntensityZeroIntensity approved these changes

Assignees

@encukouencukou

Labels

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@encukou@StanFromIreland@bedevere-bot@ZeroIntensity
[8]ページ先頭
©2009-2026 Movatter.jp