Skip to content

Conversation

@timonrieger
Copy link
Contributor

@timonrieger timonrieger commented Feb 11, 2026

When an OpenAPI schema property has both format: uuid and a pattern constraint, the Python client generator emits a @field_validator decorator in the generated model but fails to add the corresponding from pydantic import field_validator import. This causes a NameError at runtime.

Root cause: In AbstractPythonCodegen, the PydanticType.fromCommon() type dispatch is an exclusive if/else chain. UUID is checked before string, so uuidType() is called (which doesn't handle patterns) and stringType() (which adds the field_validator import for patterns) is never reached. Meanwhile, the mustache template emits @field_validator based on the x-regex vendor extension, which is set independently for any property with a pattern.

Fix: Add a type-independent pattern != null check in fromCommon() before the type dispatch, ensuring field_validator is imported for any property type that has a pattern constraint.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

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.

  • Bug Fixes
    • Always import field_validator when a property has a pattern, regardless of type (added check in fromCommon).
    • Added a test with a UUID + pattern schema to confirm the import is present.

Written for commit c666f03. Summary will update on new commits.

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 3 files

@timonrieger
Copy link
Contributor Author

alternatively, to be less defensive and only apply that to UUID types instead of all types with regex pattern

private PythonType uuidType(IJsonSchemaValidationProperties cp) {
    moduleImports.add("uuid", "UUID");
    if (cp.getPattern() != null) {
        moduleImports.add("pydantic", "field_validator");
    }
    return new PythonType("UUID");
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant