Skip to content

[python] add circular reference import #16940

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.

Sign up for GitHub

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 2 commits into from
Nov 2, 2023
Merged

[python] add circular reference import #16940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
492f023
[python] add circular reference import
fa0311 Oct 20, 2023
104b9c9
[python] update samples
fa0311 Oct 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions modules/openapi-generator/src/main/resources/python/model_anyof.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,10 +183,8 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}

{{#vendorExtensions.x-py-postponed-model-imports.size}}
{{#vendorExtensions.x-py-postponed-model-imports}}
from typing import TYPE_CHECKING
if TYPE_CHECKING:
{{{.}}}
# TODO: pydantic v2
{{{.}}}
{{/vendorExtensions.x-py-postponed-model-imports}}
# {{classname}}.model_rebuild()
# TODO: Rewrite to not use raise_errors
{{classname}}.model_rebuild(raise_errors=False)
{{/vendorExtensions.x-py-postponed-model-imports.size}}
7 changes: 2 additions & 5 deletions modules/openapi-generator/src/main/resources/python/model_generic.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,9 +379,6 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
{{#vendorExtensions.x-py-postponed-model-imports}}
{{{.}}}
{{/vendorExtensions.x-py-postponed-model-imports}}
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# {{classname}}.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
{{classname}}.model_rebuild(raise_errors=False)
{{/vendorExtensions.x-py-postponed-model-imports.size}}
8 changes: 3 additions & 5 deletions modules/openapi-generator/src/main/resources/python/model_oneof.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,10 +207,8 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}

{{#vendorExtensions.x-py-postponed-model-imports.size}}
{{#vendorExtensions.x-py-postponed-model-imports}}
from typing import TYPE_CHECKING
if TYPE_CHECKING:
{{{.}}}
# TODO: pydantic v2
{{{.}}}
{{/vendorExtensions.x-py-postponed-model-imports}}
# {{classname}}.model_rebuild()
# TODO: Rewrite to not use raise_errors
{{classname}}.model_rebuild(raise_errors=False)
{{/vendorExtensions.x-py-postponed-model-imports.size}}
7 changes: 2 additions & 5 deletions samples/openapi3/client/petstore/python-aiohttp/petstore_api/models/animal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,6 @@ def from_dict(cls, obj: dict) -> Union[Self, Self]:

from petstore_api.models.cat import Cat
from petstore_api.models.dog import Dog
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# Animal.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
Animal.model_rebuild(raise_errors=False)

7 changes: 2 additions & 5 deletions ...s/openapi3/client/petstore/python-aiohttp/petstore_api/models/circular_reference_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,6 @@ def from_dict(cls, obj: dict) -> Self:
return _obj

from petstore_api.models.first_ref import FirstRef
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# CircularReferenceModel.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
CircularReferenceModel.model_rebuild(raise_errors=False)

7 changes: 2 additions & 5 deletions samples/openapi3/client/petstore/python-aiohttp/petstore_api/models/dummy_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,6 @@ def from_dict(cls, obj: dict) -> Self:
return _obj

from petstore_api.models.self_reference_model import SelfReferenceModel
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# DummyModel.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
DummyModel.model_rebuild(raise_errors=False)

7 changes: 2 additions & 5 deletions samples/openapi3/client/petstore/python-aiohttp/petstore_api/models/first_ref.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,6 @@ def from_dict(cls, obj: dict) -> Self:
return _obj

from petstore_api.models.second_ref import SecondRef
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# FirstRef.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
FirstRef.model_rebuild(raise_errors=False)

7 changes: 2 additions & 5 deletions samples/openapi3/client/petstore/python-aiohttp/petstore_api/models/second_ref.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,6 @@ def from_dict(cls, obj: dict) -> Self:
return _obj

from petstore_api.models.circular_reference_model import CircularReferenceModel
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# SecondRef.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
SecondRef.model_rebuild(raise_errors=False)

7 changes: 2 additions & 5 deletions samples/openapi3/client/petstore/python-aiohttp/petstore_api/models/self_reference_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,6 @@ def from_dict(cls, obj: dict) -> Self:
return _obj

from petstore_api.models.dummy_model import DummyModel
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# SelfReferenceModel.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
SelfReferenceModel.model_rebuild(raise_errors=False)

7 changes: 2 additions & 5 deletions samples/openapi3/client/petstore/python/petstore_api/models/animal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,6 @@ def from_dict(cls, obj: dict) -> Union[Self, Self]:

from petstore_api.models.cat import Cat
from petstore_api.models.dog import Dog
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# Animal.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
Animal.model_rebuild(raise_errors=False)

7 changes: 2 additions & 5 deletions samples/openapi3/client/petstore/python/petstore_api/models/circular_reference_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,6 @@ def from_dict(cls, obj: dict) -> Self:
return _obj

from petstore_api.models.first_ref import FirstRef
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# CircularReferenceModel.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
CircularReferenceModel.model_rebuild(raise_errors=False)

7 changes: 2 additions & 5 deletions samples/openapi3/client/petstore/python/petstore_api/models/dummy_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,6 @@ def from_dict(cls, obj: dict) -> Self:
return _obj

from petstore_api.models.self_reference_model import SelfReferenceModel
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# DummyModel.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
DummyModel.model_rebuild(raise_errors=False)

7 changes: 2 additions & 5 deletions samples/openapi3/client/petstore/python/petstore_api/models/first_ref.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,6 @@ def from_dict(cls, obj: dict) -> Self:
return _obj

from petstore_api.models.second_ref import SecondRef
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# FirstRef.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
FirstRef.model_rebuild(raise_errors=False)

7 changes: 2 additions & 5 deletions samples/openapi3/client/petstore/python/petstore_api/models/second_ref.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,6 @@ def from_dict(cls, obj: dict) -> Self:
return _obj

from petstore_api.models.circular_reference_model import CircularReferenceModel
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# SecondRef.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
SecondRef.model_rebuild(raise_errors=False)

7 changes: 2 additions & 5 deletions samples/openapi3/client/petstore/python/petstore_api/models/self_reference_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,6 @@ def from_dict(cls, obj: dict) -> Self:
return _obj

from petstore_api.models.dummy_model import DummyModel
from typing import TYPE_CHECKING
if TYPE_CHECKING:
# TODO: pydantic v2
# SelfReferenceModel.model_rebuild()
pass
# TODO: Rewrite to not use raise_errors
SelfReferenceModel.model_rebuild(raise_errors=False)

1 change: 0 additions & 1 deletion samples/openapi3/client/petstore/python/tests/test_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -560,7 +560,6 @@ def test_object_with_additional_properties(self):
# should not throw the following errors:
# pydantic.errors.ConfigError: field "additional_properties" not yet prepared so type is still a ForwardRef, you might need to call ObjectToTestAdditionalProperties.update_forward_refs().

@unittest.skip("TODO: pydantic v2: fix circular dependencies between CircularReferenceModel, FirstRef, SecondRef")
def test_first_ref(self):
# shouldn't throw "still a ForwardRef" error
a = petstore_api.FirstRef.from_dict({})
Expand Down