Improve several stdlib setdefault methods
#9612
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This is not a comprehensive review of all |
AlexWaygood
commented
Jan 29, 2023
|
Diff from mypy_primer, showing the effect of this PR on open source code: urllib3 (https://github.com/urllib3/urllib3)
+ src/urllib3/_collections.py:270: error: Signature of "setdefault" incompatible with supertype "MutableMapping" [override]
+ src/urllib3/_collections.py:270: note: Superclass:
+ src/urllib3/_collections.py:270: note: @overload
+ src/urllib3/_collections.py:270: note: def setdefault(self, str, None = ..., /) -> Optional[str]
+ src/urllib3/_collections.py:270: note: @overload
+ src/urllib3/_collections.py:270: note: def setdefault(self, str, str, /) -> str
+ src/urllib3/_collections.py:270: note: Subclass:
+ src/urllib3/_collections.py:270: note: def setdefault(self, key: str, default: str = ...) -> str
|
JelleZijlstra
approved these changes
Jan 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MutableMapping.setdefault. It's okay to specify a value for thedefaultparameter and still have this overload match, as long as the value passed for this parameter isNone. Adjustcollections.OrderedDict.setdefaultandweakref.WeakKeyDictionary.setdefaultto match. Add @JelleZijlstra's test cases from Improve type for setdefault() #6941 (comment), to make sure that the method is still working as expected.ChainMap.setdefaultin sync withMutableMapping.setdefault. At runtime, it is directly inherited fromMutableMapping.setdefault. (We don't do that in the stub because we pretendMutableMapping.setdefaulthas positional-only parameters so thatdictcan inherit fromMutableMappingwithout having totype: ignorethesetdefaultmethod.)= ...fromweakref.WeakValueDictionary.setdefault. This has got a default value ofNoneat runtime, but it will always error out if you don't specify a value for thedefaultparameter. (This is because you can't create a weak reference toNone.) It will serve users better if we specify in the stub that you have to provide a value for thedefaultparameter.Refs #9608.