Skip to content

bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' #22291

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 3 commits into from
Oct 2, 2020
Merged

bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' #22291

merged 3 commits into from
Oct 2, 2020

Conversation

ideasman42
Copy link
Contributor

@ideasman42 ideasman42 commented Sep 17, 2020 •
edited by bedevere-bot
Loading

Correct Documentation, as it's not documented that deleting a key PyDict_DelItem will raise a KeyError if it's not in the dictionary.

This caused me to accidentally misuse the API recently.

https://developer.blender.org/rBef4877fde311f0638617cc6ff29cf64aedb4dab3

issue #41802

https://bugs.python.org/issue41802

@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@ideasman42

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Sep 17, 2020
@ideasman42
Copy link
Contributor Author

ideasman42 commented Sep 19, 2020 •
edited
Loading

Signed the CLA (not sure how long these systems take to refresh).

iritkatriel
iritkatriel reviewed Sep 25, 2020
View reviewed changes
@ideasman42
Update dict.rst
1747c17 
Use new sentence based on feedback.
@iritkatriel
Copy link
Member

You need to link this PR to the bpo ticket: https://bugs.python.org/issue41802
Put the ticket number in the title of the PR (look at other PRs for examples).

@serhiy-storchaka serhiy-storchaka changed the title Document 'PyDict_DelItem' can raise a 'KeyError' bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' Oct 2, 2020
@serhiy-storchaka serhiy-storchaka merged commit 20ce62f into python:master Oct 2, 2020
@miss-islington
Copy link
Contributor

Thanks @ideasman42 for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 2, 2020
@ideasman42 @miss-islington
bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (pythonGH…
0e0871b 
…-22291)

(cherry picked from commit 20ce62f)

Co-authored-by: Campbell Barton <ideasman42@gmail.com>
@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Oct 2, 2020
@bedevere-bot
Copy link

GH-22493 is a backport of this pull request to the 3.9 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 2, 2020
@ideasman42 @miss-islington
bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (pythonGH…
9585d39 
…-22291)

(cherry picked from commit 20ce62f)

Co-authored-by: Campbell Barton <ideasman42@gmail.com>
@bedevere-bot
Copy link

GH-22494 is a backport of this pull request to the 3.8 branch.

miss-islington added a commit that referenced this pull request Oct 2, 2020
@miss-islington @ideasman42
bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (GH-22291)
ab32ea8 
(cherry picked from commit 20ce62f)

Co-authored-by: Campbell Barton <ideasman42@gmail.com>
miss-islington added a commit that referenced this pull request Oct 2, 2020
@miss-islington @ideasman42
bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (GH-22291)
6dc8e0e 
(cherry picked from commit 20ce62f)

Co-authored-by: Campbell Barton <ideasman42@gmail.com>
ambv pushed a commit to ambv/cpython that referenced this pull request Oct 4, 2020
@miss-islington @ideasman42 @ambv
bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (pythonGH…
95de362 
…-22291)

(cherry picked from commit 20ce62f)

Co-authored-by: Campbell Barton <ideasman42@gmail.com>
xzy3 pushed a commit to xzy3/cpython that referenced this pull request Oct 18, 2020
@ideasman42
bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (pythonGH…
4515dd3 
…-22291)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iritkatriel iritkatriel iritkatriel approved these changes

@serhiy-storchaka serhiy-storchaka serhiy-storchaka 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.
7 participants
@ideasman42 @the-knights-who-say-ni @iritkatriel @miss-islington @bedevere-bot @serhiy-storchaka @csabella