fix(python): missing field_validator import for UUID properties with pattern #22947
+28
−0
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 an OpenAPI schema property has both
format: uuidand apatternconstraint, the Python client generator emits a@field_validatordecorator in the generated model but fails to add the correspondingfrom pydantic import field_validatorimport. This causes aNameErrorat runtime.Root cause: In
AbstractPythonCodegen, thePydanticType.fromCommon()type dispatch is an exclusive if/else chain. UUID is checked before string, souuidType()is called (which doesn't handle patterns) andstringType()(which adds thefield_validatorimport for patterns) is never reached. Meanwhile, the mustache template emits@field_validatorbased on thex-regexvendor extension, which is set independently for any property with a pattern.Fix: Add a type-independent
pattern != nullcheck infromCommon()before the type dispatch, ensuringfield_validatoris imported for any property type that has a pattern constraint.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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)cc @cbornet (2017/09) @tomplus (2018/10) @krjakbrjak (2023/02) @fa0311 (2023/10) @multani (2023/10)
Summary by cubic
Fix missing pydantic field_validator import in generated Python models when a UUID property also has a pattern, preventing a runtime NameError.
Written for commit c666f03. Summary will update on new commits.