-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Add protocols SequenceLike and MappingLike
#15152
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.
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
Open
srittau
wants to merge
3
commits into
python:main
Choose a base branch
from
srittau:like-protos
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+45
−1
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,18 @@ | |
| # See the README.md file in this directory for more information. | ||
|
|
||
| import sys | ||
| from collections.abc import Awaitable, Callable, Iterable, Iterator, Sequence, Set as AbstractSet, Sized | ||
| from collections.abc import ( | ||
| Awaitable, | ||
| Callable, | ||
| ItemsView, | ||
| Iterable, | ||
| Iterator, | ||
| KeysView, | ||
| Sequence, | ||
| Set as AbstractSet, | ||
| Sized, | ||
| ValuesView, | ||
| ) | ||
| from dataclasses import Field | ||
| from os import PathLike | ||
| from types import FrameType, TracebackType | ||
|
|
@@ -179,6 +190,39 @@ class SupportsItemAccess(Protocol[_KT_contra, _VT]): | |
| def __setitem__(self, key: _KT_contra, value: _VT, /) -> None: ... | ||
| def __delitem__(self, key: _KT_contra, /) -> None: ... | ||
|
|
||
| # Protocol for sequence-like objects. This includes commonly used methods | ||
| # from collections.abc.Sequence, and can be used in argument types when using | ||
| # more specific protocols would be cumbersome. | ||
| # | ||
| # Please note that this protocol is not yet marked as stable, and may be | ||
| # extended in the future to include more methods. | ||
| class SequenceLike(Protocol[_T_co]): | ||
| def __contains__(self, value: object, /) -> bool: ... | ||
| @overload | ||
| def __getitem__(self, index: int, /) -> _T_co: ... | ||
| # This does not necessarily return a sequence of the same type. | ||
| @overload | ||
| def __getitem__(self, index: slice, /) -> SequenceLike[_T_co]: ... | ||
| def __iter__(self) -> Iterator[_T_co]: ... | ||
| def __len__(self) -> int: ... | ||
|
|
||
| # Protocol for mapping-like objects. This includes the methods from | ||
| # collections.abc.Mapping, and can be used in argument types when using | ||
| # more specific protocols would be cumbersome. | ||
| class MappingLike(Protocol[_KT, _VT_co]): | ||
| def __contains__(self, key: object, /) -> bool: ... | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. see my comment at |
||
| def __getitem__(self, key: _KT, /) -> _VT_co: ... | ||
| def __len__(self) -> int: ... | ||
| @overload | ||
| def get(self, key: _KT, /) -> _VT_co | None: ... | ||
| @overload | ||
| def get(self, key: _KT, default: _VT, /) -> _VT_co | _VT: ... | ||
| def items(self) -> ItemsView[_KT, _VT_co]: ... | ||
| def keys(self) -> KeysView[_KT]: ... | ||
| def values(self) -> ValuesView[_VT_co]: ... | ||
|
|
||
| # Path- and I/O-related types | ||
|
|
||
| StrPath: TypeAlias = str | PathLike[str] # stable | ||
| BytesPath: TypeAlias = bytes | PathLike[bytes] # stable | ||
| GenericPath: TypeAlias = AnyStr | PathLike[AnyStr] | ||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe
objectis a bit too restrictive, seeing as this is a contravariant position? (It's not needed for NumPy or anything, just a thought.)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This mirrors the current annotations for
Sequence. Using_T_cowould not work, as that would break covariance. We could useAny, but I'm personally fine with requiring implementors to accept arbitrary objects (since that's whatSequencewas mandating).