GH1189/GH1181 Timestamp subtraction and index shift #1191
Merged
Conversation
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
loicdiridollou
commented
Apr 19, 2025
pandas-stubs/core/indexes/base.pyi
Outdated
| @@ -393,7 +393,7 @@ class Index(IndexOpsMixin[S1]): | |||
| def asof_locs(self, where, mask): ... | |||
| def sort_values(self, return_indexer: bool = ..., ascending: bool = ...): ... | |||
| def sort(self, *args, **kwargs) -> None: ... | |||
| def shift(self, periods: int = ..., freq=...) -> None: ... | |||
| def shift(self, periods: int = ..., freq=...) -> Self: ... | |||
There was a problem hiding this comment.
One small question here, pd.Index.shift is technically not implemented so wondering if it should be NoReturn here and Self for pd.DatetimeIndex, pd.TimedeltaIndex and pd.PeriodIndex or if this is fine as is (technically it would fail at runtime anyway so the typing would not help much to spot the bug).
There was a problem hiding this comment.
I think we should take shift() out of here and only include it in the stubs for those 3 types.
There was a problem hiding this comment.
Agreed! Thanks for the direction
Dr-Irv
requested changes
Apr 19, 2025
pandas-stubs/core/indexes/base.pyi
Outdated
| @@ -393,7 +393,7 @@ class Index(IndexOpsMixin[S1]): | |||
| def asof_locs(self, where, mask): ... | |||
| def sort_values(self, return_indexer: bool = ..., ascending: bool = ...): ... | |||
| def sort(self, *args, **kwargs) -> None: ... | |||
| def shift(self, periods: int = ..., freq=...) -> None: ... | |||
| def shift(self, periods: int = ..., freq=...) -> Self: ... | |||
There was a problem hiding this comment.
I think we should take shift() out of here and only include it in the stubs for those 3 types.
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.
assert_type()to assert the type of any return value