fix: Multipart uploads for httpx >= 0.19.0

Fixes #508

BREAKING CHANGE: `File` uploads can now only accept binary payloads (`BinaryIO`).

Author: dbanty

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

@@ -102,36 +102,40 @@ def to_dict(self) -> Dict[str, Any]:
     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_object = (None, json.dumps(self.some_object.to_dict()).encode(), "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
+        some_string = (
+            self.some_string if self.some_string is UNSET else (None, str(self.some_string).encode(), "text/plain")
+        )
+        some_number = (
+            self.some_number if self.some_number is UNSET else (None, str(self.some_number).encode(), "text/plain")
+        )
+        some_array: Union[Unset, Tuple[None, bytes, 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_array = (None, json.dumps(_temp_some_array).encode(), "application/json")
 
-        some_optional_object: Union[Unset, Tuple[None, str, str]] = UNSET
+        some_optional_object: Union[Unset, Tuple[None, bytes, 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_optional_object = (None, json.dumps(self.some_optional_object.to_dict()).encode(), "application/json")
 
         some_nullable_object = (
-            (None, json.dumps(self.some_nullable_object.to_dict()), "application/json")
+            (None, json.dumps(self.some_nullable_object.to_dict()).encode(), "application/json")
             if self.some_nullable_object
             else None
         )
 
-        some_enum: Union[Unset, Tuple[None, str, str]] = UNSET
+        some_enum: Union[Unset, Tuple[None, bytes, str]] = UNSET
         if not isinstance(self.some_enum, Unset):
-            some_enum = (None, str(self.some_enum.value), "text/plain")
+            some_enum = (None, str(self.some_enum.value).encode(), "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[prop_name] = (None, json.dumps(prop.to_dict()).encode(), "application/json")
 
         field_dict.update(
             {

end_to_end_tests/golden-record/my_test_api_client/types.py

@@ -1,5 +1,5 @@
 """ Contains some shared types for properties """
-from typing import BinaryIO, Generic, MutableMapping, Optional, TextIO, Tuple, TypeVar, Union
+from typing import BinaryIO, Generic, MutableMapping, Optional, Tuple, TypeVar
 
 import attr
 
@@ -11,14 +11,14 @@ def __bool__(self) -> bool:
 
 UNSET: Unset = Unset()
 
-FileJsonType = Tuple[Optional[str], Union[BinaryIO, TextIO], Optional[str]]
+FileJsonType = Tuple[Optional[str], BinaryIO, Optional[str]]
 
 
 @attr.s(auto_attribs=True)
 class File:
     """Contains information for file uploads"""
 
-    payload: Union[BinaryIO, TextIO]
+    payload: BinaryIO
     file_name: Optional[str] = None
     mime_type: Optional[str] = None
 

openapi_python_client/templates/model.py.jinja

@@ -68,9 +68,10 @@ class {{ class_name }}:
 {% for property in model.required_properties + model.optional_properties %}
 {% if property.template %}
 {% from "property_templates/" + property.template import transform %}
-{{ transform(property, "self." + property.python_name, property.python_name, stringify=multipart) }}
+{# Stopped here #}
+{{ transform(property, "self." + property.python_name, property.python_name, multipart=multipart) }}
 {% elif multipart %}
-{{ property.python_name }} = self.{{ property.python_name }} if self.{{ property.python_name }} is UNSET else (None, str(self.{{ property.python_name }}), "text/plain")
+{{ property.python_name }} = self.{{ property.python_name }} if self.{{ property.python_name }} is UNSET else (None, str(self.{{ property.python_name }}).encode(), "text/plain")
 {% else %}
 {{ property.python_name }} = self.{{ property.python_name }}
 {% endif %}
@@ -81,10 +82,10 @@ field_dict: Dict[str, Any] = {}
 {% if model.additional_properties.template %}
 {% from "property_templates/" + model.additional_properties.template import transform %}
 for prop_name, prop in self.additional_properties.items():
-    {{ transform(model.additional_properties, "prop", "field_dict[prop_name]", stringify=multipart) | indent(4) }}
+    {{ transform(model.additional_properties, "prop", "field_dict[prop_name]", multipart=multipart) | indent(4) }}
 {% elif multipart %}
 field_dict.update({
-    key: (None, str(value), "text/plain")
+    key: (None, str(value).encode(), "text/plain")
     for key, value in self.additional_properties.items()
 })
 {% else %}

openapi_python_client/templates/property_templates/any_property.py.jinja

@@ -2,6 +2,6 @@
 {{ property.python_name }} = {{ source }}
 {% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True, stringify=False) %}
+{% macro transform(property, source, destination, declare_type=True, multipart=False) %}
 {{ destination }} = {{ source }}
 {% endmacro %}

openapi_python_client/templates/property_templates/date_property.py.jinja

@@ -10,16 +10,20 @@ isoparse({{ source }}).date()
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, str){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True, stringify=False) %}
+{% macro transform(property, source, destination, declare_type=True, multipart=False) %}
+{% set transformed = source + ".isoformat()" %}
+{% if multipart %} {# Multipart data must be bytes, not str #}
+{% set transformed = transformed + ".encode()" %}
+{% endif %}
 {% if property.required %}
-{{ destination }} = {{ source }}.isoformat() {% if property.nullable %}if {{ source }} else None {%endif%}
+{{ destination }} = {{ transformed }} {% if property.nullable %}if {{ source }} else None {%endif%}
 {% else %}
 {{ destination }}{% if declare_type %}: {{ property.get_type_string(json=True) }}{% endif %} = UNSET
 if not isinstance({{ source }}, Unset):
 {% if property.nullable %}
-    {{ destination }} = {{ source }}.isoformat() if {{ source }} else None
+    {{ destination }} = {{ transformed }} if {{ source }} else None
 {% else %}
-    {{ destination }} = {{ source }}.isoformat()
+    {{ destination }} = {{ transformed }}
 {% endif %}
 {% endif %}
 {% endmacro %}

openapi_python_client/templates/property_templates/datetime_property.py.jinja

@@ -10,20 +10,24 @@ isoparse({{ source }})
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, str){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True, stringify=False) %}
+{% macro transform(property, source, destination, declare_type=True, multipart=False) %}
+{% set transformed = source + ".isoformat()" %}
+{% if multipart %} {# Multipart data must be bytes, not str #}
+{% set transformed = transformed + ".encode()" %}
+{% endif %}
 {% if property.required %}
 {% if property.nullable %}
-{{ destination }} = {{ source }}.isoformat() if {{ source }} else None
+{{ destination }} = {{ transformed }} if {{ source }} else None
 {% else %}
-{{ destination }} = {{ source }}.isoformat()
+{{ destination }} = {{ transformed }}
 {% endif %}
 {% else %}
 {{ destination }}{% if declare_type %}: {{ property.get_type_string(json=True) }}{% endif %} = UNSET
 if not isinstance({{ source }}, Unset):
 {% if property.nullable %}
-    {{ destination }} = {{ source }}.isoformat() if {{ source }} else None
+    {{ destination }} = {{ transformed }} if {{ source }} else None
 {% else %}
-    {{ destination }} = {{ source }}.isoformat()
+    {{ destination }} = {{ transformed }}
 {% endif %}
 {% endif %}
 {% endmacro %}

openapi_python_client/templates/property_templates/enum_property.py.jinja

@@ -10,12 +10,12 @@
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, {{ property.value_type.__name__ }}){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True, stringify=False) %}
+{% macro transform(property, source, destination, declare_type=True, multipart=False) %}
 {% set transformed = source + ".value" %}
 {% set type_string = property.get_type_string(json=True) %}
-{% if stringify %}
-    {% set transformed = "(None, str(" + transformed + "), 'text/plain')" %}
-    {% set type_string = "Union[Unset, Tuple[None, str, str]]" %}
+{% if multipart %}
+    {% set transformed = "(None, str(" + transformed + ").encode(), \"text/plain\")" %}
+    {% set type_string = "Union[Unset, Tuple[None, bytes, str]]" %}
 {% endif %}
 {% if property.required %}
 {% if property.nullable %}

openapi_python_client/templates/property_templates/file_property.py.jinja

@@ -12,7 +12,7 @@ File(
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, bytes){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True, stringify=False) %}
+{% macro transform(property, source, destination, declare_type=True, multipart=False) %}
 {% if property.required %}
 {% if property.nullable %}
 {{ destination }} = {{ source }}.to_tuple() if {{ source }} else None

openapi_python_client/templates/property_templates/list_property.py.jinja

@@ -17,10 +17,10 @@ for {{ inner_source }} in (_{{ property.python_name }} or []):
 {% endif %}
 {% endmacro %}
 
-{% macro _transform(property, source, destination, stringify, transform_method) %}
+{% macro _transform(property, source, destination, multipart, transform_method) %}
 {% set inner_property = property.inner_property %}
-{% if stringify %}
-{% set stringified_destination = destination %}
+{% if multipart %}
+{% set multipart_destination = destination %}
 {% set destination = "_temp_" + destination %}
 {% endif %}
 {% if inner_property.template %}
@@ -33,17 +33,17 @@ for {{ inner_source }} in {{ source }}:
 {% else %}
 {{ destination }} = {{ source }}
 {% endif %}
-{% if stringify %}
-{{ stringified_destination }} = (None, json.dumps({{ destination }}), 'application/json')
+{% if multipart %}
+{{ multipart_destination }} = (None, json.dumps({{ destination }}).encode(), 'application/json')
 {% endif %}
 {% endmacro %}
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, list){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True, stringify=False, transform_method="to_dict") %}
+{% macro transform(property, source, destination, declare_type=True, multipart=False, transform_method="to_dict") %}
 {% set inner_property = property.inner_property %}
-{% if stringify %}
-    {% set type_string = "Union[Unset, Tuple[None, str, str]]" %}
+{% if multipart %}
+    {% set type_string = "Union[Unset, Tuple[None, bytes, str]]" %}
 {% else %}
     {% set type_string = property.get_type_string(json=True) %}
 {% endif %}
@@ -52,9 +52,9 @@ for {{ inner_source }} in {{ source }}:
 if {{ source }} is None:
     {{ destination }} = None
 else:
-    {{ _transform(property, source, destination, stringify, transform_method) | indent(4) }}
+    {{ _transform(property, source, destination, multipart, transform_method) | indent(4) }}
 {% else %}
-{{ _transform(property, source, destination, stringify, transform_method) }}
+{{ _transform(property, source, destination, multipart, transform_method) }}
 {% endif %}
 {% else %}
 {{ destination }}{% if declare_type %}: {{ type_string }}{% endif %} = UNSET
@@ -63,9 +63,9 @@ if not isinstance({{ source }}, Unset):
     if {{ source }} is None:
         {{ destination }} = None
     else:
-        {{ _transform(property, source, destination, stringify, transform_method) | indent(8)}}
+        {{ _transform(property, source, destination, multipart, transform_method) | indent(8)}}
 {% else %}
-    {{ _transform(property, source, destination, stringify, transform_method) | indent(4)}}
+    {{ _transform(property, source, destination, multipart, transform_method) | indent(4)}}
 {% endif %}
 {% endif %}
 

openapi_python_client/templates/property_templates/model_property.py.jinja

@@ -10,11 +10,11 @@
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, dict){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True, stringify=False, transform_method="to_dict") %}
+{% macro transform(property, source, destination, declare_type=True, multipart=False, transform_method="to_dict") %}
 {% set transformed = source + "." + transform_method + "()" %}
-{% if stringify %}
-    {% set transformed = "(None, json.dumps(" + transformed + "), 'application/json')" %}
-    {% set type_string = "Union[Unset, Tuple[None, str, str]]" %}
+{% if multipart %}
+    {% set transformed = "(None, json.dumps(" + transformed + ").encode(), 'application/json')" %}
+    {% set type_string = "Union[Unset, Tuple[None, bytes, str]]" %}
 {% else %}
     {% set type_string = property.get_type_string(json=True) %}
 {% endif %}

openapi_python_client/templates/property_templates/union_property.py.jinja

@@ -35,7 +35,7 @@ def _parse_{{ property.python_name }}(data: object) -> {{ property.get_type_stri
 {{ property.python_name }} = _parse_{{ property.python_name }}({{ source }})
 {% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True, stringify=False) %}
+{% macro transform(property, source, destination, declare_type=True, multipart=False) %}
 {% if not property.required or property.nullable %}
 {{ destination }}{% if declare_type %}: {{ property.get_type_string(json=True) }}{% endif %}
 
@@ -61,7 +61,7 @@ elif isinstance({{ source }}, {{ inner_property.get_instance_type_string() }}):
 else:
     {% endif %}
     {% from "property_templates/" + inner_property.template import transform %}
-    {{ transform(inner_property, source, destination, declare_type=False, stringify=stringify) | indent(4) }}
+    {{ transform(inner_property, source, destination, declare_type=False, multipart=multipart) | indent(4) }}
 {% endfor %}
 {% if property.has_properties_without_templates and (property.inner_properties_with_template() | any or not property.required)%}
 else:

openapi_python_client/templates/types.py.jinja

@@ -1,5 +1,5 @@
 """ Contains some shared types for properties """
-from typing import Any, BinaryIO, Generic, MutableMapping, Optional, TextIO, Tuple, TypeVar, Union
+from typing import Any, BinaryIO, Generic, MutableMapping, Optional, Tuple, TypeVar
 
 import attr
 
@@ -12,14 +12,14 @@ class Unset:
 UNSET: Unset = Unset()
 
 {# Used as `FileProperty._json_type_string` #}
-FileJsonType = Tuple[Optional[str], Union[BinaryIO, TextIO], Optional[str]]
+FileJsonType = Tuple[Optional[str], BinaryIO, Optional[str]]
 
 
 @attr.s(auto_attribs=True)
 class File:
     """ Contains information for file uploads """
 
-    payload: Union[BinaryIO, TextIO]
+    payload: BinaryIO
     file_name: Optional[str] = None
     mime_type: Optional[str] = None