v3 fixes type errors (#175)

* Fixes errors in server.py

* Fixes some errors in server py files

* Fixes schema_config type error

* Fixes errors in api_configuration

* Adds type ignoring for enum values, schemas fixed

* Fixes python tests

* Moves ApiException back into the exceptions module

* Fixes timeout type and rest client response type

* Adds int input back into timeout, fixes type errors in rest.py

* Fixes decimal exponent access

* Parameter content storage updated to tuple so code can see length 1

* Uses content tuple in serialize methods

* Adds __HeaderParameterBase to fix type error

* Updates urllib3.HTTPResponse -> urllib3_response.BaseHTTPResponse

* Adds _SERIALIZE_TYPES

* Fixes explode type error

* Fixes urllib3 response type + header and parameter schema references

* Fixes response type, fixes api_response header type

* Fixes 2 type errors

* Adds assertion

* Adds assertion

* Adds from_tuples method and needed types

* Fixes return type of __serialize_application_octet_stream

* Fixes __serialize_json

* Fixes __serialize_text_plain

* Fixes __serialize_application_x_www_form_data

* Fixes type error

* Fixes __serialize_multipart_form_data

* Fixes FieldValue types

* Fixes uer agent type error

* Fixes another type error

* Fixes type error

* Fixes type errors in security_schemes

* Fixes errors in two tests

* Fixes more type errors

* Fixes error in get_server_url invocation

* Fixes parameter and header serialization/deserialization

* Fixes content references

* Fixes parameter tests

* Fixes last python test errors

* Samples regen

Author: spacether

modules/openapi-json-schema-generator/src/main/java/org/openapijsonschematools/codegen/languages/PythonClientCodegen.java

@@ -720,6 +720,7 @@ public void processOpts() {
         }
 
         supportingFiles.add(new SupportingFile("api_client.hbs", packagePath(), "api_client.py"));
+        supportingFiles.add(new SupportingFile("api_response.hbs", packagePath(), "api_response.py"));
         supportingFiles.add(new SupportingFile("rest.hbs", packagePath(), "rest.py"));
         supportingFiles.add(new SupportingFile("schemas.hbs", packagePath(), "schemas.py"));
         supportingFiles.add(new SupportingFile("security_schemes.hbs", packagePath(), "security_schemes.py"));

modules/openapi-json-schema-generator/src/main/resources/python/api_client.hbs

@@ -0,0 +1,24 @@
+# coding: utf-8
+{{> _helper_header }}
+
+import dataclasses
+import typing
+
+import typing_extensions
+import urllib3
+
+from {{packageName}} import schemas
+
+
+@dataclasses.dataclass
+class ApiResponse:
+    response: urllib3.HTTPResponse
+    body: typing.Union[schemas.Unset, schemas.Schema] = schemas.unset
+    headers: typing.Union[schemas.Unset, typing_extensions.TypedDict] = schemas.unset
+
+
+@dataclasses.dataclass
+class ApiResponseWithoutDeserialization(ApiResponse):
+    response: urllib3.HTTPResponse
+    body: typing.Union[schemas.Unset, schemas.Schema] = schemas.unset
+    headers: typing.Union[schemas.Unset, typing_extensions.TypedDict] = schemas.unset

modules/openapi-json-schema-generator/src/main/resources/python/api_response.hbs

@@ -41,19 +41,17 @@ class {{jsonPathPiece.camelCase}}(api_client.{{#if noName}}Header{{/if}}{{#eq in
         {{/with}}
     {{/with}}
 {{/each}}
+{{#each content}}
     Content = typing_extensions.TypedDict(
         'Content',
         {
-{{#each content}}
             '{{{@key.original}}}': typing.Type[{{@key.camelCase}}MediaType],
-{{/each}}
         }
     )
     content: Content = {
-{{#each content}}
         '{{{@key.original}}}': {{@key.camelCase}}MediaType,
-{{/each}}
     }
+{{/each}}
 {{/if}}
 {{#if required}}
     required = True

modules/openapi-json-schema-generator/src/main/resources/python/components/_helper_param_or_header_instance.hbs

@@ -31,7 +31,7 @@ from .headers import {{jsonPathPiece.snakeCase}}
 
 
 @dataclasses.dataclass
-class Api{{jsonPathPiece.camelCase}}(api_client.ApiResponse):
+class Api{{jsonPathPiece.camelCase}}(api_response.ApiResponse):
     response: urllib3.HTTPResponse
     {{#and headers content}}
         {{#if hasContentSchema}}

modules/openapi-json-schema-generator/src/main/resources/python/components/responses/response.hbs

@@ -4,23 +4,23 @@
 @schemas.classproperty
 def {{this}}(cls):
     {{#eq @key.type "string"}}
-    return cls("{{{@key.value}}}")
+    return cls("{{{@key.value}}}") # type: ignore
     {{/eq}}
     {{#eq @key.type "number"}}
-    return cls({{{@key.value}}})
+    return cls({{{@key.value}}}) # type: ignore
     {{/eq}}
     {{#eq @key.type "integer"}}
-    return cls({{{@key.value}}})
+    return cls({{{@key.value}}}) # type: ignore
     {{/eq}}
     {{#eq @key.type "boolean"}}
         {{#if @key.value}}
-    return cls(True)
+    return cls(True) # type: ignore
         {{else}}
-    return cls(False)
+    return cls(False) # type: ignore
         {{/if}}
     {{/eq}}
     {{#eq @key.type "null"}}
-    return cls(None)
+    return cls(None) # type: ignore
     {{/eq}}
 {{/each}}
 {{/if}}

modules/openapi-json-schema-generator/src/main/resources/python/components/schemas/_helper_enums.hbs

@@ -409,7 +409,7 @@ class ApiConfiguration(object):
                 used_index = self.server_index_info[key_prefix]
             except KeyError:
                 # fallback and use the default index
-                used_index = self.server_index_info["servers"]
+                used_index = self.server_index_info.get("servers", 0)
         server = self.server_info[f"{key_prefix}/{used_index}"]
         return server.url
 {{#if securitySchemes}}
@@ -431,6 +431,6 @@ class ApiConfiguration(object):
                 used_index = self.security_index_info[key_prefix]
             except KeyError:
                 # fallback and use the default index
-                used_index = self.security_index_info["security"]
+                used_index = self.security_index_info.get("security", 0)
         return security_requirement_objects[used_index]
 {{/if}}

modules/openapi-json-schema-generator/src/main/resources/python/configurations/api_configuration.hbs

@@ -62,7 +62,7 @@ class SchemaConfiguration:
 
     def __init__(
         self,
-        disabled_json_schema_keywords = frozenset(),
+        disabled_json_schema_keywords = set(),
     ):
         """Constructor
         """

modules/openapi-json-schema-generator/src/main/resources/python/configurations/schema_configuration.hbs

@@ -1,15 +1,26 @@
 # coding: utf-8
 
 {{> _helper_header }}
+
 import dataclasses
 import typing
 
-from urllib3._collections import HTTPHeaderDict
+from {{packageName}} import api_response
 
 
 class OpenApiException(Exception):
     """The base exception class for all OpenAPIExceptions"""
 
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result
+
 
 class ApiTypeError(OpenApiException, TypeError):
     def __init__(self, msg, path_to_item=None, valid_classes=None,
@@ -93,14 +104,13 @@ class ApiKeyError(OpenApiException, KeyError):
             full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
         super(ApiKeyError, self).__init__(full_msg)
 
-
-T = typing.TypeVar("T")
+T = typing.TypeVar('T', bound=api_response.ApiResponse)
 
 
 @dataclasses.dataclass
 class ApiException(OpenApiException, typing.Generic[T]):
     status: int
-    reason: str
+    reason: typing.Optional[str] = None
     api_response: typing.Optional[T] = None
 
     def __str__(self):
@@ -115,14 +125,3 @@ class ApiException(OpenApiException, typing.Generic[T]):
                 error_message += "HTTP response body: {0}\n".format(self.api_response.response.data)
 
         return error_message
-
-
-def render_path(path_to_item):
-    """Returns a string representation of a path"""
-    result = ""
-    for pth in path_to_item:
-        if isinstance(pth, int):
-            result += "[{0}]".format(pth)
-        else:
-            result += "['{0}']".format(pth)
-    return result

modules/openapi-json-schema-generator/src/main/resources/python/exceptions.hbs

@@ -21,7 +21,7 @@
     cookie_params: RequestCookieParameters.Params = frozendict.frozendict(),
 {{/if}}
 {{#if produces}}
-    accept_content_types: typing.Tuple[str] = _all_accept_content_types,
+    accept_content_types: typing.Tuple[str, ...] = _all_accept_content_types,
 {{/if}}
 {{#neq security null}}
     {{#gt security.size 0}}
@@ -36,7 +36,7 @@
 {{/neq}}
     server_index: typing.Optional[int] = None,
     stream: bool = False,
-    timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
+    timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None,
     {{#if isOverload}}
         {{#eq skipDeserialization "False"}}
     skip_deserialization: typing_extensions.Literal[False] = ...,
@@ -48,10 +48,10 @@
     skip_deserialization: bool = False,
     {{/if}}
 {{#eq skipDeserialization "True"}}
-) -> api_client.ApiResponseWithoutDeserialization: ...
+) -> api_response.ApiResponseWithoutDeserialization: ...
 {{/eq}}
 {{#eq skipDeserialization "False"}}
-) -> {{#if getAllResponsesAreErrors}}api_client.ApiResponseWithoutDeserialization: ...{{else}}{{#gt getNonErrorResponses.size 1}}typing.Union[
+) -> {{#if getAllResponsesAreErrors}}api_response.ApiResponseWithoutDeserialization: ...{{else}}{{#gt getNonErrorResponses.size 1}}typing.Union[
     {{> paths/path/verb/_helper_operation_response_type_hint multiple=true }}
 ]{{else}}{{> paths/path/verb/_helper_operation_response_type_hint multiple=false }}{{/gt}}: ...
     {{/if}}
@@ -60,7 +60,7 @@
 {{#if isOverload}}
 ) -> typing.Union[
     {{> paths/path/verb/_helper_operation_response_type_hint multiple=true }}
-    api_client.ApiResponseWithoutDeserialization,
+    api_response.ApiResponseWithoutDeserialization,
 ]: ...
 {{else}}
 ):

modules/openapi-json-schema-generator/src/main/resources/python/paths/path/verb/_helper_operation_args.hbs

@@ -253,7 +253,7 @@ class BaseApi(api_client.Api):
     {{else}}
         {{#if pathItem.servers}}
         host = self.api_client.configuration.get_server_url(
-            'paths/' + path + '/' + '/servers', server_index
+            'paths/' + path + '/servers', server_index
         )
         {{else}}
         host = self.api_client.configuration.get_server_url(
@@ -281,7 +281,7 @@ class BaseApi(api_client.Api):
         {{/neq}}
     {{/neq}}
 
-        response = self.api_client.call_api(
+        raw_response = self.api_client.call_api(
             resource_path=used_path,
             method='{{httpMethod.original}}',
             host=host,
@@ -308,10 +308,10 @@ class BaseApi(api_client.Api):
         )
 
         if skip_deserialization:
-            api_response = api_client.ApiResponseWithoutDeserialization(response=response)
+            response = api_response.ApiResponseWithoutDeserialization(response=raw_response)
         else:
 {{#if nonDefaultResponses}}
-            status = str(response.status)
+            status = str(raw_response.status)
     {{#if wildcardCodeResponses}}
             ranged_response_status_code = status[0]
     {{/if}}
@@ -322,17 +322,17 @@ class BaseApi(api_client.Api):
                     '{{@key}}',
         {{/each}}
                 ]
-                api_response = _status_code_to_response[status].deserialize(
-                    response, self.api_client.schema_configuration)
+                response = _status_code_to_response[status].deserialize(
+                    raw_response, self.api_client.schema_configuration)
         {{#if wildcardCodeResponses}}
             elif ranged_response_status_code in _ranged_status_code_to_response:
                 ranged_response_status_code: typing_extensions.Literal[
         {{#each wildcardCodeResponses}}
                     '{{@key}}',
         {{/each}}
                 ]
-                api_response = _ranged_status_code_to_response[ranged_response_status_code].deserialize(
-                    response, self.api_client.schema_configuration)
+                response = _ranged_status_code_to_response[ranged_response_status_code].deserialize(
+                    raw_response, self.api_client.schema_configuration)
         {{/if}}
     {{else}}
             if ranged_response_status_code in _ranged_status_code_to_response:
@@ -341,26 +341,26 @@ class BaseApi(api_client.Api):
                     '{{@key}}',
         {{/each}}
                 ]
-                api_response = _ranged_status_code_to_response[ranged_response_status_code].deserialize(
-                    response, self.api_client.schema_configuration)
+                response = _ranged_status_code_to_response[ranged_response_status_code].deserialize(
+                    raw_response, self.api_client.schema_configuration)
     {{/if}}
             else:
     {{#if defaultResponse}}
-                api_response = default_response.deserialize(response, self.api_client.schema_configuration)
+                response = default_response.deserialize(raw_response, self.api_client.schema_configuration)
     {{else}}
-                api_response = api_client.ApiResponseWithoutDeserialization(response=response)
+                response = api_response.ApiResponseWithoutDeserialization(response=raw_response)
     {{/if}}
 {{else}}
     {{#if defaultResponse}}
-            api_response = default_response.deserialize(response, self.api_client.schema_configuration)
+            response = default_response.deserialize(raw_response, self.api_client.schema_configuration)
     {{else}}
-            api_response = api_client.ApiResponseWithoutDeserialization(response=response)
+            response = api_response.ApiResponseWithoutDeserialization(response=raw_response)
     {{/if}}
 {{/if}}
 
-        self._verify_response_status(api_response)
+        self._verify_response_status(response)
 
-        return api_response
+        return response
 
 
 class {{operationId.camelCase}}(BaseApi):

modules/openapi-json-schema-generator/src/main/resources/python/paths/path/verb/operation.hbs

@@ -94,7 +94,7 @@ accept_content_types | typing.Tuple[str] | default is ({{#each produces}}"{{{.}}
 server_index | typing.Optional[int] | default is None | Allows one to select a different server
 stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
 timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
-skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
+skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_response.ApiResponseWithoutDeserialization will be returned
     {{#if requestBody}}
         {{#unless requestBody.refInfo}}
 
@@ -118,7 +118,7 @@ skip_deserialization | bool | default is False | when True, headers and body wil
 
 HTTP Status Code | Class | Description
 ------------- | ------------- | -------------
-n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
+n/a | api_response.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
 {{#if defaultResponse}}
     {{#with defaultResponse}}
         {{#if refInfo}}