feat!:Allow more types in multipart payloads by defaulting to JSON for complex types (#372). Thanks @csymeonides-mf!

* fix: Detect File fields correctly

* fix: Optional File field caused missing import error

* fix: Non-string multipart fields must be stringified

* chore: Reformat

* fix: Put non-file fields as tuples in the files dict

* refactor: Avoid runtime type checks

* fix: Declaring types is necessary

* fix: Remove dead code

* fix: Non-JSON non-file multipart props need to be text/plain

* refactor: Avoid breaking change

Co-authored-by: Constantinos Symeonides <[email protected]>

Author: 2 people

end_to_end_tests/golden-record/my_test_api_client/api/tests/upload_file_tests_upload_post.py

@@ -5,7 +5,7 @@
 from ...client import Client
 from ...models.body_upload_file_tests_upload_post import BodyUploadFileTestsUploadPost
 from ...models.http_validation_error import HTTPValidationError
-from ...types import UNSET, File, Response, Unset
+from ...types import UNSET, Response, Unset
 
 
 def _get_kwargs(
@@ -22,21 +22,14 @@ def _get_kwargs(
     if keep_alive is not UNSET:
         headers["keep-alive"] = keep_alive
 
-    files = {}
-    data = {}
-    for key, value in multipart_data.to_dict().items():
-        if isinstance(value, File):
-            files[key] = value
-        else:
-            data[key] = value
+    multipart_multipart_data = multipart_data.to_multipart()
 
     return {
         "url": url,
         "headers": headers,
         "cookies": cookies,
         "timeout": client.get_timeout(),
-        "files": files,
-        "data": data,
+        "files": multipart_multipart_data,
     }
 
 

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

@@ -9,6 +9,10 @@
 from .an_int_enum import AnIntEnum
 from .another_all_of_sub_model import AnotherAllOfSubModel
 from .body_upload_file_tests_upload_post import BodyUploadFileTestsUploadPost
+from .body_upload_file_tests_upload_post_additional_property import BodyUploadFileTestsUploadPostAdditionalProperty
+from .body_upload_file_tests_upload_post_some_nullable_object import BodyUploadFileTestsUploadPostSomeNullableObject
+from .body_upload_file_tests_upload_post_some_object import BodyUploadFileTestsUploadPostSomeObject
+from .body_upload_file_tests_upload_post_some_optional_object import BodyUploadFileTestsUploadPostSomeOptionalObject
 from .different_enum import DifferentEnum
 from .free_form_model import FreeFormModel
 from .http_validation_error import HTTPValidationError

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

@@ -1,9 +1,21 @@
+import json
 from io import BytesIO
-from typing import Any, Dict, Type, TypeVar, Union
+from typing import Any, Dict, List, Optional, Tuple, Type, TypeVar, Union, cast
 
 import attr
 
-from ..types import UNSET, File, Unset
+from ..models.body_upload_file_tests_upload_post_additional_property import (
+    BodyUploadFileTestsUploadPostAdditionalProperty,
+)
+from ..models.body_upload_file_tests_upload_post_some_nullable_object import (
+    BodyUploadFileTestsUploadPostSomeNullableObject,
+)
+from ..models.body_upload_file_tests_upload_post_some_object import BodyUploadFileTestsUploadPostSomeObject
+from ..models.body_upload_file_tests_upload_post_some_optional_object import (
+    BodyUploadFileTestsUploadPostSomeOptionalObject,
+)
+from ..models.different_enum import DifferentEnum
+from ..types import UNSET, File, FileJsonType, Unset
 
 T = TypeVar("T", bound="BodyUploadFileTestsUploadPost")
 
@@ -13,21 +25,122 @@ class BodyUploadFileTestsUploadPost:
     """ """
 
     some_file: File
+    some_object: BodyUploadFileTestsUploadPostSomeObject
+    some_nullable_object: Optional[BodyUploadFileTestsUploadPostSomeNullableObject]
+    some_optional_file: Union[Unset, File] = UNSET
     some_string: Union[Unset, str] = "some_default_string"
+    some_number: Union[Unset, float] = UNSET
+    some_array: Union[Unset, List[float]] = UNSET
+    some_optional_object: Union[Unset, BodyUploadFileTestsUploadPostSomeOptionalObject] = UNSET
+    some_enum: Union[Unset, DifferentEnum] = UNSET
+    additional_properties: Dict[str, BodyUploadFileTestsUploadPostAdditionalProperty] = attr.ib(
+        init=False, factory=dict
+    )
 
     def to_dict(self) -> Dict[str, Any]:
         some_file = self.some_file.to_tuple()
 
+        some_object = self.some_object.to_dict()
+
+        some_optional_file: Union[Unset, FileJsonType] = UNSET
+        if not isinstance(self.some_optional_file, Unset):
+            some_optional_file = self.some_optional_file.to_tuple()
+
         some_string = self.some_string
+        some_number = self.some_number
+        some_array: Union[Unset, List[float]] = UNSET
+        if not isinstance(self.some_array, Unset):
+            some_array = self.some_array
+
+        some_optional_object: Union[Unset, Dict[str, Any]] = UNSET
+        if not isinstance(self.some_optional_object, Unset):
+            some_optional_object = self.some_optional_object.to_dict()
+
+        some_nullable_object = self.some_nullable_object.to_dict() if self.some_nullable_object else None
+
+        some_enum: Union[Unset, str] = UNSET
+        if not isinstance(self.some_enum, Unset):
+            some_enum = self.some_enum.value
 
         field_dict: Dict[str, Any] = {}
+        for prop_name, prop in self.additional_properties.items():
+            field_dict[prop_name] = prop.to_dict()
+
         field_dict.update(
             {
                 "some_file": some_file,
+                "some_object": some_object,
+                "some_nullable_object": some_nullable_object,
             }
         )
+        if some_optional_file is not UNSET:
+            field_dict["some_optional_file"] = some_optional_file
         if some_string is not UNSET:
             field_dict["some_string"] = some_string
+        if some_number is not UNSET:
+            field_dict["some_number"] = some_number
+        if some_array is not UNSET:
+            field_dict["some_array"] = some_array
+        if some_optional_object is not UNSET:
+            field_dict["some_optional_object"] = some_optional_object
+        if some_enum is not UNSET:
+            field_dict["some_enum"] = some_enum
+
+        return field_dict
+
+    def to_multipart(self) -> Dict[str, Any]:
+        some_file = self.some_file.to_tuple()
+
+        some_object = (None, json.dumps(self.some_object.to_dict()), "application/json")
+
+        some_optional_file: Union[Unset, FileJsonType] = UNSET
+        if not isinstance(self.some_optional_file, Unset):
+            some_optional_file = self.some_optional_file.to_tuple()
+
+        some_string = self.some_string if self.some_string is UNSET else (None, str(self.some_string), "text/plain")
+        some_number = self.some_number if self.some_number is UNSET else (None, str(self.some_number), "text/plain")
+        some_array: Union[Unset, Tuple[None, str, str]] = UNSET
+        if not isinstance(self.some_array, Unset):
+            _temp_some_array = self.some_array
+            some_array = (None, json.dumps(_temp_some_array), "application/json")
+
+        some_optional_object: Union[Unset, Tuple[None, str, str]] = UNSET
+        if not isinstance(self.some_optional_object, Unset):
+            some_optional_object = (None, json.dumps(self.some_optional_object.to_dict()), "application/json")
+
+        some_nullable_object = (
+            (None, json.dumps(self.some_nullable_object.to_dict()), "application/json")
+            if self.some_nullable_object
+            else None
+        )
+
+        some_enum: Union[Unset, Tuple[None, str, str]] = UNSET
+        if not isinstance(self.some_enum, Unset):
+            some_enum = (None, str(self.some_enum.value), "text/plain")
+
+        field_dict: Dict[str, Any] = {}
+        for prop_name, prop in self.additional_properties.items():
+            field_dict[prop_name] = (None, json.dumps(prop.to_dict()), "application/json")
+
+        field_dict.update(
+            {
+                "some_file": some_file,
+                "some_object": some_object,
+                "some_nullable_object": some_nullable_object,
+            }
+        )
+        if some_optional_file is not UNSET:
+            field_dict["some_optional_file"] = some_optional_file
+        if some_string is not UNSET:
+            field_dict["some_string"] = some_string
+        if some_number is not UNSET:
+            field_dict["some_number"] = some_number
+        if some_array is not UNSET:
+            field_dict["some_array"] = some_array
+        if some_optional_object is not UNSET:
+            field_dict["some_optional_object"] = some_optional_object
+        if some_enum is not UNSET:
+            field_dict["some_enum"] = some_enum
 
         return field_dict
 
@@ -36,11 +149,75 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
         d = src_dict.copy()
         some_file = File(payload=BytesIO(d.pop("some_file")))
 
+        some_object = BodyUploadFileTestsUploadPostSomeObject.from_dict(d.pop("some_object"))
+
+        _some_optional_file = d.pop("some_optional_file", UNSET)
+        some_optional_file: Union[Unset, File]
+        if isinstance(_some_optional_file, Unset):
+            some_optional_file = UNSET
+        else:
+            some_optional_file = File(payload=BytesIO(_some_optional_file))
+
         some_string = d.pop("some_string", UNSET)
 
+        some_number = d.pop("some_number", UNSET)
+
+        some_array = cast(List[float], d.pop("some_array", UNSET))
+
+        _some_optional_object = d.pop("some_optional_object", UNSET)
+        some_optional_object: Union[Unset, BodyUploadFileTestsUploadPostSomeOptionalObject]
+        if isinstance(_some_optional_object, Unset):
+            some_optional_object = UNSET
+        else:
+            some_optional_object = BodyUploadFileTestsUploadPostSomeOptionalObject.from_dict(_some_optional_object)
+
+        _some_nullable_object = d.pop("some_nullable_object")
+        some_nullable_object: Optional[BodyUploadFileTestsUploadPostSomeNullableObject]
+        if _some_nullable_object is None:
+            some_nullable_object = None
+        else:
+            some_nullable_object = BodyUploadFileTestsUploadPostSomeNullableObject.from_dict(_some_nullable_object)
+
+        _some_enum = d.pop("some_enum", UNSET)
+        some_enum: Union[Unset, DifferentEnum]
+        if isinstance(_some_enum, Unset):
+            some_enum = UNSET
+        else:
+            some_enum = DifferentEnum(_some_enum)
+
         body_upload_file_tests_upload_post = cls(
             some_file=some_file,
+            some_object=some_object,
+            some_optional_file=some_optional_file,
             some_string=some_string,
+            some_number=some_number,
+            some_array=some_array,
+            some_optional_object=some_optional_object,
+            some_nullable_object=some_nullable_object,
+            some_enum=some_enum,
         )
 
+        additional_properties = {}
+        for prop_name, prop_dict in d.items():
+            additional_property = BodyUploadFileTestsUploadPostAdditionalProperty.from_dict(prop_dict)
+
+            additional_properties[prop_name] = additional_property
+
+        body_upload_file_tests_upload_post.additional_properties = additional_properties
         return body_upload_file_tests_upload_post
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> BodyUploadFileTestsUploadPostAdditionalProperty:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: BodyUploadFileTestsUploadPostAdditionalProperty) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

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

@@ -0,0 +1,54 @@
+from typing import Any, Dict, List, Type, TypeVar, Union
+
+import attr
+
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="BodyUploadFileTestsUploadPostAdditionalProperty")
+
+
+@attr.s(auto_attribs=True)
+class BodyUploadFileTestsUploadPostAdditionalProperty:
+    """ """
+
+    foo: Union[Unset, str] = UNSET
+    additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        foo = self.foo
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+        if foo is not UNSET:
+            field_dict["foo"] = foo
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        d = src_dict.copy()
+        foo = d.pop("foo", UNSET)
+
+        body_upload_file_tests_upload_post_additional_property = cls(
+            foo=foo,
+        )
+
+        body_upload_file_tests_upload_post_additional_property.additional_properties = d
+        return body_upload_file_tests_upload_post_additional_property
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

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

@@ -0,0 +1,54 @@
+from typing import Any, Dict, List, Type, TypeVar, Union
+
+import attr
+
+from ..types import UNSET, Unset
+
+T = TypeVar("T", bound="BodyUploadFileTestsUploadPostSomeNullableObject")
+
+
+@attr.s(auto_attribs=True)
+class BodyUploadFileTestsUploadPostSomeNullableObject:
+    """ """
+
+    bar: Union[Unset, str] = UNSET
+    additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        bar = self.bar
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+        if bar is not UNSET:
+            field_dict["bar"] = bar
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        d = src_dict.copy()
+        bar = d.pop("bar", UNSET)
+
+        body_upload_file_tests_upload_post_some_nullable_object = cls(
+            bar=bar,
+        )
+
+        body_upload_file_tests_upload_post_some_nullable_object.additional_properties = d
+        return body_upload_file_tests_upload_post_some_nullable_object
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties