680 lines
25 KiB
Plaintext
680 lines
25 KiB
Plaintext
|
{{>partial_header}}
|
||
|
|
|
||
|
|
import copy
|
||
|
|
import logging
|
||
|
|
{{^asyncio}}
|
||
|
|
import multiprocessing
|
||
|
|
{{/asyncio}}
|
||
|
|
import sys
|
||
|
|
import typing
|
||
|
|
import urllib3
|
||
|
|
|
||
|
|
from http import client as http_client
|
||
|
|
from {{packageName}}.exceptions import ApiValueError
|
||
|
|
|
||
|
|
|
||
|
|
JSON_SCHEMA_VALIDATION_KEYWORDS = {
|
||
|
|
'multipleOf', 'maximum', 'exclusiveMaximum',
|
||
|
|
'minimum', 'exclusiveMinimum', 'maxLength',
|
||
|
|
'minLength', 'pattern', 'maxItems', 'minItems'
|
||
|
|
}
|
||
|
|
|
||
|
|
class Configuration:
|
||
|
|
"""
|
||
|
|
NOTE: This class is auto generated by OpenAPI Generator
|
||
|
|
|
||
|
|
Ref: https://openapi-generator.tech
|
||
|
|
Do not edit the class manually.
|
||
|
|
|
||
|
|
:param host: Base url
|
||
|
|
:param api_key: Dict to store API key(s).
|
||
|
|
Each entry in the dict specifies an API key.
|
||
|
|
The dict key is the name of the security scheme in the OAS specification.
|
||
|
|
The dict value is the API key secret.
|
||
|
|
Supported key names:{{#authMethods}}{{#isApiKey}}
|
||
|
|
'{{name}}'{{/isApiKey}}{{/authMethods}}
|
||
|
|
:param api_key_prefix: Dict to store API prefix (e.g. Bearer)
|
||
|
|
The dict key is the name of the security scheme in the OAS specification.
|
||
|
|
The dict value is an API key prefix when generating the auth data.
|
||
|
|
{{#authMethods}}{{#-first}}Default prefixes for API keys:{{/-first}}{{#isApiKey}}{{#vendorExtensions.x-token-prefix}}
|
||
|
|
{{name}}: '{{.}}'{{/vendorExtensions.x-token-prefix}}{{/isApiKey}}{{/authMethods}}
|
||
|
|
:param username: Username for HTTP basic authentication
|
||
|
|
:param password: Password for HTTP basic authentication
|
||
|
|
:param discard_unknown_keys: Boolean value indicating whether to discard
|
||
|
|
unknown properties. A server may send a response that includes additional
|
||
|
|
properties that are not known by the client in the following scenarios:
|
||
|
|
1. The OpenAPI document is incomplete, i.e. it does not match the server
|
||
|
|
implementation.
|
||
|
|
2. The client was generated using an older version of the OpenAPI document
|
||
|
|
and the server has been upgraded since then.
|
||
|
|
If a schema in the OpenAPI document defines the additionalProperties attribute,
|
||
|
|
then all undeclared properties received by the server are injected into the
|
||
|
|
additional properties map. In that case, there are undeclared properties, and
|
||
|
|
nothing to discard.
|
||
|
|
:param disabled_client_side_validations (string): Comma-separated list of
|
||
|
|
JSON schema validation keywords to disable JSON schema structural validation
|
||
|
|
rules. The following keywords may be specified: multipleOf, maximum,
|
||
|
|
exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern,
|
||
|
|
maxItems, minItems.
|
||
|
|
By default, the validation is performed for data generated locally by the client
|
||
|
|
and data received from the server, independent of any validation performed by
|
||
|
|
the server side. If the input data does not satisfy the JSON schema validation
|
||
|
|
rules specified in the OpenAPI document, an exception is raised.
|
||
|
|
If disabled_client_side_validations is set, structural validation is
|
||
|
|
disabled. This can be useful to troubleshoot data validation problem, such as
|
||
|
|
when the OpenAPI document validation rules do not match the actual API data
|
||
|
|
received by the server.
|
||
|
|
{{#hasHttpSignatureMethods}}
|
||
|
|
:param signing_info: Configuration parameters for the HTTP signature security scheme.
|
||
|
|
Must be an instance of {{{packageName}}}.signing.HttpSigningConfiguration
|
||
|
|
{{/hasHttpSignatureMethods}}
|
||
|
|
:param server_index: Index to servers configuration.
|
||
|
|
:param server_variables: Mapping with string values to replace variables in
|
||
|
|
templated server configuration. The validation of enums is performed for
|
||
|
|
variables with defined enum values before.
|
||
|
|
:param server_operation_index: Mapping from operation ID to an index to server
|
||
|
|
configuration.
|
||
|
|
:param server_operation_variables: Mapping from operation ID to a mapping with
|
||
|
|
string values to replace variables in templated server configuration.
|
||
|
|
The validation of enums is performed for variables with defined enum values before.
|
||
|
|
:param ssl_ca_cert: the path to a file of concatenated CA certificates in PEM format
|
||
|
|
:param verify_ssl: whether to verify server SSL certificates or not.
|
||
|
|
|
||
|
|
{{#hasAuthMethods}}
|
||
|
|
:Example:
|
||
|
|
{{#hasApiKeyMethods}}
|
||
|
|
|
||
|
|
API Key Authentication Example.
|
||
|
|
|
||
|
|
You can authenticate with session tokens after logging in the following way:
|
||
|
|
|
||
|
|
conf = {{{packageName}}}.Configuration(
|
||
|
|
...
|
||
|
|
api_key={
|
||
|
|
"sessionAuth": <sessionid cookie value>,
|
||
|
|
"csrfAuth": <csrftoken cookie value>,
|
||
|
|
}
|
||
|
|
)
|
||
|
|
|
||
|
|
Alternatively, you can authenticate with a token after logging in the following way:
|
||
|
|
|
||
|
|
conf = {{{packageName}}}.Configuration(
|
||
|
|
...
|
||
|
|
api_key={
|
||
|
|
"tokenAuth": <auth key value>,
|
||
|
|
}
|
||
|
|
)
|
||
|
|
|
||
|
|
If your custom server uses another token prefix, use the 'api_key_prefix' parameter.
|
||
|
|
This authentication option is deprecated and will be removed in future.
|
||
|
|
|
||
|
|
{{/hasApiKeyMethods}}
|
||
|
|
{{#hasHttpBasicMethods}}
|
||
|
|
|
||
|
|
HTTP Basic Authentication Example.
|
||
|
|
Given the following security scheme in the OpenAPI specification:
|
||
|
|
components:
|
||
|
|
securitySchemes:
|
||
|
|
http_basic_auth:
|
||
|
|
type: http
|
||
|
|
scheme: basic
|
||
|
|
|
||
|
|
Configure API client with HTTP basic authentication:
|
||
|
|
|
||
|
|
conf = {{{packageName}}}.Configuration(
|
||
|
|
...,
|
||
|
|
username='the-user',
|
||
|
|
password='the-password',
|
||
|
|
)
|
||
|
|
|
||
|
|
{{/hasHttpBasicMethods}}
|
||
|
|
{{#hasHttpSignatureMethods}}
|
||
|
|
|
||
|
|
HTTP Signature Authentication Example.
|
||
|
|
Given the following security scheme in the OpenAPI specification:
|
||
|
|
components:
|
||
|
|
securitySchemes:
|
||
|
|
http_basic_auth:
|
||
|
|
type: http
|
||
|
|
scheme: signature
|
||
|
|
|
||
|
|
Configure API client with HTTP signature authentication. Use the 'hs2019' signature scheme,
|
||
|
|
sign the HTTP requests with the RSA-SSA-PSS signature algorithm, and set the expiration time
|
||
|
|
of the signature to 5 minutes after the signature has been created.
|
||
|
|
Note you can use the constants defined in the {{{packageName}}}.signing module, and you can
|
||
|
|
also specify arbitrary HTTP headers to be included in the HTTP signature, except for the
|
||
|
|
'Authorization' header, which is used to carry the signature.
|
||
|
|
|
||
|
|
One may be tempted to sign all headers by default, but in practice it rarely works.
|
||
|
|
This is because explicit proxies, transparent proxies, TLS termination endpoints or
|
||
|
|
load balancers may add/modify/remove headers. Include the HTTP headers that you know
|
||
|
|
are not going to be modified in transit.
|
||
|
|
|
||
|
|
conf = {{{packageName}}}.Configuration(
|
||
|
|
signing_info = {{{packageName}}}.signing.HttpSigningConfiguration(
|
||
|
|
key_id = 'my-key-id',
|
||
|
|
private_key_path = 'rsa.pem',
|
||
|
|
signing_scheme = {{{packageName}}}.signing.SCHEME_HS2019,
|
||
|
|
signing_algorithm = {{{packageName}}}.signing.ALGORITHM_RSASSA_PSS,
|
||
|
|
signed_headers = [{{{packageName}}}.signing.HEADER_REQUEST_TARGET,
|
||
|
|
{{{packageName}}}.signing.HEADER_CREATED,
|
||
|
|
{{{packageName}}}.signing.HEADER_EXPIRES,
|
||
|
|
{{{packageName}}}.signing.HEADER_HOST,
|
||
|
|
{{{packageName}}}.signing.HEADER_DATE,
|
||
|
|
{{{packageName}}}.signing.HEADER_DIGEST,
|
||
|
|
'Content-Type',
|
||
|
|
'User-Agent'
|
||
|
|
],
|
||
|
|
signature_max_validity = datetime.timedelta(minutes=5)
|
||
|
|
)
|
||
|
|
)
|
||
|
|
{{/hasHttpSignatureMethods}}
|
||
|
|
{{/hasAuthMethods}}
|
||
|
|
"""
|
||
|
|
|
||
|
|
_default = None
|
||
|
|
|
||
|
|
def __init__(self,
|
||
|
|
host: typing.Optional[str] = None,
|
||
|
|
api_key: typing.Optional[dict[str, str]] = None,
|
||
|
|
api_key_prefix: typing.Optional[dict[str, str]] = None,
|
||
|
|
username: typing.Optional[str] = None,
|
||
|
|
password: typing.Optional[str]=None,
|
||
|
|
discard_unknown_keys: bool = False,
|
||
|
|
disabled_client_side_validations: str = "",
|
||
|
|
{{#hasHttpSignatureMethods}}
|
||
|
|
signing_info=None,
|
||
|
|
{{/hasHttpSignatureMethods}}
|
||
|
|
server_index: typing.Optional[int] = None,
|
||
|
|
server_variables: typing.Optional[dict[str, str]] = None,
|
||
|
|
server_operation_index: typing.Optional[int] = None,
|
||
|
|
server_operation_variables: typing.Optional[dict[str, str]] = None,
|
||
|
|
ssl_ca_cert: typing.Optional[str] = None,
|
||
|
|
verify_ssl: typing.Optional[bool] = None,
|
||
|
|
) -> None:
|
||
|
|
self._base_path = self._fix_host_url("{{{basePath}}}" if host is None else host)
|
||
|
|
"""Default Base url"""
|
||
|
|
|
||
|
|
self.server_index = 0 if server_index is None and host is None else server_index
|
||
|
|
"""Default server index"""
|
||
|
|
|
||
|
|
self.server_operation_index = server_operation_index or {}
|
||
|
|
"""Default server operation index"""
|
||
|
|
|
||
|
|
self.server_variables = server_variables or {}
|
||
|
|
"""Default server variables"""
|
||
|
|
|
||
|
|
self.server_operation_variables = server_operation_variables or {}
|
||
|
|
"""Default server variables"""
|
||
|
|
|
||
|
|
self.temp_folder_path = None
|
||
|
|
"""Temp file folder for downloading files"""
|
||
|
|
|
||
|
|
# Authentication Settings
|
||
|
|
self.access_token = None
|
||
|
|
"""Bearer API token"""
|
||
|
|
|
||
|
|
self.api_key = {}
|
||
|
|
"""dict to store API key(s)"""
|
||
|
|
if api_key:
|
||
|
|
self.api_key = api_key
|
||
|
|
|
||
|
|
self.api_key_prefix = { {{#authMethods}}{{#isApiKey}}{{#vendorExtensions.x-token-prefix}}
|
||
|
|
'{{name}}': '{{.}}'{{/vendorExtensions.x-token-prefix}}{{/isApiKey}}{{/authMethods}}
|
||
|
|
}
|
||
|
|
"""dict to store API prefix (e.g. Bearer)"""
|
||
|
|
if api_key_prefix:
|
||
|
|
self.api_key_prefix.update(api_key_prefix)
|
||
|
|
|
||
|
|
self.refresh_api_key_hook = None
|
||
|
|
"""function hook to refresh API key if expired"""
|
||
|
|
|
||
|
|
self.username = username
|
||
|
|
"""Username for HTTP basic authentication"""
|
||
|
|
|
||
|
|
self.password = password
|
||
|
|
"""Password for HTTP basic authentication"""
|
||
|
|
|
||
|
|
self.discard_unknown_keys = discard_unknown_keys
|
||
|
|
"""A flag to control unknown key deserialization behaviour"""
|
||
|
|
|
||
|
|
self.disabled_client_side_validations = disabled_client_side_validations
|
||
|
|
"""A flag to enable or disable specific model field validation in the client"""
|
||
|
|
|
||
|
|
{{#hasHttpSignatureMethods}}
|
||
|
|
if signing_info is not None:
|
||
|
|
signing_info.host = host
|
||
|
|
self.signing_info = signing_info
|
||
|
|
"""The HTTP signing configuration
|
||
|
|
"""
|
||
|
|
{{/hasHttpSignatureMethods}}
|
||
|
|
self.logger = {}
|
||
|
|
"""Logging Settings"""
|
||
|
|
|
||
|
|
self.logger["package_logger"] = logging.getLogger("{{packageName}}")
|
||
|
|
self.logger["urllib3_logger"] = logging.getLogger("urllib3")
|
||
|
|
|
||
|
|
self.logger_format = '%(asctime)s %(levelname)s %(message)s'
|
||
|
|
"""Log format"""
|
||
|
|
|
||
|
|
self.logger_stream_handler = None
|
||
|
|
"""Log stream handler"""
|
||
|
|
|
||
|
|
self.logger_file_handler = None
|
||
|
|
"""Log file handler"""
|
||
|
|
|
||
|
|
self.logger_file = None
|
||
|
|
"""Debug file location"""
|
||
|
|
|
||
|
|
self.debug = False
|
||
|
|
"""Debug switch"""
|
||
|
|
|
||
|
|
self.verify_ssl = verify_ssl if verify_ssl is not None else True
|
||
|
|
"""
|
||
|
|
SSL/TLS verification
|
||
|
|
Set this to false to skip verifying SSL certificate when calling API
|
||
|
|
from https server.
|
||
|
|
"""
|
||
|
|
|
||
|
|
self.ssl_ca_cert = ssl_ca_cert
|
||
|
|
"""Set this to customize the certificate file to verify the peer."""
|
||
|
|
|
||
|
|
self.cert_file = None
|
||
|
|
"""client certificate file"""
|
||
|
|
|
||
|
|
self.key_file = None
|
||
|
|
"""client key file"""
|
||
|
|
|
||
|
|
self.assert_hostname = None
|
||
|
|
"""Set this to True/False to enable/disable SSL hostname verification."""
|
||
|
|
|
||
|
|
{{#asyncio}}
|
||
|
|
self.connection_pool_maxsize = 100
|
||
|
|
"""This value is passed to the aiohttp to limit simultaneous connections.
|
||
|
|
Default values is 100, None means no-limit.
|
||
|
|
"""
|
||
|
|
{{/asyncio}}
|
||
|
|
{{^asyncio}}
|
||
|
|
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
|
||
|
|
"""urllib3 connection pool's maximum number of connections saved
|
||
|
|
per pool. urllib3 uses 1 connection as default value, but this is
|
||
|
|
not the best value when you are making a lot of possibly parallel
|
||
|
|
requests to the same host, which is often the case here.
|
||
|
|
cpu_count * 5 is used as default value to increase performance.
|
||
|
|
"""
|
||
|
|
{{/asyncio}}
|
||
|
|
|
||
|
|
self.proxy = None
|
||
|
|
"""Proxy URL"""
|
||
|
|
|
||
|
|
self.no_proxy = None
|
||
|
|
"""bypass proxy for host in the no_proxy list."""
|
||
|
|
|
||
|
|
self.proxy_headers = None
|
||
|
|
"""Proxy headers"""
|
||
|
|
|
||
|
|
self.safe_chars_for_path_param = ''
|
||
|
|
"""Safe chars for path_param"""
|
||
|
|
|
||
|
|
self.retries = None
|
||
|
|
"""Adding retries to override urllib3 default value 3"""
|
||
|
|
|
||
|
|
# Enable client side validation
|
||
|
|
self.client_side_validation = True
|
||
|
|
|
||
|
|
# Options to pass down to the underlying urllib3 socket
|
||
|
|
self.socket_options = None
|
||
|
|
|
||
|
|
def __deepcopy__(self, memo):
|
||
|
|
cls = self.__class__
|
||
|
|
result = cls.__new__(cls)
|
||
|
|
memo[id(self)] = result
|
||
|
|
for k, v in self.__dict__.items():
|
||
|
|
if k not in ('logger', 'logger_file_handler'):
|
||
|
|
setattr(result, k, copy.deepcopy(v, memo))
|
||
|
|
# shallow copy of loggers
|
||
|
|
result.logger = copy.copy(self.logger)
|
||
|
|
# use setters to configure loggers
|
||
|
|
result.logger_file = self.logger_file
|
||
|
|
result.debug = self.debug
|
||
|
|
return result
|
||
|
|
|
||
|
|
def __setattr__(self, name, value):
|
||
|
|
object.__setattr__(self, name, value)
|
||
|
|
if name == 'disabled_client_side_validations':
|
||
|
|
s = set(filter(None, value.split(',')))
|
||
|
|
for v in s:
|
||
|
|
if v not in JSON_SCHEMA_VALIDATION_KEYWORDS:
|
||
|
|
raise ApiValueError(
|
||
|
|
"Invalid keyword: '{0}''".format(v))
|
||
|
|
self._disabled_client_side_validations = s
|
||
|
|
{{#hasHttpSignatureMethods}}
|
||
|
|
if name == "signing_info" and value is not None:
|
||
|
|
# Ensure the host parameter from signing info is the same as
|
||
|
|
# Configuration.host.
|
||
|
|
value.host = self.host
|
||
|
|
{{/hasHttpSignatureMethods}}
|
||
|
|
|
||
|
|
@classmethod
|
||
|
|
def set_default(cls, default):
|
||
|
|
"""Set default instance of configuration.
|
||
|
|
|
||
|
|
It stores default configuration, which can be
|
||
|
|
returned by get_default_copy method.
|
||
|
|
|
||
|
|
:param default: object of Configuration
|
||
|
|
"""
|
||
|
|
cls._default = copy.deepcopy(default)
|
||
|
|
|
||
|
|
@classmethod
|
||
|
|
def get_default_copy(cls):
|
||
|
|
"""Return new instance of configuration.
|
||
|
|
|
||
|
|
This method returns newly created, based on default constructor,
|
||
|
|
object of Configuration class or returns a copy of default
|
||
|
|
configuration passed by the set_default method.
|
||
|
|
|
||
|
|
:return: The configuration object.
|
||
|
|
"""
|
||
|
|
if cls._default is not None:
|
||
|
|
return copy.deepcopy(cls._default)
|
||
|
|
return Configuration()
|
||
|
|
|
||
|
|
@property
|
||
|
|
def logger_file(self):
|
||
|
|
"""The logger file.
|
||
|
|
|
||
|
|
If the logger_file is None, then add stream handler and remove file
|
||
|
|
handler. Otherwise, add file handler and remove stream handler.
|
||
|
|
|
||
|
|
:param value: The logger_file path.
|
||
|
|
:type: str
|
||
|
|
"""
|
||
|
|
return self.__logger_file
|
||
|
|
|
||
|
|
@logger_file.setter
|
||
|
|
def logger_file(self, value):
|
||
|
|
"""The logger file.
|
||
|
|
|
||
|
|
If the logger_file is None, then add stream handler and remove file
|
||
|
|
handler. Otherwise, add file handler and remove stream handler.
|
||
|
|
|
||
|
|
:param value: The logger_file path.
|
||
|
|
:type: str
|
||
|
|
"""
|
||
|
|
self.__logger_file = value
|
||
|
|
if self.__logger_file:
|
||
|
|
# If set logging file,
|
||
|
|
# then add file handler and remove stream handler.
|
||
|
|
self.logger_file_handler = logging.FileHandler(self.__logger_file)
|
||
|
|
self.logger_file_handler.setFormatter(self.logger_formatter)
|
||
|
|
for _, logger in self.logger.items():
|
||
|
|
logger.addHandler(self.logger_file_handler)
|
||
|
|
|
||
|
|
@property
|
||
|
|
def debug(self):
|
||
|
|
"""Debug status
|
||
|
|
|
||
|
|
:param value: The debug status, True or False.
|
||
|
|
:type: bool
|
||
|
|
"""
|
||
|
|
return self.__debug
|
||
|
|
|
||
|
|
@debug.setter
|
||
|
|
def debug(self, value):
|
||
|
|
"""Debug status
|
||
|
|
|
||
|
|
:param value: The debug status, True or False.
|
||
|
|
:type: bool
|
||
|
|
"""
|
||
|
|
self.__debug = value
|
||
|
|
if self.__debug:
|
||
|
|
# if debug status is True, turn on debug logging
|
||
|
|
for _, logger in self.logger.items():
|
||
|
|
logger.setLevel(logging.DEBUG)
|
||
|
|
# turn on http_client debug
|
||
|
|
http_client.HTTPConnection.debuglevel = 1
|
||
|
|
else:
|
||
|
|
# if debug status is False, turn off debug logging,
|
||
|
|
# setting log level to default `logging.WARNING`
|
||
|
|
for _, logger in self.logger.items():
|
||
|
|
logger.setLevel(logging.WARNING)
|
||
|
|
# turn off http_client debug
|
||
|
|
http_client.HTTPConnection.debuglevel = 0
|
||
|
|
|
||
|
|
@property
|
||
|
|
def logger_format(self):
|
||
|
|
"""The logger format.
|
||
|
|
|
||
|
|
The logger_formatter will be updated when sets logger_format.
|
||
|
|
|
||
|
|
:param value: The format string.
|
||
|
|
:type: str
|
||
|
|
"""
|
||
|
|
return self.__logger_format
|
||
|
|
|
||
|
|
@logger_format.setter
|
||
|
|
def logger_format(self, value):
|
||
|
|
"""The logger format.
|
||
|
|
|
||
|
|
The logger_formatter will be updated when sets logger_format.
|
||
|
|
|
||
|
|
:param value: The format string.
|
||
|
|
:type: str
|
||
|
|
"""
|
||
|
|
self.__logger_format = value
|
||
|
|
self.logger_formatter = logging.Formatter(self.__logger_format)
|
||
|
|
|
||
|
|
def get_api_key_with_prefix(self, identifier: str, *,
|
||
|
|
alias: typing.Optional[str] = None
|
||
|
|
) -> typing.Optional[str]:
|
||
|
|
"""Gets API key (with prefix if set).
|
||
|
|
|
||
|
|
:param identifier: The identifier of apiKey.
|
||
|
|
:param alias: The alternative identifier of apiKey.
|
||
|
|
:return: The token for api key authentication.
|
||
|
|
"""
|
||
|
|
if self.refresh_api_key_hook is not None:
|
||
|
|
self.refresh_api_key_hook(self)
|
||
|
|
key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None)
|
||
|
|
if key:
|
||
|
|
prefix = self.api_key_prefix.get(identifier)
|
||
|
|
if prefix:
|
||
|
|
return "%s %s" % (prefix, key)
|
||
|
|
else:
|
||
|
|
return key
|
||
|
|
|
||
|
|
def get_basic_auth_token(self):
|
||
|
|
"""Gets HTTP basic authentication header (string).
|
||
|
|
|
||
|
|
:return: The token for basic HTTP authentication.
|
||
|
|
"""
|
||
|
|
username = ""
|
||
|
|
if self.username is not None:
|
||
|
|
username = self.username
|
||
|
|
password = ""
|
||
|
|
if self.password is not None:
|
||
|
|
password = self.password
|
||
|
|
return urllib3.util.make_headers(
|
||
|
|
basic_auth=username + ':' + password
|
||
|
|
).get('authorization')
|
||
|
|
|
||
|
|
def auth_settings(self):
|
||
|
|
"""Gets Auth Settings dict for api client.
|
||
|
|
|
||
|
|
:return: The Auth Settings information dict.
|
||
|
|
"""
|
||
|
|
auth = {}
|
||
|
|
{{#authMethods}}
|
||
|
|
{{#isApiKey}}
|
||
|
|
if '{{name}}' in self.api_key{{#vendorExtensions.x-auth-id-alias}} or '{{.}}' in self.api_key{{/vendorExtensions.x-auth-id-alias}}:
|
||
|
|
auth['{{name}}'] = {
|
||
|
|
'type': 'api_key',
|
||
|
|
'in': {{#isKeyInCookie}}'cookie'{{/isKeyInCookie}}{{#isKeyInHeader}}'header'{{/isKeyInHeader}}{{#isKeyInQuery}}'query'{{/isKeyInQuery}},
|
||
|
|
'key': '{{keyParamName}}',
|
||
|
|
'value': self.get_api_key_with_prefix(
|
||
|
|
'{{name}}',{{#vendorExtensions.x-auth-id-alias}}
|
||
|
|
alias='{{.}}',{{/vendorExtensions.x-auth-id-alias}}
|
||
|
|
),
|
||
|
|
}
|
||
|
|
{{/isApiKey}}
|
||
|
|
{{#isBasic}}
|
||
|
|
{{#isBasicBasic}}
|
||
|
|
if self.username is not None and self.password is not None:
|
||
|
|
auth['{{name}}'] = {
|
||
|
|
'type': 'basic',
|
||
|
|
'in': 'header',
|
||
|
|
'key': 'Authorization',
|
||
|
|
'value': self.get_basic_auth_token()
|
||
|
|
}
|
||
|
|
{{/isBasicBasic}}
|
||
|
|
{{#isBasicBearer}}
|
||
|
|
if self.access_token is not None:
|
||
|
|
auth['{{name}}'] = {
|
||
|
|
'type': 'bearer',
|
||
|
|
'in': 'header',
|
||
|
|
{{#bearerFormat}}
|
||
|
|
'format': '{{{.}}}',
|
||
|
|
{{/bearerFormat}}
|
||
|
|
'key': 'Authorization',
|
||
|
|
'value': 'Bearer ' + self.access_token
|
||
|
|
}
|
||
|
|
{{/isBasicBearer}}
|
||
|
|
{{#isHttpSignature}}
|
||
|
|
if self.signing_info is not None:
|
||
|
|
auth['{{name}}'] = {
|
||
|
|
'type': 'http-signature',
|
||
|
|
'in': 'header',
|
||
|
|
'key': 'Authorization',
|
||
|
|
'value': None # Signature headers are calculated for every HTTP request
|
||
|
|
}
|
||
|
|
{{/isHttpSignature}}
|
||
|
|
{{/isBasic}}
|
||
|
|
{{#isOAuth}}
|
||
|
|
if self.access_token is not None:
|
||
|
|
auth['{{name}}'] = {
|
||
|
|
'type': 'oauth2',
|
||
|
|
'in': 'header',
|
||
|
|
'key': 'Authorization',
|
||
|
|
'value': 'Bearer ' + self.access_token
|
||
|
|
}
|
||
|
|
{{/isOAuth}}
|
||
|
|
{{/authMethods}}
|
||
|
|
|
||
|
|
if 'csrfAuth' in auth and 'csrfHeaderAuth' not in auth:
|
||
|
|
# Copy 'csrfAuth' into 'csrfHeaderAuth' by default
|
||
|
|
auth['csrfHeaderAuth'] = {
|
||
|
|
'type': 'api_key',
|
||
|
|
'in': 'header',
|
||
|
|
'key': 'X-CSRFToken',
|
||
|
|
'value': auth['csrfAuth']['value'],
|
||
|
|
}
|
||
|
|
|
||
|
|
return auth
|
||
|
|
|
||
|
|
def to_debug_report(self):
|
||
|
|
"""Gets the essential information for debugging.
|
||
|
|
|
||
|
|
:return: The report for debugging.
|
||
|
|
"""
|
||
|
|
return "Python SDK Debug Report:\n"\
|
||
|
|
"OS: {env}\n"\
|
||
|
|
"Python Version: {pyversion}\n"\
|
||
|
|
"Version of the API: {{version}}\n"\
|
||
|
|
"SDK Package Version: {{packageVersion}}".\
|
||
|
|
format(env=sys.platform, pyversion=sys.version)
|
||
|
|
|
||
|
|
def get_host_settings(self):
|
||
|
|
"""Gets an array of host settings
|
||
|
|
|
||
|
|
:return: An array of host settings
|
||
|
|
"""
|
||
|
|
return [
|
||
|
|
{{#servers}}
|
||
|
|
{
|
||
|
|
'url': "{{{url}}}",
|
||
|
|
'description': "{{{description}}}{{^description}}No description provided{{/description}}",
|
||
|
|
{{#variables}}
|
||
|
|
{{#-first}}
|
||
|
|
'variables': {
|
||
|
|
{{/-first}}
|
||
|
|
'{{{name}}}': {
|
||
|
|
'description': "{{{description}}}{{^description}}No description provided{{/description}}",
|
||
|
|
'default_value': "{{{defaultValue}}}",
|
||
|
|
{{#enumValues}}
|
||
|
|
{{#-first}}
|
||
|
|
'enum_values': [
|
||
|
|
{{/-first}}
|
||
|
|
"{{{.}}}"{{^-last}},{{/-last}}
|
||
|
|
{{#-last}}
|
||
|
|
]
|
||
|
|
{{/-last}}
|
||
|
|
{{/enumValues}}
|
||
|
|
}{{^-last}},{{/-last}}
|
||
|
|
{{#-last}}
|
||
|
|
}
|
||
|
|
{{/-last}}
|
||
|
|
{{/variables}}
|
||
|
|
}{{^-last}},{{/-last}}
|
||
|
|
{{/servers}}
|
||
|
|
]
|
||
|
|
|
||
|
|
def get_host_from_settings(self, index, variables=None, servers=None):
|
||
|
|
"""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
|
||
|
|
:param servers: an array of host settings or None
|
||
|
|
:return: URL based on host settings
|
||
|
|
"""
|
||
|
|
if index is None:
|
||
|
|
return self._base_path
|
||
|
|
|
||
|
|
variables = {} if variables is None else variables
|
||
|
|
servers = self.get_host_settings() if servers is None else servers
|
||
|
|
|
||
|
|
try:
|
||
|
|
server = servers[index]
|
||
|
|
except IndexError:
|
||
|
|
raise ValueError(
|
||
|
|
"Invalid index {0} when selecting the host settings. "
|
||
|
|
"Must be less than {1}".format(index, len(servers)))
|
||
|
|
|
||
|
|
url = server['url']
|
||
|
|
|
||
|
|
# go through variables and replace placeholders
|
||
|
|
for variable_name, variable in server.get('variables', {}).items():
|
||
|
|
used_value = variables.get(
|
||
|
|
variable_name, variable['default_value'])
|
||
|
|
|
||
|
|
if 'enum_values' in variable \
|
||
|
|
and used_value not in variable['enum_values']:
|
||
|
|
raise ValueError(
|
||
|
|
"The variable `{0}` in the host URL has invalid value "
|
||
|
|
"{1}. Must be {2}.".format(
|
||
|
|
variable_name, variables[variable_name],
|
||
|
|
variable['enum_values']))
|
||
|
|
|
||
|
|
url = url.replace("{" + variable_name + "}", used_value)
|
||
|
|
|
||
|
|
return url
|
||
|
|
|
||
|
|
@property
|
||
|
|
def host(self):
|
||
|
|
"""Return generated host."""
|
||
|
|
return self.get_host_from_settings(self.server_index, variables=self.server_variables)
|
||
|
|
|
||
|
|
@host.setter
|
||
|
|
def host(self, value):
|
||
|
|
"""Fix base path."""
|
||
|
|
self._base_path = value
|
||
|
|
self.server_index = None
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def _fix_host_url(url):
|
||
|
|
url = url.rstrip("/")
|
||
|
|
|
||
|
|
if not (url.startswith("http://") or url.startswith("https://")):
|
||
|
|
url = "http://" + url
|
||
|
|
|
||
|
|
return url
|