WIP support reference requestBodies

Author: supermihi

end_to_end_tests/test_end_to_end.py

@@ -1,8 +1,7 @@
-import os
 import shutil
 from filecmp import cmpfiles, dircmp
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import Dict, List
 
 import pytest
 from typer.testing import CliRunner

openapi_python_client/parser/openapi.py

@@ -20,10 +20,11 @@
     Property,
     Schemas,
     build_parameters,
+    build_request_bodies,
     build_schemas,
     property_from_data,
 )
-from .properties.schemas import parameter_from_reference
+from .properties.schemas import RequestBodies, parameter_from_reference
 from .responses import Response, response_from_data
 
 _PATH_PARAM_REGEX = re.compile("{([a-zA-Z_][a-zA-Z0-9_]*)}")
@@ -44,7 +45,12 @@ class EndpointCollection:
 
     @staticmethod
     def from_data(
-        *, data: Dict[str, oai.PathItem], schemas: Schemas, parameters: Parameters, config: Config
+        *,
+        data: Dict[str, oai.PathItem],
+        schemas: Schemas,
+        parameters: Parameters,
+        request_bodies: RequestBodies,
+        config: Config,
     ) -> Tuple[Dict[utils.PythonIdentifier, "EndpointCollection"], Schemas, Parameters]:
         """Parse the openapi paths data to get EndpointCollections by tag"""
         endpoints_by_tag: Dict[utils.PythonIdentifier, EndpointCollection] = {}
@@ -65,6 +71,7 @@ def from_data(
                     tag=tag,
                     schemas=schemas,
                     parameters=parameters,
+                    request_bodies=request_bodies,
                     config=config,
                 )
                 # Add `PathItem` parameters
@@ -191,15 +198,19 @@ def _add_body(
         endpoint: "Endpoint",
         data: oai.Operation,
         schemas: Schemas,
+        request_bodies: RequestBodies,
         config: Config,
     ) -> Tuple[Union[ParseError, "Endpoint"], Schemas]:
         """Adds form or JSON body to Endpoint if included in data"""
         endpoint = deepcopy(endpoint)
-        if data.requestBody is None or isinstance(data.requestBody, oai.Reference):
+        if data.requestBody is None:
             return endpoint, schemas
-
+        if isinstance(data.requestBody, oai.Reference):
+            request_body = request_bodies.bodies_by_reference[data.requestBody.ref]
+        else:
+            request_body = data.requestBody
         form_body, schemas = Endpoint.parse_request_form_body(
-            body=data.requestBody, schemas=schemas, parent_name=endpoint.name, config=config
+            body=request_body, schemas=schemas, parent_name=endpoint.name, config=config
         )
 
         if isinstance(form_body, ParseError):
@@ -213,7 +224,7 @@ def _add_body(
             )
 
         json_body, schemas = Endpoint.parse_request_json_body(
-            body=data.requestBody, schemas=schemas, parent_name=endpoint.name, config=config
+            body=request_body, schemas=schemas, parent_name=endpoint.name, config=config
         )
         if isinstance(json_body, ParseError):
             return (
@@ -226,7 +237,7 @@ def _add_body(
             )
 
         multipart_body, schemas = Endpoint.parse_multipart_body(
-            body=data.requestBody, schemas=schemas, parent_name=endpoint.name, config=config
+            body=request_body, schemas=schemas, parent_name=endpoint.name, config=config
         )
         if isinstance(multipart_body, ParseError):
             return (
@@ -465,6 +476,7 @@ def from_data(
         tag: str,
         schemas: Schemas,
         parameters: Parameters,
+        request_bodies: RequestBodies,
         config: Config,
     ) -> Tuple[Union["Endpoint", ParseError], Schemas, Parameters]:
         """Construct an endpoint from the OpenAPI data"""
@@ -490,7 +502,9 @@ def from_data(
         if isinstance(result, ParseError):
             return result, schemas, parameters
         result, schemas = Endpoint._add_responses(endpoint=result, data=data.responses, schemas=schemas, config=config)
-        result, schemas = Endpoint._add_body(endpoint=result, data=data, schemas=schemas, config=config)
+        result, schemas = Endpoint._add_body(
+            endpoint=result, data=data, schemas=schemas, request_bodies=request_bodies, config=config
+        )
 
         return result, schemas, parameters
 
@@ -549,8 +563,10 @@ def from_dict(data: Dict[str, Any], *, config: Config) -> Union["GeneratorData",
             schemas = build_schemas(components=openapi.components.schemas, schemas=schemas, config=config)
         if openapi.components and openapi.components.parameters:
             parameters = build_parameters(components=openapi.components.parameters, parameters=parameters)
+        if openapi.components and openapi.components.requestBodies:
+            request_bodies = build_request_bodies(components=openapi.components.requestBodies)
         endpoint_collections_by_tag, schemas, parameters = EndpointCollection.from_data(
-            data=openapi.paths, schemas=schemas, parameters=parameters, config=config
+            data=openapi.paths, schemas=schemas, parameters=parameters, request_bodies=request_bodies, config=config
         )
 
         enums = (prop for prop in schemas.classes_by_name.values() if isinstance(prop, EnumProperty))

openapi_python_client/parser/properties/__init__.py

@@ -19,6 +19,7 @@
 from ... import Config
 from ... import schema as oai
 from ... import utils
+from ...schema import Reference, RequestBody
 from ..errors import ParameterError, ParseError, PropertyError, ValidationError
 from .converter import convert, convert_chain
 from .enum_property import EnumProperty
@@ -27,6 +28,7 @@
 from .schemas import (
     Class,
     Parameters,
+    RequestBodies,
     Schemas,
     parse_reference_path,
     update_parameters_with_data,
@@ -776,3 +778,15 @@ def build_parameters(
 
     parameters.errors.extend(errors)
     return parameters
+
+
+def build_request_bodies(components: Dict[str, Union[RequestBody, Reference]]):
+
+    direct_entries = {
+        f"#/components/requestBodies/{name}": body for name, body in components.items() if isinstance(body, RequestBody)
+    }
+    result = RequestBodies(bodies_by_reference=direct_entries)
+    ref_entries: Dict[str, Reference] = {name: body for name, body in components.items() if isinstance(body, Reference)}
+    for name, ref in ref_entries.items():
+        result.errors.append(ParseError(detail=f"Unimplemented support for reference request body: {name}"))
+    return result

openapi_python_client/parser/properties/schemas.py

@@ -16,6 +16,7 @@
 
 from ... import Config
 from ... import schema as oai
+from ...schema import RequestBody
 from ...schema.openapi_schema_pydantic import Parameter
 from ...utils import ClassName, PythonIdentifier
 from ..errors import ParameterError, ParseError, PropertyError
@@ -126,6 +127,14 @@ class Parameters:
     errors: List[ParseError] = attr.ib(factory=list)
 
 
+@attr.s(auto_attribs=True, frozen=True)
+class RequestBodies:
+    """Structure for containing all defined, shareable, and reusable request bodies"""
+
+    bodies_by_reference: Dict[str, RequestBody] = attr.ib(factory=dict)
+    errors: List[ParseError] = attr.ib(factory=list)
+
+
 def parameter_from_data(
     *,
     name: str,

tests/test___main__.py

@@ -2,6 +2,5 @@ def test_main(mocker):
     app = mocker.patch("openapi_python_client.cli.app")
 
     # noinspection PyUnresolvedReferences
-    from openapi_python_client import __main__
 
     app.assert_called_once()

tests/test_cli.py

@@ -4,7 +4,6 @@
 import pytest
 from typer.testing import CliRunner
 
-from openapi_python_client import Config
 from openapi_python_client.parser.errors import GeneratorError, ParseError
 
 runner = CliRunner()
@@ -149,7 +148,7 @@ def test_generate_encoding(self, _create_new_client):
     def test_generate_encoding_errors(self, _create_new_client):
         path = "cool/path"
         file_encoding = "error-file-encoding"
-        from openapi_python_client.cli import MetaType, app
+        from openapi_python_client.cli import app
 
         result = runner.invoke(app, ["generate", f"--path={path}", f"--file-encoding={file_encoding}"])
 
@@ -286,7 +285,7 @@ def test_update_encoding(self, _update_existing_client):
     def test_update_encoding_errors(self, _update_existing_client):
         path = "cool/path"
         file_encoding = "error-file-encoding"
-        from openapi_python_client.cli import MetaType, app
+        from openapi_python_client.cli import app
 
         result = runner.invoke(app, ["update", f"--path={path}", f"--file-encoding={file_encoding}"])
 

tests/test_parser/test_properties/test_init.py

@@ -338,7 +338,7 @@ def test_property_from_data_str_enum_with_null(self, enum_property_factory):
         }
 
     def test_property_from_data_null_enum(self, enum_property_factory, none_property_factory):
-        from openapi_python_client.parser.properties import Class, Schemas, property_from_data
+        from openapi_python_client.parser.properties import Schemas, property_from_data
         from openapi_python_client.schema import Schema
 
         data = Schema(title="AnEnumWithOnlyNull", enum=[None], nullable=False, default=None)
@@ -459,7 +459,7 @@ def test_property_from_data_ref_enum_with_invalid_default(self, enum_property_fa
         assert prop == PropertyError(data=data, detail="x is an invalid default for enum MyEnum")
 
     def test_property_from_data_ref_model(self, model_property_factory):
-        from openapi_python_client.parser.properties import Class, ModelProperty, Schemas, property_from_data
+        from openapi_python_client.parser.properties import Class, Schemas, property_from_data
 
         name = "new_name"
         required = False
@@ -646,7 +646,7 @@ def test_property_from_data_union(self, mocker):
         )
 
     def test_property_from_data_union_of_one_element(self, mocker, model_property_factory):
-        from openapi_python_client.parser.properties import Class, ModelProperty, Schemas, property_from_data
+        from openapi_python_client.parser.properties import Schemas, property_from_data
 
         name = "new_name"
         required = False

tests/test_parser/test_properties/test_schemas.py

@@ -57,7 +57,7 @@ def test_cannot_parse_parameters_by_reference(self):
     def test_parameters_without_schema_are_ignored(self):
         from openapi_python_client.parser.properties import Parameters
         from openapi_python_client.parser.properties.schemas import parameter_from_data
-        from openapi_python_client.schema import ParameterLocation, Schema
+        from openapi_python_client.schema import ParameterLocation
 
         param = Parameter(name="a_schemaless_param", param_in=ParameterLocation.QUERY)
         parameters = Parameters()

tests/test_parser/test_responses.py

@@ -2,7 +2,7 @@
 
 import openapi_python_client.schema as oai
 from openapi_python_client.parser.errors import ParseError, PropertyError
-from openapi_python_client.parser.properties import AnyProperty, Schemas, StringProperty
+from openapi_python_client.parser.properties import Schemas
 
 MODULE_NAME = "openapi_python_client.parser.responses"
 

tests/test_templates/test_property_templates/test_date_property/optional_nullable.py

@@ -1,5 +1,5 @@
 from datetime import date
-from typing import cast, Union
+from typing import Union
 
 from dateutil.parser import isoparse
 some_source = date(2020, 10, 12)