Fix tick delta type handling
#546
Merged
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
## `FrozenDateTimeFactory.tick` The `delta` argument is capable of handling `float`s. In previous versions of freezgun, the `.pyi` type annotations were correctly reflecting that. For some reason, when moving the type annotations into the `.py` file, this information got lost. Further, checking for `isinstance(delta, numbers.Real)` is probably not what was intended as `fraction.Fraction` is a subclass of `Real`, but will cause an error when passed into `datetime.timedelta(seconds=delta)`. ## `StepTickTimeFactory.tick` The same issue with the type hint applies here. Fruther, passing an integer/float `delta` would lead to that number being added to the frozen `datetime.datetime`, which is not a valid operation (`TypeError: unsupported operand type(s) for +: 'datetime.datetime' and 'int'`).
bblommers
requested changes
May 4, 2024
|
I came up with what I think is a way to keep the runtime functionality as is, and get the type hints to be somewhat ™️ accurate. |
bblommers
approved these changes
May 8, 2024
There was a problem hiding this comment.
Looks great, thank you for fixing this and for adding the tests @robsdedude!
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.
FrozenDateTimeFactory.tickThe
deltaargument is capable of handlingfloats. In previous versions of freezgun, the.pyitype annotations were correctly reflecting that. For some reason, when moving the type annotations into the.pyfile, this information got lost.Further, checking for
isinstance(delta, numbers.Real)is probably not what was intended asfraction.Fractionis a subclass ofReal, but will cause an error when passed intodatetime.timedelta(seconds=delta).StepTickTimeFactory.tickThe same issue with the type hint applies here.
Fruther, passing an integer/float
deltawould lead to that number being added to the frozendatetime.datetime, which is not a valid operation (TypeError: unsupported operand type(s) for +: 'datetime.datetime' and 'int').