Merge branch 'main' into fix-generated-readme-async-example

Author: dbanty

CHANGELOG.md

@@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Attempt to detect and alert users if they are using an unsupported version of OpenAPI (#281).
 - Fixes `Enum` deserialization when the value is `UNSET`.
 - Add handling of application/vnd.api+json media type.
+- Support passing models into query parameters (#316). Thanks @forest-benchling!
 
 ### Changes
 
@@ -30,6 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixes
 
+- Endpoint tags are now sanitized during parsing to fix an issue where `My Tag` and `MyTag` are seen as two different tags but are then later unified, causing errors when creating directories. Thanks @p1-ra! (#328)
 - Parser will softly ignore value error during schema responses' status code convertion from string to integer (not a number). Errors will be reported to the end user and parsing will continue to proceed (#327).
 - The generated `from_dict` and `to_dict` methods of models will now properly handle `nullable` and `not required` properties that are themselves generated models (#315). Thanks @forest-benchling!
 - Fixed a typo in the async example in generated README.md files (#337). Thanks @synchronizing!

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

@@ -13,6 +13,7 @@
 
 from ...models.an_enum import AnEnum
 from ...models.http_validation_error import HTTPValidationError
+from ...models.model_with_union_property import ModelWithUnionProperty
 from ...types import UNSET, Unset
 
 
@@ -50,6 +51,8 @@ def httpx_request(
     union_prop: Union[Unset, float, str] = "not a float",
     union_prop_with_ref: Union[Unset, float, AnEnum] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
+    model_prop: Union[ModelWithUnionProperty, Unset] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Response[Union[None, HTTPValidationError]]:
 
     json_datetime_prop: Union[Unset, str] = UNSET
@@ -89,6 +92,12 @@ def httpx_request(
     if not isinstance(enum_prop, Unset):
         json_enum_prop = enum_prop
 
+    json_model_prop: Union[Unset, Dict[str, Any]] = UNSET
+    if not isinstance(model_prop, Unset):
+        json_model_prop = model_prop.to_dict()
+
+    json_required_model_prop = required_model_prop.to_dict()
+
     params: Dict[str, Any] = {
         "string_prop": string_prop,
         "datetime_prop": json_datetime_prop,
@@ -101,6 +110,9 @@ def httpx_request(
         "union_prop_with_ref": json_union_prop_with_ref,
         "enum_prop": json_enum_prop,
     }
+    if not isinstance(json_model_prop, Unset):
+        params.update(json_model_prop)
+    params.update(json_required_model_prop)
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
     response = client.request(

end_to_end_tests/golden-record/my_test_api_client/api/tests/defaults_tests_defaults_post.py

@@ -7,6 +7,7 @@
 from ...client import Client
 from ...models.an_enum import AnEnum
 from ...models.http_validation_error import HTTPValidationError
+from ...models.model_with_union_property import ModelWithUnionProperty
 from ...types import UNSET, Response, Unset
 
 
@@ -23,6 +24,8 @@ def _get_kwargs(
     union_prop: Union[Unset, float, str] = "not a float",
     union_prop_with_ref: Union[Unset, float, AnEnum] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
+    model_prop: Union[ModelWithUnionProperty, Unset] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Dict[str, Any]:
     url = "{}/tests/defaults".format(client.base_url)
 
@@ -65,6 +68,12 @@ def _get_kwargs(
     if not isinstance(enum_prop, Unset):
         json_enum_prop = enum_prop
 
+    json_model_prop: Union[Unset, Dict[str, Any]] = UNSET
+    if not isinstance(model_prop, Unset):
+        json_model_prop = model_prop.to_dict()
+
+    json_required_model_prop = required_model_prop.to_dict()
+
     params: Dict[str, Any] = {
         "string_prop": string_prop,
         "datetime_prop": json_datetime_prop,
@@ -77,6 +86,9 @@ def _get_kwargs(
         "union_prop_with_ref": json_union_prop_with_ref,
         "enum_prop": json_enum_prop,
     }
+    if not isinstance(json_model_prop, Unset):
+        params.update(json_model_prop)
+    params.update(json_required_model_prop)
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
     return {
@@ -122,6 +134,8 @@ def sync_detailed(
     union_prop: Union[Unset, float, str] = "not a float",
     union_prop_with_ref: Union[Unset, float, AnEnum] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
+    model_prop: Union[ModelWithUnionProperty, Unset] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Response[Union[None, HTTPValidationError]]:
     kwargs = _get_kwargs(
         client=client,
@@ -135,6 +149,8 @@ def sync_detailed(
         union_prop=union_prop,
         union_prop_with_ref=union_prop_with_ref,
         enum_prop=enum_prop,
+        model_prop=model_prop,
+        required_model_prop=required_model_prop,
     )
 
     response = httpx.post(
@@ -157,6 +173,8 @@ def sync(
     union_prop: Union[Unset, float, str] = "not a float",
     union_prop_with_ref: Union[Unset, float, AnEnum] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
+    model_prop: Union[ModelWithUnionProperty, Unset] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Optional[Union[None, HTTPValidationError]]:
     """  """
 
@@ -172,6 +190,8 @@ def sync(
         union_prop=union_prop,
         union_prop_with_ref=union_prop_with_ref,
         enum_prop=enum_prop,
+        model_prop=model_prop,
+        required_model_prop=required_model_prop,
     ).parsed
 
 
@@ -188,6 +208,8 @@ async def asyncio_detailed(
     union_prop: Union[Unset, float, str] = "not a float",
     union_prop_with_ref: Union[Unset, float, AnEnum] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
+    model_prop: Union[ModelWithUnionProperty, Unset] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Response[Union[None, HTTPValidationError]]:
     kwargs = _get_kwargs(
         client=client,
@@ -201,6 +223,8 @@ async def asyncio_detailed(
         union_prop=union_prop,
         union_prop_with_ref=union_prop_with_ref,
         enum_prop=enum_prop,
+        model_prop=model_prop,
+        required_model_prop=required_model_prop,
     )
 
     async with httpx.AsyncClient() as _client:
@@ -222,6 +246,8 @@ async def asyncio(
     union_prop: Union[Unset, float, str] = "not a float",
     union_prop_with_ref: Union[Unset, float, AnEnum] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
+    model_prop: Union[ModelWithUnionProperty, Unset] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Optional[Union[None, HTTPValidationError]]:
     """  """
 
@@ -238,5 +264,7 @@ async def asyncio(
             union_prop=union_prop,
             union_prop_with_ref=union_prop_with_ref,
             enum_prop=enum_prop,
+            model_prop=model_prop,
+            required_model_prop=required_model_prop,
         )
     ).parsed

end_to_end_tests/openapi.json

@@ -396,6 +396,22 @@
             },
             "name": "enum_prop",
             "in": "query"
+          },
+          {
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/ModelWithUnionProperty"
+            },
+            "name": "model_prop",
+            "in": "query"
+          },
+          {
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/ModelWithUnionProperty"
+            },
+            "name": "required_model_prop",
+            "in": "query"
           }
         ],
         "responses": {

openapi_python_client/__init__.py

@@ -235,7 +235,6 @@ def _build_api(self) -> None:
 
         endpoint_template = self.env.get_template("endpoint_module.py.jinja")
         for tag, collection in self.openapi.endpoint_collections_by_tag.items():
-            tag = utils.snake_case(tag)
             tag_dir = api_dir / tag
             tag_dir.mkdir()
             (tag_dir / "__init__.py").touch()

openapi_python_client/parser/openapi.py

@@ -48,7 +48,7 @@ def from_data(
                 operation: Optional[oai.Operation] = getattr(path_data, method)
                 if operation is None:
                     continue
-                tag = (operation.tags or ["default"])[0]
+                tag = utils.snake_case((operation.tags or ["default"])[0])
                 collection = endpoints_by_tag.setdefault(tag, EndpointCollection(tag=tag))
                 endpoint, schemas = Endpoint.from_data(
                     data=operation, path=path, method=method, tag=tag, schemas=schemas

openapi_python_client/parser/properties/model_property.py

@@ -19,6 +19,7 @@ class ModelProperty(Property):
     additional_properties: Union[bool, Property]
 
     template: ClassVar[str] = "model_property.py.jinja"
+    json_is_dict: ClassVar[bool] = True
 
     def get_type_string(self, no_optional: bool = False) -> str:
         """ Get a string representation of type that should be used when declaring this property """

openapi_python_client/parser/properties/property.py

@@ -28,6 +28,7 @@ class Property:
     python_name: str = attr.ib(init=False)
 
     template: ClassVar[Optional[str]] = None
+    json_is_dict: ClassVar[bool] = False
 
     def __attrs_post_init__(self) -> None:
         object.__setattr__(self, "python_name", utils.to_valid_python_identifier(utils.snake_case(self.name)))

openapi_python_client/templates/endpoint_macros.py.jinja

@@ -22,13 +22,26 @@ if {{ parameter.python_name }} is not UNSET:
     {% endfor %}
 params: Dict[str, Any] = {
     {% for property in endpoint.query_parameters %}
-        {% if property.template %}
+        {% if not property.json_is_dict %}
+            {% if property.template %}
     "{{ property.name }}": {{ "json_" + property.python_name }},
-        {% else %}
+            {% else %}
     "{{ property.name }}": {{ property.python_name }},
+            {% endif %}
         {% endif %}
     {% endfor %}
 }
+    {% for property in endpoint.query_parameters %}
+        {% if property.json_is_dict %}
+            {% set property_name = "json_" + property.python_name %}
+            {% if property.required and not property.nullable %}
+params.update({{ property_name }})
+            {% else %}
+if {% if not property.required %}not isinstance({{ property_name }}, Unset){% endif %}{% if not property.required and property.nullable %} and {% endif %}{% if property.nullable %}{{ property_name }} is not None{% endif %}:
+    params.update({{ property_name }})
+            {% endif %}
+        {% endif %}
+    {% endfor %}
 params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 {% endif %}
 {% endmacro %}

tests/test_parser/test_openapi.py

@@ -829,3 +829,51 @@ def test_from_data_errors(self, mocker):
         assert result["default"].parse_errors[1].data == "3"
         assert result["tag_2"].parse_errors[0].data == "2"
         assert result_schemas == schemas_3
+
+    def test_from_data_tags_snake_case_sanitizer(self, mocker):
+        from openapi_python_client.parser.openapi import Endpoint, EndpointCollection
+
+        path_1_put = oai.Operation.construct()
+        path_1_post = oai.Operation.construct(tags=["AMF Subscription Info (Document)", "tag_3"])
+        path_2_get = oai.Operation.construct()
+        data = {
+            "path_1": oai.PathItem.construct(post=path_1_post, put=path_1_put),
+            "path_2": oai.PathItem.construct(get=path_2_get),
+        }
+        endpoint_1 = mocker.MagicMock(autospec=Endpoint, tag="default", relative_imports={"1", "2"})
+        endpoint_2 = mocker.MagicMock(autospec=Endpoint, tag="AMFSubscriptionInfo (Document)", relative_imports={"2"})
+        endpoint_3 = mocker.MagicMock(autospec=Endpoint, tag="default", relative_imports={"2", "3"})
+        schemas_1 = mocker.MagicMock()
+        schemas_2 = mocker.MagicMock()
+        schemas_3 = mocker.MagicMock()
+        endpoint_from_data = mocker.patch.object(
+            Endpoint,
+            "from_data",
+            side_effect=[(endpoint_1, schemas_1), (endpoint_2, schemas_2), (endpoint_3, schemas_3)],
+        )
+        schemas = mocker.MagicMock()
+
+        result = EndpointCollection.from_data(data=data, schemas=schemas)
+
+        endpoint_from_data.assert_has_calls(
+            [
+                mocker.call(data=path_1_put, path="path_1", method="put", tag="default", schemas=schemas),
+                mocker.call(
+                    data=path_1_post,
+                    path="path_1",
+                    method="post",
+                    tag="amf_subscription_info_document",
+                    schemas=schemas_1,
+                ),
+                mocker.call(data=path_2_get, path="path_2", method="get", tag="default", schemas=schemas_2),
+            ],
+        )
+        assert result == (
+            {
+                "default": EndpointCollection("default", endpoints=[endpoint_1, endpoint_3]),
+                "amf_subscription_info_document": EndpointCollection(
+                    "amf_subscription_info_document", endpoints=[endpoint_2]
+                ),
+            },
+            schemas_3,
+        )