Skip to content

gh-141004: Document PyOS_InterruptOccurred #141526

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Nov 14, 2025
Merged

gh-141004: Document PyOS_InterruptOccurred #141526

merged 4 commits into from
Nov 14, 2025

Conversation

@StanFromIreland
Copy link
Member

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

@bedevere-app bedevere-app bot mentioned this pull request Nov 13, 2025
Open
ZeroIntensity
ZeroIntensity reviewed Nov 13, 2025
View reviewed changes
ZeroIntensity
ZeroIntensity reviewed Nov 13, 2025
View reviewed changes
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.

Nearly there!

@ZeroIntensity ZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Nov 13, 2025
ZeroIntensity
ZeroIntensity approved these changes Nov 14, 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.

LGTM

@ZeroIntensity ZeroIntensity merged commit ef90261 into python:main Nov 14, 2025
32 checks passed
@miss-islington-app
Copy link

miss-islington-app bot commented Nov 14, 2025

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 14, 2025
@StanFromIreland @miss-islington
pythongh-141004: Document PyOS_InterruptOccurred (pythonGH-141526)
0ff6083 
(cherry picked from commit ef90261)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Nov 14, 2025

GH-141549 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 Nov 14, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 14, 2025
@StanFromIreland @miss-islington
pythongh-141004: Document PyOS_InterruptOccurred (pythonGH-141526)
fd42c02 
(cherry picked from commit ef90261)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Nov 14, 2025

GH-141550 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 Nov 14, 2025
ZeroIntensity pushed a commit that referenced this pull request Nov 14, 2025
@miss-islington @StanFromIreland
[3.14] gh-141004: Document PyOS_InterruptOccurred (GH-141526) (GH-1…
72a8ea7 
…41549)

gh-141004: Document `PyOS_InterruptOccurred` (GH-141526)
(cherry picked from commit ef90261)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@vstinner
Copy link
Member

vstinner commented Nov 14, 2025

The documentation doesn't mention that the function always returns 0 if called from a thread which is not the main thread, or an interpreter which is not the main interpreter. Only the main thread of the main interpreter can return 1.

@ZeroIntensity
Copy link
Member

ZeroIntensity commented Nov 14, 2025

I thought about that, but I didn't think it was particularly important; it's technically an implementation detail, it's not too noticeable in practice, and most people should use PyErr_CheckSignals anyway. Feel free to submit a follow-up PR if you feel strongly about documenting that.

ZeroIntensity pushed a commit that referenced this pull request Nov 14, 2025
@miss-islington @StanFromIreland
[3.13] gh-141004: Document PyOS_InterruptOccurred (GH-141526) (GH-1…
c8c8cc2 
…41550)

gh-141004: Document `PyOS_InterruptOccurred` (GH-141526)
(cherry picked from commit ef90261)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.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

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@StanFromIreland @vstinner @ZeroIntensity