Enforce constraints on arbitrary types via functional validators #5883
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
Deploying with
|
| Latest commit: |
e028826
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d22ee5ea.pydantic-docs2.pages.dev |
| Branch Preview URL: | https://arbitrary-type-constraints.pydantic-docs2.pages.dev |
|
please review |
pydantic/_internal/_validators.py
Outdated
|
|
||
| def greater_than_validator(x: Any, gt: Any) -> Any: | ||
| if not (x > gt): | ||
| raise PydanticCustomError('greater_than', 'Input should be greater than {gt}', {'gt': gt}) |
There was a problem hiding this comment.
Suggested change
| raise PydanticCustomError('greater_than', 'Input should be greater than {gt}', {'gt': gt}) | |
| raise PydanticKnownError('greater_than', {'gt': gt}) |
There was a problem hiding this comment.
Won't work:
def greater_than_validator(x: Any, gt: Any) -> Any:
if not (x > gt):
> raise PydanticKnownError('greater_than', {'gt': gt})
E TypeError: GreaterThan: 'gt' context value must be a Number
There was a problem hiding this comment.
needs to be fixed in core, bit this is fine for now.
There was a problem hiding this comment.
I hadn't realised it was every single one that was using PydanticCustomError, we should adopt PydanticKnownError where possible.
There was a problem hiding this comment.
Unless I’m missing something, you already pointed that out and as per above, it won’t work unless we make extensive changes in pydantic-core. It also makes no difference for users as far as I can tell.
adriangb
force-pushed
the
arbitrary-type-constraints
branch
from
c7252b4
to
27f476f
Compare
adriangb
force-pushed
the
arbitrary-type-constraints
branch
from
27f476f
to
4befd4f
Compare
samuelcolvin
approved these changes
May 27, 2023
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.
This makes constraints work on arbitrary types that don't "know" how to consume them by applying a functional validator that enforces the constraint in Python. Of course, if the type wants to it can "consume" the constraint via
__prepare_pydantic_annotations__to e.g. use a more efficient implementation, or if the schema is a schema that accepts the constraint directly (e.g.gtw/ afloatschema) then it gets applied that way instead of via Python.Selected Reviewer: @dmontagu