-
-
Notifications
You must be signed in to change notification settings - Fork 7.4k
[Python] Fix python template for list and dicts of dicts #23112
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
wing328
merged 3 commits into
OpenAPITools:master
from
ottmar-zittlau:fix/Python-template-for-dict
Mar 6, 2026
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
29 changes: 29 additions & 0 deletions
29
samples/openapi3/client/petstore/python-aiohttp/docs/ArrayOfMapModel.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # ArrayOfMapModel | ||
|
|
||
|
|
||
| ## Properties | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **array_of_map_property** | **List[Dict[str, Tag]]** | | [optional] | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| from petstore_api.models.array_of_map_model import ArrayOfMapModel | ||
|
|
||
| # TODO update the JSON string below | ||
| json = "{}" | ||
| # create an instance of ArrayOfMapModel from a JSON string | ||
| array_of_map_model_instance = ArrayOfMapModel.from_json(json) | ||
| # print the JSON string representation of the object | ||
| print(ArrayOfMapModel.to_json()) | ||
|
|
||
| # convert the object into a dict | ||
| array_of_map_model_dict = array_of_map_model_instance.to_dict() | ||
| # create an instance of ArrayOfMapModel from a dict | ||
| array_of_map_model_from_dict = ArrayOfMapModel.from_dict(array_of_map_model_dict) | ||
| ``` | ||
| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
|
||
|
|
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
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
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
101 changes: 101 additions & 0 deletions
101
samples/openapi3/client/petstore/python-aiohttp/petstore_api/models/array_of_map_model.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| # coding: utf-8 | ||
|
|
||
| """ | ||
| OpenAPI Petstore | ||
|
|
||
| This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ | ||
|
|
||
| The version of the OpenAPI document: 1.0.0 | ||
| Generated by OpenAPI Generator (https://openapi-generator.tech) | ||
|
|
||
| Do not edit the class manually. | ||
| """ # noqa: E501 | ||
|
|
||
|
|
||
| from __future__ import annotations | ||
| import pprint | ||
| import re # noqa: F401 | ||
| import json | ||
|
|
||
| from pydantic import BaseModel, ConfigDict | ||
| from typing import Any, ClassVar, Dict, List, Optional | ||
| from petstore_api.models.tag import Tag | ||
| from typing import Optional, Set | ||
| from typing_extensions import Self | ||
|
|
||
| class ArrayOfMapModel(BaseModel): | ||
| """ | ||
| ArrayOfMapModel | ||
| """ # noqa: E501 | ||
| array_of_map_property: Optional[List[Dict[str, Tag]]] = None | ||
| __properties: ClassVar[List[str]] = ["array_of_map_property"] | ||
|
|
||
| model_config = ConfigDict( | ||
| validate_by_name=True, | ||
| validate_by_alias=True, | ||
| validate_assignment=True, | ||
| protected_namespaces=(), | ||
| ) | ||
|
|
||
|
|
||
| def to_str(self) -> str: | ||
| """Returns the string representation of the model using alias""" | ||
| return pprint.pformat(self.model_dump(by_alias=True)) | ||
|
|
||
| def to_json(self) -> str: | ||
| """Returns the JSON representation of the model using alias""" | ||
| # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead | ||
| return json.dumps(self.to_dict()) | ||
|
|
||
| @classmethod | ||
| def from_json(cls, json_str: str) -> Optional[Self]: | ||
| """Create an instance of ArrayOfMapModel from a JSON string""" | ||
| return cls.from_dict(json.loads(json_str)) | ||
|
|
||
| def to_dict(self) -> Dict[str, Any]: | ||
| """Return the dictionary representation of the model using alias. | ||
|
|
||
| This has the following differences from calling pydantic's | ||
| `self.model_dump(by_alias=True)`: | ||
|
|
||
| * `None` is only added to the output dict for nullable fields that | ||
| were set at model initialization. Other fields with value `None` | ||
| are ignored. | ||
| """ | ||
| excluded_fields: Set[str] = set([ | ||
| ]) | ||
|
|
||
| _dict = self.model_dump( | ||
| by_alias=True, | ||
| exclude=excluded_fields, | ||
| exclude_none=True, | ||
| ) | ||
| # override the default output from pydantic by calling `to_dict()` of each item in array_of_map_property (list of dict) | ||
| _items = [] | ||
| if self.array_of_map_property: | ||
| for _item_array_of_map_property in self.array_of_map_property: | ||
| if _item_array_of_map_property: | ||
| _items.append( | ||
| {_inner_key: _inner_value.to_dict() for _inner_key, _inner_value in _item_array_of_map_property.items()} | ||
| ) | ||
| _dict['array_of_map_property'] = _items | ||
| return _dict | ||
|
|
||
| @classmethod | ||
| def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: | ||
| """Create an instance of ArrayOfMapModel from a dict""" | ||
| if obj is None: | ||
| return None | ||
|
|
||
| if not isinstance(obj, dict): | ||
| return cls.model_validate(obj) | ||
|
|
||
| _obj = cls.model_validate({ | ||
| "array_of_map_property": [ | ||
| {_inner_key: Tag.from_dict(_inner_value) for _inner_key, _inner_value in _item.items()} | ||
| for _item in obj["array_of_map_property"] | ||
| ] if obj.get("array_of_map_property") is not None else None | ||
| }) | ||
| return _obj | ||
|
|
||
|
|
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.