[Schedule] Update type hints for ScheduleCronTrigger to avoid unexpected pydantic behaviour #3286
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
assaf758
approved these changes
Mar 22, 2023
assaf758
pushed a commit
to assaf758/mlrun
that referenced
this pull request
Mar 22, 2023
…ted pydantic behaviour (mlrun#3286)
Eyal-Danieli
added a commit
to Eyal-Danieli/mlrun
that referenced
this pull request
Mar 22, 2023
…ted pydantic behaviour (mlrun#3286)
yaelgen
pushed a commit
to yaelgen/mlrun
that referenced
this pull request
Apr 24, 2023
…ted pydantic behaviour (mlrun#3286)
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.
When defining type hints for
pydanticobjects withtyping.Union,pydanticwill attempt to match any of the types defined undertyping.Unionand will use the first one that matches.However, when adding
typing.Optional(e.g.Optional[Union[datetime, str]]) the user may face unexpected behaviour in which the order within theUnionhas been changed andpydanticwill match the wrong type (e.g. trying to matchstrbeforedatetimealthoughdatetimeis the first type in theUnionlist). This bug occurs following different imports of 3rd libraries. More info about thispydanticbehaviour can be found here: pydantic/pydantic#4474pydantic/pydantic#4519
To avoid this unexpected behaviour, in this PR we replace
typing.Optionalwith defaultNonevalue for the fieldsstart_dateandend_datewithinScheduleCronTriggerobject.Pleas note that new tests are not required as this behaviour is already being tested through
test_update_schedule().A related JIRA ticket - https://jira.iguazeng.com/browse/ML-3624