pinecone.core.client.configuration

  1"""
  2    Pinecone API
  3
  4    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
  5
  6    The version of the OpenAPI document: version not set
  7    Contact: support@pinecone.io
  8    Generated by: https://openapi-generator.tech
  9"""
 10
 11
 12import copy
 13import logging
 14import multiprocessing
 15import sys
 16import urllib3
 17
 18from http import client as http_client
 19from pinecone.core.client.exceptions import ApiValueError
 20
 21
 22JSON_SCHEMA_VALIDATION_KEYWORDS = {
 23    "multipleOf",
 24    "maximum",
 25    "exclusiveMaximum",
 26    "minimum",
 27    "exclusiveMinimum",
 28    "maxLength",
 29    "minLength",
 30    "pattern",
 31    "maxItems",
 32    "minItems",
 33}
 34
 35
 36class Configuration(object):
 37    """NOTE: This class is auto generated by OpenAPI Generator
 38
 39        Ref: https://openapi-generator.tech
 40        Do not edit the class manually.
 41
 42        :param host: Base url
 43        :param api_key: Dict to store API key(s).
 44          Each entry in the dict specifies an API key.
 45          The dict key is the name of the security scheme in the OAS specification.
 46          The dict value is the API key secret.
 47        :param api_key_prefix: Dict to store API prefix (e.g. Bearer)
 48          The dict key is the name of the security scheme in the OAS specification.
 49          The dict value is an API key prefix when generating the auth data.
 50        :param username: Username for HTTP basic authentication
 51        :param password: Password for HTTP basic authentication
 52        :param discard_unknown_keys: Boolean value indicating whether to discard
 53          unknown properties. A server may send a response that includes additional
 54          properties that are not known by the client in the following scenarios:
 55          1. The OpenAPI document is incomplete, i.e. it does not match the server
 56             implementation.
 57          2. The client was generated using an older version of the OpenAPI document
 58             and the server has been upgraded since then.
 59          If a schema in the OpenAPI document defines the additionalProperties attribute,
 60          then all undeclared properties received by the server are injected into the
 61          additional properties map. In that case, there are undeclared properties, and
 62          nothing to discard.
 63        :param disabled_client_side_validations (string): Comma-separated list of
 64          JSON schema validation keywords to disable JSON schema structural validation
 65          rules. The following keywords may be specified: multipleOf, maximum,
 66          exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern,
 67          maxItems, minItems.
 68          By default, the validation is performed for data generated locally by the client
 69          and data received from the server, independent of any validation performed by
 70          the server side. If the input data does not satisfy the JSON schema validation
 71          rules specified in the OpenAPI document, an exception is raised.
 72          If disabled_client_side_validations is set, structural validation is
 73          disabled. This can be useful to troubleshoot data validation problem, such as
 74          when the OpenAPI document validation rules do not match the actual API data
 75          received by the server.
 76        :param server_index: Index to servers configuration.
 77        :param server_variables: Mapping with string values to replace variables in
 78          templated server configuration. The validation of enums is performed for
 79          variables with defined enum values before.
 80        :param server_operation_index: Mapping from operation ID to an index to server
 81          configuration.
 82        :param server_operation_variables: Mapping from operation ID to a mapping with
 83          string values to replace variables in templated server configuration.
 84          The validation of enums is performed for variables with defined enum values before.
 85        :param ssl_ca_cert: str - the path to a file of concatenated CA certificates
 86          in PEM format
 87
 88        :Example:
 89
 90        API Key Authentication Example.
 91        Given the following security scheme in the OpenAPI specification:
 92          components:
 93            securitySchemes:
 94              cookieAuth:         # name for the security scheme
 95                type: apiKey
 96                in: cookie
 97                name: JSESSIONID  # cookie name
 98
 99        You can programmatically set the cookie:
100
101    conf = pinecone.core.client.Configuration(
102        api_key={'cookieAuth': 'abc123'}
103        api_key_prefix={'cookieAuth': 'JSESSIONID'}
104    )
105
106        The following cookie will be added to the HTTP request:
107           Cookie: JSESSIONID abc123
108    """
109
110    _default = None
111
112    def __init__(
113        self,
114        host=None,
115        api_key=None,
116        api_key_prefix=None,
117        access_token=None,
118        username=None,
119        password=None,
120        discard_unknown_keys=False,
121        disabled_client_side_validations="",
122        server_index=None,
123        server_variables=None,
124        server_operation_index=None,
125        server_operation_variables=None,
126        ssl_ca_cert=None,
127    ):
128        """Constructor"""
129        self._base_path = "https://unknown-unknown.svc.unknown.pinecone.io" if host is None else host
130        """Default Base url
131        """
132        self.server_index = 0 if server_index is None and host is None else server_index
133        self.server_operation_index = server_operation_index or {}
134        """Default server index
135        """
136        self.server_variables = server_variables or {}
137        self.server_operation_variables = server_operation_variables or {}
138        """Default server variables
139        """
140        self.temp_folder_path = None
141        """Temp file folder for downloading files
142        """
143        # Authentication Settings
144        self.access_token = access_token
145        self.api_key = {}
146        if api_key:
147            self.api_key = api_key
148        """dict to store API key(s)
149        """
150        self.api_key_prefix = {}
151        if api_key_prefix:
152            self.api_key_prefix = api_key_prefix
153        """dict to store API prefix (e.g. Bearer)
154        """
155        self.refresh_api_key_hook = None
156        """function hook to refresh API key if expired
157        """
158        self.username = username
159        """Username for HTTP basic authentication
160        """
161        self.password = password
162        """Password for HTTP basic authentication
163        """
164        self.discard_unknown_keys = discard_unknown_keys
165        self.disabled_client_side_validations = disabled_client_side_validations
166        self.logger = {}
167        """Logging Settings
168        """
169        self.logger["package_logger"] = logging.getLogger("pinecone.core.client")
170        self.logger["urllib3_logger"] = logging.getLogger("urllib3")
171        self.logger_format = "%(asctime)s %(levelname)s %(message)s"
172        """Log format
173        """
174        self.logger_stream_handler = None
175        """Log stream handler
176        """
177        self.logger_file_handler = None
178        """Log file handler
179        """
180        self.logger_file = None
181        """Debug file location
182        """
183        self.debug = False
184        """Debug switch
185        """
186
187        self.verify_ssl = True
188        """SSL/TLS verification
189           Set this to false to skip verifying SSL certificate when calling API
190           from https server.
191        """
192        self.ssl_ca_cert = ssl_ca_cert
193        """Set this to customize the certificate file to verify the peer.
194        """
195        self.cert_file = None
196        """client certificate file
197        """
198        self.key_file = None
199        """client key file
200        """
201        self.assert_hostname = None
202        """Set this to True/False to enable/disable SSL hostname verification.
203        """
204
205        self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
206        """urllib3 connection pool's maximum number of connections saved
207           per pool. urllib3 uses 1 connection as default value, but this is
208           not the best value when you are making a lot of possibly parallel
209           requests to the same host, which is often the case here.
210           cpu_count * 5 is used as default value to increase performance.
211        """
212
213        self.proxy = None
214        """Proxy URL
215        """
216        self.proxy_headers = None
217        """Proxy headers
218        """
219        self.safe_chars_for_path_param = ""
220        """Safe chars for path_param
221        """
222        self.retries = None
223        """Adding retries to override urllib3 default value 3
224        """
225        # Enable client side validation
226        self.client_side_validation = True
227
228        # Options to pass down to the underlying urllib3 socket
229        self.socket_options = None
230
231    def __deepcopy__(self, memo):
232        cls = self.__class__
233        result = cls.__new__(cls)
234        memo[id(self)] = result
235        for k, v in self.__dict__.items():
236            if k not in ("logger", "logger_file_handler"):
237                setattr(result, k, copy.deepcopy(v, memo))
238        # shallow copy of loggers
239        result.logger = copy.copy(self.logger)
240        # use setters to configure loggers
241        result.logger_file = self.logger_file
242        result.debug = self.debug
243        return result
244
245    def __setattr__(self, name, value):
246        object.__setattr__(self, name, value)
247        if name == "disabled_client_side_validations":
248            s = set(filter(None, value.split(",")))
249            for v in s:
250                if v not in JSON_SCHEMA_VALIDATION_KEYWORDS:
251                    raise ApiValueError("Invalid keyword: '{0}''".format(v))
252            self._disabled_client_side_validations = s
253
254    @classmethod
255    def set_default(cls, default):
256        """Set default instance of configuration.
257
258        It stores default configuration, which can be
259        returned by get_default_copy method.
260
261        :param default: object of Configuration
262        """
263        cls._default = copy.deepcopy(default)
264
265    @classmethod
266    def get_default_copy(cls):
267        """Return new instance of configuration.
268
269        This method returns newly created, based on default constructor,
270        object of Configuration class or returns a copy of default
271        configuration passed by the set_default method.
272
273        :return: The configuration object.
274        """
275        if cls._default is not None:
276            return copy.deepcopy(cls._default)
277        return Configuration()
278
279    @property
280    def logger_file(self):
281        """The logger file.
282
283        If the logger_file is None, then add stream handler and remove file
284        handler. Otherwise, add file handler and remove stream handler.
285
286        :param value: The logger_file path.
287        :type: str
288        """
289        return self.__logger_file
290
291    @logger_file.setter
292    def logger_file(self, value):
293        """The logger file.
294
295        If the logger_file is None, then add stream handler and remove file
296        handler. Otherwise, add file handler and remove stream handler.
297
298        :param value: The logger_file path.
299        :type: str
300        """
301        self.__logger_file = value
302        if self.__logger_file:
303            # If set logging file,
304            # then add file handler and remove stream handler.
305            self.logger_file_handler = logging.FileHandler(self.__logger_file)
306            self.logger_file_handler.setFormatter(self.logger_formatter)
307            for _, logger in self.logger.items():
308                logger.addHandler(self.logger_file_handler)
309
310    @property
311    def debug(self):
312        """Debug status
313
314        :param value: The debug status, True or False.
315        :type: bool
316        """
317        return self.__debug
318
319    @debug.setter
320    def debug(self, value):
321        """Debug status
322
323        :param value: The debug status, True or False.
324        :type: bool
325        """
326        self.__debug = value
327        if self.__debug:
328            # if debug status is True, turn on debug logging
329            for _, logger in self.logger.items():
330                logger.setLevel(logging.DEBUG)
331            # turn on http_client debug
332            http_client.HTTPConnection.debuglevel = 1
333        else:
334            # if debug status is False, turn off debug logging,
335            # setting log level to default `logging.WARNING`
336            for _, logger in self.logger.items():
337                logger.setLevel(logging.WARNING)
338            # turn off http_client debug
339            http_client.HTTPConnection.debuglevel = 0
340
341    @property
342    def logger_format(self):
343        """The logger format.
344
345        The logger_formatter will be updated when sets logger_format.
346
347        :param value: The format string.
348        :type: str
349        """
350        return self.__logger_format
351
352    @logger_format.setter
353    def logger_format(self, value):
354        """The logger format.
355
356        The logger_formatter will be updated when sets logger_format.
357
358        :param value: The format string.
359        :type: str
360        """
361        self.__logger_format = value
362        self.logger_formatter = logging.Formatter(self.__logger_format)
363
364    def get_api_key_with_prefix(self, identifier, alias=None):
365        """Gets API key (with prefix if set).
366
367        :param identifier: The identifier of apiKey.
368        :param alias: The alternative identifier of apiKey.
369        :return: The token for api key authentication.
370        """
371        if self.refresh_api_key_hook is not None:
372            self.refresh_api_key_hook(self)
373        key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None)
374        if key:
375            prefix = self.api_key_prefix.get(identifier)
376            if prefix:
377                return "%s %s" % (prefix, key)
378            else:
379                return key
380
381    def get_basic_auth_token(self):
382        """Gets HTTP basic authentication header (string).
383
384        :return: The token for basic HTTP authentication.
385        """
386        username = ""
387        if self.username is not None:
388            username = self.username
389        password = ""
390        if self.password is not None:
391            password = self.password
392        return urllib3.util.make_headers(basic_auth=username + ":" + password).get("authorization")
393
394    def auth_settings(self):
395        """Gets Auth Settings dict for api client.
396
397        :return: The Auth Settings information dict.
398        """
399        auth = {}
400        if "ApiKeyAuth" in self.api_key:
401            auth["ApiKeyAuth"] = {
402                "type": "api_key",
403                "in": "header",
404                "key": "Api-Key",
405                "value": self.get_api_key_with_prefix(
406                    "ApiKeyAuth",
407                ),
408            }
409        return auth
410
411    def to_debug_report(self):
412        """Gets the essential information for debugging.
413
414        :return: The report for debugging.
415        """
416        return (
417            "Python SDK Debug Report:\n"
418            "OS: {env}\n"
419            "Python Version: {pyversion}\n"
420            "Version of the API: version not set\n"
421            "SDK Package Version: 1.0.0".format(env=sys.platform, pyversion=sys.version)
422        )
423
424    def get_host_settings(self):
425        """Gets an array of host settings
426
427        :return: An array of host settings
428        """
429        return [
430            {
431                "url": "https://{index_name}-{project_name}.svc.{environment}.pinecone.io",
432                "description": "No description provided",
433                "variables": {
434                    "index_name": {
435                        "description": "No description provided",
436                        "default_value": "unknown",
437                    },
438                    "project_name": {
439                        "description": "No description provided",
440                        "default_value": "unknown",
441                    },
442                    "environment": {
443                        "description": "No description provided",
444                        "default_value": "unknown",
445                    },
446                },
447            }
448        ]
449
450    def get_host_from_settings(self, index, variables=None, servers=None):
451        """Gets host URL based on the index and variables
452        :param index: array index of the host settings
453        :param variables: hash of variable and the corresponding value
454        :param servers: an array of host settings or None
455        :return: URL based on host settings
456        """
457        if index is None:
458            return self._base_path
459
460        variables = {} if variables is None else variables
461        servers = self.get_host_settings() if servers is None else servers
462
463        try:
464            server = servers[index]
465        except IndexError:
466            raise ValueError(
467                "Invalid index {0} when selecting the host settings. "
468                "Must be less than {1}".format(index, len(servers))
469            )
470
471        url = server["url"]
472
473        # go through variables and replace placeholders
474        for variable_name, variable in server.get("variables", {}).items():
475            used_value = variables.get(variable_name, variable["default_value"])
476
477            if "enum_values" in variable and used_value not in variable["enum_values"]:
478                raise ValueError(
479                    "The variable `{0}` in the host URL has invalid value "
480                    "{1}. Must be {2}.".format(variable_name, variables[variable_name], variable["enum_values"])
481                )
482
483            url = url.replace("{" + variable_name + "}", used_value)
484
485        return url
486
487    @property
488    def host(self):
489        """Return generated host."""
490        return self.get_host_from_settings(self.server_index, variables=self.server_variables)
491
492    @host.setter
493    def host(self, value):
494        """Fix base path."""
495        self._base_path = value
496        self.server_index = None