Your advanced code editor is loading.

Please wait a moment.

#editor-loading { display: none; }

””” Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: release-1.31 Generated by: https://openapi-generator.tech

””“

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 Configuration(object): “”“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.
          :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 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:
          
          The OpenAPI document is incomplete, i.e. it does not match the server
          implementation.
          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.
          
          :Example:
          API Key Authentication Example.
          Given the following security scheme in the OpenAPI specification:
          components:
          securitySchemes:
          cookieAuth:         # name for the security scheme
          type: apiKey
          in: cookie
          name: JSESSIONID  # cookie name
          You can programmatically set the cookie:
          conf = client.Configuration(
          api_key={'cookieAuth': 'abc123'}
          api_key_prefix={'cookieAuth': 'JSESSIONID'}
          )
          The following cookie will be added to the HTTP request:
          Cookie: JSESSIONID abc123
          """
          _default = None
          def init(self, host="http://localhost",
          api_key=None, api_key_prefix=None,
          username=None, password=None,
          discard_unknown_keys=False,
          ):
          """Constructor
          """
          self.host = host
          """Default Base url
          """
          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.discard_unknown_keys = discard_unknown_keys
          self.logger = {}
          """Logging Settings
          """
          self.logger["package_logger"] = logging.getLogger("client")
          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 = None
          """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.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.
          """
          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
          """
          Disable client side validation
          self.client_side_validation = True
          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
          @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 six.iteritems(self.logger):
          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 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
          @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):
          “”“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 is not None:
          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
          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 = {}
          if ‘authorization’ in self.api_key:
          auth[‘BearerToken’] = {
          ‘type’: ‘api_key’,
          ‘in’: ‘header’,
          ‘key’: ‘authorization’,
          ‘value’: self.get_api_key_with_prefix(‘authorization’)
          }
          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: release-1.31\n”
           “SDK Package Version: 31.0.0+snapshot”.
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):
          “”“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
          :return: URL based on host settings
          “””
          variables = {} if variables is None else variables
          servers = self.get_host_settings()
          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[‘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

Explanation

This code defines a Configuration class, responsible for managing various configuration settings related to interacting with a Kubernetes API. Here’s a breakdown:

Core Configuration Properties:

host: The base URL of the Kubernetes API server. Defaults to http://localhost.
api_key: A dictionary storing API key values. The keys of this dictionary correspond to security scheme names defined in the OpenAPI specification, and the values are the secret API key strings.
api_key_prefix: A dictionary for storing API key prefixes (like “Bearer”). Similar structure to api_key, but stores prefixes instead of keys.
username & password: Used for basic HTTP authentication.
discard_unknown_keys: A boolean flag controlling whether to discard unknown properties received from the API server. This helps handle situations where the OpenAPI specification doesn’t fully match the server implementation.
temp_folder_path: Specifies a folder for storing temporary files, useful for downloading files from the API.

Logging Configuration:

logger: A dictionary storing logging objects. This allows fine-grained logging control for different components of the code.
logger_format: Sets the format of log messages.
logger_stream_handler: Handles log output to the console.
logger_file_handler: Handles log output to a file, controlled by the logger_file property.
logger_file: Specifies the path of the log file.

HTTP Client Settings:

verify_ssl: Controls whether SSL/TLS certificate verification is enabled. Set to False to disable verification.
ssl_ca_cert: Allows customizing the CA certificate used for verifying the server’s certificate.
cert_file & key_file: Specify client certificate and key files for client-side SSL authentication.
assert_hostname: Enables/disables hostname verification during SSL handshakes.
tls_server_name: Allows setting the SNI (Server Name Indication) value for TLS connections.
connection_pool_maxsize: Controls the maximum number of connections in urllib3’s connection pool.
proxy: Sets a proxy URL for HTTP requests.
no_proxy: Specifies a list of hosts to exclude from using the proxy.
proxy_headers: Adds custom headers to requests going through the proxy.
safe_chars_for_path_param: Specifies characters considered safe for use in URL path parameters.
retries: Overrides the default retry count for urllib3 requests.

API Key Management:

get_api_key_with_prefix: Fetches an API key (and its prefix) from the api_key and api_key_prefix dictionaries based on the provided identifier.
get_basic_auth_token: Constructs the HTTP Basic authentication header.
auth_settings: Returns a dictionary describing the authentication settings for the API client.

Utility Methods:

to_debug_report: Returns a string with essential debugging information about the Python SDK.
get_host_settings: Provides an array of host settings (likely used for selecting different API endpoints).
get_host_from_settings: Constructs a complete host URL based on the given index in the host settings and any provided variables.

Key Considerations:

Default Configuration: The class provides methods for setting a default configuration (using set_default) and retrieving a copy of it (using get_default_copy). This is useful for standardizing settings across multiple instances of the client.
Logging: The class offers flexible logging control, allowing developers to configure log levels, formats, and output destinations.
API Key Management: The class provides mechanisms for storing, retrieving, and prefixing API keys.
HTTP Client Customization: The class allows for extensive customization of HTTP client behavior, including SSL configuration, proxy settings, retry policies, and connection pooling.

The Configuration class provides a comprehensive framework for configuring the Kubernetes Python client. By properly utilizing its features, developers can streamline the process of interacting with the Kubernetes API and tailor the client’s behavior to suit their specific needs.

Your advanced code editor is loading.

Please wait a moment.

Explanation

Graph

Symbols

We couldn't identify any entrypoints. If you believe this to be incorrect then please contact support.