Add Ellipsis typehints #7017
Add Ellipsis typehints #7017
Conversation
|
|
||
| T_Dataset = TypeVar("T_Dataset", bound="Dataset") | ||
| T_DataArray = TypeVar("T_DataArray", bound="DataArray") | ||
| T_Variable = TypeVar("T_Variable", bound="Variable") | ||
| T_Array = TypeVar("T_Array", bound="AbstractArray") |
There was a problem hiding this comment.
whoops that was not supposed to be checked in, but I guess it doesn't hurt.
| @@ -3769,7 +3770,7 @@ def imag(self: T_DataArray) -> T_DataArray: | |||
| def dot( | |||
| self: T_DataArray, | |||
| other: T_DataArray, | |||
| dims: Hashable | Sequence[Hashable] | None = None, | |||
| dims: str | Iterable[Hashable] | Ellipsis | None = None, | |||
There was a problem hiding this comment.
Excellent! Great that we can roll the str | Iterable[Hashable] out
There was a problem hiding this comment.
Yes, as soon as you try to type some internals you will run into problems with Hashable | Sequence[Hashable].
This really seems to be the only way.
We should probably add a parser for this in utils such that all methods handle it the same.
Maybe I can come up with a PR for that.
I saw that issue :) |
|
That makes sense. Until mypy make the change, I think this is a nice signpost for users, and will be easily forward compatible… |
For Groupby reductions |
This PR adds an
Ellipsistypehint to some functions.Interestingly mypy did not complain at the tests before, I assume it is because "..." is Hashable or something like that?
I don't know what to do with reductions, since they also support ellipsis, but it is basically the same as using None.
Therefore, I assume it is not necessary to expose this feature.
Did I miss any functions where ellipsis is supported? It is hard to look for "..."... xD