fix: Optional File field caused missing import error

Author: Constantinos Symeonides

end_to_end_tests/golden_record/my_test_api_client/models/body_upload_file_tests_upload_post.py

@@ -3,7 +3,7 @@
 
 import attr
 
-from ..types import UNSET, File, Unset
+from ..types import UNSET, File, FileJsonType, Unset
 
 T = TypeVar("T", bound="BodyUploadFileTestsUploadPost")
 
@@ -13,11 +13,16 @@ class BodyUploadFileTestsUploadPost:
     """  """
 
     some_file: File
+    some_optional_file: Union[Unset, File] = UNSET
     some_string: Union[Unset, str] = "some_default_string"
 
     def to_dict(self) -> Dict[str, Any]:
         some_file = self.some_file.to_tuple()
 
+        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
 
         field_dict: Dict[str, Any] = {}
@@ -26,6 +31,8 @@ def to_dict(self) -> Dict[str, Any]:
                 "some_file": some_file,
             }
         )
+        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
 
@@ -36,10 +43,16 @@ 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_optional_file: Union[Unset, File] = UNSET
+        _some_optional_file = d.pop("some_optional_file", UNSET)
+        if not isinstance(_some_optional_file, Unset):
+            some_optional_file = File(payload=BytesIO(_some_optional_file))
+
         some_string = d.pop("some_string", UNSET)
 
         body_upload_file_tests_upload_post = cls(
             some_file=some_file,
+            some_optional_file=some_optional_file,
             some_string=some_string,
         )
 

end_to_end_tests/golden_record/my_test_api_client/types.py

@@ -45,4 +45,4 @@ class Response(Generic[T]):
     parsed: Optional[T]
 
 
-__all__ = ["File", "Response", "is_file"]
+__all__ = ["File", "Response", "is_file", "FileJsonType"]

end_to_end_tests/openapi.json

@@ -934,6 +934,11 @@
             "type": "string",
             "format": "binary"
           },
+          "some_optional_file": {
+            "title": "Some Optional File",
+            "type": "string",
+            "format": "binary"
+          },
           "some_string": {
             "title": "Some String",
             "type": "string",

end_to_end_tests/test_end_to_end.py

@@ -95,15 +95,15 @@ def test_file_upload(mocker):
 
     base_url = "http://my.base.url"
     client = mocker.MagicMock(base_url=base_url)
-    get = mocker.patch("httpx.post")
+    post = mocker.patch("httpx.post")
 
     # Act
     from .golden_record.my_test_api_client.api.tests import upload_file_tests_upload_post
 
     upload_file_tests_upload_post.sync(client=client, multipart_data=multipart_data)
 
     # Assert
-    get.assert_called_once_with(
+    post.assert_called_once_with(
         url=f"{base_url}/tests/upload",
         headers=ANY,
         cookies=ANY,

openapi_python_client/parser/properties/__init__.py

@@ -83,7 +83,7 @@ class FileProperty(Property):
 
     _type_string: ClassVar[str] = "File"
     # Return type of File.to_tuple()
-    _json_type_string: ClassVar[str] = "Tuple[Optional[str], Union[BinaryIO, TextIO], Optional[str]]"
+    _json_type_string: ClassVar[str] = "FileJsonType"
     template: ClassVar[str] = "file_property.py.jinja"
 
     def get_imports(self, *, prefix: str) -> Set[str]:
@@ -95,7 +95,7 @@ def get_imports(self, *, prefix: str) -> Set[str]:
             back to the root of the generated client.
         """
         imports = super().get_imports(prefix=prefix)
-        imports.update({f"from {prefix}types import File", "from io import BytesIO"})
+        imports.update({f"from {prefix}types import File, FileJsonType", "from io import BytesIO"})
         return imports
 
 

openapi_python_client/templates/types.py.jinja

@@ -46,4 +46,4 @@ class Response(Generic[T]):
     parsed: Optional[T]
 
 
-__all__ = ["File", "Response", "is_file"]
+__all__ = ["File", "Response", "is_file", "FileJsonType"]

tests/test_parser/test_properties/test_init.py

@@ -162,21 +162,21 @@ def test_get_imports(self):
         p = FileProperty(name="test", required=True, default=None, nullable=False)
         assert p.get_imports(prefix=prefix) == {
             "from io import BytesIO",
-            "from ...types import File",
+            "from ...types import File, FileJsonType",
         }
 
         p = FileProperty(name="test", required=False, default=None, nullable=False)
         assert p.get_imports(prefix=prefix) == {
             "from io import BytesIO",
-            "from ...types import File",
+            "from ...types import File, FileJsonType",
             "from typing import Union",
             "from ...types import UNSET, Unset",
         }
 
         p = FileProperty(name="test", required=False, default=None, nullable=True)
         assert p.get_imports(prefix=prefix) == {
             "from io import BytesIO",
-            "from ...types import File",
+            "from ...types import File, FileJsonType",
             "from typing import Union",
             "from typing import Optional",
             "from ...types import UNSET, Unset",