Remove support for defaults in lists/dicts. Closes #170

Author: dbanty

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.6.0 - Unreleased
+### Breaking Changes
+- Reorganized api calls in generated clients. `async_api` will no longer be generated. Each path operation will now 
+    have it's own module under its tag. For example, if there was a generated function `api.my_tag.my_function()` it is 
+    replaced with `api.my_tag.my_function.sync()`. The async version can be called with `asyncio()` instead of `sync()`.
+- Removed support for mutable default values (e.g. dicts, lists). They may be added back in a future version given enough 
+    demand, but the existing implementation was not up to this project's standards.
+
 
 ## 0.5.4 - Unreleased
 ### Additions

end_to_end_tests/golden-master/my_test_api_client/api/tests/test_defaults_tests_test_defaults_post.py

@@ -1,5 +1,5 @@
 import datetime
-from dataclasses import asdict, field
+from dataclasses import asdict
 from typing import Any, Dict, List, Optional, Union, cast
 
 import httpx
@@ -20,9 +20,7 @@ def _get_kwargs(
     float_prop: Optional[float] = 3.14,
     int_prop: Optional[int] = 7,
     boolean_prop: Optional[bool] = False,
-    list_prop: Optional[List[AnEnum]] = field(
-        default_factory=lambda: cast(Optional[List[AnEnum]], [AnEnum.FIRST_VALUE, AnEnum.SECOND_VALUE])
-    ),
+    list_prop: Optional[List[AnEnum]] = None,
     union_prop: Optional[Union[Optional[float], Optional[str]]] = "not a float",
     enum_prop: Optional[AnEnum] = None,
 ) -> Dict[str, Any]:
@@ -105,9 +103,7 @@ def sync(
     float_prop: Optional[float] = 3.14,
     int_prop: Optional[int] = 7,
     boolean_prop: Optional[bool] = False,
-    list_prop: Optional[List[AnEnum]] = field(
-        default_factory=lambda: cast(Optional[List[AnEnum]], [AnEnum.FIRST_VALUE, AnEnum.SECOND_VALUE])
-    ),
+    list_prop: Optional[List[AnEnum]] = None,
     union_prop: Optional[Union[Optional[float], Optional[str]]] = "not a float",
     enum_prop: Optional[AnEnum] = None,
 ) -> Union[
@@ -144,9 +140,7 @@ async def asyncio(
     float_prop: Optional[float] = 3.14,
     int_prop: Optional[int] = 7,
     boolean_prop: Optional[bool] = False,
-    list_prop: Optional[List[AnEnum]] = field(
-        default_factory=lambda: cast(Optional[List[AnEnum]], [AnEnum.FIRST_VALUE, AnEnum.SECOND_VALUE])
-    ),
+    list_prop: Optional[List[AnEnum]] = None,
     union_prop: Optional[Union[Optional[float], Optional[str]]] = "not a float",
     enum_prop: Optional[AnEnum] = None,
 ) -> Union[

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

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import datetime
-from dataclasses import dataclass, field
+from dataclasses import dataclass
 from typing import Any, Dict, List, Optional, Union, cast
 
 from .an_enum import AnEnum
@@ -16,9 +16,7 @@ class AModel:
     some_dict: Dict[Any, Any]
     a_camel_date_time: Union[datetime.datetime, datetime.date]
     a_date: datetime.date
-    nested_list_of_enums: Optional[List[List[DifferentEnum]]] = field(
-        default_factory=lambda: cast(Optional[List[List[DifferentEnum]]], [])
-    )
+    nested_list_of_enums: Optional[List[List[DifferentEnum]]] = None
 
     def to_dict(self) -> Dict[str, Any]:
         an_enum_value = self.an_enum_value.value

openapi_python_client/parser/properties.py

@@ -233,20 +233,10 @@ def get_imports(self, *, prefix: str) -> Set[str]:
         imports = super().get_imports(prefix=prefix)
         imports.update(self.inner_property.get_imports(prefix=prefix))
         imports.add("from typing import List")
-        if self.default is not None:
-            imports.add("from dataclasses import field")
-            imports.add("from typing import cast")
         return imports
 
-    def _validate_default(self, default: Any) -> str:
-        if not isinstance(default, list):
-            raise ValidationError()
-
-        default = list(map(self.inner_property._validate_default, default))
-        if isinstance(self.inner_property, RefProperty):  # Fix enums to use the actual value
-            default = str(default).replace("'", "")
-
-        return f"field(default_factory=lambda: cast({self.get_type_string()}, {default}))"
+    def _validate_default(self, default: Any) -> None:
+        return None
 
 
 @dataclass
@@ -432,10 +422,8 @@ def get_imports(self, *, prefix: str) -> Set[str]:
             imports.add("from typing import cast")
         return imports
 
-    def _validate_default(self, default: Any) -> str:
-        if isinstance(default, dict):
-            return repr(default)
-        raise ValidationError
+    def _validate_default(self, default: Any) -> None:
+        return None
 
 
 def _string_based_property(

tests/test_openapi_parser/test_properties.py

@@ -226,9 +226,6 @@ def test_get_type_string(self, mocker):
         p.required = False
         assert p.get_type_string() == f"Optional[List[{inner_type_string}]]"
 
-        p = ListProperty(name="test", required=True, default=[], inner_property=inner_property, nullable=False)
-        assert p.default == f"field(default_factory=lambda: cast(List[{inner_type_string}], []))"
-
     def test_get_type_imports(self, mocker):
         from openapi_python_client.parser.properties import ListProperty
 
@@ -249,40 +246,13 @@ def test_get_type_imports(self, mocker):
             "from typing import Optional",
         }
 
-        p.default = mocker.MagicMock()
-        assert p.get_imports(prefix=prefix) == {
-            inner_import,
-            "from typing import Optional",
-            "from typing import List",
-            "from typing import cast",
-            "from dataclasses import field",
-        }
-
     def test__validate_default(self, mocker):
         from openapi_python_client.parser.properties import ListProperty
 
         inner_property = mocker.MagicMock()
-        inner_type_string = mocker.MagicMock()
-        inner_property.get_type_string.return_value = inner_type_string
-        inner_property._validate_default.return_value = "y"
 
         p = ListProperty(name="a name", required=True, default=["x"], inner_property=inner_property, nullable=False)
-        assert p.default == f"field(default_factory=lambda: cast(List[{inner_type_string}], ['y']))"
-
-        with pytest.raises(ValidationError):
-            ListProperty(name="a name", required=True, default="x", inner_property=inner_property, nullable=False)
-
-    def test__validate_default_enum_items(self, mocker):
-        from openapi_python_client.parser.properties import ListProperty, RefProperty
-
-        inner_enum_property = mocker.MagicMock(spec=RefProperty)
-        inner_enum_property.get_type_string.return_value = "AnEnum"
-        inner_enum_property._validate_default.return_value = "AnEnum.val1"
-
-        p = ListProperty(
-            name="a name", required=True, default=["val1"], inner_property=inner_enum_property, nullable=False
-        )
-        assert p.default == "field(default_factory=lambda: cast(List[AnEnum], [AnEnum.val1]))"
+        assert p.default is None
 
 
 class TestUnionProperty:
@@ -607,10 +577,9 @@ def test_get_imports(self, mocker):
     def test__validate_default(self):
         from openapi_python_client.parser.properties import DictProperty
 
-        DictProperty(name="a name", required=True, default={"key": "value"}, nullable=False)
+        p = DictProperty(name="a name", required=True, default={"key": "value"}, nullable=False)
 
-        with pytest.raises(ValidationError):
-            DictProperty(name="a name", required=True, default="not a dict", nullable=False)
+        assert p.default is None
 
 
 class TestPropertyFromData: