Shortens operation + response files, improves request body serialize typing (#195)

* Generates separate file for pathparameters

* Adds x_parameters files

* Fixes typo

* Passes body_info into _get_fields_and_body

* Adds RequestBodyInfo ref linking

* Fixes body types in BodyInfoForX

* Fixes one python test

* Fixes one test

* Fixes another test

* Fixes test_body_with_query_params

* Fixes test_composed_one_of_different_types

* Fixes test_inline_composition

* Fixes test_json_patch

* Fixes test_json_with_charset

* Fixes test_mammal, test_missing_or_unset_required_body

* Fixes two tests

* Fixes two tests

* Fixes two tests

* Fixes two tests

* Fixes last python test

* Allows body_info to be None

* Adds request_body imports for endpoint code sample

* Adds body_info to endpoint docs

* Stops generating requestbodyinfo schemas for refed schemas

* Dereferences request body schemas

* Improves refModuleAlias values, prevents collisions based on usages

* Samples regenerated

* Samples actually regenerated

* Fixes test for the nonCOmpliantDiscriminator sample

* Fixes unit tests

* Runs ensure up to date

* Adds content type back in

* Adds content type overload condition branch

* Adds per content type operation overloads

* Removes unused getContentTypeToOperation, adds requestBodySchema

* Adds and sets requestBodySchema in CodegenOperation

* Uses a linkedhashmap to store properties before making requestBodySchema

* Uses requestBodySchema.properties to define type hints for operation fn implementation signature

* Adds request body schema imports at the top of the operation file

* Adds body type hints for operation

* Switches code back to using body + content_type

* FIxes two tests

* Runs black on file, fixes three tests

* Fixes 3 tests

* Fixes 3 more tests

* Updates operation variable names

* Fixes body schema input type to use refModuleAlias, samples regen

* FIxes unitt est specs

* Updates templates to remove RequestBodyInfo

* Samples regenerated

* Updates operation to directly import query cookie header path param schema classes

* Sets skip_validation to True in _get_used_path

* FIxes mypy type errors, improves request body typing

* Samples regen

* Fixes typo

* Removes unused doc import

Author: spacether

samples/client/3_0_3_unit_test/python/src/unit_test_api/api_client.py

@@ -385,6 +385,16 @@ def _serialize_json(
     schemas.immutabledict
 ]
 
+_JSON_TYPES = typing.Union[
+    int,
+    float,
+    str,
+    None,
+    bool,
+    typing.Tuple['_JSON_TYPES'],
+    schemas.immutabledict[str, '_JSON_TYPES'],
+]
+
 @dataclasses.dataclass
 class PathParameter(ParameterBase, StyleSimpleSerializer):
     name: str
@@ -1206,24 +1216,26 @@ def _get_headers(
     @staticmethod
     def _get_fields_and_body(
         request_body: typing.Type[RequestBody],
-        body: typing.Any,
-        headers: _collections.HTTPHeaderDict,
-        content_type: str
+        body: typing.Union[schemas.INPUT_TYPES_ALL, schemas.Unset],
+        content_type: str,
+        headers: _collections.HTTPHeaderDict
     ):
         if request_body.required and body is schemas.unset:
             raise exceptions.ApiValueError(
                 'The required body parameter has an invalid value of: unset. Set a valid value instead')
-        _fields = None
-        _body = None
-
-        if request_body.required or ((not request_body.required) and body is not schemas.unset):
-            serialized_data = request_body.serialize(body, content_type)
-            headers.add('Content-Type', content_type)
-            if 'fields' in serialized_data:
-                _fields = serialized_data['fields']
-            elif 'body' in serialized_data:
-                _body = serialized_data['body']
-        return _fields, _body
+
+        if isinstance(body, schemas.Unset):
+            return None, None
+
+        serialized_fields = None
+        serialized_body = None
+        serialized_data = request_body.serialize(body, content_type)
+        headers.add('Content-Type', content_type)
+        if 'fields' in serialized_data:
+            serialized_fields = serialized_data['fields']
+        elif 'body' in serialized_data:
+            serialized_body = serialized_data['body']
+        return serialized_fields, serialized_body
 
     @staticmethod
     def _verify_response_status(response: api_response.ApiResponse):
@@ -1252,7 +1264,7 @@ class RequestBody(StyleFormSerializer, JSONDetector):
     @classmethod
     def __serialize_json(
         cls,
-        in_data: typing.Any
+        in_data: _JSON_TYPES
     ) -> SerializedRequestBody:
         in_data = cls.__json_encoder.default(in_data)
         json_str = json.dumps(in_data, separators=(",", ":"), ensure_ascii=False).encode(
@@ -1261,26 +1273,18 @@ def __serialize_json(
         return {'body': json_str}
 
     @staticmethod
-    def __serialize_text_plain(in_data: typing.Any) -> SerializedRequestBody:
-        if in_data is None:
-            raise ValueError('Unable to serialize type None to text/plain')
-        elif isinstance(in_data, schemas.immutabledict):
-            raise ValueError('Unable to serialize type schemas.immutabledict to text/plain')
-        elif isinstance(in_data, tuple):
-            raise ValueError('Unable to serialize type tuple to text/plain')
-        elif isinstance(in_data, bool):
-            raise ValueError('Unable to serialize type bool to text/plain')
+    def __serialize_text_plain(in_data: typing.Union[int, float, str]) -> SerializedRequestBody:
         return {'body': str(in_data)}
 
     @classmethod
-    def __multipart_json_item(cls, key: str, value: schemas.Schema) -> rest.RequestField:
+    def __multipart_json_item(cls, key: str, value: _JSON_TYPES) -> rest.RequestField:
         json_value = cls.__json_encoder.default(value)
         request_field = rest.RequestField(name=key, data=json.dumps(json_value))
         request_field.make_multipart(content_type='application/json')
         return request_field
 
     @classmethod
-    def __multipart_form_item(cls, key: str, value: schemas.Schema) -> rest.RequestField:
+    def __multipart_form_item(cls, key: str, value: typing.Union[_JSON_TYPES, bytes, schemas.FileIO]) -> rest.RequestField:
         if isinstance(value, str):
             request_field = rest.RequestField(name=key, data=str(value))
             request_field.make_multipart(content_type='text/plain')
@@ -1289,19 +1293,17 @@ def __multipart_form_item(cls, key: str, value: schemas.Schema) -> rest.RequestF
             request_field.make_multipart(content_type='application/octet-stream')
         elif isinstance(value, schemas.FileIO):
             # TODO use content.encoding to limit allowed content types if they are present
-            request_field = rest.RequestField.from_tuples(key, (os.path.basename(str(value.name)), value.read()))
-            request_field = typing.cast(rest.RequestField, request_field)
+            urllib3_request_field = rest.RequestField.from_tuples(key, (os.path.basename(str(value.name)), value.read()))
+            request_field = typing.cast(rest.RequestField, urllib3_request_field)
             value.close()
         else:
             request_field = cls.__multipart_json_item(key=key, value=value)
         return request_field
 
     @classmethod
     def __serialize_multipart_form_data(
-        cls, in_data: schemas.Schema
+        cls, in_data: schemas.immutabledict[str, typing.Union[_JSON_TYPES, bytes, schemas.FileIO]]
     ) -> SerializedRequestBody:
-        if not isinstance(in_data, schemas.immutabledict):
-            raise ValueError(f'Unable to serialize {in_data} to multipart/form-data because it is not a dict of data')
         """
         In a multipart/form-data request body, each schema property, or each element of a schema array property,
         takes a section in the payload with an internal header as defined by RFC7578. The serialization strategy
@@ -1344,21 +1346,18 @@ def __serialize_application_octet_stream(in_data: typing.Union[schemas.FileIO, b
 
     @classmethod
     def __serialize_application_x_www_form_data(
-        cls, in_data: typing.Any
+        cls, in_data: schemas.immutabledict[str, _JSON_TYPES]
     ) -> SerializedRequestBody:
         """
         POST submission of form data in body
         """
-        if not isinstance(in_data, schemas.immutabledict):
-            raise ValueError(
-                f'Unable to serialize {in_data} to application/x-www-form-urlencoded because it is not a dict of data')
         cast_in_data = cls.__json_encoder.default(in_data)
         value = cls._serialize_form(cast_in_data, name='', explode=True, percent_encode=True)
         return {'body': value}
 
     @classmethod
     def serialize(
-        cls, in_data: typing.Any, content_type: str
+        cls, in_data: schemas.INPUT_TYPES_ALL, content_type: str
     ) -> SerializedRequestBody:
         """
         If a str is returned then the result will be assigned to data when making the request
@@ -1376,15 +1375,24 @@ def serialize(
         # TODO check for and use encoding if it exists
         # and content_type is multipart or application/x-www-form-urlencoded
         if cls._content_type_is_json(content_type):
+            if isinstance(cast_in_data, (schemas.FileIO, bytes)):
+                raise ValueError(f"Invalid input data type. Data must be int/float/str/bool/None/tuple/immutabledict and it was type {type(cast_in_data)}")
             return cls.__serialize_json(cast_in_data)
         elif content_type == 'text/plain':
+            if not isinstance(cast_in_data, (int, float, str)):
+                raise ValueError(f"Unable to serialize type {type(cast_in_data)} to text/plain")
             return cls.__serialize_text_plain(cast_in_data)
         elif content_type == 'multipart/form-data':
+            if not isinstance(cast_in_data, schemas.immutabledict):
+                raise ValueError(f"Unable to serialize {cast_in_data} to multipart/form-data because it is not a dict of data")
             return cls.__serialize_multipart_form_data(cast_in_data)
         elif content_type == 'application/x-www-form-urlencoded':
+            if not isinstance(cast_in_data, schemas.immutabledict):
+                raise ValueError(
+                    f"Unable to serialize {cast_in_data} to application/x-www-form-urlencoded because it is not a dict of data")
             return cls.__serialize_application_x_www_form_data(cast_in_data)
         elif content_type == 'application/octet-stream':
             if not isinstance(cast_in_data, (schemas.FileIO, bytes)):
-                raise ValueError(f'Invalid input data type. Data must be bytes or File for content_type={content_type}')
+                raise ValueError(f"Invalid input data type. Data must be bytes or File for content_type={content_type}")
             return cls.__serialize_application_octet_stream(cast_in_data)
         raise NotImplementedError('Serialization has not yet been implemented for {}'.format(content_type))

samples/client/3_0_3_unit_test/python/src/unit_test_api/paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post/operation.py

@@ -4,16 +4,13 @@
     Generated by: https://github.com/openapi-json-schema-tools/openapi-json-schema-generator
 """
 
-from __future__ import annotations
-from unit_test_api.shared_imports.schema_imports import *  # pyright: ignore [reportWildcardImportFromLibrary]
 from unit_test_api import api_client
 from unit_test_api.shared_imports.operation_imports import *  # pyright: ignore [reportWildcardImportFromLibrary]
+from unit_test_api.components.schema import additionalproperties_allows_a_schema_which_should_validate
 
 from .. import path
 from .responses import response_200
 from . import request_body
-from unit_test_api.components.schema import additionalproperties_allows_a_schema_which_should_validate as request_body_application_json_schema
-
 
 
 __StatusCodeToResponse = typing_extensions.TypedDict(
@@ -35,8 +32,8 @@ class BaseApi(api_client.Api):
     def _post_additionalproperties_allows_a_schema_which_should_validate_request_body(
         self,
         body: typing.Union[
-            request_body_application_json_schema.AdditionalpropertiesAllowsASchemaWhichShouldValidateDictInput,
-            request_body_application_json_schema.AdditionalpropertiesAllowsASchemaWhichShouldValidateDict,
+            additionalproperties_allows_a_schema_which_should_validate.AdditionalpropertiesAllowsASchemaWhichShouldValidateDictInput,
+            additionalproperties_allows_a_schema_which_should_validate.AdditionalpropertiesAllowsASchemaWhichShouldValidateDict,
         ],
         *,
         skip_deserialization: typing_extensions.Literal[False] = False,
@@ -50,8 +47,8 @@ def _post_additionalproperties_allows_a_schema_which_should_validate_request_bod
     def _post_additionalproperties_allows_a_schema_which_should_validate_request_body(
         self,
         body: typing.Union[
-            request_body_application_json_schema.AdditionalpropertiesAllowsASchemaWhichShouldValidateDictInput,
-            request_body_application_json_schema.AdditionalpropertiesAllowsASchemaWhichShouldValidateDict,
+            additionalproperties_allows_a_schema_which_should_validate.AdditionalpropertiesAllowsASchemaWhichShouldValidateDictInput,
+            additionalproperties_allows_a_schema_which_should_validate.AdditionalpropertiesAllowsASchemaWhichShouldValidateDict,
         ],
         *,
         skip_deserialization: typing_extensions.Literal[True],
@@ -64,8 +61,8 @@ def _post_additionalproperties_allows_a_schema_which_should_validate_request_bod
     def _post_additionalproperties_allows_a_schema_which_should_validate_request_body(
         self,
         body: typing.Union[
-            request_body_application_json_schema.AdditionalpropertiesAllowsASchemaWhichShouldValidateDictInput,
-            request_body_application_json_schema.AdditionalpropertiesAllowsASchemaWhichShouldValidateDict,
+            additionalproperties_allows_a_schema_which_should_validate.AdditionalpropertiesAllowsASchemaWhichShouldValidateDictInput,
+            additionalproperties_allows_a_schema_which_should_validate.AdditionalpropertiesAllowsASchemaWhichShouldValidateDict,
         ],
         *,
         skip_deserialization: bool = False,
@@ -80,14 +77,14 @@ def _post_additionalproperties_allows_a_schema_which_should_validate_request_bod
             class instances
         """
         used_path = path
-        _headers = self._get_headers()
+        headers = self._get_headers()
         # TODO add cookie handling
 
-        _fields, _body = self._get_fields_and_body(
+        fields, serialized_body = self._get_fields_and_body(
             request_body=request_body.RequestBody,
             body=body,
-            headers=_headers,
-            content_type=content_type
+            content_type=content_type,
+            headers=headers
         )
         host = self.api_client.configuration.get_server_url(
             "servers", server_index
@@ -97,9 +94,9 @@ class instances
             resource_path=used_path,
             method='post',
             host=host,
-            headers=_headers,
-            fields=_fields,
-            body=_body,
+            headers=headers,
+            fields=fields,
+            body=serialized_body,
             stream=stream,
             timeout=timeout,
         )

samples/client/3_0_3_unit_test/python/src/unit_test_api/paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post/request_body/__init__.py

@@ -8,6 +8,7 @@
 
 from .content.application_json import schema as application_json_schema
 
+
 class RequestBody(api_client.RequestBody):
 
 

samples/client/3_0_3_unit_test/python/src/unit_test_api/paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post/operation.py

@@ -4,16 +4,13 @@
     Generated by: https://github.com/openapi-json-schema-tools/openapi-json-schema-generator
 """
 
-from __future__ import annotations
-from unit_test_api.shared_imports.schema_imports import *  # pyright: ignore [reportWildcardImportFromLibrary]
 from unit_test_api import api_client
 from unit_test_api.shared_imports.operation_imports import *  # pyright: ignore [reportWildcardImportFromLibrary]
+from unit_test_api.components.schema import additionalproperties_are_allowed_by_default
 
 from .. import path
 from .responses import response_200
 from . import request_body
-from unit_test_api.components.schema import additionalproperties_are_allowed_by_default as request_body_application_json_schema
-
 
 
 __StatusCodeToResponse = typing_extensions.TypedDict(
@@ -80,14 +77,14 @@ def _post_additionalproperties_are_allowed_by_default_request_body(
             class instances
         """
         used_path = path
-        _headers = self._get_headers()
+        headers = self._get_headers()
         # TODO add cookie handling
 
-        _fields, _body = self._get_fields_and_body(
+        fields, serialized_body = self._get_fields_and_body(
             request_body=request_body.RequestBody,
             body=body,
-            headers=_headers,
-            content_type=content_type
+            content_type=content_type,
+            headers=headers
         )
         host = self.api_client.configuration.get_server_url(
             "servers", server_index
@@ -97,9 +94,9 @@ class instances
             resource_path=used_path,
             method='post',
             host=host,
-            headers=_headers,
-            fields=_fields,
-            body=_body,
+            headers=headers,
+            fields=fields,
+            body=serialized_body,
             stream=stream,
             timeout=timeout,
         )

samples/client/3_0_3_unit_test/python/src/unit_test_api/paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post/request_body/__init__.py

@@ -8,6 +8,7 @@
 
 from .content.application_json import schema as application_json_schema
 
+
 class RequestBody(api_client.RequestBody):