Skip to content
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

bpo-35461: Document C API functions which suppress exceptions. #11119

Merged
merged 3 commits into from
Dec 18, 2018
Merged

bpo-35461: Document C API functions which suppress exceptions. #11119

merged 3 commits into from
Dec 18, 2018

Conversation

serhiy-storchaka
Copy link
Member

@serhiy-storchaka serhiy-storchaka commented Dec 11, 2018 •
edited by bedevere-bot
Loading

vstinner
vstinner reviewed Dec 11, 2018
View reviewed changes
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

"Note that errors raised in" is vague. Reader can understand "exceptions directly raised by the executed code", but these functions can get exceptions caused by a signal handler like KeyboardInterrupt.

Maybe add a new paragraph somewhere in the C API documentation to explain that, and add a link to paragraph?

@serhiy-storchaka
Copy link
Member Author

The wording was slightly changed.

vstinner
vstinner approved these changes Dec 18, 2018
View reviewed changes
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

LGTM.

@serhiy-storchaka serhiy-storchaka merged commit 3fcc1e0 into python:master Dec 18, 2018
@miss-islington
Copy link
Contributor

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 2.7, 3.6, 3.7.
🐍🍒⛏🤖

@serhiy-storchaka serhiy-storchaka deleted the doc-c-api-suppress-exceptions branch December 18, 2018 11:57
@bedevere-bot
Copy link

GH-11209 is a backport of this pull request to the 3.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 18, 2018
@serhiy-storchaka @miss-islington
bpo-35461: Document C API functions which suppress exceptions. (pytho…
a452e19 
…nGH-11119)

(cherry picked from commit 3fcc1e0)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-bot
Copy link

GH-11210 is a backport of this pull request to the 3.6 branch.

@miss-islington
Copy link
Contributor

Sorry, @serhiy-storchaka, I could not cleanly backport this to 2.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 3fcc1e08db6fb7e17acc4a8f63be3e42f52f094b 2.7

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 18, 2018
@serhiy-storchaka @miss-islington
bpo-35461: Document C API functions which suppress exceptions. (pytho…
8afe996 
…nGH-11119)

(cherry picked from commit 3fcc1e0)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
miss-islington added a commit that referenced this pull request Dec 18, 2018
@miss-islington @serhiy-storchaka
bpo-35461: Document C API functions which suppress exceptions. (GH-11119
f265afe 
)

(cherry picked from commit 3fcc1e0)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@serhiy-storchaka serhiy-storchaka removed their assignment Dec 19, 2018
ned-deily pushed a commit that referenced this pull request Dec 20, 2018
@miss-islington @serhiy-storchaka @ned-deily
bpo-35461: Document C API functions which suppress exceptions. (GH-11119
ff740db 
) (GH-11210)

(cherry picked from commit 3fcc1e0)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
christopheNan
christopheNan reviewed Mar 2, 2019
View reviewed changes
Doc/c-api/objbuffer.rst
Otherwise returns ``0``. This function always succeeds.

Note that this function tries to get and release a buffer, and exceptions
which occur while calling correspoding functions will get suppressed.
Copy link
Contributor

@christopheNan christopheNan Mar 2, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

There is a typo in "corresponding"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christopheNan christopheNan christopheNan left review comments

@vstinner vstinner vstinner approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@serhiy-storchaka @miss-islington @bedevere-bot @vstinner @christopheNan @the-knights-who-say-ni