Skip to content

gh-141004: Document missing descriptor C APIs - #159709

Merged
ZeroIntensity merged 8 commits into
python:mainfrom
ZeroIntensity:docs/c-api/missing-descriptor-functions
Oct 21, 2026
Merged

gh-141004: Document missing descriptor C APIs#159709
ZeroIntensity merged 8 commits into
python:mainfrom
ZeroIntensity:docs/c-api/missing-descriptor-functions

Conversation

@ZeroIntensity

@ZeroIntensity ZeroIntensity commented Oct 19, 2026 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Member

@ZeroIntensity ZeroIntensity added needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Oct 19, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Sprint Oct 19, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Oct 19, 2026
Closed
@ZeroIntensity ZeroIntensity added docs Documentation in the Doc dir skip news labels Oct 19, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Oct 19, 2026
@read-the-docs-community

read-the-docs-community Bot commented Oct 19, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35311135 | 📁 Comparing ded0b99 against main (036d309)

  🔍 Preview build  

56 files changed · + 1 added · ± 55 modified

+ Added

± Modified

@ZeroIntensity ZeroIntensity removed needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Oct 19, 2026
@ZeroIntensity

ZeroIntensity commented Oct 19, 2026

Copy link
Copy Markdown
Member Author

(I need to do the backports manually to avoid adding the soft deprecation in older versions.)

@ZeroIntensity
ZeroIntensity requested a review from encukou October 19, 2026 18:42
encukou
encukou reviewed Oct 21, 2026
View reviewed changes
Comment thread Doc/c-api/descriptor.rst Outdated

@encukou encukou Oct 21, 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.

IMO, we should either document all the fields here, in a way that makes it clear how/why to use this thing, or soft-deprecate PyDescr_NewWrapper & wrapperbase.

@ZeroIntensity ZeroIntensity Oct 21, 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.

I went with the former.

ZeroIntensity and others added 5 commits October 21, 2026 13:50
@ZeroIntensity
Merge branch 'main' of https://github.com/python/cpython into docs/c-…
aeccda2 
…api/missing-descriptor-functions
@ZeroIntensity
Explain how to use PyDescr_NewWrapper.
99d1f96
@ZeroIntensity
Fix checker script.
97030dc
@ZeroIntensity
Document wrapper stuff as internal.
0f76cbb
@encukou
Here's what I meant :)
ded0b99 
- Mention the publicly-unusable API from prose, with no-typesetting
  entries for search & index
- Merge the duplicate description of what wrapperdescrs are; put
  it in the type docs. (The *type* might be useful for extensions.)
@ZeroIntensity
ZeroIntensity enabled auto-merge (squash) October 21, 2026 22:22
@ZeroIntensity
ZeroIntensity merged commit aed4ad8 into python:main Oct 21, 2026
39 checks passed
@ZeroIntensity
ZeroIntensity deleted the docs/c-api/missing-descriptor-functions branch October 21, 2026 22:24
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Oct 21, 2026
@github-project-automation github-project-automation Bot moved this from Todo to Done in Sprint Oct 21, 2026
@ZeroIntensity ZeroIntensity added needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Oct 21, 2026
@miss-islington-app

miss-islington-app Bot commented Oct 21, 2026

Copy link
Copy Markdown

Thanks @ZeroIntensity for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app

miss-islington-app Bot commented Oct 21, 2026

Copy link
Copy Markdown

Thanks @ZeroIntensity for the PR 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app

miss-islington-app Bot commented Oct 21, 2026

Copy link
Copy Markdown

Sorry, @ZeroIntensity, I could not cleanly backport this to 3.14 due to a conflict.

Please backport manually with cherry_picker, see the devguide for more information.

cherry_picker aed4ad8c4397595df7d822749556681a8a86208d 3.14

@miss-islington-app

miss-islington-app Bot commented Oct 21, 2026

Copy link
Copy Markdown

Sorry, @ZeroIntensity, I could not cleanly backport this to 3.15 due to a conflict.

Please backport manually with cherry_picker, see the devguide for more information.

cherry_picker aed4ad8c4397595df7d822749556681a8a86208d 3.15

@bedevere-app

bedevere-app Bot commented Oct 21, 2026

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Oct 21, 2026
@bedevere-app

bedevere-app Bot commented Oct 21, 2026

Copy link
Copy Markdown

GH-160137 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 Oct 21, 2026
ZeroIntensity added a commit that referenced this pull request Oct 21, 2026
@ZeroIntensity @encukou
[3.15] gh-141004: Document missing descriptor C APIs (GH-159709) (GH-…
0cd10d0 
…160136)

(cherry picked from commit aed4ad8)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
ZeroIntensity added a commit that referenced this pull request Oct 21, 2026
@ZeroIntensity @encukou
[3.14] gh-141004: Document missing descriptor C APIs (GH-159709) (GH-…
e51d358 
…160137)

(cherry picked from commit aed4ad8)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@encukou encukou encukou left review comments
@AA-Turner AA-Turner Awaiting requested review from AA-Turner

Assignees

@ZeroIntensity ZeroIntensity

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

@ZeroIntensity @encukou