configuration.py

Go to the documentation of this file.

# coding: utf-8
 
"""
    cloudFPGA Resource Manager API
 
    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
 
    OpenAPI spec version: 0.8
    
    Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
 
from __future__ import absolute_import
 
import copy
import logging
import multiprocessing
import sys
import urllib3
 
import six
from six.moves import http_client as httplib
 
 
class TypeWithDefault(type):
    def __init__(cls, name, bases, dct):
        super(TypeWithDefault, cls).__init__(name, bases, dct)
        cls._default_default = None
 
    def __call__(cls):
        if cls._default_default is None:
            cls._default_default = type.__call__(cls)
        return copy.copy(cls._default_default)
 
    def set_default(cls, default):
        cls._default_default = copy.copy(default)
 
 
class Configuration(six.with_metaclass(TypeWithDefault, object)):
    """NOTE: This class is auto generated by the swagger code generator program.
 
    Ref: https://github.com/swagger-api/swagger-codegen
    Do not edit the class manually.
    """
 
    def __init__(self):
        """Constructor"""
        # Default Base url
        self.hosthost = "/"
        # Temp file folder for downloading files
        self.temp_folder_pathtemp_folder_path = None
 
        # Authentication Settings
        # dict to store API key(s)
        self.api_keyapi_key = {}
        # dict to store API prefix (e.g. Bearer)
        self.api_key_prefixapi_key_prefix = {}
        # function to refresh API key if expired
        self.refresh_api_key_hookrefresh_api_key_hook = None
        # Username for HTTP basic authentication
        self.usernameusername = ""
        # Password for HTTP basic authentication
        self.passwordpassword = ""
        # Logging Settings
        self.loggerlogger = {}
        self.loggerlogger["package_logger"] = logging.getLogger("swagger_client")
        self.loggerlogger["urllib3_logger"] = logging.getLogger("urllib3")
        # Log format
        self.logger_formatlogger_formatlogger_formatlogger_format = '%(asctime)s %(levelname)s %(message)s'
        # Log stream handler
        self.logger_stream_handlerlogger_stream_handler = None
        # Log file handler
        self.logger_file_handlerlogger_file_handler = None
        # Debug file location
        self.logger_filelogger_filelogger_filelogger_file = None
        # Debug switch
        self.debugdebugdebugdebug = False
 
        # SSL/TLS verification
        # Set this to false to skip verifying SSL certificate when calling API
        # from https server.
        self.verify_sslverify_ssl = True
        # Set this to customize the certificate file to verify the peer.
        self.ssl_ca_certssl_ca_cert = None
        # client certificate file
        self.cert_filecert_file = None
        # client key file
        self.key_filekey_file = None
        # Set this to True/False to enable/disable SSL hostname verification.
        self.assert_hostnameassert_hostname = None
 
        # 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.
        self.connection_pool_maxsizeconnection_pool_maxsize = multiprocessing.cpu_count() * 5
 
        # Proxy URL
        self.proxyproxy = None
        # Safe chars for path_param
        self.safe_chars_for_path_paramsafe_chars_for_path_param = ''
 
    @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
 
    @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__logger_file = value
        if self.__logger_file__logger_file:
            # If set logging file,
            # then add file handler and remove stream handler.
            self.logger_file_handlerlogger_file_handler = logging.FileHandler(self.__logger_file__logger_file)
            self.logger_file_handlerlogger_file_handler.setFormatter(self.logger_formatterlogger_formatter)
            for _, logger in six.iteritems(self.loggerlogger):
                logger.addHandler(self.logger_file_handlerlogger_file_handler)
                if self.logger_stream_handlerlogger_stream_handler:
                    logger.removeHandler(self.logger_stream_handlerlogger_stream_handler)
        else:
            # If not set logging file,
            # then add stream handler and remove file handler.
            self.logger_stream_handlerlogger_stream_handler = logging.StreamHandler()
            self.logger_stream_handlerlogger_stream_handler.setFormatter(self.logger_formatterlogger_formatter)
            for _, logger in six.iteritems(self.loggerlogger):
                logger.addHandler(self.logger_stream_handlerlogger_stream_handler)
                if self.logger_file_handlerlogger_file_handler:
                    logger.removeHandler(self.logger_file_handlerlogger_file_handler)
 
    @property
    def debug(self):
        """Debug status
 
        :param value: The debug status, True or False.
        :type: bool
        """
        return self.__debug__debug
 
    @debug.setter
    def debug(self, value):
        """Debug status
 
        :param value: The debug status, True or False.
        :type: bool
        """
        self.__debug__debug = value
        if self.__debug__debug:
            # if debug status is True, turn on debug logging
            for _, logger in six.iteritems(self.loggerlogger):
                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 six.iteritems(self.loggerlogger):
                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
 
    @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__logger_format = value
        self.logger_formatterlogger_formatter = logging.Formatter(self.__logger_format__logger_format)
 
    def get_api_key_with_prefix(self, identifier):
        """Gets API key (with prefix if set).
 
        :param identifier: The identifier of apiKey.
        :return: The token for api key authentication.
        """
        if self.refresh_api_key_hookrefresh_api_key_hook:
            self.refresh_api_key_hookrefresh_api_key_hook(self)
 
        key = self.api_keyapi_key.get(identifier)
        if key:
            prefix = self.api_key_prefixapi_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.
        """
        return urllib3.util.make_headers(
            basic_auth=self.usernameusername + ':' + self.passwordpassword
        ).get('authorization')
 
    def auth_settings(self):
        """Gets Auth Settings dict for api client.
 
        :return: The Auth Settings information dict.
        """
        return {
        }
 
    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: 0.8\n"\
               "SDK Package Version: 1.0.0".\
               format(env=sys.platform, pyversion=sys.version)