Update timestamps.pyi #818
Closed
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
Dr-Irv
requested changes
Nov 10, 2023
davetapley
commented
Nov 10, 2023
Dr-Irv
requested changes
Nov 10, 2023
Comment on lines
+305
to
+306
| def unit(self) -> str: ... | ||
| def as_unit(self, unit: str, round_ok: bool = ...) -> Timestamp: ... |
There was a problem hiding this comment.
The only possible values for the return of unit are Literal["s", "ms", "us", "ns"] In pandas, this is now defined in pandas._typing.py via:
TimeUnit = Literal["s", "ms", "us", "ns"]So can you do the following:
- Add that line to
pandas-stubs/_typing.pyi - Make the return value of
unitbeTimeUnit - Make the allowable values of
unitinas_unitto beTimeUnit
You probably will have to change the test for ts.unit to use assert_type() testing against TimeUnit
If you want to go beyond that, the declaration Literal["s", "ms", "us", "ns"] appears in the following files and should be replaced with TimeUnit:
- pandas-stubs/core/frame.pyi
- pandas-stubs/core/indexes/datetimes.pyi
- pandas-stubs/core/series.pyi
- pandas-stubs/io/json/_json.pyi
But if you don't want to make that change, it's OK - I can just create a new issue for that once this PR is done.
| @@ -1530,6 +1531,8 @@ def test_timestamp_misc_methods() -> None: | |||
| pd.Timestamp, | |||
| ) | |||
|
|
|||
| check(assert_type(ts2.as_unit('ns'), pd.Timestamp), pd.Timestamp) | |||
There was a problem hiding this comment.
Suggested change
| check(assert_type(ts2.as_unit('ns'), pd.Timestamp), pd.Timestamp) | |
| check(assert_type(ts2.as_unit("ns"), pd.Timestamp), pd.Timestamp) |
use the pre-commit hook. You need double quotes here.
|
Closing in favor of #864 |
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.
pandas-dev/pandas@f3c46cd
pandas-dev/pandas#48819
#797
assert_type()to assert the type of any return value