Inheritance diagram for cFSPlib.python_api_client.swagger_client.configuration.Configuration:

Collaboration diagram for cFSPlib.python_api_client.swagger_client.configuration.Configuration:

Public Member Functions
def	__init__ (self)

def	logger_file (self)

def	logger_file (self, value)

def	debug (self)

def	debug (self, value)

def	logger_format (self)

def	logger_format (self, value)

def	get_api_key_with_prefix (self, identifier)

def	get_basic_auth_token (self)

def	auth_settings (self)

def	to_debug_report (self)

Public Member Functions inherited from cFSPlib.python_api_client.swagger_client.configuration.TypeWithDefault
def	__init__ (cls, name, bases, dct)

def	__call__ (cls)

def	set_default (cls, default)

Detailed Description

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.

Definition at line 39 of file configuration.py.

Constructor & Destructor Documentation

◆ init()

def cFSPlib.python_api_client.swagger_client.configuration.Configuration.__init__ ( self )

Constructor

Definition at line 46 of file configuration.py.

     def __init__(self):
         """Constructor"""
         # Default Base url
         self.host = "/"
         # Temp file folder for downloading files
         self.temp_folder_path = None
  
         # Authentication Settings
         # dict to store API key(s)
         self.api_key = {}
         # dict to store API prefix (e.g. Bearer)
         self.api_key_prefix = {}
         # function to refresh API key if expired
         self.refresh_api_key_hook = None
         # Username for HTTP basic authentication
         self.username = ""
         # Password for HTTP basic authentication
         self.password = ""
         # Logging Settings
         self.logger = {}
         self.logger["package_logger"] = logging.getLogger("swagger_client")
         self.logger["urllib3_logger"] = logging.getLogger("urllib3")
         # Log format
         self.logger_format = '%(asctime)s %(levelname)s %(message)s'
         # Log stream handler
         self.logger_stream_handler = None
         # Log file handler
         self.logger_file_handler = None
         # Debug file location
         self.logger_file = None
         # Debug switch
         self.debug = False
  
         # SSL/TLS verification
         # Set this to false to skip verifying SSL certificate when calling API
         # from https server.
         self.verify_ssl = True
         # Set this to customize the certificate file to verify the peer.
         self.ssl_ca_cert = None
         # client certificate file
         self.cert_file = None
         # client key file
         self.key_file = None
         # Set this to True/False to enable/disable SSL hostname verification.
         self.assert_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_maxsize = multiprocessing.cpu_count() * 5
  
         # Proxy URL
         self.proxy = None
         # Safe chars for path_param
         self.safe_chars_for_path_param = ''
  

Member Function Documentation

◆ auth_settings()

def cFSPlib.python_api_client.swagger_client.configuration.Configuration.auth_settings ( self )

Gets Auth Settings dict for api client.

:return: The Auth Settings information dict.

Definition at line 226 of file configuration.py.

     def auth_settings(self):
         """Gets Auth Settings dict for api client.
  
         :return: The Auth Settings information dict.
         """
         return {
         }
  

◆ debug() [1/2]

def cFSPlib.python_api_client.swagger_client.configuration.Configuration.debug ( self )

Debug status

:param value: The debug status, True or False.
:type: bool

Definition at line 147 of file configuration.py.

     def debug(self):
         """Debug status
  
         :param value: The debug status, True or False.
         :type: bool
         """
         return self.__debug
  

◆ debug() [2/2]

def cFSPlib.python_api_client.swagger_client.configuration.Configuration.debug	(	self,
		value
	)

Debug status

:param value: The debug status, True or False.
:type: bool

Definition at line 156 of file configuration.py.

     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 six.iteritems(self.logger):
                 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.logger):
                 logger.setLevel(logging.WARNING)
             # turn off httplib debug
             httplib.HTTPConnection.debuglevel = 0
  

◆ get_api_key_with_prefix()

def cFSPlib.python_api_client.swagger_client.configuration.Configuration.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.

Definition at line 200 of file configuration.py.

     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_hook:
             self.refresh_api_key_hook(self)
  
         key = self.api_key.get(identifier)
         if key:
             prefix = self.api_key_prefix.get(identifier)
             if prefix:
                 return "%s %s" % (prefix, key)
             else:
                 return key
  

◆ get_basic_auth_token()

def cFSPlib.python_api_client.swagger_client.configuration.Configuration.get_basic_auth_token ( self )

Gets HTTP basic authentication header (string).

:return: The token for basic HTTP authentication.

Definition at line 217 of file configuration.py.

     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.username + ':' + self.password
         ).get('authorization')
  

◆ logger_file() [1/2]

def cFSPlib.python_api_client.swagger_client.configuration.Configuration.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

Definition at line 105 of file configuration.py.

     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() [2/2]

def cFSPlib.python_api_client.swagger_client.configuration.Configuration.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

Definition at line 117 of file configuration.py.

     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 six.iteritems(self.logger):
                 logger.addHandler(self.logger_file_handler)
                 if self.logger_stream_handler:
                     logger.removeHandler(self.logger_stream_handler)
         else:
             # If not set logging file,
             # then add stream handler and remove file handler.
             self.logger_stream_handler = logging.StreamHandler()
             self.logger_stream_handler.setFormatter(self.logger_formatter)
             for _, logger in six.iteritems(self.logger):
                 logger.addHandler(self.logger_stream_handler)
                 if self.logger_file_handler:
                     logger.removeHandler(self.logger_file_handler)
  

◆ logger_format() [1/2]

def cFSPlib.python_api_client.swagger_client.configuration.Configuration.logger_format ( self )

The logger format.

The logger_formatter will be updated when sets logger_format.

:param value: The format string.
:type: str

Definition at line 178 of file configuration.py.

     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() [2/2]

def cFSPlib.python_api_client.swagger_client.configuration.Configuration.logger_format	(	self,
		value
	)

The logger format.

The logger_formatter will be updated when sets logger_format.

:param value: The format string.
:type: str

Definition at line 189 of file configuration.py.

     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)
  

◆ to_debug_report()

def cFSPlib.python_api_client.swagger_client.configuration.Configuration.to_debug_report ( self )

Gets the essential information for debugging.

:return: The report for debugging.

Definition at line 234 of file 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: 0.8\n"\
                "SDK Package Version: 1.0.0".\
                format(env=sys.platform, pyversion=sys.version)

Member Data Documentation

◆ api_key

cFSPlib.python_api_client.swagger_client.configuration.Configuration.api_key

Definition at line 55 of file configuration.py.

◆ api_key_prefix

cFSPlib.python_api_client.swagger_client.configuration.Configuration.api_key_prefix

Definition at line 57 of file configuration.py.

◆ assert_hostname

cFSPlib.python_api_client.swagger_client.configuration.Configuration.assert_hostname

Definition at line 90 of file configuration.py.

◆ cert_file

cFSPlib.python_api_client.swagger_client.configuration.Configuration.cert_file

Definition at line 86 of file configuration.py.

◆ connection_pool_maxsize

cFSPlib.python_api_client.swagger_client.configuration.Configuration.connection_pool_maxsize

Definition at line 97 of file configuration.py.

◆ debug

cFSPlib.python_api_client.swagger_client.configuration.Configuration.debug

Definition at line 77 of file configuration.py.

◆ host

cFSPlib.python_api_client.swagger_client.configuration.Configuration.host

Definition at line 49 of file configuration.py.

◆ key_file

cFSPlib.python_api_client.swagger_client.configuration.Configuration.key_file

Definition at line 88 of file configuration.py.

◆ logger

cFSPlib.python_api_client.swagger_client.configuration.Configuration.logger

Definition at line 65 of file configuration.py.

◆ logger_file

cFSPlib.python_api_client.swagger_client.configuration.Configuration.logger_file

Definition at line 75 of file configuration.py.

◆ logger_file_handler

cFSPlib.python_api_client.swagger_client.configuration.Configuration.logger_file_handler

Definition at line 73 of file configuration.py.

◆ logger_format

cFSPlib.python_api_client.swagger_client.configuration.Configuration.logger_format

Definition at line 69 of file configuration.py.

◆ logger_formatter

cFSPlib.python_api_client.swagger_client.configuration.Configuration.logger_formatter

Definition at line 198 of file configuration.py.

◆ logger_stream_handler

cFSPlib.python_api_client.swagger_client.configuration.Configuration.logger_stream_handler

Definition at line 71 of file configuration.py.

◆ password

cFSPlib.python_api_client.swagger_client.configuration.Configuration.password

Definition at line 63 of file configuration.py.

◆ proxy

cFSPlib.python_api_client.swagger_client.configuration.Configuration.proxy

Definition at line 100 of file configuration.py.

◆ refresh_api_key_hook

cFSPlib.python_api_client.swagger_client.configuration.Configuration.refresh_api_key_hook

Definition at line 59 of file configuration.py.

◆ safe_chars_for_path_param

cFSPlib.python_api_client.swagger_client.configuration.Configuration.safe_chars_for_path_param

Definition at line 102 of file configuration.py.

◆ ssl_ca_cert

cFSPlib.python_api_client.swagger_client.configuration.Configuration.ssl_ca_cert

Definition at line 84 of file configuration.py.

◆ temp_folder_path

cFSPlib.python_api_client.swagger_client.configuration.Configuration.temp_folder_path

Definition at line 51 of file configuration.py.

◆ username

cFSPlib.python_api_client.swagger_client.configuration.Configuration.username

Definition at line 61 of file configuration.py.

◆ verify_ssl

cFSPlib.python_api_client.swagger_client.configuration.Configuration.verify_ssl

Definition at line 82 of file configuration.py.

The documentation for this class was generated from the following file:

repos_for_Dox/cFSP/cFSPlib/python_api_client/swagger_client/configuration.py

Public Attributes
	host

	temp_folder_path

	api_key

	api_key_prefix

	refresh_api_key_hook

	username

	password

	logger

	logger_format

	logger_stream_handler

	logger_file_handler

	logger_file

	debug

	verify_ssl

	ssl_ca_cert

	cert_file

	key_file

	assert_hostname

	connection_pool_maxsize

	proxy

	safe_chars_for_path_param

	logger_formatter

Public Member Functions

Public Attributes