Skip to content

gh-141004: Document PyException_HEAD#141522

Closed
StanFromIreland wants to merge 1 commit intopython:mainfrom
StanFromIreland:PyException_HEAD
Closed

gh-141004: Document PyException_HEAD#141522
StanFromIreland wants to merge 1 commit intopython:mainfrom
StanFromIreland:PyException_HEAD

Conversation

@StanFromIreland
Copy link
Member

@StanFromIreland StanFromIreland commented Nov 13, 2025 •
edited by github-actions bot
Loading

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Nov 13, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Nov 13, 2025
@bedevere-app bedevere-app bot mentioned this pull request Nov 13, 2025
Open
ZeroIntensity
ZeroIntensity reviewed Nov 13, 2025
View reviewed changes
Copy link
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

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

Please bring this one up with the C API WG for soft-deprecation. Ideally, new types should use PEP-697.

@vstinner
Copy link
Member

vstinner commented Nov 13, 2025

Is PyException_HEAD used by 3rd party projects? I hope that it's not :-) I don't think that we should document this internal macro.

@StanFromIreland
Copy link
Member Author

StanFromIreland commented Nov 13, 2025

In the top 7000 or so projects:

./confluent_kafka-2.11.0.tar.gz: confluent_kafka-2.11.0/src/confluent_kafka/src/confluent_kafka.c: PyException_HEAD
./confluent_kafka-2.11.1.tar.gz: confluent_kafka-2.11.1/src/confluent_kafka/src/confluent_kafka.c: PyException_HEAD

Time: 0:00:17.890798
Found 2 matching lines in 2 projects

@ZeroIntensity
Copy link
Member

ZeroIntensity commented Nov 14, 2025

I would assume that's being used there because they saw how we define exceptions internally and must have thought, "Oh, so that's how you do that". I'd be in favor of hard-deprecating this one, since it will likely create an actual maintenance burden if we want to change exceptions to use PEP 697 someday.

@StanFromIreland StanFromIreland deleted the PyException_HEAD branch November 14, 2025 16:25
@ZeroIntensity
Copy link
Member

ZeroIntensity commented Nov 14, 2025

Please open a new issue and PR for deprecating this one.

@Krishna-web-hub Krishna-web-hub mentioned this pull request Dec 8, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ZeroIntensity ZeroIntensity ZeroIntensity left review comments

Assignees

No one assigned

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@StanFromIreland @vstinner @ZeroIntensity