arthur-client 1.4.0__py3-none-any.whl → 1.4.1186__py3-none-any.whl

arthur_client/api_bindings/api_response.py

@@ -0,0 +1,21 @@
+"""API response object."""
+
+from __future__ import annotations
+from typing import Optional, Generic, Mapping, TypeVar
+from pydantic import Field, StrictInt, StrictBytes, BaseModel
+
+T = TypeVar("T")
+
+class ApiResponse(BaseModel, Generic[T]):
+    """
+    API response object
+    """
+
+    status_code: StrictInt = Field(description="HTTP status code")
+    headers: Optional[Mapping[str, str]] = Field(None, description="HTTP headers")
+    data: T = Field(description="Deserialized data given the data type")
+    raw_data: StrictBytes = Field(description="Raw data (HTTP response body)")
+
+    model_config = {
+        "arbitrary_types_allowed": True
+    }

arthur_client/api_bindings/configuration.py

@@ -0,0 +1,458 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import copy
+import logging
+from logging import FileHandler
+import multiprocessing
+import sys
+from typing import Optional
+import urllib3
+
+import http.client as httplib
+
+JSON_SCHEMA_VALIDATION_KEYWORDS = {
+    'multipleOf', 'maximum', 'exclusiveMaximum',
+    'minimum', 'exclusiveMinimum', 'maxLength',
+    'minLength', 'pattern', 'maxItems', 'minItems'
+}
+
+class Configuration:
+    """This class contains various settings of the API client.
+
+    :param host: Base url.
+    :param ignore_operation_servers
+      Boolean to ignore operation servers for the API client.
+      Config will use `host` as the base url regardless of the operation servers.
+    :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.
+    :param retries: Number of retries for API requests.
+
+    :Example:
+    """
+
+    _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,
+                 ignore_operation_servers=False,
+                 ssl_ca_cert=None,
+                 retries=None,
+                 *,
+                 debug: Optional[bool] = 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.ignore_operation_servers = ignore_operation_servers
+        """Ignore operation servers
+        """
+        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("arthur_client.api_bindings")
+        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: Optional[FileHandler] = None
+        """Log file handler
+        """
+        self.logger_file = None
+        """Debug file location
+        """
+        if debug is not None:
+            self.debug = debug
+        else:
+            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.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: Optional[str] = None
+        """Proxy URL
+        """
+        self.proxy_headers = None
+        """Proxy headers
+        """
+        self.safe_chars_for_path_param = ''
+        """Safe chars for path_param
+        """
+        self.retries = retries
+        """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 = {}
+        if self.access_token is not None:
+            auth['OAuth2AuthorizationCode'] = {
+                'type': 'oauth2',
+                'in': 'header',
+                'key': 'Authorization',
+                'value': 'Bearer ' + self.access_token
+            }
+        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: 0.1.0\n"\
+               "SDK Package Version: 0.1.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

arthur_client/api_bindings/docs/AggregationMetricType.md

@@ -0,0 +1,12 @@
+# AggregationMetricType
+
+
+## Enum
+
+* `SKETCH` (value: `'sketch'`)
+
+* `NUMERIC` (value: `'numeric'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/AggregationSpec.md

@@ -0,0 +1,31 @@
+# AggregationSpec
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aggregation_id** | **str** | Unique identifier of the aggregation. | 
+**aggregation_init_args** | [**List[MetricsArgSpec]**](MetricsArgSpec.md) | List of arguments to the aggregation's init function. | 
+**aggregation_args** | [**List[MetricsArgSpec]**](MetricsArgSpec.md) | List of arguments to the aggregation's aggregate function. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.aggregation_spec import AggregationSpec
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AggregationSpec from a JSON string
+aggregation_spec_instance = AggregationSpec.from_json(json)
+# print the JSON string representation of the object
+print(AggregationSpec.to_json())
+
+# convert the object into a dict
+aggregation_spec_dict = aggregation_spec_instance.to_dict()
+# create an instance of AggregationSpec from a dict
+aggregation_spec_from_dict = AggregationSpec.from_dict(aggregation_spec_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/AggregationSpecSchema.md

@@ -0,0 +1,34 @@
+# AggregationSpecSchema
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Name of the aggregation function. | 
+**id** | **str** | Unique identifier of the aggregation function. | 
+**description** | **str** | Description of the aggregation function and what it aggregates. | 
+**metric_type** | [**AggregationMetricType**](AggregationMetricType.md) | Return type of the aggregations aggregate function. | 
+**init_args** | [**List[AggregationSpecSchemaInitArgsInner]**](AggregationSpecSchemaInitArgsInner.md) | List of parameters to the aggregation's init function. | 
+**aggregate_args** | [**List[AggregationSpecSchemaInitArgsInner]**](AggregationSpecSchemaInitArgsInner.md) | List of parameters to the aggregation's aggregate function. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.aggregation_spec_schema import AggregationSpecSchema
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AggregationSpecSchema from a JSON string
+aggregation_spec_schema_instance = AggregationSpecSchema.from_json(json)
+# print the JSON string representation of the object
+print(AggregationSpecSchema.to_json())
+
+# convert the object into a dict
+aggregation_spec_schema_dict = aggregation_spec_schema_instance.to_dict()
+# create an instance of AggregationSpecSchema from a dict
+aggregation_spec_schema_from_dict = AggregationSpecSchema.from_dict(aggregation_spec_schema_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/AggregationSpecSchemaInitArgsInner.md

@@ -0,0 +1,39 @@
+# AggregationSpecSchemaInitArgsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameter_key** | **str** | Name of the parameter. | 
+**optional** | **bool** | Boolean denoting if the parameter is optional. | [optional] [default to False]
+**friendly_name** | **str** | User facing name of the parameter. | 
+**description** | **str** | Description of the parameter. | 
+**parameter_type** | **str** |  | [optional] [default to 'column_list']
+**model_problem_type** | [**ModelProblemType**](ModelProblemType.md) |  | [optional] 
+**parameter_dtype** | [**DType**](DType.md) | Data type of the parameter. | 
+**tag_hints** | [**List[ScopeSchemaTag]**](ScopeSchemaTag.md) | List of tags that are applicable to this parameter. Datasets with columns that have matching tags can be inferred this way. | [optional] [default to []]
+**source_dataset_parameter_key** | **str** | Name of the parameter that provides the dataset to be used for this column. | 
+**allowed_column_types** | [**List[MetricsColumnListParameterSchemaAllowedColumnTypesInner]**](MetricsColumnListParameterSchemaAllowedColumnTypesInner.md) |  | [optional] 
+**allow_any_column_type** | **bool** | Indicates if this metric parameter can accept any column type. | [optional] [default to False]
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.aggregation_spec_schema_init_args_inner import AggregationSpecSchemaInitArgsInner
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AggregationSpecSchemaInitArgsInner from a JSON string
+aggregation_spec_schema_init_args_inner_instance = AggregationSpecSchemaInitArgsInner.from_json(json)
+# print the JSON string representation of the object
+print(AggregationSpecSchemaInitArgsInner.to_json())
+
+# convert the object into a dict
+aggregation_spec_schema_init_args_inner_dict = aggregation_spec_schema_init_args_inner_instance.to_dict()
+# create an instance of AggregationSpecSchemaInitArgsInner from a dict
+aggregation_spec_schema_init_args_inner_from_dict = AggregationSpecSchemaInitArgsInner.from_dict(aggregation_spec_schema_init_args_inner_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/Alert.md

@@ -0,0 +1,44 @@
+# Alert
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **str** |  | 
+**timestamp** | **datetime** | The timestamp of the alert. | 
+**value** | **float** | The value of the metric that triggered the alert. | 
+**threshold** | **float** | The threshold that triggered the alert. | 
+**bound** | [**AlertBound**](AlertBound.md) | The bound of the alert. | 
+**interval** | [**AlertRuleInterval**](AlertRuleInterval.md) | The interval of the alert rule, commonly '1 day', '1 hour', etc. | 
+**dimensions** | **object** |  | 
+**alert_rule_id** | **str** | The alert rule id of the alert. | 
+**job_id** | **str** |  | [optional] 
+**created_at** | **datetime** | Time of record creation. | 
+**updated_at** | **datetime** | Time of last record update. | 
+**id** | **str** | The id of the alert. | 
+**model_id** | **str** | The model id of the alert. | 
+**alert_rule_name** | **str** | The name of the alert rule. | 
+**alert_rule_metric_name** | **str** | The name of the metric returned by the alert rule query. | 
+**is_duplicate_of** | **str** |  | [optional] 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.alert import Alert
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Alert from a JSON string
+alert_instance = Alert.from_json(json)
+# print the JSON string representation of the object
+print(Alert.to_json())
+
+# convert the object into a dict
+alert_dict = alert_instance.to_dict()
+# create an instance of Alert from a dict
+alert_from_dict = Alert.from_dict(alert_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/AlertBound.md

@@ -0,0 +1,12 @@
+# AlertBound
+
+
+## Enum
+
+* `UPPER_BOUND` (value: `'upper_bound'`)
+
+* `LOWER_BOUND` (value: `'lower_bound'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/AlertCheckJobSpec.md

@@ -0,0 +1,32 @@
+# AlertCheckJobSpec
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_type** | **str** |  | [optional] [default to 'alert_check']
+**scope_model_id** | **str** | The id of the model to check alerts. | 
+**check_range_start_timestamp** | **datetime** | The start timestamp to use for checking the alerts on the data. | 
+**check_range_end_timestamp** | **datetime** | The end timestamp to use for checking the alerts on the data. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.alert_check_job_spec import AlertCheckJobSpec
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AlertCheckJobSpec from a JSON string
+alert_check_job_spec_instance = AlertCheckJobSpec.from_json(json)
+# print the JSON string representation of the object
+print(AlertCheckJobSpec.to_json())
+
+# convert the object into a dict
+alert_check_job_spec_dict = alert_check_job_spec_instance.to_dict()
+# create an instance of AlertCheckJobSpec from a dict
+alert_check_job_spec_from_dict = AlertCheckJobSpec.from_dict(alert_check_job_spec_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+