[python] Fixes endpoint overload type hint + required property not in…

… properties (#13790) * Adds endpoint overload type hint fix to template * Samples regenerated * Adds fix for required property not in properties * Regenerates samples
OpenAPITools · Oct 22, 2022 · ac3bb68 · ac3bb68
1 parent c0c31e8
commit ac3bb68
Show file tree

Hide file tree

Showing 236 changed files with 1,235 additions and 1 deletion.
diff --git a/modules/openapi-generator/src/main/resources/python/endpoint_args.handlebars b/modules/openapi-generator/src/main/resources/python/endpoint_args.handlebars
@@ -73,6 +73,12 @@
         {{/eq}}
         {{/with}}
     {{/if}}
+{{else}}
+    {{#if isOverload}}
+        {{#eq skipDeserialization "True"}}
+    skip_deserialization: typing_extensions.Literal[True],
+        {{/eq}}
+    {{/if}}
 {{/if}}
 {{#if queryParams}}
     query_params: RequestQueryParams = frozendict.frozendict(),

diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/new.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/new.handlebars
@@ -17,7 +17,15 @@ def __new__(
 {{#if complexType}}
     {{baseName}}: '{{complexType}}',
 {{else}}
+    {{#if getSchemaIsFromAdditionalProperties}}
+        {{#if addPropsUnset}}
+    {{baseName}}: typing.Union[schemas.AnyTypeSchema, {{> model_templates/schema_python_types }}],
+        {{else}}
+    {{baseName}}: typing.Union[MetaOapg.additional_properties, {{> model_templates/schema_python_types }}],
+        {{/if}}
+    {{else}}
     {{baseName}}: typing.Union[MetaOapg.properties.{{baseName}}, {{> model_templates/schema_python_types }}],
+    {{/if}}
 {{/if}}
 {{/unless}}
 {{/with}}

diff --git a/modules/openapi-generator/src/main/resources/python/model_templates/schema_dict.handlebars b/modules/openapi-generator/src/main/resources/python/model_templates/schema_dict.handlebars
@@ -32,4 +32,8 @@ class {{> model_templates/classname }}(
 {{/if}}
     {{> model_templates/property_type_hints }}
 
+{{#if additionalProperties}}
     {{> model_templates/new }}
+{{else}}
+    {{> model_templates/new addPropsUnset=true }}
+{{/if}}
diff --git a/...urces/3_0/python/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml b/...urces/3_0/python/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml
@@ -2978,4 +2978,17 @@ components:
           $ref: "#/components/schemas/ArrayWithValidationsInItems"
       required:
         - from
-        - "!reference"
+        - "!reference"
+    ObjectWithOptionalTestProp:
+      type: object
+      properties:
+        test:
+          type: string
+    ObjectWithAllOfWithReqTestPropFromUnsetAddProp:
+      allOf:
+        - $ref: '#/components/schemas/ObjectWithOptionalTestProp'
+        - type: object
+          required: [ test ]
+          properties:
+            name:
+              type: string
diff --git a/...lproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.py b/...lproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.py
@@ -71,6 +71,7 @@ def _post_additionalproperties_allows_a_schema_which_should_validate_response_bo
     @typing.overload
     def _post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -148,6 +149,7 @@ def post_additionalproperties_allows_a_schema_which_should_validate_response_bod
     @typing.overload
     def post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -197,6 +199,7 @@ def post(
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/...properties_allows_a_schema_which_should_validate_response_body_for_content_types/post.pyi b/...properties_allows_a_schema_which_should_validate_response_body_for_content_types/post.pyi
@@ -66,6 +66,7 @@ class BaseApi(api_client.Api):
     @typing.overload
     def _post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -143,6 +144,7 @@ class PostAdditionalpropertiesAllowsASchemaWhichShouldValidateResponseBodyForCon
     @typing.overload
     def post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -192,6 +194,7 @@ class ApiForpost(BaseApi):
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/..._post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.py b/..._post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.py
@@ -71,6 +71,7 @@ def _post_additionalproperties_are_allowed_by_default_response_body_for_content_
     @typing.overload
     def _post_additionalproperties_are_allowed_by_default_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -148,6 +149,7 @@ def post_additionalproperties_are_allowed_by_default_response_body_for_content_t
     @typing.overload
     def post_additionalproperties_are_allowed_by_default_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -197,6 +199,7 @@ def post(
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/...post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.pyi b/...post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.pyi
@@ -66,6 +66,7 @@ class BaseApi(api_client.Api):
     @typing.overload
     def _post_additionalproperties_are_allowed_by_default_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -143,6 +144,7 @@ class PostAdditionalpropertiesAreAllowedByDefaultResponseBodyForContentTypes(Bas
     @typing.overload
     def post_additionalproperties_are_allowed_by_default_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -192,6 +194,7 @@ class ApiForpost(BaseApi):
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/...ody_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.py b/...ody_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.py
@@ -71,6 +71,7 @@ def _post_additionalproperties_can_exist_by_itself_response_body_for_content_typ
     @typing.overload
     def _post_additionalproperties_can_exist_by_itself_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -148,6 +149,7 @@ def post_additionalproperties_can_exist_by_itself_response_body_for_content_type
     @typing.overload
     def post_additionalproperties_can_exist_by_itself_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -197,6 +199,7 @@ def post(
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/...dy_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.pyi b/...dy_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.pyi
@@ -66,6 +66,7 @@ class BaseApi(api_client.Api):
     @typing.overload
     def _post_additionalproperties_can_exist_by_itself_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -143,6 +144,7 @@ class PostAdditionalpropertiesCanExistByItselfResponseBodyForContentTypes(BaseAp
     @typing.overload
     def post_additionalproperties_can_exist_by_itself_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -192,6 +194,7 @@ class ApiForpost(BaseApi):
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/...ditionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.py b/...ditionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.py
@@ -71,6 +71,7 @@ def _post_additionalproperties_should_not_look_in_applicators_response_body_for_
     @typing.overload
     def _post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -148,6 +149,7 @@ def post_additionalproperties_should_not_look_in_applicators_response_body_for_c
     @typing.overload
     def post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -197,6 +199,7 @@ def post(
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/...itionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.pyi b/...itionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.pyi
@@ -66,6 +66,7 @@ class BaseApi(api_client.Api):
     @typing.overload
     def _post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -143,6 +144,7 @@ class PostAdditionalpropertiesShouldNotLookInApplicatorsResponseBodyForContentTy
     @typing.overload
     def post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -192,6 +194,7 @@ class ApiForpost(BaseApi):
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/...esponse_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.py b/...esponse_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.py
@@ -71,6 +71,7 @@ def _post_allof_combined_with_anyof_oneof_response_body_for_content_types_oapg(
     @typing.overload
     def _post_allof_combined_with_anyof_oneof_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -148,6 +149,7 @@ def post_allof_combined_with_anyof_oneof_response_body_for_content_types(
     @typing.overload
     def post_allof_combined_with_anyof_oneof_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -197,6 +199,7 @@ def post(
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/...sponse_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.pyi b/...sponse_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.pyi
@@ -66,6 +66,7 @@ class BaseApi(api_client.Api):
     @typing.overload
     def _post_allof_combined_with_anyof_oneof_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -143,6 +144,7 @@ class PostAllofCombinedWithAnyofOneofResponseBodyForContentTypes(BaseApi):
     @typing.overload
     def post_allof_combined_with_anyof_oneof_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -192,6 +194,7 @@ class ApiForpost(BaseApi):
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/...thon/unit_test_api/paths/response_body_post_allof_response_body_for_content_types/post.py b/...thon/unit_test_api/paths/response_body_post_allof_response_body_for_content_types/post.py
@@ -71,6 +71,7 @@ def _post_allof_response_body_for_content_types_oapg(
     @typing.overload
     def _post_allof_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -148,6 +149,7 @@ def post_allof_response_body_for_content_types(
     @typing.overload
     def post_allof_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -197,6 +199,7 @@ def post(
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/...hon/unit_test_api/paths/response_body_post_allof_response_body_for_content_types/post.pyi b/...hon/unit_test_api/paths/response_body_post_allof_response_body_for_content_types/post.pyi
@@ -66,6 +66,7 @@ class BaseApi(api_client.Api):
     @typing.overload
     def _post_allof_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -143,6 +144,7 @@ class PostAllofResponseBodyForContentTypes(BaseApi):
     @typing.overload
     def post_allof_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -192,6 +194,7 @@ class ApiForpost(BaseApi):
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/...t_api/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.py b/...t_api/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.py
@@ -71,6 +71,7 @@ def _post_allof_simple_types_response_body_for_content_types_oapg(
     @typing.overload
     def _post_allof_simple_types_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -148,6 +149,7 @@ def post_allof_simple_types_response_body_for_content_types(
     @typing.overload
     def post_allof_simple_types_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -197,6 +199,7 @@ def post(
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,

diff --git a/..._api/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.pyi b/..._api/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.pyi
@@ -66,6 +66,7 @@ class BaseApi(api_client.Api):
     @typing.overload
     def _post_allof_simple_types_response_body_for_content_types_oapg(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -143,6 +144,7 @@ class PostAllofSimpleTypesResponseBodyForContentTypes(BaseApi):
     @typing.overload
     def post_allof_simple_types_response_body_for_content_types(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
@@ -192,6 +194,7 @@ class ApiForpost(BaseApi):
     @typing.overload
     def post(
         self,
+        skip_deserialization: typing_extensions.Literal[True],
         accept_content_types: typing.Tuple[str] = _all_accept_content_types,
         stream: bool = False,
         timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,