configuration

😸 Cheshire-Cat API

Production ready AI assistant framework

The version of the OpenAPI document: 1.3.1 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

Configuration

This class contains various settings of the API client.

Parameters:

Name	Type	Description	Default
host		Base url.	None
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.	None
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.	None
username		Username for HTTP basic authentication.	None
password		Password for HTTP basic authentication.	None
access_token		Access token.	None
server_index		Index to servers configuration.	None
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.	None
server_operation_index		Mapping from operation ID to an index to server configuration.	None
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.	None
ssl_ca_cert		str - the path to a file of concatenated CA certificates in PEM format.	None

Source code in cheshire_cat_api/configuration.py

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

    :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.
    :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.
    :param username: Username for HTTP basic authentication.
    :param password: Password for HTTP basic authentication.
    :param access_token: Access token.
    :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: str - the path to a file of concatenated CA certificates
      in PEM format.

    """

    _default = None

    def __init__(self, host=None,
                 api_key=None, api_key_prefix=None,
                 username=None, password=None,
                 access_token=None,
                 server_index=None, server_variables=None,
                 server_operation_index=None, server_operation_variables=None,
                 ssl_ca_cert=None,
                 ) -> None:
        """Constructor
        """
        self._base_path = "http://localhost" 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
        self.server_operation_index = server_operation_index or {}
        """Default server index
        """
        self.server_variables = server_variables or {}
        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.api_key = {}
        if api_key:
            self.api_key = api_key
        """dict to store API key(s)
        """
        self.api_key_prefix = {}
        if api_key_prefix:
            self.api_key_prefix = api_key_prefix
        """dict to store API prefix (e.g. Bearer)
        """
        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.access_token = access_token
        """Access token
        """
        self.logger = {}
        """Logging Settings
        """
        self.logger["package_logger"] = logging.getLogger("cheshire_cat_api")
        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 = 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.
        """
        self.tls_server_name = None
        """SSL/TLS Server Name Indication (SNI)
           Set this to the SNI value expected by the server.
        """


        self.proxy = None
        """Proxy URL
        """
        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

        self.socket_options = None
        """Options to pass down to the underlying urllib3 socket
        """

        self.datetime_format = "%Y-%m-%dT%H:%M:%S.%f%z"
        """datetime format
        """

        self.date_format = "%Y-%m-%d"
        """date format
        """

    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)

    @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 = default

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

        Deprecated. Please use `get_default` instead.

        :return: The configuration object.
        """
        return cls.get_default()

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

        This method returns newly created, based on default constructor,
        object of Configuration class or returns a copy of default
        configuration.

        :return: The configuration object.
        """
        if cls._default is None:
            cls._default = Configuration()
        return cls._default

    @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 httplib debug
            httplib.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 httplib debug
            httplib.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, alias=None):
        """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 = {}
        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: 1.3.1\n"\
               "SDK Package Version: 1.0.0".\
               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 [
            {
                'url': "",
                'description': "No description provided",
            }
        ]

    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

access_token = access_token instance-attribute

Access token

assert_hostname = None instance-attribute

Set this to True/False to enable/disable SSL hostname verification.

cert_file = None instance-attribute

client certificate file

date_format = '%Y-%m-%d' instance-attribute

date format

datetime_format = '%Y-%m-%dT%H:%M:%S.%f%z' instance-attribute

datetime format

debug property writable

Debug status

Parameters:

Name	Type	Description	Default
value		The debug status, True or False.	required

host property writable

Return generated host.

key_file = None instance-attribute

client key file

logger = {} instance-attribute

Logging Settings

logger_file property writable

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.

Parameters:

Name	Type	Description	Default
value		The logger_file path.	required

logger_file_handler = None instance-attribute

Log file handler

logger_format property writable

The logger format.

The logger_formatter will be updated when sets logger_format.

Parameters:

Name	Type	Description	Default
value		The format string.	required

logger_stream_handler = None instance-attribute

Log stream handler

password = password instance-attribute

Password for HTTP basic authentication

proxy = None instance-attribute

Proxy URL

proxy_headers = None instance-attribute

Proxy headers

refresh_api_key_hook = None instance-attribute

function hook to refresh API key if expired

retries = None instance-attribute

Adding retries to override urllib3 default value 3

safe_chars_for_path_param = '' instance-attribute

Safe chars for path_param

server_operation_index = server_operation_index or {} instance-attribute

Default server index

server_operation_variables = server_operation_variables or {} instance-attribute

Default server variables

socket_options = None instance-attribute

Options to pass down to the underlying urllib3 socket

ssl_ca_cert = ssl_ca_cert instance-attribute

Set this to customize the certificate file to verify the peer.

temp_folder_path = None instance-attribute

Temp file folder for downloading files

tls_server_name = None instance-attribute

SSL/TLS Server Name Indication (SNI) Set this to the SNI value expected by the server.

username = username instance-attribute

Username for HTTP basic authentication

verify_ssl = True instance-attribute

SSL/TLS verification Set this to false to skip verifying SSL certificate when calling API from https server.

__init__(host=None, api_key=None, api_key_prefix=None, username=None, password=None, access_token=None, server_index=None, server_variables=None, server_operation_index=None, server_operation_variables=None, ssl_ca_cert=None)

Constructor

Source code in cheshire_cat_api/configuration.py

def __init__(self, host=None,
             api_key=None, api_key_prefix=None,
             username=None, password=None,
             access_token=None,
             server_index=None, server_variables=None,
             server_operation_index=None, server_operation_variables=None,
             ssl_ca_cert=None,
             ) -> None:
    """Constructor
    """
    self._base_path = "http://localhost" 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
    self.server_operation_index = server_operation_index or {}
    """Default server index
    """
    self.server_variables = server_variables or {}
    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.api_key = {}
    if api_key:
        self.api_key = api_key
    """dict to store API key(s)
    """
    self.api_key_prefix = {}
    if api_key_prefix:
        self.api_key_prefix = api_key_prefix
    """dict to store API prefix (e.g. Bearer)
    """
    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.access_token = access_token
    """Access token
    """
    self.logger = {}
    """Logging Settings
    """
    self.logger["package_logger"] = logging.getLogger("cheshire_cat_api")
    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 = 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.
    """
    self.tls_server_name = None
    """SSL/TLS Server Name Indication (SNI)
       Set this to the SNI value expected by the server.
    """


    self.proxy = None
    """Proxy URL
    """
    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

    self.socket_options = None
    """Options to pass down to the underlying urllib3 socket
    """

    self.datetime_format = "%Y-%m-%dT%H:%M:%S.%f%z"
    """datetime format
    """

    self.date_format = "%Y-%m-%d"
    """date format
    """

auth_settings()

Gets Auth Settings dict for api client.

Returns:

Type	Description
	The Auth Settings information dict.

Source code in cheshire_cat_api/configuration.py

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

    :return: The Auth Settings information dict.
    """
    auth = {}
    return auth

get_api_key_with_prefix(identifier, alias=None)

Gets API key (with prefix if set).

Parameters:

Name	Type	Description	Default
identifier		The identifier of apiKey.	required
alias		The alternative identifier of apiKey.	None

Returns:

Type	Description
	The token for api key authentication.

Source code in cheshire_cat_api/configuration.py

def get_api_key_with_prefix(self, identifier, alias=None):
    """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

get_basic_auth_token()

Gets HTTP basic authentication header (string).

Returns:

Type	Description
	The token for basic HTTP authentication.

Source code in cheshire_cat_api/configuration.py

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')

get_default() classmethod

Return the default configuration.

This method returns newly created, based on default constructor, object of Configuration class or returns a copy of default configuration.

Returns:

Type	Description
	The configuration object.

Source code in cheshire_cat_api/configuration.py

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

    This method returns newly created, based on default constructor,
    object of Configuration class or returns a copy of default
    configuration.

    :return: The configuration object.
    """
    if cls._default is None:
        cls._default = Configuration()
    return cls._default

get_default_copy() classmethod

Deprecated. Please use get_default instead.

Deprecated. Please use get_default instead.

Returns:

Type	Description
	The configuration object.

Source code in cheshire_cat_api/configuration.py

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

    Deprecated. Please use `get_default` instead.

    :return: The configuration object.
    """
    return cls.get_default()

get_host_from_settings(index, variables=None, servers=None)

Gets host URL based on the index and variables

Parameters:

Name	Type	Description	Default
index		array index of the host settings	required
variables		hash of variable and the corresponding value	None
servers		an array of host settings or None	None

Returns:

Type	Description
	URL based on host settings

Source code in cheshire_cat_api/configuration.py

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

get_host_settings()

Gets an array of host settings

Returns:

Type	Description
	An array of host settings

Source code in cheshire_cat_api/configuration.py

def get_host_settings(self):
    """Gets an array of host settings

    :return: An array of host settings
    """
    return [
        {
            'url': "",
            'description': "No description provided",
        }
    ]

set_default(default) classmethod

Set default instance of configuration.

It stores default configuration, which can be returned by get_default_copy method.

Parameters:

Name	Type	Description	Default
default		object of Configuration	required

Source code in cheshire_cat_api/configuration.py

@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 = default

to_debug_report()

Gets the essential information for debugging.

Returns:

Type	Description
	The report for debugging.

Source code in cheshire_cat_api/configuration.py

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: 1.3.1\n"\
           "SDK Package Version: 1.0.0".\
           format(env=sys.platform, pyversion=sys.version)