New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add types.OnErrorOmit #8222
Merged
Merged
Add types.OnErrorOmit #8222
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -104,9 +104,13 @@ | |
'Tag', | ||
'Discriminator', | ||
'JsonValue', | ||
'OnErrorOmit', | ||
) | ||
|
||
|
||
T = TypeVar('T') | ||
|
||
|
||
@_dataclasses.dataclass | ||
class Strict(_fields.PydanticMetadata, BaseMetadata): | ||
"""Usage docs: https://docs.pydantic.dev/2.6/concepts/strict_mode/#strict-mode-with-annotated-strict | ||
|
@@ -2800,3 +2804,21 @@ class Model(BaseModel): | |
_AllowAnyJson, | ||
], | ||
) | ||
|
||
|
||
class _OnErrorOmit: | ||
@classmethod | ||
def __get_pydantic_core_schema__(cls, source_type: Any, handler: GetCoreSchemaHandler) -> CoreSchema: | ||
# there is no actual default value here but we use with_default_schema since it already has the on_error | ||
# behavior implemented and it would be no more efficient to implement it on every other validator | ||
# or as a standalone validator | ||
return core_schema.with_default_schema(schema=handler(source_type), on_error='omit') | ||
|
||
|
||
OnErrorOmit = Annotated[T, _OnErrorOmit] | ||
""" | ||
When used as an item in a list, the key type in a dict, optional values of a TypedDict, etc. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. key or value? we should probably add a test. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I did |
||
this annotation omits the item from the iteration if there is any error validating it. | ||
That is, instead of a ValidationError being propagated up and the entire iterable being discarded | ||
adriangb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
any invalid items are discarded and the valid ones are returned. | ||
""" |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we should we make this a dataclass?
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It sounds like you want to fully expose the
with_default_value
options, but IMO even if we do that later on this use case is simple and common enough to warrant it's own annotation with no options so you don't need to doAnnotated[..., OnError(on_error='omit')]
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR welcome for anyone to add
OnError
as described by me above.