arthur-client 1.3.0__py3-none-any.whl → 1.4.1055__py3-none-any.whl

arthur_client/api_bindings/models/metrics_calculation_job_spec.py

@@ -0,0 +1,104 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MetricsCalculationJobSpec(BaseModel):
+    """
+    MetricsCalculationJobSpec
+    """ # noqa: E501
+    job_type: Optional[StrictStr] = 'metrics_calculation'
+    scope_model_id: StrictStr = Field(description="The id of the model to calculate metrics.")
+    start_timestamp: datetime = Field(description="The start timestamp to use for fetching data.")
+    end_timestamp: datetime = Field(description="The end timestamp to use for fetching data.")
+    __properties: ClassVar[List[str]] = ["job_type", "scope_model_id", "start_timestamp", "end_timestamp"]
+
+    @field_validator('job_type')
+    def job_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['metrics_calculation']):
+            raise ValueError("must be one of enum values ('metrics_calculation')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MetricsCalculationJobSpec from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MetricsCalculationJobSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job_type": obj.get("job_type") if obj.get("job_type") is not None else 'metrics_calculation',
+            "scope_model_id": obj.get("scope_model_id"),
+            "start_timestamp": obj.get("start_timestamp"),
+            "end_timestamp": obj.get("end_timestamp")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/metrics_column_list_parameter_schema.py

@@ -0,0 +1,105 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MetricsColumnListParameterSchema(BaseModel):
+    """
+    MetricsColumnListParameterSchema
+    """ # noqa: E501
+    parameter_key: StrictStr = Field(description="Name of the parameter.")
+    optional: Optional[StrictBool] = Field(default=False, description="Boolean denoting if the parameter is optional.")
+    friendly_name: StrictStr = Field(description="User facing name of the parameter.")
+    description: StrictStr = Field(description="Description of the parameter.")
+    parameter_type: Optional[StrictStr] = 'column_list'
+    __properties: ClassVar[List[str]] = ["parameter_key", "optional", "friendly_name", "description", "parameter_type"]
+
+    @field_validator('parameter_type')
+    def parameter_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['column_list']):
+            raise ValueError("must be one of enum values ('column_list')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MetricsColumnListParameterSchema from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MetricsColumnListParameterSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameter_key": obj.get("parameter_key"),
+            "optional": obj.get("optional") if obj.get("optional") is not None else False,
+            "friendly_name": obj.get("friendly_name"),
+            "description": obj.get("description"),
+            "parameter_type": obj.get("parameter_type") if obj.get("parameter_type") is not None else 'column_list'
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/metrics_column_parameter_schema.py

@@ -0,0 +1,127 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.metrics_column_parameter_schema_allowed_column_types_inner import MetricsColumnParameterSchemaAllowedColumnTypesInner
+from arthur_client.api_bindings.models.scope_schema_tag import ScopeSchemaTag
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MetricsColumnParameterSchema(BaseModel):
+    """
+    MetricsColumnParameterSchema
+    """ # noqa: E501
+    parameter_key: StrictStr = Field(description="Name of the parameter.")
+    optional: Optional[StrictBool] = Field(default=False, description="Boolean denoting if the parameter is optional.")
+    friendly_name: StrictStr = Field(description="User facing name of the parameter.")
+    description: StrictStr = Field(description="Description of the parameter.")
+    parameter_type: Optional[StrictStr] = 'column'
+    tag_hints: Optional[List[ScopeSchemaTag]] = Field(default=None, description="List of tags that are applicable to this parameter. Datasets with columns that have matching tags can be inferred this way.")
+    source_dataset_parameter_key: StrictStr = Field(description="Name of the parameter that provides the dataset to be used for this column.")
+    allowed_column_types: Optional[List[MetricsColumnParameterSchemaAllowedColumnTypesInner]] = None
+    allow_any_column_type: Optional[StrictBool] = Field(default=False, description="Indicates if this metric parameter can accept any column type.")
+    __properties: ClassVar[List[str]] = ["parameter_key", "optional", "friendly_name", "description", "parameter_type", "tag_hints", "source_dataset_parameter_key", "allowed_column_types", "allow_any_column_type"]
+
+    @field_validator('parameter_type')
+    def parameter_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['column']):
+            raise ValueError("must be one of enum values ('column')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MetricsColumnParameterSchema from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in allowed_column_types (list)
+        _items = []
+        if self.allowed_column_types:
+            for _item_allowed_column_types in self.allowed_column_types:
+                if _item_allowed_column_types:
+                    _items.append(_item_allowed_column_types.to_dict())
+            _dict['allowed_column_types'] = _items
+        # set to None if allowed_column_types (nullable) is None
+        # and model_fields_set contains the field
+        if self.allowed_column_types is None and "allowed_column_types" in self.model_fields_set:
+            _dict['allowed_column_types'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MetricsColumnParameterSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameter_key": obj.get("parameter_key"),
+            "optional": obj.get("optional") if obj.get("optional") is not None else False,
+            "friendly_name": obj.get("friendly_name"),
+            "description": obj.get("description"),
+            "parameter_type": obj.get("parameter_type") if obj.get("parameter_type") is not None else 'column',
+            "tag_hints": obj.get("tag_hints"),
+            "source_dataset_parameter_key": obj.get("source_dataset_parameter_key"),
+            "allowed_column_types": [MetricsColumnParameterSchemaAllowedColumnTypesInner.from_dict(_item) for _item in obj["allowed_column_types"]] if obj.get("allowed_column_types") is not None else None,
+            "allow_any_column_type": obj.get("allow_any_column_type") if obj.get("allow_any_column_type") is not None else False
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/metrics_column_parameter_schema_allowed_column_types_inner.py

@@ -0,0 +1,151 @@
+# 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
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Optional
+from arthur_client.api_bindings.models.scalar_type import ScalarType
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+METRICSCOLUMNPARAMETERSCHEMAALLOWEDCOLUMNTYPESINNER_ANY_OF_SCHEMAS = ["ListType", "ObjectType", "ScalarType"]
+
+class MetricsColumnParameterSchemaAllowedColumnTypesInner(BaseModel):
+    """
+    MetricsColumnParameterSchemaAllowedColumnTypesInner
+    """
+
+    # data type: ScalarType
+    anyof_schema_1_validator: Optional[ScalarType] = None
+    # data type: ObjectType
+    anyof_schema_2_validator: Optional[ObjectType] = None
+    # data type: ListType
+    anyof_schema_3_validator: Optional[ListType] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[ListType, ObjectType, ScalarType]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "ListType", "ObjectType", "ScalarType" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = MetricsColumnParameterSchemaAllowedColumnTypesInner.model_construct()
+        error_messages = []
+        # validate data type: ScalarType
+        if not isinstance(v, ScalarType):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ScalarType`")
+        else:
+            return v
+
+        # validate data type: ObjectType
+        if not isinstance(v, ObjectType):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ObjectType`")
+        else:
+            return v
+
+        # validate data type: ListType
+        if not isinstance(v, ListType):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ListType`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in MetricsColumnParameterSchemaAllowedColumnTypesInner with anyOf schemas: ListType, ObjectType, ScalarType. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[ScalarType] = None
+        try:
+            instance.actual_instance = ScalarType.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[ObjectType] = None
+        try:
+            instance.actual_instance = ObjectType.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[ListType] = None
+        try:
+            instance.actual_instance = ListType.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into MetricsColumnParameterSchemaAllowedColumnTypesInner with anyOf schemas: ListType, ObjectType, ScalarType. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], ListType, ObjectType, ScalarType]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+from arthur_client.api_bindings.models.list_type import ListType
+from arthur_client.api_bindings.models.object_type import ObjectType
+# TODO: Rewrite to not use raise_errors
+MetricsColumnParameterSchemaAllowedColumnTypesInner.model_rebuild(raise_errors=False)
+

arthur_client/api_bindings/models/metrics_dataset_parameter_schema.py

@@ -0,0 +1,113 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.model_problem_type import ModelProblemType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MetricsDatasetParameterSchema(BaseModel):
+    """
+    MetricsDatasetParameterSchema
+    """ # noqa: E501
+    parameter_key: StrictStr = Field(description="Name of the parameter.")
+    optional: Optional[StrictBool] = Field(default=False, description="Boolean denoting if the parameter is optional.")
+    friendly_name: StrictStr = Field(description="User facing name of the parameter.")
+    description: StrictStr = Field(description="Description of the parameter.")
+    parameter_type: Optional[StrictStr] = 'dataset'
+    model_problem_type: Optional[ModelProblemType] = None
+    __properties: ClassVar[List[str]] = ["parameter_key", "optional", "friendly_name", "description", "parameter_type", "model_problem_type"]
+
+    @field_validator('parameter_type')
+    def parameter_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['dataset']):
+            raise ValueError("must be one of enum values ('dataset')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MetricsDatasetParameterSchema from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if model_problem_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.model_problem_type is None and "model_problem_type" in self.model_fields_set:
+            _dict['model_problem_type'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MetricsDatasetParameterSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameter_key": obj.get("parameter_key"),
+            "optional": obj.get("optional") if obj.get("optional") is not None else False,
+            "friendly_name": obj.get("friendly_name"),
+            "description": obj.get("description"),
+            "parameter_type": obj.get("parameter_type") if obj.get("parameter_type") is not None else 'dataset',
+            "model_problem_type": obj.get("model_problem_type")
+        })
+        return _obj
+
+