Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

python: stronger typing for the "configuration" module #20014

Merged
merged 4 commits into from
Nov 6, 2024
Merged

python: stronger typing for the "configuration" module #20014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7025d47
python: strong typing for the configuration module
multani Nov 3, 2024
0dd0ede
3.8 compatibility
multani Nov 3, 2024
7727588
fix bearer format
multani Nov 3, 2024
b2fc64f
Specific auth settings
multani Nov 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
216 changes: 179 additions & 37 deletions modules/openapi-generator/src/main/resources/python/configuration.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,152 @@
{{>partial_header}}

import copy
import http.client as httplib
import logging
from logging import FileHandler
{{^asyncio}}
import multiprocessing
{{/asyncio}}
import sys
from typing import Optional
from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict
from typing_extensions import NotRequired, Self

import urllib3

import http.client as httplib
{{#hasHttpSignatureMethods}}
from {{packageName}}.signing import HttpSigningConfiguration
{{/hasHttpSignatureMethods}}

JSON_SCHEMA_VALIDATION_KEYWORDS = {
'multipleOf', 'maximum', 'exclusiveMaximum',
'minimum', 'exclusiveMinimum', 'maxLength',
'minLength', 'pattern', 'maxItems', 'minItems'
}

ServerVariablesT = Dict[str, str]

GenericAuthSetting = TypedDict(
"GenericAuthSetting",
{
"type": str,
"in": str,
"key": str,
"value": str,
},
)


OAuth2AuthSetting = TypedDict(
"OAuth2AuthSetting",
{
"type": Literal["oauth2"],
"in": Literal["header"],
"key": Literal["Authorization"],
"value": str,
},
)


APIKeyAuthSetting = TypedDict(
"APIKeyAuthSetting",
{
"type": Literal["api_key"],
"in": str,
"key": str,
"value": Optional[str],
},
)


BasicAuthSetting = TypedDict(
"BasicAuthSetting",
{
"type": Literal["basic"],
"in": Literal["header"],
"key": Literal["Authorization"],
"value": Optional[str],
},
)


BearerFormatAuthSetting = TypedDict(
"BearerFormatAuthSetting",
{
"type": Literal["bearer"],
"in": Literal["header"],
"format": Literal["JWT"],
"key": Literal["Authorization"],
"value": str,
},
)


BearerAuthSetting = TypedDict(
"BearerAuthSetting",
{
"type": Literal["bearer"],
"in": Literal["header"],
"key": Literal["Authorization"],
"value": str,
},
)


HTTPSignatureAuthSetting = TypedDict(
"HTTPSignatureAuthSetting",
{
"type": Literal["http-signature"],
"in": Literal["header"],
"key": Literal["Authorization"],
"value": None,
},
)


AuthSettings = TypedDict(
"AuthSettings",
{
{{#authMethods}}
{{#isOAuth}}
"{{name}}": OAuth2AuthSetting,
{{/isOAuth}}
{{#isApiKey}}
"{{name}}": APIKeyAuthSetting,
{{/isApiKey}}
{{#isBasic}}
{{#isBasicBasic}}
"{{name}}": BasicAuthSetting,
{{/isBasicBasic}}
{{#isBasicBearer}}
{{#bearerFormat}}
"{{name}}": BearerFormatAuthSetting,
{{/bearerFormat}}
{{^bearerFormat}}
"{{name}}": BearerAuthSetting,
{{/bearerFormat}}
{{/isBasicBearer}}
{{#isHttpSignature}}
"{{name}}": HTTPSignatureAuthSetting,
{{/isHttpSignature}}
{{/isBasic}}
{{/authMethods}}
},
total=False,
)


class HostSettingVariable(TypedDict):
description: str
default_value: str
enum_values: List[str]


class HostSetting(TypedDict):
url: str
description: str
variables: NotRequired[Dict[str, HostSettingVariable]]


class Configuration:
"""This class contains various settings of the API client.

Expand Down Expand Up @@ -140,23 +269,29 @@ conf = {{{packageName}}}.Configuration(
{{/hasAuthMethods}}
"""

_default = None
_default: ClassVar[Optional[Self]] = None

def __init__(self, host=None,
api_key=None, api_key_prefix=None,
username=None, password=None,
access_token=None,
def __init__(
self,
host: Optional[str]=None,
api_key: Optional[Dict[str, str]]=None,
api_key_prefix: Optional[Dict[str, str]]=None,
username: Optional[str]=None,
password: Optional[str]=None,
access_token: Optional[str]=None,
{{#hasHttpSignatureMethods}}
signing_info=None,
signing_info: Optional[HttpSigningConfiguration]=None,
{{/hasHttpSignatureMethods}}
server_index=None, server_variables=None,
server_operation_index=None, server_operation_variables=None,
ignore_operation_servers=False,
ssl_ca_cert=None,
retries=None,
*,
debug: Optional[bool] = None
) -> None:
server_index: Optional[int]=None,
server_variables: Optional[ServerVariablesT]=None,
server_operation_index: Optional[Dict[int, int]]=None,
server_operation_variables: Optional[Dict[int, ServerVariablesT]]=None,
ignore_operation_servers: bool=False,
ssl_ca_cert: Optional[str]=None,
retries: Optional[int] = None,
*,
debug: Optional[bool] = None,
) -> None:
"""Constructor
"""
self._base_path = "{{{basePath}}}" if host is None else host
Expand Down Expand Up @@ -295,7 +430,7 @@ conf = {{{packageName}}}.Configuration(
"""date format
"""

def __deepcopy__(self, memo):
def __deepcopy__(self, memo: Dict[int, Any]) -> Self:
cls = self.__class__
result = cls.__new__(cls)
memo[id(self)] = result
Expand All @@ -309,7 +444,7 @@ conf = {{{packageName}}}.Configuration(
result.debug = self.debug
return result

def __setattr__(self, name, value):
def __setattr__(self, name: str, value: Any) -> None:
object.__setattr__(self, name, value)
{{#hasHttpSignatureMethods}}
if name == "signing_info" and value is not None:
Expand All @@ -319,7 +454,7 @@ conf = {{{packageName}}}.Configuration(
{{/hasHttpSignatureMethods}}

@classmethod
def set_default(cls, default):
def set_default(cls, default: Optional[Self]) -> None:
"""Set default instance of configuration.

It stores default configuration, which can be
Expand All @@ -330,7 +465,7 @@ conf = {{{packageName}}}.Configuration(
cls._default = default

@classmethod
def get_default_copy(cls):
def get_default_copy(cls) -> Self:
"""Deprecated. Please use `get_default` instead.

Deprecated. Please use `get_default` instead.
Expand All @@ -340,7 +475,7 @@ conf = {{{packageName}}}.Configuration(
return cls.get_default()

@classmethod
def get_default(cls):
def get_default(cls) -> Self:
"""Return the default configuration.

This method returns newly created, based on default constructor,
Expand All @@ -350,11 +485,11 @@ conf = {{{packageName}}}.Configuration(
:return: The configuration object.
"""
if cls._default is None:
cls._default = Configuration()
cls._default = cls()
return cls._default

@property
def logger_file(self):
def logger_file(self) -> Optional[str]:
"""The logger file.

If the logger_file is None, then add stream handler and remove file
Expand All @@ -366,7 +501,7 @@ conf = {{{packageName}}}.Configuration(
return self.__logger_file

@logger_file.setter
def logger_file(self, value):
def logger_file(self, value: Optional[str]) -> None:
"""The logger file.

If the logger_file is None, then add stream handler and remove file
Expand All @@ -385,7 +520,7 @@ conf = {{{packageName}}}.Configuration(
logger.addHandler(self.logger_file_handler)

@property
def debug(self):
def debug(self) -> bool:
"""Debug status

:param value: The debug status, True or False.
Expand All @@ -394,7 +529,7 @@ conf = {{{packageName}}}.Configuration(
return self.__debug

@debug.setter
def debug(self, value):
def debug(self, value: bool) -> None:
"""Debug status

:param value: The debug status, True or False.
Expand All @@ -416,7 +551,7 @@ conf = {{{packageName}}}.Configuration(
httplib.HTTPConnection.debuglevel = 0

@property
def logger_format(self):
def logger_format(self) -> str:
"""The logger format.

The logger_formatter will be updated when sets logger_format.
Expand All @@ -427,7 +562,7 @@ conf = {{{packageName}}}.Configuration(
return self.__logger_format

@logger_format.setter
def logger_format(self, value):
def logger_format(self, value: str) -> None:
"""The logger format.

The logger_formatter will be updated when sets logger_format.
Expand All @@ -438,7 +573,7 @@ conf = {{{packageName}}}.Configuration(
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)

def get_api_key_with_prefix(self, identifier, alias=None):
def get_api_key_with_prefix(self, identifier: str, alias: Optional[str]=None) -> Optional[str]:
"""Gets API key (with prefix if set).

:param identifier: The identifier of apiKey.
Expand All @@ -455,7 +590,9 @@ conf = {{{packageName}}}.Configuration(
else:
return key

def get_basic_auth_token(self):
return None

def get_basic_auth_token(self) -> Optional[str]:
"""Gets HTTP basic authentication header (string).

:return: The token for basic HTTP authentication.
Expand All @@ -470,12 +607,12 @@ conf = {{{packageName}}}.Configuration(
basic_auth=username + ':' + password
).get('authorization')

def auth_settings(self):
def auth_settings(self)-> AuthSettings:
"""Gets Auth Settings dict for api client.

:return: The Auth Settings information dict.
"""
auth = {}
auth: AuthSettings = {}
{{#authMethods}}
{{#isApiKey}}
if '{{name}}' in self.api_key{{#vendorExtensions.x-auth-id-alias}} or '{{.}}' in self.api_key{{/vendorExtensions.x-auth-id-alias}}:
Expand Down Expand Up @@ -533,7 +670,7 @@ conf = {{{packageName}}}.Configuration(
{{/authMethods}}
return auth

def to_debug_report(self):
def to_debug_report(self) -> str:
"""Gets the essential information for debugging.

:return: The report for debugging.
Expand All @@ -545,7 +682,7 @@ conf = {{{packageName}}}.Configuration(
"SDK Package Version: {{packageVersion}}".\
format(env=sys.platform, pyversion=sys.version)

def get_host_settings(self):
def get_host_settings(self) -> List[HostSetting]:
"""Gets an array of host settings

:return: An array of host settings
Expand Down Expand Up @@ -580,7 +717,12 @@ conf = {{{packageName}}}.Configuration(
{{/servers}}
]

def get_host_from_settings(self, index, variables=None, servers=None):
def get_host_from_settings(
self,
index: Optional[int],
variables: Optional[ServerVariablesT]=None,
servers: Optional[List[HostSetting]]=None,
) -> str:
"""Gets host URL based on the index and variables
:param index: array index of the host settings
:param variables: hash of variable and the corresponding value
Expand Down Expand Up @@ -620,12 +762,12 @@ conf = {{{packageName}}}.Configuration(
return url

@property
def host(self):
def host(self) -> str:
"""Return generated host."""
return self.get_host_from_settings(self.server_index, variables=self.server_variables)

@host.setter
def host(self, value):
def host(self, value: str) -> None:
"""Fix base path."""
self._base_path = value
self.server_index = None
Loading
Loading