Skip to content

fix!: Change reference resolution to use reference path instead of class name (fixes #342) #366

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
dbanty merged 13 commits into from
Apr 12, 2021
Merged

fix!: Change reference resolution to use reference path instead of class name (fixes #342) #366

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
b58fe09
refactorWIP refactor reference / class name handling to fix resolutio…
dbanty Mar 24, 2021
da8a09e
refactorRevert field_prefix refactor, continue class name refactor [WIP]
dbanty Mar 27, 2021
ff8bdb9
test: Fix all the type errors and start fixing unit tests
dbanty Mar 27, 2021
2bbbed6
test: Fix more broken tests
dbanty Mar 27, 2021
10163b2
test: Fix more unit tests
dbanty Mar 27, 2021
af8d0ea
test: Finish fixing broken unit tests
dbanty Apr 4, 2021
503a7a6
test: Fix errors found by E2E test
dbanty Apr 4, 2021
0648aa0
docs: Update usage.md
dbanty Apr 4, 2021
5005d82
test: Add more unit test coverage
dbanty Apr 4, 2021
7f9051b
Merge branch 'main' into 342-could-not-find-reference-in-parsed-model…
dbanty Apr 4, 2021
fed62b0
fix: nullable passthrough in single union refs
dbanty Apr 4, 2021
d457227
docs: Improve `properties.Class` docstring
dbanty Apr 5, 2021
e131d13
Merge branch 'main' into 342-could-not-find-reference-in-parsed-model…
dbanty Apr 7, 2021
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
Prev Previous commit
Next Next commit
fix: nullable passthrough in single union refs
  • Loading branch information
@dbanty
dbanty committed Apr 4, 2021
commit fed62b053fada87d223578f78d7d46e47eeef005
31 changes: 16 additions & 15 deletions end_to_end_tests/golden-record/my_test_api_client/api/tests/defaults_tests_defaults_post.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ def _get_kwargs(
enum_prop: Union[Unset, AnEnum] = UNSET,
model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
required_model_prop: ModelWithUnionProperty,
nullable_model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
nullable_required_model_prop: ModelWithUnionProperty,
nullable_model_prop: Union[Unset, None, ModelWithUnionProperty] = UNSET,
nullable_required_model_prop: Optional[ModelWithUnionProperty],
) -> Dict[str, Any]:
url = "{}/tests/defaults".format(client.base_url)

Expand Down Expand Up @@ -92,11 +92,11 @@ def _get_kwargs(

json_required_model_prop = required_model_prop.to_dict()

json_nullable_model_prop: Union[Unset, Dict[str, Any]] = UNSET
json_nullable_model_prop: Union[Unset, None, Dict[str, Any]] = UNSET
if not isinstance(nullable_model_prop, Unset):
json_nullable_model_prop = nullable_model_prop.to_dict()
json_nullable_model_prop = nullable_model_prop.to_dict() if nullable_model_prop else None

json_nullable_required_model_prop = nullable_required_model_prop.to_dict()
json_nullable_required_model_prop = nullable_required_model_prop.to_dict() if nullable_required_model_prop else None

params: Dict[str, Any] = {
"string_prop": string_prop,
Expand All @@ -116,9 +116,10 @@ def _get_kwargs(
if not isinstance(json_model_prop, Unset):
params.update(json_model_prop)
params.update(json_required_model_prop)
if not isinstance(json_nullable_model_prop, Unset):
if not isinstance(json_nullable_model_prop, Unset) and json_nullable_model_prop is not None:
params.update(json_nullable_model_prop)
params.update(json_nullable_required_model_prop)
if json_nullable_required_model_prop is not None:
params.update(json_nullable_required_model_prop)
params = {k: v for k, v in params.items() if v is not UNSET and v is not None}

return {
Expand Down Expand Up @@ -169,8 +170,8 @@ def sync_detailed(
enum_prop: Union[Unset, AnEnum] = UNSET,
model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
required_model_prop: ModelWithUnionProperty,
nullable_model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
nullable_required_model_prop: ModelWithUnionProperty,
nullable_model_prop: Union[Unset, None, ModelWithUnionProperty] = UNSET,
nullable_required_model_prop: Optional[ModelWithUnionProperty],
) -> Response[Union[None, HTTPValidationError]]:
kwargs = _get_kwargs(
client=client,
Expand Down Expand Up @@ -218,8 +219,8 @@ def sync(
enum_prop: Union[Unset, AnEnum] = UNSET,
model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
required_model_prop: ModelWithUnionProperty,
nullable_model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
nullable_required_model_prop: ModelWithUnionProperty,
nullable_model_prop: Union[Unset, None, ModelWithUnionProperty] = UNSET,
nullable_required_model_prop: Optional[ModelWithUnionProperty],
) -> Optional[Union[None, HTTPValidationError]]:
""" """

Expand Down Expand Up @@ -263,8 +264,8 @@ async def asyncio_detailed(
enum_prop: Union[Unset, AnEnum] = UNSET,
model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
required_model_prop: ModelWithUnionProperty,
nullable_model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
nullable_required_model_prop: ModelWithUnionProperty,
nullable_model_prop: Union[Unset, None, ModelWithUnionProperty] = UNSET,
nullable_required_model_prop: Optional[ModelWithUnionProperty],
) -> Response[Union[None, HTTPValidationError]]:
kwargs = _get_kwargs(
client=client,
Expand Down Expand Up @@ -311,8 +312,8 @@ async def asyncio(
enum_prop: Union[Unset, AnEnum] = UNSET,
model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
required_model_prop: ModelWithUnionProperty,
nullable_model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
nullable_required_model_prop: ModelWithUnionProperty,
nullable_model_prop: Union[Unset, None, ModelWithUnionProperty] = UNSET,
nullable_required_model_prop: Optional[ModelWithUnionProperty],
) -> Optional[Union[None, HTTPValidationError]]:
""" """

Expand Down
29 changes: 17 additions & 12 deletions end_to_end_tests/golden-record/my_test_api_client/models/a_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class AModel:
required_not_nullable: str
one_of_models: Union[FreeFormModel, ModelWithUnionProperty]
model: ModelWithUnionProperty
nullable_model: ModelWithUnionProperty
a_nullable_date: Optional[datetime.date]
required_nullable: Optional[str]
nullable_one_of_models: Union[FreeFormModel, ModelWithUnionProperty, None]
nullable_model: Optional[ModelWithUnionProperty]
nested_list_of_enums: Union[Unset, List[List[DifferentEnum]]] = UNSET
a_not_required_date: Union[Unset, datetime.date] = UNSET
attr_1_leading_digit: Union[Unset, str] = UNSET
Expand All @@ -35,7 +35,7 @@ class AModel:
not_required_one_of_models: Union[FreeFormModel, ModelWithUnionProperty, Unset] = UNSET
not_required_nullable_one_of_models: Union[FreeFormModel, ModelWithUnionProperty, None, Unset, str] = UNSET
not_required_model: Union[Unset, ModelWithUnionProperty] = UNSET
not_required_nullable_model: Union[Unset, ModelWithUnionProperty] = UNSET
not_required_nullable_model: Union[Unset, None, ModelWithUnionProperty] = UNSET

def to_dict(self) -> Dict[str, Any]:
an_enum_value = self.an_enum_value.value
Expand All @@ -56,8 +56,6 @@ def to_dict(self) -> Dict[str, Any]:

model = self.model.to_dict()

nullable_model = self.nullable_model.to_dict()

nested_list_of_enums: Union[Unset, List[List[str]]] = UNSET
if not isinstance(self.nested_list_of_enums, Unset):
nested_list_of_enums = []
Expand Down Expand Up @@ -119,13 +117,17 @@ def to_dict(self) -> Dict[str, Any]:
else:
not_required_nullable_one_of_models = self.not_required_nullable_one_of_models

nullable_model = self.nullable_model.to_dict() if self.nullable_model else None

not_required_model: Union[Unset, Dict[str, Any]] = UNSET
if not isinstance(self.not_required_model, Unset):
not_required_model = self.not_required_model.to_dict()

not_required_nullable_model: Union[Unset, Dict[str, Any]] = UNSET
not_required_nullable_model: Union[Unset, None, Dict[str, Any]] = UNSET
if not isinstance(self.not_required_nullable_model, Unset):
not_required_nullable_model = self.not_required_nullable_model.to_dict()
not_required_nullable_model = (
self.not_required_nullable_model.to_dict() if self.not_required_nullable_model else None
)

field_dict: Dict[str, Any] = {}
field_dict.update(
Expand All @@ -136,10 +138,10 @@ def to_dict(self) -> Dict[str, Any]:
"required_not_nullable": required_not_nullable,
"one_of_models": one_of_models,
"model": model,
"nullable_model": nullable_model,
"a_nullable_date": a_nullable_date,
"required_nullable": required_nullable,
"nullable_one_of_models": nullable_one_of_models,
"nullable_model": nullable_model,
}
)
if nested_list_of_enums is not UNSET:
Expand Down Expand Up @@ -212,8 +214,6 @@ def _parse_one_of_models(data: object) -> Union[FreeFormModel, ModelWithUnionPro

model = ModelWithUnionProperty.from_dict(d.pop("model"))

nullable_model = ModelWithUnionProperty.from_dict(d.pop("nullable_model"))

nested_list_of_enums = []
_nested_list_of_enums = d.pop("nested_list_of_enums", UNSET)
for nested_list_of_enums_item_data in _nested_list_of_enums or []:
Expand Down Expand Up @@ -333,14 +333,19 @@ def _parse_not_required_nullable_one_of_models(
d.pop("not_required_nullable_one_of_models", UNSET)
)

nullable_model = None
_nullable_model = d.pop("nullable_model")
if _nullable_model is not None:
nullable_model = ModelWithUnionProperty.from_dict(_nullable_model)

not_required_model: Union[Unset, ModelWithUnionProperty] = UNSET
_not_required_model = d.pop("not_required_model", UNSET)
if not isinstance(_not_required_model, Unset):
not_required_model = ModelWithUnionProperty.from_dict(_not_required_model)

not_required_nullable_model: Union[Unset, ModelWithUnionProperty] = UNSET
not_required_nullable_model = None
_not_required_nullable_model = d.pop("not_required_nullable_model", UNSET)
if not isinstance(_not_required_nullable_model, Unset):
if _not_required_nullable_model is not None and not isinstance(_not_required_nullable_model, Unset):
not_required_nullable_model = ModelWithUnionProperty.from_dict(_not_required_nullable_model)

a_model = cls(
Expand All @@ -350,7 +355,6 @@ def _parse_not_required_nullable_one_of_models(
required_not_nullable=required_not_nullable,
one_of_models=one_of_models,
model=model,
nullable_model=nullable_model,
nested_list_of_enums=nested_list_of_enums,
a_nullable_date=a_nullable_date,
a_not_required_date=a_not_required_date,
Expand All @@ -361,6 +365,7 @@ def _parse_not_required_nullable_one_of_models(
nullable_one_of_models=nullable_one_of_models,
not_required_one_of_models=not_required_one_of_models,
not_required_nullable_one_of_models=not_required_nullable_one_of_models,
nullable_model=nullable_model,
not_required_model=not_required_model,
not_required_nullable_model=not_required_nullable_model,
)
Expand Down
2 changes: 1 addition & 1 deletion openapi_python_client/parser/properties/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ def _property_from_ref(
existing = schemas.classes_by_reference.get(ref_path)
if existing:
return (
attr.evolve(existing, required=required, name=name),
attr.evolve(existing, required=required, name=name, nullable=nullable),
schemas,
)
return PropertyError(data=data, detail="Could not find reference in parsed models or enums"), schemas
Expand Down