add .get() to the PackageMetadata protocol#444
Merged
jaraco merged 2 commits intopython:mainfrom Apr 7, 2023
dimbleby:metadata-get
Merged
add .get() to the PackageMetadata protocol#444jaraco merged 2 commits intopython:mainfrom dimbleby:metadata-get
jaraco merged 2 commits intopython:mainfrom
dimbleby:metadata-get
Conversation
Contributor
Author
|
Just spotted previous discussion in #384. Conversation there doesn't sound too opposed to this. IMO it's a very natural thing to have on the API, perhaps the new annoyance with the hard-to-avoid warning, alongside an actual merge request, is enough to settle the matter... |
jaraco
approved these changes
Apr 7, 2023
Member
jaraco
left a comment
There was a problem hiding this comment.
Looks good. I'll just add a changelog entry and we can roll this out.
This file contains hidden or 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
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.
__getitem__warns that it will raiseKeyErrorrather than returningNone(I see #371 etc)that's all very well but there's currently no comfortable way for users who anticipate missing values to write their code in a way that doesn't trigger that warning. We seem to be steered towards
which sure seems like a lot of ceremony.
The natural way to do it would be just
value = metadata.get(key). That method exists, but is not exposed by the protocol so if we try to use it then mypy shouts at usTherefore add
get()to that protocol (and testcases showing that it works).