Support inline object schemas (#236)

* Major refactor of models/enums/schemas.

* Switch properties to use attr.s instead of dataclass

* Fix forward references and properly allow Unset for ModelPropertys

* Refactor response handling to use the same schema generation as input properties.

* Added improved naming scheme of models/enums using parent elements

Co-authored-by: Ethan Mann <emann@triaxtec.com>

Author: dbanty

.gitignore

@@ -26,4 +26,5 @@ test-reports/
 htmlcov/
 
 # Generated end to end test data
-my-test-api-client
+my-test-api-client/
+custom-e2e/

CHANGELOG.md

@@ -11,11 +11,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Any request/response field that is not `required` and wasn't specified is now set to `UNSET` instead of `None`. 
 - Values that are `UNSET` will not be sent along in API calls
+- Schemas defined with `type=object` will now be converted into classes, just like if they were created as ref components. 
+    The previous behavior was a combination of skipping and using generic Dicts for these schemas.
+- Response schema handling was unified with input schema handling, meaning that responses will behave differently than before. 
+    Specifically, instead of the content-type deciding what the generated Python type is, the schema itself will.
+    - As a result of this, endpoints that used to return `bytes` when content-type was application/octet-stream will now return a `File` object if the type of the data is "binary", just like if you were submitting that type instead of receiving it.
+- Instead of skipping input properties with no type, enum, anyOf, or oneOf declared, the property will be declared as `None`.
+- Class (models and Enums) names will now contain the name of their parent element (if any). For example, a property 
+    declared in an endpoint will be named like {endpoint_name}_{previous_class_name}. Classes will no longer be
+    deduplicated by appending a number to the end of the generated name, so if two names conflict with this new naming 
+    scheme, there will be an error instead.
 
 ### Additions
 
 - Added a `--custom-template-path` option for providing custom jinja2 templates (#231 - Thanks @erichulburd!).
 - Better compatibility for "required" (whether or not the field must be included) and "nullable" (whether or not the field can be null) (#205 & #208). Thanks @bowenwr & @emannguitar!
+- Support for all the same schemas in responses as are supported in parameters.
 
 ## 0.6.2 - 2020-11-03
 

end_to_end_tests/custom_config.yml

@@ -0,0 +1,13 @@
+project_name_override: "custom-e2e"
+package_name_override: "custom_e2e"
+class_overrides:
+  _ABCResponse:
+    class_name: ABCResponse
+    module_name: abc_response
+  AnEnumValueItem:
+    class_name: AnEnumValue
+    module_name: an_enum_value
+  NestedListOfEnumsItemItem:
+    class_name: AnEnumValue
+    module_name: an_enum_value
+field_prefix: attr_

end_to_end_tests/golden-record-custom/README.md

@@ -1,37 +1,37 @@
-# my-test-api-client
+# custom-e2e
 A client library for accessing My Test API
 
 ## Usage
 First, create a client:
 
 ```python
-from my_test_api_client import Client
+from custom_e2e import Client
 
 client = Client(base_url="https://api.example.com")
 ```
 
 If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
 
 ```python
-from my_test_api_client import AuthenticatedClient
+from custom_e2e import AuthenticatedClient
 
 client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
 ```
 
 Now call your endpoint and use your models:
 
 ```python
-from my_test_api_client.models import MyDataModel
-from my_test_api_client.api.my_tag import get_my_data_model
+from custom_e2e.models import MyDataModel
+from custom_e2e.api.my_tag import get_my_data_model
 
 my_data: MyDataModel = get_my_data_model(client=client)
 ```
 
 Or do the same thing with an async version:
 
 ```python
-from my_test_api_client.models import MyDataModel
-from my_test_api_client.async_api.my_tag import get_my_data_model
+from custom_e2e.models import MyDataModel
+from custom_e2e.async_api.my_tag import get_my_data_model
 
 my_data: MyDataModel = await get_my_data_model(client=client)
 ```
@@ -40,9 +40,9 @@ Things to know:
 1. Every path/method combo becomes a Python function with type annotations. 
 1. All path/query params, and bodies become method arguments.
 1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
-1. Any endpoint which did not have a tag will be in `my_test_api_client.api.default`
+1. Any endpoint which did not have a tag will be in `custom_e2e.api.default`
 1. If the API returns a response code that was not declared in the OpenAPI document, a 
-    `my_test_api_client.api.errors.ApiResponseError` wil be raised 
+    `custom_e2e.api.errors.ApiResponseError` wil be raised 
     with the `response` attribute set to the `httpx.Response` that was received.
 
 

end_to_end_tests/golden-record-custom/my_test_api_client/__init__.py renamed to end_to_end_tests/golden-record-custom/custom_e2e/__init__.py

@@ -2,10 +2,12 @@
 
 import httpx
 
+from ...types import Response
+
 Client = httpx.Client
 
 import datetime
-from typing import Dict, List, Optional, Union, cast
+from typing import Dict, List, Union
 
 from dateutil.parser import isoparse
 
@@ -16,14 +18,18 @@
 
 def _parse_response(*, response: httpx.Response) -> Optional[Union[None, HTTPValidationError]]:
     if response.status_code == 200:
-        return None
+        response_200 = None
+
+        return response_200
     if response.status_code == 422:
-        return HTTPValidationError.from_dict(cast(Dict[str, Any], response.json()))
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
     return None
 
 
-def _build_response(*, response: httpx.Response) -> httpx.Response[Union[None, HTTPValidationError]]:
-    return httpx.Response(
+def _build_response(*, response: httpx.Response) -> Response[Union[None, HTTPValidationError]]:
+    return Response(
         status_code=response.status_code,
         content=response.content,
         headers=response.headers,
@@ -34,7 +40,6 @@ def _build_response(*, response: httpx.Response) -> httpx.Response[Union[None, H
 def httpx_request(
     *,
     client: Client,
-    json_body: Dict[Any, Any],
     string_prop: Union[Unset, str] = "the default string",
     datetime_prop: Union[Unset, datetime.datetime] = isoparse("1010-10-10T00:00:00"),
     date_prop: Union[Unset, datetime.date] = isoparse("1010-10-10").date(),
@@ -44,7 +49,7 @@ def httpx_request(
     list_prop: Union[Unset, List[AnEnum]] = UNSET,
     union_prop: Union[Unset, float, str] = "not a float",
     enum_prop: Union[Unset, AnEnum] = UNSET,
-) -> httpx.Response[Union[None, HTTPValidationError]]:
+) -> Response[Union[None, HTTPValidationError]]:
 
     json_datetime_prop: Union[Unset, str] = UNSET
     if not isinstance(datetime_prop, Unset):
@@ -94,12 +99,9 @@ def httpx_request(
     if enum_prop is not UNSET:
         params["enum_prop"] = json_enum_prop
 
-    json_json_body = json_body
-
     response = client.request(
         "post",
         "/tests/defaults",
-        json=json_json_body,
         params=params,
     )
 

end_to_end_tests/golden-record-custom/my_test_api_client/api/__init__.py renamed to end_to_end_tests/golden-record-custom/custom_e2e/api/__init__.py

@@ -2,17 +2,23 @@
 
 import httpx
 
+from ...types import Response
+
 Client = httpx.Client
 
+from typing import List, cast
+
 
 def _parse_response(*, response: httpx.Response) -> Optional[List[bool]]:
     if response.status_code == 200:
-        return [bool(item) for item in cast(List[bool], response.json())]
+        response_200 = cast(List[bool], response.json())
+
+        return response_200
     return None
 
 
-def _build_response(*, response: httpx.Response) -> httpx.Response[List[bool]]:
-    return httpx.Response(
+def _build_response(*, response: httpx.Response) -> Response[List[bool]]:
+    return Response(
         status_code=response.status_code,
         content=response.content,
         headers=response.headers,
@@ -23,7 +29,7 @@ def _build_response(*, response: httpx.Response) -> httpx.Response[List[bool]]:
 def httpx_request(
     *,
     client: Client,
-) -> httpx.Response[List[bool]]:
+) -> Response[List[bool]]:
 
     response = client.request(
         "get",

end_to_end_tests/golden-record-custom/my_test_api_client/api/default/__init__.py renamed to end_to_end_tests/golden-record-custom/custom_e2e/api/tests/__init__.py

@@ -2,17 +2,23 @@
 
 import httpx
 
+from ...types import Response
+
 Client = httpx.Client
 
+from typing import List, cast
+
 
 def _parse_response(*, response: httpx.Response) -> Optional[List[float]]:
     if response.status_code == 200:
-        return [float(item) for item in cast(List[float], response.json())]
+        response_200 = cast(List[float], response.json())
+
+        return response_200
     return None
 
 
-def _build_response(*, response: httpx.Response) -> httpx.Response[List[float]]:
-    return httpx.Response(
+def _build_response(*, response: httpx.Response) -> Response[List[float]]:
+    return Response(
         status_code=response.status_code,
         content=response.content,
         headers=response.headers,
@@ -23,7 +29,7 @@ def _build_response(*, response: httpx.Response) -> httpx.Response[List[float]]:
 def httpx_request(
     *,
     client: Client,
-) -> httpx.Response[List[float]]:
+) -> Response[List[float]]:
 
     response = client.request(
         "get",

end_to_end_tests/golden-record-custom/my_test_api_client/api/tests/defaults_tests_defaults_post.py renamed to end_to_end_tests/golden-record-custom/custom_e2e/api/tests/defaults_tests_defaults_post.py

@@ -2,17 +2,23 @@
 
 import httpx
 
+from ...types import Response
+
 Client = httpx.Client
 
+from typing import List, cast
+
 
 def _parse_response(*, response: httpx.Response) -> Optional[List[int]]:
     if response.status_code == 200:
-        return [int(item) for item in cast(List[int], response.json())]
+        response_200 = cast(List[int], response.json())
+
+        return response_200
     return None
 
 
-def _build_response(*, response: httpx.Response) -> httpx.Response[List[int]]:
-    return httpx.Response(
+def _build_response(*, response: httpx.Response) -> Response[List[int]]:
+    return Response(
         status_code=response.status_code,
         content=response.content,
         headers=response.headers,
@@ -23,7 +29,7 @@ def _build_response(*, response: httpx.Response) -> httpx.Response[List[int]]:
 def httpx_request(
     *,
     client: Client,
-) -> httpx.Response[List[int]]:
+) -> Response[List[int]]:
 
     response = client.request(
         "get",

end_to_end_tests/golden-record-custom/my_test_api_client/api/tests/get_basic_list_of_booleans.py renamed to end_to_end_tests/golden-record-custom/custom_e2e/api/tests/get_basic_list_of_booleans.py

@@ -2,17 +2,23 @@
 
 import httpx
 
+from ...types import Response
+
 Client = httpx.Client
 
+from typing import List, cast
+
 
 def _parse_response(*, response: httpx.Response) -> Optional[List[str]]:
     if response.status_code == 200:
-        return [str(item) for item in cast(List[str], response.json())]
+        response_200 = cast(List[str], response.json())
+
+        return response_200
     return None
 
 
-def _build_response(*, response: httpx.Response) -> httpx.Response[List[str]]:
-    return httpx.Response(
+def _build_response(*, response: httpx.Response) -> Response[List[str]]:
+    return Response(
         status_code=response.status_code,
         content=response.content,
         headers=response.headers,
@@ -23,7 +29,7 @@ def _build_response(*, response: httpx.Response) -> httpx.Response[List[str]]:
 def httpx_request(
     *,
     client: Client,
-) -> httpx.Response[List[str]]:
+) -> Response[List[str]]:
 
     response = client.request(
         "get",

end_to_end_tests/golden-record-custom/my_test_api_client/api/tests/get_basic_list_of_floats.py renamed to end_to_end_tests/golden-record-custom/custom_e2e/api/tests/get_basic_list_of_floats.py

@@ -2,10 +2,12 @@
 
 import httpx
 
+from ...types import Response
+
 Client = httpx.Client
 
 import datetime
-from typing import Dict, List, Union, cast
+from typing import Dict, List, Union
 
 from ...models.a_model import AModel
 from ...models.an_enum import AnEnum
@@ -14,14 +16,22 @@
 
 def _parse_response(*, response: httpx.Response) -> Optional[Union[List[AModel], HTTPValidationError]]:
     if response.status_code == 200:
-        return [AModel.from_dict(item) for item in cast(List[Dict[str, Any]], response.json())]
+        response_200 = []
+        for response_200_item_data in response.json():
+            response_200_item = AModel.from_dict(response_200_item_data)
+
+            response_200.append(response_200_item)
+
+        return response_200
     if response.status_code == 422:
-        return HTTPValidationError.from_dict(cast(Dict[str, Any], response.json()))
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
     return None
 
 
-def _build_response(*, response: httpx.Response) -> httpx.Response[Union[List[AModel], HTTPValidationError]]:
-    return httpx.Response(
+def _build_response(*, response: httpx.Response) -> Response[Union[List[AModel], HTTPValidationError]]:
+    return Response(
         status_code=response.status_code,
         content=response.content,
         headers=response.headers,
@@ -34,7 +44,7 @@ def httpx_request(
     client: Client,
     an_enum_value: List[AnEnum],
     some_date: Union[datetime.date, datetime.datetime],
-) -> httpx.Response[Union[List[AModel], HTTPValidationError]]:
+) -> Response[Union[List[AModel], HTTPValidationError]]:
 
     json_an_enum_value = []
     for an_enum_value_item_data in an_enum_value: