content_type_overrides (#1010)

Implemented content_type_overrides from #657 #810

---------

Co-authored-by: Dylan Anthony <[email protected]>
Co-authored-by: Dylan Anthony <[email protected]>

Author: gaarutyunov

.changeset/add_config_option_to_override_content_types.md

@@ -0,0 +1,16 @@
+---
+default: minor
+---
+
+# Add config option to override content types
+
+You can now define a `content_type_overrides` field in your `config.yml`:
+
+```yaml
+content_type_overrides:
+  application/zip: application/octet-stream
+```
+
+This allows `openapi-python-client` to generate code for content types it doesn't recognize.
+
+PR #1010 closes #810. Thanks @gaarutyunov!

README.md

@@ -156,6 +156,16 @@ If this option results in conflicts, you will need to manually override class na
 
 By default, the timeout for retrieving the schema file via HTTP is 5 seconds. In case there is an error when retrieving the schema, you might try and increase this setting to a higher value.
 
+### content_type_overrides
+
+Normally, `openapi-python-client` will skip any bodies or responses that it doesn't recognize the content type for.
+This config tells the generator to treat a given content type like another.
+
+```yaml
+content_type_overrides:
+  application/zip: application/octet-stream
+```
+
 [changelog.md]: CHANGELOG.md
 [poetry]: https://python-poetry.org/
 [PDM]: https://pdm-project.org/latest/

end_to_end_tests/baseline_openapi_3.0.json

@@ -1578,6 +1578,36 @@
           }
         }
       }
+    },
+    "/config/content-type-override": {
+      "post": {
+        "tags": [
+          "config"
+        ],
+        "summary": "Content Type Override",
+        "operationId": "content_type_override",
+        "requestBody": {
+          "content": {
+            "openapi/python/client": {
+              "schema": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "openapi/python/client": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {

end_to_end_tests/baseline_openapi_3.1.yaml

@@ -1572,6 +1572,36 @@ info:
         }
       }
     }
+  },
+  "/config/content-type-override": {
+    "post": {
+      "tags": [
+        "config"
+      ],
+      "summary": "Content Type Override",
+      "operationId": "content_type_override",
+      "requestBody": {
+        "content": {
+          "openapi/python/client": {
+            "schema": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "Successful Response",
+          "content": {
+            "openapi/python/client": {
+              "schema": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    }
   }
 }
 "components": {

end_to_end_tests/config.yml

@@ -9,3 +9,5 @@ class_overrides:
     class_name: AnEnumValue
     module_name: an_enum_value
 field_prefix: attr_
+content_type_overrides:
+   openapi/python/client: application/json

end_to_end_tests/custom-templates-golden-record/my_test_api_client/api/__init__.py

@@ -3,6 +3,7 @@
 from typing import Type
 
 from .bodies import BodiesEndpoints
+from .config import ConfigEndpoints
 from .default import DefaultEndpoints
 from .defaults import DefaultsEndpoints
 from .enums import EnumsEndpoints
@@ -64,3 +65,7 @@ def naming(cls) -> Type[NamingEndpoints]:
     @classmethod
     def parameter_references(cls) -> Type[ParameterReferencesEndpoints]:
         return ParameterReferencesEndpoints
+
+    @classmethod
+    def config(cls) -> Type[ConfigEndpoints]:
+        return ConfigEndpoints

end_to_end_tests/custom-templates-golden-record/my_test_api_client/api/config/__init__.py

@@ -0,0 +1,14 @@
+"""Contains methods for accessing the API Endpoints"""
+
+import types
+
+from . import content_type_override
+
+
+class ConfigEndpoints:
+    @classmethod
+    def content_type_override(cls) -> types.ModuleType:
+        """
+        Content Type Override
+        """
+        return content_type_override

end_to_end_tests/golden-record/my_test_api_client/api/config/__init__.py

@@ -0,0 +1,153 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: str,
+) -> Dict[str, Any]:
+    headers: Dict[str, Any] = {}
+
+    _kwargs: Dict[str, Any] = {
+        "method": "post",
+        "url": "/config/content-type-override",
+    }
+
+    _body = body
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "openapi/python/client"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[str]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = cast(str, response.json())
+        return response_200
+    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[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],
+    body: str,
+) -> Response[str]:
+    """Content Type Override
+
+    Args:
+        body (str):
+
+    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[str]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: str,
+) -> Optional[str]:
+    """Content Type Override
+
+    Args:
+        body (str):
+
+    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:
+        str
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: str,
+) -> Response[str]:
+    """Content Type Override
+
+    Args:
+        body (str):
+
+    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[str]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: str,
+) -> Optional[str]:
+    """Content Type Override
+
+    Args:
+        body (str):
+
+    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:
+        str
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

end_to_end_tests/golden-record/my_test_api_client/api/config/content_type_override.py

@@ -35,6 +35,7 @@ class ConfigFile(BaseModel):
     """
 
     class_overrides: Optional[Dict[str, ClassOverride]] = None
+    content_type_overrides: Optional[Dict[str, str]] = None
     project_name_override: Optional[str] = None
     package_name_override: Optional[str] = None
     package_version_override: Optional[str] = None
@@ -70,6 +71,7 @@ class Config:
     http_timeout: int
     document_source: Union[Path, str]
     file_encoding: str
+    content_type_overrides: Dict[str, str]
 
     @staticmethod
     def from_sources(
@@ -91,6 +93,7 @@ def from_sources(
         config = Config(
             meta_type=meta_type,
             class_overrides=config_file.class_overrides or {},
+            content_type_overrides=config_file.content_type_overrides or {},
             project_name_override=config_file.project_name_override,
             package_name_override=config_file.package_name_override,
             package_version_override=config_file.package_version_override,

openapi_python_client/config.py

@@ -56,7 +56,7 @@ def body_from_data(
     prefix_type_names = len(body_content) > 1
 
     for content_type, media_type in body_content.items():
-        simplified_content_type = get_content_type(content_type)
+        simplified_content_type = get_content_type(content_type, config)
         if simplified_content_type is None:
             bodies.append(
                 ParseError(

openapi_python_client/parser/bodies.py

@@ -37,8 +37,8 @@ class Response:
     data: Union[oai.Response, oai.Reference]  # Original data which created this response, useful for custom templates
 
 
-def _source_by_content_type(content_type: str) -> Optional[_ResponseSource]:
-    parsed_content_type = utils.get_content_type(content_type)
+def _source_by_content_type(content_type: str, config: Config) -> Optional[_ResponseSource]:
+    parsed_content_type = utils.get_content_type(content_type, config)
     if parsed_content_type is None:
         return None
 
@@ -114,7 +114,7 @@ def response_from_data(
         )
 
     for content_type, media_type in content.items():
-        source = _source_by_content_type(content_type)
+        source = _source_by_content_type(content_type, config)
         if source is not None:
             schema_data = media_type.media_type_schema
             break

openapi_python_client/parser/responses.py

@@ -6,6 +6,8 @@
 from keyword import iskeyword
 from typing import Any
 
+from .config import Config
+
 DELIMITERS = r"\. _-"
 
 
@@ -105,10 +107,11 @@ def remove_string_escapes(value: str) -> str:
     return value.replace('"', r"\"")
 
 
-def get_content_type(content_type: str) -> str | None:
+def get_content_type(content_type: str, config: Config) -> str | None:
     """
     Given a string representing a content type with optional parameters, returns the content type only
     """
+    content_type = config.content_type_overrides.get(content_type, content_type)
     message = Message()
     message.add_header("Content-Type", content_type)