content_type_overrides

Author: gaarutyunov

openapi_python_client/config.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/parser/responses.py

@@ -37,8 +37,10 @@ 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(
+        config.content_type_overrides.get(content_type, content_type)
+    )
     if parsed_content_type is None:
         return None
 
@@ -114,7 +116,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

tests/test_parser/test_responses.py

@@ -63,12 +63,14 @@ def test_response_from_data_unsupported_content_type():
     from openapi_python_client.parser.responses import response_from_data
 
     data = oai.Response.model_construct(description="", content={"blah": None})
+    config = MagicMock()
+    config.content_type_overrides = {}
     response, schemas = response_from_data(
         status_code=200,
         data=data,
         schemas=Schemas(),
         parent_name="parent",
-        config=MagicMock(),
+        config=config,
     )
 
     assert response == ParseError(data=data, detail="Unsupported content_type {'blah': None}")
@@ -81,12 +83,14 @@ def test_response_from_data_no_content_schema(any_property_factory):
         description="",
         content={"application/vnd.api+json; version=2.2": oai.MediaType.model_construct()},
     )
+    config = MagicMock()
+    config.content_type_overrides = {}
     response, schemas = response_from_data(
         status_code=200,
         data=data,
         schemas=Schemas(),
         parent_name="parent",
-        config=MagicMock(),
+        config=config,
     )
 
     assert response == Response(
@@ -111,6 +115,7 @@ def test_response_from_data_property_error(mocker):
         content={"application/json": oai.MediaType.model_construct(media_type_schema="something")},
     )
     config = MagicMock()
+    config.content_type_overrides = {}
 
     response, schemas = responses.response_from_data(
         status_code=400,
@@ -141,6 +146,7 @@ def test_response_from_data_property(mocker, any_property_factory):
         content={"application/json": oai.MediaType.model_construct(media_type_schema="something")},
     )
     config = MagicMock()
+    config.content_type_overrides = {}
 
     response, schemas = responses.response_from_data(
         status_code=400,
@@ -164,3 +170,35 @@ def test_response_from_data_property(mocker, any_property_factory):
         parent_name="parent",
         config=config,
     )
+
+
+def test_response_from_data_content_type_overrides(any_property_factory):
+    from openapi_python_client.parser.responses import Response, response_from_data
+
+    data = oai.Response.model_construct(
+        description="",
+        content={"application/zip": oai.MediaType.model_construct()},
+    )
+    config = MagicMock()
+    config.content_type_overrides = {
+        "application/zip": "application/octet-stream"
+    }
+    response, schemas = response_from_data(
+        status_code=200,
+        data=data,
+        schemas=Schemas(),
+        parent_name="parent",
+        config=config,
+    )
+
+    assert response == Response(
+        status_code=200,
+        prop=any_property_factory(
+            name="response_200",
+            default=None,
+            required=True,
+            description=data.description,
+        ),
+        source=NONE_SOURCE,
+        data=data,
+    )