Skip to content

gh-131885: Document that dict.setdefault takes no keyword arguments#128208

Merged
picnixz merged 4 commits intopython:mainfrom
adamtheturtle:patch-2
Mar 30, 2025
Merged

gh-131885: Document that dict.setdefault takes no keyword arguments#128208
picnixz merged 4 commits intopython:mainfrom
adamtheturtle:patch-2

Conversation

@adamtheturtle
Copy link
Contributor

@adamtheturtle adamtheturtle commented Dec 23, 2024 •
edited by picnixz
Loading

Running

{}.setdefault("a", default=1)

gives:

TypeError: dict.setdefault() takes no keyword arguments

📚 Documentation preview 📚: https://cpython-previews--128208.org.readthedocs.build/en/128208/library/stdtypes.html#dict.setdefault

@adamtheturtle
Document that dict.setdefault takes no keyword arguments
9cac0ec 
Running

```python
{}.setdefault("a", default=1)
```

gives:

```
TypeError: dict.setdefault() takes no keyword arguments
```
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Dec 23, 2024
@adamtheturtle
Copy link
Contributor Author

adamtheturtle commented Dec 24, 2024

Related: #128207

@ZeroIntensity ZeroIntensity added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Mar 25, 2025
ZeroIntensity
ZeroIntensity reviewed Mar 25, 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.

Sorry for the delay on the review. Could you document this for get as well?

@adamtheturtle
Copy link
Contributor Author

adamtheturtle commented Mar 25, 2025

Could you document this for get as well?

@ZeroIntensity I have now done that

ZeroIntensity
ZeroIntensity approved these changes Mar 25, 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.

Thanks, LGTM.

@ZeroIntensity ZeroIntensity mentioned this pull request Mar 25, 2025
Closed
@ZeroIntensity ZeroIntensity requested a review from picnixz March 25, 2025 15:28
@picnixz picnixz changed the title Document that dict.setdefault takes no keyword arguments gh-131885: Document that dict.setdefault takes no keyword arguments Mar 30, 2025
picnixz
picnixz approved these changes Mar 30, 2025
View reviewed changes
Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

We could argue that this would violate the Mapping contract and that we have a "bug". Yes it violates the contract, however, the EB has decided that this should be the guidelines (see also #129669 (comment)), so this specific change should not be blocked.

@picnixz picnixz mentioned this pull request Mar 30, 2025
Open
5 tasks
@picnixz picnixz enabled auto-merge (squash) March 30, 2025 09:18
@picnixz picnixz merged commit edfbd8c into python:main Mar 30, 2025
26 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Mar 30, 2025
@miss-islington-app
Copy link

miss-islington-app bot commented Mar 30, 2025

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 30, 2025
@adamtheturtle @miss-islington
pythongh-131885: Document that dict.setdefault and dict.get take …
b5d3303 
…no keyword arguments (pythonGH-128208)

(cherry picked from commit edfbd8c)

Co-authored-by: Adam Dangoor <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Mar 30, 2025

GH-131893 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 Mar 30, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 30, 2025
@adamtheturtle @miss-islington
pythongh-131885: Document that dict.setdefault and dict.get take …
000b076 
…no keyword arguments (pythonGH-128208)

(cherry picked from commit edfbd8c)

Co-authored-by: Adam Dangoor <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Mar 30, 2025

GH-131894 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Mar 30, 2025
@picnixz
Copy link
Member

picnixz commented Mar 30, 2025

Thank you for the fix!

picnixz pushed a commit that referenced this pull request Mar 30, 2025
@miss-islington @adamtheturtle
[3.13] gh-131885: Document that dict.setdefault and dict.get take…
2570896 
… no keyword arguments (GH-128208) (#131893)

gh-131885: Document that `dict.setdefault` and `dict.get` take no keyword arguments (GH-128208)
(cherry picked from commit edfbd8c)

Co-authored-by: Adam Dangoor <[email protected]>
picnixz pushed a commit that referenced this pull request Mar 30, 2025
@miss-islington @adamtheturtle
[3.12] gh-131885: Document that dict.setdefault and dict.get take…
525eddf 
… no keyword arguments (GH-128208) (#131894)

gh-131885: Document that `dict.setdefault` and `dict.get` take no keyword arguments (GH-128208)
(cherry picked from commit edfbd8c)

Co-authored-by: Adam Dangoor <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixz picnixz picnixz approved these changes

@ZeroIntensity ZeroIntensity ZeroIntensity approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@adamtheturtle @picnixz @ZeroIntensity