Skip to content

[Python] Some fixes for pydantic v1 templates for nested dicts#23162

Merged
wing328 merged 7 commits intoOpenAPITools:masterfrom
ottmar-zittlau:fix/Pydantic-v1-templates-for-nested-dicts
Mar 7, 2026
Merged

[Python] Some fixes for pydantic v1 templates for nested dicts#23162
wing328 merged 7 commits intoOpenAPITools:masterfrom
ottmar-zittlau:fix/Pydantic-v1-templates-for-nested-dicts

Conversation

@ottmar-zittlau
Copy link
Copy Markdown
Contributor

@ottmar-zittlau ottmar-zittlau commented Mar 7, 2026

I fixed some issues with the pydantic v1 template concerning nested dicts (dicts of dicts and list of dicts).

The main issue is here here. Here, from_dict is called on the type hint [Dict[str, Tag]

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.

Summary by cubic

Fixes pydantic v1 templates to correctly (de)serialize nested dict/list containers and use valid Union[...] return types for discriminator models. Adds None-safe handling to prevent data loss and type errors for arrays of maps, maps of arrays, maps of maps, and lists of lists.

  • Bug Fixes

    • Handle nested containers in to_dict/from_dict (list of maps, map of arrays, map of maps, lists of lists) with None checks, calling to_dict/from_dict on inner models.
    • Use correct typing: Union[...] in from_json/from_dict for discriminator returns.
    • Generate from_dict for arrays of dicts and to_dict for lists of maps.
  • Refactors

    • Simplify generated code with dict/list comprehensions and literals; streamline enum/ref map handling.
    • Update samples to match the new template output.

Written for commit 63f7c80. Summary will update on new commits.

Copy link
Copy Markdown
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.

2 issues found across 14 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="samples/openapi3/client/petstore/python-pydantic-v1/petstore_api/models/unnamed_dict_with_additional_model_list_properties.py">

<violation number="1" location="samples/openapi3/client/petstore/python-pydantic-v1/petstore_api/models/unnamed_dict_with_additional_model_list_properties.py:84">
P1: `from_dict` can crash on valid input because it unconditionally calls `.items()` on an optional `dictProperty` value.</violation>
</file>

<file name="samples/openapi3/client/petstore/python-pydantic-v1/petstore_api/models/array_of_map_model.py">

<violation number="1" location="samples/openapi3/client/petstore/python-pydantic-v1/petstore_api/models/array_of_map_model.py:64">
P1: `to_dict()` incorrectly iterates `_item.items` instead of `_item.items()`, causing a runtime TypeError during serialization.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

@wing328
Copy link
Copy Markdown
Member

wing328 commented Mar 7, 2026

thanks for the PR

can you please review the feedback from cubic-dev-ai when you've time?

@ottmar-zittlau ottmar-zittlau force-pushed the fix/Pydantic-v1-templates-for-nested-dicts branch from 585070d to 63f7c80 Compare March 7, 2026 16:04
@ottmar-zittlau
Copy link
Copy Markdown
Contributor Author

thanks for the PR

can you please review the feedback from cubic-dev-ai when you've time?

@wing328 Yes, of course. I noticed that some java-related files have changed upon running the samples generation script. I didn't commit them, because I think these changes are unrelated to mine. But let me know if I should add them.

@wing328 wing328 merged commit b13e908 into OpenAPITools:master Mar 7, 2026
23 checks passed
@wing328 wing328 added this to the 7.21.0 milestone Mar 7, 2026
davidricodias pushed a commit to davidricodias/openapi-generator that referenced this pull request Mar 11, 2026
…PITools#23162)

* Fix to_dict method

* Fix union type hint

* Use more concise code for dict generation

* Add from dict method for array of dicts

* Fix after reviewer comments

* add check for none

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants