Implement binary request bodies for endpoints

kgutwin · kgutwin · commit c258fabe43db · 2023-12-06T12:36:41.000-05:00
diff --git a/end_to_end_tests/custom-templates-golden-record/my_test_api_client/api/tests/__init__.py b/end_to_end_tests/custom-templates-golden-record/my_test_api_client/api/tests/__init__.py
@@ -15,6 +15,7 @@
     json_body_tests_json_body_post,
     no_response_tests_no_response_get,
     octet_stream_tests_octet_stream_get,
+    octet_stream_tests_octet_stream_post,
     post_form_data,
     post_form_data_inline,
     post_tests_json_body_string,
@@ -118,6 +119,13 @@ def octet_stream_tests_octet_stream_get(cls) -> types.ModuleType:
         """
         return octet_stream_tests_octet_stream_get
 
+    @classmethod
+    def octet_stream_tests_octet_stream_post(cls) -> types.ModuleType:
+        """
+        Binary (octet stream) request body
+        """
+        return octet_stream_tests_octet_stream_post
+
     @classmethod
     def no_response_tests_no_response_get(cls) -> types.ModuleType:
         """
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/octet_stream_tests_octet_stream_post.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/octet_stream_tests_octet_stream_post.py
@@ -0,0 +1,157 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...types import File, Response
+
+
+def _get_kwargs(
+    *,
+    binary_body: File,
+) -> Dict[str, Any]:
+    headers = {}
+    headers["Content-Type"] = binary_body.mime_type if binary_body.mime_type else "application/octet-stream"
+
+    return {
+        "method": "post",
+        "url": "/tests/octet_stream",
+        "content": binary_body,
+        "headers": headers,
+    }
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[HTTPValidationError, str]]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = cast(str, response.json())
+        return response_200
+    if response.status_code == HTTPStatus.UNPROCESSABLE_ENTITY:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[HTTPValidationError, str]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    binary_body: File,
+) -> Response[Union[HTTPValidationError, str]]:
+    """Binary (octet stream) request body
+
+    Args:
+        binary_body (File): A file to upload
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[HTTPValidationError, str]]
+    """
+
+    kwargs = _get_kwargs(
+        binary_body=binary_body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    binary_body: File,
+) -> Optional[Union[HTTPValidationError, str]]:
+    """Binary (octet stream) request body
+
+    Args:
+        binary_body (File): A file to upload
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[HTTPValidationError, str]
+    """
+
+    return sync_detailed(
+        client=client,
+        binary_body=binary_body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    binary_body: File,
+) -> Response[Union[HTTPValidationError, str]]:
+    """Binary (octet stream) request body
+
+    Args:
+        binary_body (File): A file to upload
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[HTTPValidationError, str]]
+    """
+
+    kwargs = _get_kwargs(
+        binary_body=binary_body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    binary_body: File,
+) -> Optional[Union[HTTPValidationError, str]]:
+    """Binary (octet stream) request body
+
+    Args:
+        binary_body (File): A file to upload
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[HTTPValidationError, str]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            binary_body=binary_body,
+        )
+    ).parsed
diff --git a/end_to_end_tests/openapi.json b/end_to_end_tests/openapi.json
@@ -625,6 +625,46 @@
             }
           }
         }
+      },
+      "post": {
+        "tags": [
+          "tests"
+        ],
+        "summary": "Binary (octet stream) request body",
+        "operationId": "octet_stream_tests_octet_stream_post",
+        "requestBody": {
+          "content": {
+            "application/octet-stream": {
+              "schema": {
+                "description": "A file to upload",
+                "type": "string",
+                "format": "binary"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
       }
     },
     "/tests/no_response": {
diff --git a/openapi_python_client/parser/openapi.py b/openapi_python_client/parser/openapi.py
@@ -134,6 +134,7 @@ class Endpoint:
     form_body: Optional[Property] = None
     json_body: Optional[Property] = None
     multipart_body: Optional[Property] = None
+    binary_body: Optional[Property] = None
     errors: List[ParseError] = field(default_factory=list)
     used_python_identifiers: Set[PythonIdentifier] = field(default_factory=set)
 
@@ -204,6 +205,30 @@ def parse_request_json_body(
             )
         return None, schemas
 
+    @staticmethod
+    def parse_request_binary_body(
+        *, body: oai.RequestBody, schemas: Schemas, parent_name: str, config: Config
+    ) -> Tuple[Union[Property, PropertyError, None], Schemas]:
+        """Return binary_body"""
+        binary_body = None
+        for content_type, schema in body.content.items():
+            content_type = get_content_type(content_type)  # noqa: PLW2901
+
+            if content_type == "application/octet-stream":
+                binary_body = schema
+                break
+
+        if binary_body is not None and binary_body.media_type_schema is not None:
+            return property_from_data(
+                name="binary_body",
+                required=True,
+                data=binary_body.media_type_schema,
+                schemas=schemas,
+                parent_name=parent_name,
+                config=config,
+            )
+        return None, schemas
+
     @staticmethod
     def _add_body(
         *,
@@ -220,6 +245,7 @@ def _add_body(
         request_body_parsers: list[tuple[str, RequestBodyParser]] = [
             ("form_body", Endpoint.parse_request_form_body),
             ("json_body", Endpoint.parse_request_json_body),
+            ("binary_body", Endpoint.parse_request_binary_body),
             ("multipart_body", Endpoint.parse_multipart_body),
         ]
 
@@ -517,6 +543,8 @@ def iter_all_parameters(self) -> Iterator[Property]:
             yield self.multipart_body
         if self.json_body:
             yield self.json_body
+        if self.binary_body:
+            yield self.binary_body
 
     def list_all_parameters(self) -> List[Property]:
         """Return a List of all the parameters of this endpoint"""
diff --git a/openapi_python_client/templates/endpoint_macros.py.jinja b/openapi_python_client/templates/endpoint_macros.py.jinja
@@ -2,8 +2,9 @@
 {% from "helpers.jinja" import safe_docstring %}
 
 {% macro header_params(endpoint) %}
-{% if endpoint.header_parameters %}
+{% if endpoint.header_parameters or endpoint.binary_body %}
 headers = {}
+{% if endpoint.header_parameters %}
     {% for parameter in endpoint.header_parameters.values() %}
         {% import "property_templates/" + parameter.template as param_template %}
         {% if param_template.transform_header %}
@@ -15,6 +16,10 @@ headers = {}
 {{ guarded_statement(parameter, parameter.python_name, statement) }}
     {% endfor %}
 {% endif %}
+{% if endpoint.binary_body %}
+headers['Content-Type'] = {{ endpoint.binary_body.python_name }}.mime_type if {{ endpoint.binary_body.python_name}}.mime_type else 'application/octet-stream'
+{% endif %}
+{% endif %}
 {% endmacro %}
 
 {% macro cookie_params(endpoint) %}
@@ -108,6 +113,9 @@ multipart_data: {{ endpoint.multipart_body.get_type_string() }},
 {% if endpoint.json_body %}
 json_body: {{ endpoint.json_body.get_type_string() }},
 {% endif %}
+{% if endpoint.binary_body %}
+binary_body: {{ endpoint.binary_body.get_type_string() }},
+{% endif %}
 {# query parameters #}
 {% for parameter in endpoint.query_parameters.values() %}
 {{ parameter.to_string() }},
@@ -138,6 +146,9 @@ multipart_data=multipart_data,
 {% if endpoint.json_body %}
 json_body=json_body,
 {% endif %}
+{% if endpoint.binary_body %}
+binary_body=binary_body,
+{% endif %}
 {% for parameter in endpoint.query_parameters.values() %}
 {{ parameter.python_name }}={{ parameter.python_name }},
 {% endfor %}
diff --git a/openapi_python_client/templates/endpoint_module.py.jinja b/openapi_python_client/templates/endpoint_module.py.jinja
@@ -47,11 +47,13 @@ def _get_kwargs(
         "files": {{ "multipart_" + endpoint.multipart_body.python_name }},
     {% elif endpoint.json_body %}
         "json": {{ "json_" + endpoint.json_body.python_name }},
+    {% elif endpoint.binary_body %}
+        "content": {{ endpoint.binary_body.python_name }},
     {% endif %}
     {% if endpoint.query_parameters %}
         "params": params,
     {% endif %}
-    {% if endpoint.header_parameters %}
+    {% if endpoint.header_parameters or endpoint.binary_body %}
         "headers": headers,
     {% endif %}
     {% if endpoint.cookie_parameters %}
diff --git a/tests/test_parser/test_openapi.py b/tests/test_parser/test_openapi.py
