Mark interfaces as Protocols and add missing self argument
#4144
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
Avasam
force-pushed
the
pkg_resources-invalid-protocols
branch
from
dbc0eb4
to
2f7156d
Compare
Avasam
force-pushed
the
pkg_resources-invalid-protocols
branch
from
2f7156d
to
f73efcc
Compare
jaraco
reviewed
Jan 24, 2024
| """Execute the named script in the supplied namespace dictionary""" | ||
|
|
||
|
|
||
| class IResourceProvider(IMetadataProvider): | ||
| class IResourceProvider(IMetadataProvider, Protocol): |
There was a problem hiding this comment.
Today I learned about extending protocols. Nice work.
jaraco
reviewed
Jan 24, 2024
| @@ -544,54 +545,54 @@ def get_entry_info(dist, group, name): | |||
| return get_distribution(dist).get_entry_info(group, name) | |||
|
|
|||
|
|
|||
| class IMetadataProvider: | |||
| def has_metadata(name): | |||
| class IMetadataProvider(Protocol): | |||
There was a problem hiding this comment.
I have no idea if these protocols are used anywhere (such as with Zope), but I suspect not. If this change ends up causing unexpected disruption, we may have to back it out. Thanks for making it a separate PR.
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.
Summary of changes
This was noticed in https://github.com/python/typeshed/pull/10058/files#diff-1acb87d31f86c216cde10127dbe27643bd9d83975a757d3fe75559c03fd9b934
This change allows users to use these Protocols in static-type-checking to ensure proper usage of any class implementing these Interfaces.
Doesn't close any open issue, but relates to/work towards #2345
Pull Request Checklist
newsfragments/.(See documentation for details)