[python] centralize the Python constraint rules#24141
Open
Mattias-Sehlstedt wants to merge 1 commit into
Open
Conversation
66aa2f6 to
dd8d9e7
Compare
This file contains hidden or 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
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.
Centralize the handling of applying constraints to different OAS types to remove duplicates (e.g., the current
StringandBinarylogic is the exact same). This also makes it easier to reuse them, for example when creating types that are purely tied to the constraints coming from OAS and not those that may be relevant for different internal Python validators (e.g., Pydantic).This could also be helpful for the case where you might want to represent constraints differently for different contexts, for example this PR where queries has to be handled differently with how constraints are constructed.
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
Python technical committee — @cbornet @tomplus @krjakbrjak @fa0311 @multani (@krjakbrjak as the python-fastapi generator author).
Summary by cubic
Centralized how OAS constraints are applied in the Python generator to remove duplicated logic and keep behavior consistent across types. This simplifies future changes and enables context-specific constraint handling.
ConstraintApplierandConstraintType(incl.ROUNDED_NUMBER) to standardize length and numeric rules.AbstractPythonCodegen; removedPydanticType.applyConstraintsand centralized comparison constants.multiple_ofonly for non-rounded numeric types.Written for commit dd8d9e7. Summary will update on new commits.