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

arthur_client/api_bindings/models/data_retrieval_operation.py

@@ -0,0 +1,103 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.data_retrieval_data import DataRetrievalData
+from arthur_client.api_bindings.models.data_retrieval_status import DataRetrievalStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DataRetrievalOperation(BaseModel):
+    """
+    DataRetrievalOperation
+    """ # noqa: E501
+    id: StrictStr = Field(description="Operation ID used for tracking the state of the operation.")
+    job_id: StrictStr = Field(description="Job ID executing the data retrieval.")
+    status: DataRetrievalStatus = Field(description="Current status of the retrieval operation.")
+    data: Optional[DataRetrievalData] = None
+    __properties: ClassVar[List[str]] = ["id", "job_id", "status", "data"]
+
+    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 DataRetrievalOperation 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 data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        # set to None if data (nullable) is None
+        # and model_fields_set contains the field
+        if self.data is None and "data" in self.model_fields_set:
+            _dict['data'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DataRetrievalOperation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "job_id": obj.get("job_id"),
+            "status": obj.get("status"),
+            "data": DataRetrievalData.from_dict(obj["data"]) if obj.get("data") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/data_retrieval_status.py

@@ -0,0 +1,38 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class DataRetrievalStatus(str, Enum):
+    """
+    DataRetrievalStatus
+    """
+
+    """
+    allowed enum values
+    """
+    PENDING_LOAD = 'pending_load'
+    LOADED = 'loaded'
+    EXPIRED = 'expired'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DataRetrievalStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/dataset.py

@@ -0,0 +1,145 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.dataset_connector import DatasetConnector
+from arthur_client.api_bindings.models.dataset_join_spec import DatasetJoinSpec
+from arthur_client.api_bindings.models.dataset_locator import DatasetLocator
+from arthur_client.api_bindings.models.dataset_schema import DatasetSchema
+from arthur_client.api_bindings.models.model_problem_type import ModelProblemType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Dataset(BaseModel):
+    """
+    Dataset
+    """ # noqa: E501
+    created_at: datetime = Field(description="Time of record creation.")
+    updated_at: datetime = Field(description="Time of last record update.")
+    id: StrictStr = Field(description="Unique ID of the dataset.")
+    name: Optional[StrictStr] = None
+    dataset_locator: Optional[DatasetLocator]
+    dataset_schema: DatasetSchema = Field(description="Schema definition of the dataset.")
+    data_plane_id: StrictStr = Field(description="ID of the data plane backing this dataset.")
+    connector: Optional[DatasetConnector] = None
+    project_id: StrictStr = Field(description="ID of parent project.")
+    join_spec: Optional[DatasetJoinSpec] = None
+    model_problem_type: ModelProblemType = Field(description="Model problem type associated with the dataset.")
+    __properties: ClassVar[List[str]] = ["created_at", "updated_at", "id", "name", "dataset_locator", "dataset_schema", "data_plane_id", "connector", "project_id", "join_spec", "model_problem_type"]
+
+    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 Dataset 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 dataset_locator
+        if self.dataset_locator:
+            _dict['dataset_locator'] = self.dataset_locator.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of dataset_schema
+        if self.dataset_schema:
+            _dict['dataset_schema'] = self.dataset_schema.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of connector
+        if self.connector:
+            _dict['connector'] = self.connector.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of join_spec
+        if self.join_spec:
+            _dict['join_spec'] = self.join_spec.to_dict()
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if dataset_locator (nullable) is None
+        # and model_fields_set contains the field
+        if self.dataset_locator is None and "dataset_locator" in self.model_fields_set:
+            _dict['dataset_locator'] = None
+
+        # set to None if connector (nullable) is None
+        # and model_fields_set contains the field
+        if self.connector is None and "connector" in self.model_fields_set:
+            _dict['connector'] = None
+
+        # set to None if join_spec (nullable) is None
+        # and model_fields_set contains the field
+        if self.join_spec is None and "join_spec" in self.model_fields_set:
+            _dict['join_spec'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Dataset from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "dataset_locator": DatasetLocator.from_dict(obj["dataset_locator"]) if obj.get("dataset_locator") is not None else None,
+            "dataset_schema": DatasetSchema.from_dict(obj["dataset_schema"]) if obj.get("dataset_schema") is not None else None,
+            "data_plane_id": obj.get("data_plane_id"),
+            "connector": DatasetConnector.from_dict(obj["connector"]) if obj.get("connector") is not None else None,
+            "project_id": obj.get("project_id"),
+            "join_spec": DatasetJoinSpec.from_dict(obj["join_spec"]) if obj.get("join_spec") is not None else None,
+            "model_problem_type": obj.get("model_problem_type")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/dataset_column.py

@@ -0,0 +1,95 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.definition import Definition
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetColumn(BaseModel):
+    """
+    DatasetColumn
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="Unique ID of the column.")
+    source_name: StrictStr
+    definition: Definition
+    __properties: ClassVar[List[str]] = ["id", "source_name", "definition"]
+
+    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 DatasetColumn 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 definition
+        if self.definition:
+            _dict['definition'] = self.definition.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatasetColumn from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "source_name": obj.get("source_name"),
+            "definition": Definition.from_dict(obj["definition"]) if obj.get("definition") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/dataset_connector.py

@@ -0,0 +1,92 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from arthur_client.api_bindings.models.connector_type import ConnectorType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetConnector(BaseModel):
+    """
+    DatasetConnector
+    """ # noqa: E501
+    id: StrictStr = Field(description="Connector ID associated with the dataset.")
+    name: StrictStr = Field(description="Connector name associated with the dataset.")
+    connector_type: ConnectorType = Field(description="Type of connector associated with the dataset.")
+    __properties: ClassVar[List[str]] = ["id", "name", "connector_type"]
+
+    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 DatasetConnector 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 DatasetConnector from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "connector_type": obj.get("connector_type")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/dataset_join_kind.py

@@ -0,0 +1,39 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class DatasetJoinKind(str, Enum):
+    """
+    DatasetJoinKind
+    """
+
+    """
+    allowed enum values
+    """
+    INNER = 'inner'
+    LEFT_OUTER = 'left_outer'
+    OUTER = 'outer'
+    RIGHT_OUTER = 'right_outer'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DatasetJoinKind from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/dataset_join_spec.py

@@ -0,0 +1,99 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.dataset_join_kind import DatasetJoinKind
+from arthur_client.api_bindings.models.joined_dataset import JoinedDataset
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetJoinSpec(BaseModel):
+    """
+    DatasetJoinSpec
+    """ # noqa: E501
+    left_joined_dataset: JoinedDataset = Field(description="Left dataset in the join.")
+    right_joined_dataset: JoinedDataset = Field(description="Right dataset in the join.")
+    join_type: Optional[DatasetJoinKind] = Field(default=None, description="Kind of SQL join to perform")
+    __properties: ClassVar[List[str]] = ["left_joined_dataset", "right_joined_dataset", "join_type"]
+
+    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 DatasetJoinSpec 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 left_joined_dataset
+        if self.left_joined_dataset:
+            _dict['left_joined_dataset'] = self.left_joined_dataset.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of right_joined_dataset
+        if self.right_joined_dataset:
+            _dict['right_joined_dataset'] = self.right_joined_dataset.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatasetJoinSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "left_joined_dataset": JoinedDataset.from_dict(obj["left_joined_dataset"]) if obj.get("left_joined_dataset") is not None else None,
+            "right_joined_dataset": JoinedDataset.from_dict(obj["right_joined_dataset"]) if obj.get("right_joined_dataset") is not None else None,
+            "join_type": obj.get("join_type")
+        })
+        return _obj
+
+