Clean up templates and document changes

Author: dbanty

.changeset/fix_lists_within_unions.md

@@ -0,0 +1,9 @@
+---
+default: patch
+---
+
+# Fix lists within unions
+
+Fixes #756 and #928. Arrays within unions (which, as of 0.17 includes nullable arrays) would generate invalid code.
+
+Thanks @kgutwin and @diesieben07!

.changeset/simplify_type_checks_for_non_required_unions.md

@@ -0,0 +1,5 @@
+---
+default: patch
+---
+
+# Simplify type checks for non-required unions

end_to_end_tests/golden-record/my_test_api_client/api/defaults/defaults_tests_defaults_post.py

@@ -58,10 +58,7 @@ def _get_kwargs(
     if isinstance(union_prop_with_ref, Unset):
         json_union_prop_with_ref = UNSET
     elif isinstance(union_prop_with_ref, AnEnum):
-        json_union_prop_with_ref = UNSET
-        if not isinstance(union_prop_with_ref, Unset):
-            json_union_prop_with_ref = union_prop_with_ref.value
-
+        json_union_prop_with_ref = union_prop_with_ref.value
     else:
         json_union_prop_with_ref = union_prop_with_ref
     params["union_prop_with_ref"] = json_union_prop_with_ref

end_to_end_tests/golden-record/my_test_api_client/api/location/get_location_query_optionality.py

@@ -32,9 +32,7 @@ def _get_kwargs(
     if isinstance(null_not_required, Unset):
         json_null_not_required = UNSET
     elif isinstance(null_not_required, datetime.datetime):
-        json_null_not_required = UNSET
-        if not isinstance(null_not_required, Unset):
-            json_null_not_required = null_not_required.isoformat()
+        json_null_not_required = null_not_required.isoformat()
     else:
         json_null_not_required = null_not_required
     params["null_not_required"] = json_null_not_required

end_to_end_tests/golden-record/my_test_api_client/models/a_model.py

@@ -159,25 +159,17 @@ def to_dict(self) -> Dict[str, Any]:
         if isinstance(self.not_required_one_of_models, Unset):
             not_required_one_of_models = UNSET
         elif isinstance(self.not_required_one_of_models, FreeFormModel):
-            not_required_one_of_models = UNSET
-            if not isinstance(self.not_required_one_of_models, Unset):
-                not_required_one_of_models = self.not_required_one_of_models.to_dict()
+            not_required_one_of_models = self.not_required_one_of_models.to_dict()
         else:
-            not_required_one_of_models = UNSET
-            if not isinstance(self.not_required_one_of_models, Unset):
-                not_required_one_of_models = self.not_required_one_of_models.to_dict()
+            not_required_one_of_models = self.not_required_one_of_models.to_dict()
 
         not_required_nullable_one_of_models: Union[Dict[str, Any], None, Unset, str]
         if isinstance(self.not_required_nullable_one_of_models, Unset):
             not_required_nullable_one_of_models = UNSET
         elif isinstance(self.not_required_nullable_one_of_models, FreeFormModel):
-            not_required_nullable_one_of_models = UNSET
-            if not isinstance(self.not_required_nullable_one_of_models, Unset):
-                not_required_nullable_one_of_models = self.not_required_nullable_one_of_models.to_dict()
+            not_required_nullable_one_of_models = self.not_required_nullable_one_of_models.to_dict()
         elif isinstance(self.not_required_nullable_one_of_models, ModelWithUnionProperty):
-            not_required_nullable_one_of_models = UNSET
-            if not isinstance(self.not_required_nullable_one_of_models, Unset):
-                not_required_nullable_one_of_models = self.not_required_nullable_one_of_models.to_dict()
+            not_required_nullable_one_of_models = self.not_required_nullable_one_of_models.to_dict()
         else:
             not_required_nullable_one_of_models = self.not_required_nullable_one_of_models
 
@@ -189,9 +181,7 @@ def to_dict(self) -> Dict[str, Any]:
         if isinstance(self.not_required_nullable_model, Unset):
             not_required_nullable_model = UNSET
         elif isinstance(self.not_required_nullable_model, ModelWithUnionProperty):
-            not_required_nullable_model = 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()
         else:
             not_required_nullable_model = self.not_required_nullable_model
 
@@ -401,24 +391,14 @@ def _parse_not_required_one_of_models(data: object) -> Union["FreeFormModel", "M
             try:
                 if not isinstance(data, dict):
                     raise TypeError()
-                _not_required_one_of_models_type_0 = data
-                not_required_one_of_models_type_0: Union[Unset, FreeFormModel]
-                if isinstance(_not_required_one_of_models_type_0, Unset):
-                    not_required_one_of_models_type_0 = UNSET
-                else:
-                    not_required_one_of_models_type_0 = FreeFormModel.from_dict(_not_required_one_of_models_type_0)
+                not_required_one_of_models_type_0 = FreeFormModel.from_dict(data)
 
                 return not_required_one_of_models_type_0
             except:  # noqa: E722
                 pass
             if not isinstance(data, dict):
                 raise TypeError()
-            _not_required_one_of_models_type_1 = data
-            not_required_one_of_models_type_1: Union[Unset, ModelWithUnionProperty]
-            if isinstance(_not_required_one_of_models_type_1, Unset):
-                not_required_one_of_models_type_1 = UNSET
-            else:
-                not_required_one_of_models_type_1 = ModelWithUnionProperty.from_dict(_not_required_one_of_models_type_1)
+            not_required_one_of_models_type_1 = ModelWithUnionProperty.from_dict(data)
 
             return not_required_one_of_models_type_1
 
@@ -434,29 +414,15 @@ def _parse_not_required_nullable_one_of_models(
             try:
                 if not isinstance(data, dict):
                     raise TypeError()
-                _not_required_nullable_one_of_models_type_0 = data
-                not_required_nullable_one_of_models_type_0: Union[Unset, FreeFormModel]
-                if isinstance(_not_required_nullable_one_of_models_type_0, Unset):
-                    not_required_nullable_one_of_models_type_0 = UNSET
-                else:
-                    not_required_nullable_one_of_models_type_0 = FreeFormModel.from_dict(
-                        _not_required_nullable_one_of_models_type_0
-                    )
+                not_required_nullable_one_of_models_type_0 = FreeFormModel.from_dict(data)
 
                 return not_required_nullable_one_of_models_type_0
             except:  # noqa: E722
                 pass
             try:
                 if not isinstance(data, dict):
                     raise TypeError()
-                _not_required_nullable_one_of_models_type_1 = data
-                not_required_nullable_one_of_models_type_1: Union[Unset, ModelWithUnionProperty]
-                if isinstance(_not_required_nullable_one_of_models_type_1, Unset):
-                    not_required_nullable_one_of_models_type_1 = UNSET
-                else:
-                    not_required_nullable_one_of_models_type_1 = ModelWithUnionProperty.from_dict(
-                        _not_required_nullable_one_of_models_type_1
-                    )
+                not_required_nullable_one_of_models_type_1 = ModelWithUnionProperty.from_dict(data)
 
                 return not_required_nullable_one_of_models_type_1
             except:  # noqa: E722
@@ -482,14 +448,7 @@ def _parse_not_required_nullable_model(data: object) -> Union["ModelWithUnionPro
             try:
                 if not isinstance(data, dict):
                     raise TypeError()
-                _not_required_nullable_model_type_1 = data
-                not_required_nullable_model_type_1: Union[Unset, ModelWithUnionProperty]
-                if isinstance(_not_required_nullable_model_type_1, Unset):
-                    not_required_nullable_model_type_1 = UNSET
-                else:
-                    not_required_nullable_model_type_1 = ModelWithUnionProperty.from_dict(
-                        _not_required_nullable_model_type_1
-                    )
+                not_required_nullable_model_type_1 = ModelWithUnionProperty.from_dict(data)
 
                 return not_required_nullable_model_type_1
             except:  # noqa: E722

end_to_end_tests/golden-record/my_test_api_client/models/body_upload_file_tests_upload_post.py

@@ -94,12 +94,10 @@ def to_dict(self) -> Dict[str, Any]:
         if isinstance(self.some_array, Unset):
             some_array = UNSET
         elif isinstance(self.some_array, list):
-            some_array = UNSET
-            if not isinstance(self.some_array, Unset):
-                some_array = []
-                for some_array_type_0_item_data in self.some_array:
-                    some_array_type_0_item = some_array_type_0_item_data.to_dict()
-                    some_array.append(some_array_type_0_item)
+            some_array = []
+            for some_array_type_0_item_data in self.some_array:
+                some_array_type_0_item = some_array_type_0_item_data.to_dict()
+                some_array.append(some_array_type_0_item)
 
         else:
             some_array = self.some_array
@@ -180,13 +178,11 @@ def to_multipart(self) -> Dict[str, Any]:
         if isinstance(self.some_array, Unset):
             some_array = UNSET
         elif isinstance(self.some_array, list):
-            some_array = UNSET
-            if not isinstance(self.some_array, Unset):
-                _temp_some_array = []
-                for some_array_type_0_item_data in self.some_array:
-                    some_array_type_0_item = some_array_type_0_item_data.to_dict()
-                    _temp_some_array.append(some_array_type_0_item)
-                some_array = (None, json.dumps(_temp_some_array).encode(), "application/json")
+            _temp_some_array = []
+            for some_array_type_0_item_data in self.some_array:
+                some_array_type_0_item = some_array_type_0_item_data.to_dict()
+                _temp_some_array.append(some_array_type_0_item)
+            some_array = (None, json.dumps(_temp_some_array).encode(), "application/json")
 
         else:
             some_array = self.some_array
@@ -297,7 +293,7 @@ def _parse_some_array(data: object) -> Union[List["AFormData"], None, Unset]:
                     raise TypeError()
                 some_array_type_0 = []
                 _some_array_type_0 = data
-                for some_array_type_0_item_data in _some_array_type_0 or []:
+                for some_array_type_0_item_data in _some_array_type_0:
                     some_array_type_0_item = AFormData.from_dict(some_array_type_0_item_data)
 
                     some_array_type_0.append(some_array_type_0_item)

end_to_end_tests/golden-record/my_test_api_client/models/model_with_union_property.py

@@ -23,14 +23,9 @@ def to_dict(self) -> Dict[str, Any]:
         if isinstance(self.a_property, Unset):
             a_property = UNSET
         elif isinstance(self.a_property, AnEnum):
-            a_property = UNSET
-            if not isinstance(self.a_property, Unset):
-                a_property = self.a_property.value
-
+            a_property = self.a_property.value
         else:
-            a_property = UNSET
-            if not isinstance(self.a_property, Unset):
-                a_property = self.a_property.value
+            a_property = self.a_property.value
 
         field_dict: Dict[str, Any] = {}
         field_dict.update({})
@@ -49,24 +44,14 @@ def _parse_a_property(data: object) -> Union[AnEnum, AnIntEnum, Unset]:
             try:
                 if not isinstance(data, str):
                     raise TypeError()
-                _a_property_type_0 = data
-                a_property_type_0: Union[Unset, AnEnum]
-                if isinstance(_a_property_type_0, Unset):
-                    a_property_type_0 = UNSET
-                else:
-                    a_property_type_0 = AnEnum(_a_property_type_0)
+                a_property_type_0 = AnEnum(data)
 
                 return a_property_type_0
             except:  # noqa: E722
                 pass
             if not isinstance(data, int):
                 raise TypeError()
-            _a_property_type_1 = data
-            a_property_type_1: Union[Unset, AnIntEnum]
-            if isinstance(_a_property_type_1, Unset):
-                a_property_type_1 = UNSET
-            else:
-                a_property_type_1 = AnIntEnum(_a_property_type_1)
+            a_property_type_1 = AnIntEnum(data)
 
             return a_property_type_1
 

end_to_end_tests/golden-record/my_test_api_client/models/model_with_union_property_inlined.py

@@ -28,13 +28,9 @@ def to_dict(self) -> Dict[str, Any]:
         if isinstance(self.fruit, Unset):
             fruit = UNSET
         elif isinstance(self.fruit, ModelWithUnionPropertyInlinedFruitType0):
-            fruit = UNSET
-            if not isinstance(self.fruit, Unset):
-                fruit = self.fruit.to_dict()
+            fruit = self.fruit.to_dict()
         else:
-            fruit = UNSET
-            if not isinstance(self.fruit, Unset):
-                fruit = self.fruit.to_dict()
+            fruit = self.fruit.to_dict()
 
         field_dict: Dict[str, Any] = {}
         field_dict.update({})
@@ -58,24 +54,14 @@ def _parse_fruit(
             try:
                 if not isinstance(data, dict):
                     raise TypeError()
-                _fruit_type_0 = data
-                fruit_type_0: Union[Unset, ModelWithUnionPropertyInlinedFruitType0]
-                if isinstance(_fruit_type_0, Unset):
-                    fruit_type_0 = UNSET
-                else:
-                    fruit_type_0 = ModelWithUnionPropertyInlinedFruitType0.from_dict(_fruit_type_0)
+                fruit_type_0 = ModelWithUnionPropertyInlinedFruitType0.from_dict(data)
 
                 return fruit_type_0
             except:  # noqa: E722
                 pass
             if not isinstance(data, dict):
                 raise TypeError()
-            _fruit_type_1 = data
-            fruit_type_1: Union[Unset, ModelWithUnionPropertyInlinedFruitType1]
-            if isinstance(_fruit_type_1, Unset):
-                fruit_type_1 = UNSET
-            else:
-                fruit_type_1 = ModelWithUnionPropertyInlinedFruitType1.from_dict(_fruit_type_1)
+            fruit_type_1 = ModelWithUnionPropertyInlinedFruitType1.from_dict(data)
 
             return fruit_type_1
 

openapi_python_client/parser/properties/union.py

@@ -57,7 +57,7 @@ def build(
         for i, sub_prop_data in enumerate(chain(data.anyOf, data.oneOf, type_list_data)):
             sub_prop, schemas = property_from_data(
                 name=f"{name}_type_{i}",
-                required=required,
+                required=True,
                 data=sub_prop_data,
                 schemas=schemas,
                 parent_name=parent_name,

openapi_python_client/templates/property_templates/date_property.py.jinja

@@ -4,8 +4,8 @@ isoparse({{ source }}).date()
 
 {% from "property_templates/property_macros.py.jinja" import construct_template %}
 
-{% macro construct(property, source, initial_value=None) %}
-{{ construct_template(construct_function, property, source, initial_value=initial_value) }}
+{% macro construct(property, source) %}
+{{ construct_template(construct_function, property, source) }}
 {% endmacro %}
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, str){% endmacro %}

openapi_python_client/templates/property_templates/datetime_property.py.jinja

@@ -4,8 +4,8 @@ isoparse({{ source }})
 
 {% from "property_templates/property_macros.py.jinja" import construct_template %}
 
-{% macro construct(property, source, initial_value=None) %}
-{{ construct_template(construct_function, property, source, initial_value=initial_value) }}
+{% macro construct(property, source) %}
+{{ construct_template(construct_function, property, source) }}
 {% endmacro %}
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, str){% endmacro %}

openapi_python_client/templates/property_templates/enum_property.py.jinja

@@ -4,8 +4,8 @@
 
 {% from "property_templates/property_macros.py.jinja" import construct_template %}
 
-{% macro construct(property, source, initial_value=None) %}
-{{ construct_template(construct_function, property, source, initial_value=initial_value) }}
+{% macro construct(property, source) %}
+{{ construct_template(construct_function, property, source) }}
 {% endmacro %}
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, {{ property.value_type.__name__ }}){% endmacro %}

openapi_python_client/templates/property_templates/file_property.py.jinja

@@ -6,8 +6,8 @@ File(
 
 {% from "property_templates/property_macros.py.jinja" import construct_template %}
 
-{% macro construct(property, source, initial_value=None) %}
-{{ construct_template(construct_function, property, source, initial_value=initial_value) }}
+{% macro construct(property, source) %}
+{{ construct_template(construct_function, property, source) }}
 {% endmacro %}
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, bytes){% endmacro %}

openapi_python_client/templates/property_templates/list_property.py.jinja

@@ -1,12 +1,9 @@
-{% macro construct(property, source, initial_value="[]") %}
+{% macro construct(property, source) %}
 {% set inner_property = property.inner_property %}
 {% import "property_templates/" + inner_property.template as inner_template %}
 {% if inner_template.construct %}
 {% set inner_source = inner_property.python_name + "_data" %}
-{% if initial_value == "UNSET" %}
-{% set initial_value = "[]" %}
-{% endif %}
-{{ property.python_name }} = {{ initial_value }}
+{{ property.python_name }} = []
 _{{ property.python_name }} = {{ source }}
 {% if property.required %}
 for {{ inner_source }} in (_{{ property.python_name }}):

openapi_python_client/templates/property_templates/model_property.py.jinja

@@ -4,8 +4,8 @@
 
 {% from "property_templates/property_macros.py.jinja" import construct_template %}
 
-{% macro construct(property, source, initial_value=None) %}
-{{ construct_template(construct_function, property, source, initial_value=initial_value) }}
+{% macro construct(property, source) %}
+{{ construct_template(construct_function, property, source) }}
 {% endmacro %}
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, dict){% endmacro %}

openapi_python_client/templates/property_templates/property_macros.py.jinja

@@ -1,13 +1,12 @@
-{% macro construct_template(construct_function, property, source, initial_value=None) %}
+{% macro construct_template(construct_function, property, source) %}
 {% if property.required %}
 {{ property.python_name }} = {{ construct_function(property, source) }}
 {% else %}{# Must be non-required #}
 _{{ property.python_name }} = {{ source }}
 {{ property.python_name }}: {{ property.get_type_string() }}
     {% if not property.required %}
 if isinstance(_{{ property.python_name }},  Unset):
-    {{ property.python_name }} = {% if initial_value != None %}{{ initial_value }}{% else %}UNSET{% endif %}
-
+    {{ property.python_name }} = UNSET
     {% endif %}
 else:
     {{ property.python_name }} = {{ construct_function(property, "_" + property.python_name) }}