digitalhub 0.7.0b2__py3-none-any.whl → 0.8.0__py3-none-any.whl

digitalhub/entities/artifact/crud.py

@@ -0,0 +1,332 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.crud import (
+    delete_entity,
+    get_material_entity,
+    get_material_entity_versions,
+    import_context_entity,
+    list_material_entities,
+    new_context_entity,
+)
+from digitalhub.entities._base.entity._constructors.uuid import build_uuid
+from digitalhub.entities.artifact._base.entity import Artifact
+from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.entities.utils.utils import build_log_path_from_source, eval_local_source
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.artifact._base.entity import Artifact
+
+
+ENTITY_TYPE = EntityTypes.ARTIFACT.value
+
+
+def new_artifact(
+    project: str,
+    name: str,
+    kind: str,
+    uuid: str | None = None,
+    description: str | None = None,
+    labels: list[str] | None = None,
+    embedded: bool = False,
+    path: str | None = None,
+    **kwargs,
+) -> Artifact:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    name : str
+        Object name.
+    kind : str
+        Kind the object.
+    uuid : str
+        ID of the object.
+    description : str
+        Description of the object (human readable).
+    labels : list[str]
+        List of labels.
+    embedded : bool
+        Flag to determine if object spec must be embedded in project spec.
+    path : str
+        Object path on local file system or remote storage. It is also the destination path of upload() method.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Artifact
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = new_artifact(project="my-project",
+    >>>                    name="my-artifact",
+    >>>                    kind="artifact",
+    >>>                    path="s3://my-bucket/my-key")
+    """
+    return new_context_entity(
+        project=project,
+        name=name,
+        kind=kind,
+        uuid=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+        path=path,
+        **kwargs,
+    )
+
+
+def log_artifact(
+    project: str,
+    name: str,
+    kind: str,
+    source: list[str] | str,
+    path: str | None = None,
+    **kwargs,
+) -> Artifact:
+    """
+    Create and upload an object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    name : str
+        Object name.
+    kind : str
+        Kind the object.
+    source : str
+        Artifact location on local path.
+    path : str
+        Destination path of the artifact. If not provided, it's generated.
+    **kwargs : dict
+        New artifact spec parameters.
+
+    Returns
+    -------
+    Artifact
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = log_artifact(project="my-project",
+    >>>                    name="my-artifact",
+    >>>                    kind="artifact",
+    >>>                    source="./local-path")
+    """
+    eval_local_source(source)
+
+    if path is None:
+        uuid = build_uuid()
+        kwargs["uuid"] = uuid
+        path = build_log_path_from_source(project, ENTITY_TYPE, name, uuid, source)
+
+    obj = new_artifact(project=project, name=name, kind=kind, path=path, **kwargs)
+    obj.upload(source)
+    return obj
+
+
+def get_artifact(
+    identifier: str,
+    project: str | None = None,
+    entity_id: str | None = None,
+    **kwargs,
+) -> Artifact:
+    """
+    Get object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    entity_id : str
+        Entity ID.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    Artifact
+        Object instance.
+
+    Examples
+    --------
+    Using entity key:
+    >>> obj = get_artifact("store://my-artifact-key")
+
+    Using entity name:
+    >>> obj = get_artifact("my-artifact-name"
+    >>>                    project="my-project",
+    >>>                    entity_id="my-artifact-id")
+    """
+    return get_material_entity(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        **kwargs,
+    )
+
+
+def get_artifact_versions(
+    identifier: str,
+    project: str | None = None,
+    **kwargs,
+) -> list[Artifact]:
+    """
+    Get object versions from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[Artifact]
+        List of object instances.
+
+    Examples
+    --------
+    Using entity key:
+    >>> obj = get_artifact_versions("store://my-artifact-key")
+
+    Using entity name:
+    >>> obj = get_artifact_versions("my-artifact-name"
+    >>>                             project="my-project")
+    """
+    return get_material_entity_versions(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        **kwargs,
+    )
+
+
+def list_artifacts(project: str, **kwargs) -> list[Artifact]:
+    """
+    List all latest version objects from backend.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[Artifact]
+        List of object instances.
+
+    Examples
+    --------
+    >>> objs = list_artifacts(project="my-project")
+    """
+    return list_material_entities(
+        project=project,
+        entity_type=ENTITY_TYPE,
+        **kwargs,
+    )
+
+
+def import_artifact(file: str) -> Artifact:
+    """
+    Import object from a YAML file.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    Artifact
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = import_artifact("my-artifact.yaml")
+    """
+    return import_context_entity(file)
+
+
+def update_artifact(entity: Artifact) -> Artifact:
+    """
+    Update object. Note that object spec are immutable.
+
+    Parameters
+    ----------
+    entity : Artifact
+        Object to update.
+
+    Returns
+    -------
+    Artifact
+        Entity updated.
+
+    Examples
+    --------
+    >>> obj = update_artifact(obj)
+    """
+    return entity.save(update=True)
+
+
+def delete_artifact(
+    identifier: str,
+    project: str | None = None,
+    entity_id: str | None = None,
+    delete_all_versions: bool = False,
+    **kwargs,
+) -> dict:
+    """
+    Delete object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    entity_id : str
+        Entity ID.
+    delete_all_versions : bool
+        Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    dict
+        Response from backend.
+
+    Examples
+    --------
+    If delete_all_versions is False:
+    >>> delete_artifact("store://my-artifact-key")
+
+    Otherwise:
+    >>> delete_artifact("my-artifact-name",
+    >>>                  project="my-project",
+    >>>                  delete_all_versions=True)
+    """
+    return delete_entity(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        delete_all_versions=delete_all_versions,
+        **kwargs,
+    )

digitalhub/entities/builders.py

@@ -0,0 +1,63 @@
+from __future__ import annotations
+
+from digitalhub.entities.artifact.artifact.builder import ArtifactArtifactBuilder
+from digitalhub.entities.dataitem.dataitem.builder import DataitemDataitemBuilder
+from digitalhub.entities.dataitem.table.builder import DataitemTableBuilder
+from digitalhub.entities.model.mlflow.builder import ModelModelBuilder
+from digitalhub.entities.project._base.builder import ProjectProjectBuilder
+from digitalhub.entities.secret._base.builder import SecretSecretBuilder
+
+entity_builders = (
+    (ProjectProjectBuilder.ENTITY_KIND, ProjectProjectBuilder),
+    (SecretSecretBuilder.ENTITY_KIND, SecretSecretBuilder),
+    (ArtifactArtifactBuilder.ENTITY_KIND, ArtifactArtifactBuilder),
+    (DataitemDataitemBuilder.ENTITY_KIND, DataitemDataitemBuilder),
+    (DataitemTableBuilder.ENTITY_KIND, DataitemTableBuilder),
+    (ModelModelBuilder.ENTITY_KIND, ModelModelBuilder),
+)
+
+##############################
+#  Potential uninstalled entities
+##############################
+
+
+try:
+    from digitalhub.entities.dataitem.iceberg.builder import DataitemIcebergBuilder
+
+    entity_builders = (
+        *entity_builders,
+        (DataitemIcebergBuilder.ENTITY_KIND, DataitemIcebergBuilder),
+    )
+except ImportError:
+    ...
+
+
+try:
+    from digitalhub.entities.model.model.builder import ModelMlflowBuilder
+
+    entity_builders = (
+        *entity_builders,
+        (ModelMlflowBuilder.ENTITY_KIND, ModelMlflowBuilder),
+    )
+except ImportError:
+    ...
+
+try:
+    from digitalhub.entities.model.sklearn.builder import ModelSklearnBuilder
+
+    entity_builders = (
+        *entity_builders,
+        (ModelSklearnBuilder.ENTITY_KIND, ModelSklearnBuilder),
+    )
+except ImportError:
+    ...
+
+try:
+    from digitalhub.entities.model.huggingface.builder import ModelHuggingfaceBuilder
+
+    entity_builders = (
+        *entity_builders,
+        (ModelHuggingfaceBuilder.ENTITY_KIND, ModelHuggingfaceBuilder),
+    )
+except ImportError:
+    ...

digitalhub/entities/dataitem/_base/builder.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.versioned.builder import VersionedBuilder
+from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.utils.exceptions import EntityError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.dataitem._base.entity import Dataitem
+
+
+class DataitemBuilder(VersionedBuilder):
+    """
+    Dataitem builder.
+    """
+
+    ENTITY_TYPE = EntityTypes.DATAITEM.value
+
+    def build(
+        self,
+        kind: str,
+        project: str,
+        name: str,
+        uuid: str | None = None,
+        description: str | None = None,
+        labels: list[str] | None = None,
+        embedded: bool = False,
+        path: str | None = None,
+        **kwargs,
+    ) -> Dataitem:
+        """
+        Create a new object.
+
+        Parameters
+        ----------
+        project : str
+            Project name.
+        name : str
+            Object name.
+        kind : str
+            Kind the object.
+        uuid : str
+            ID of the object.
+        description : str
+            Description of the object (human readable).
+        labels : list[str]
+            List of labels.
+        embedded : bool
+            Flag to determine if object spec must be embedded in project spec.
+        path : str
+            Object path on local file system or remote storage. It is also the destination path of upload() method.
+        **kwargs : dict
+            Spec keyword arguments.
+
+        Returns
+        -------
+        Dataitem
+            Object instance.
+        """
+        if path is None:
+            raise EntityError("Path must be provided.")
+
+        name = self.build_name(name)
+        uuid = self.build_uuid(uuid)
+        metadata = self.build_metadata(
+            project=project,
+            name=name,
+            description=description,
+            labels=labels,
+            embedded=embedded,
+        )
+        spec = self.build_spec(
+            path=path,
+            **kwargs,
+        )
+        status = self.build_status()
+        return self.build_entity(
+            project=project,
+            name=name,
+            uuid=uuid,
+            kind=kind,
+            metadata=metadata,
+            spec=spec,
+            status=status,
+        )

digitalhub/entities/dataitem/_base/entity.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+import typing
+from pathlib import Path
+
+from digitalhub.entities._base.material.entity import MaterialEntity
+from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.utils.exceptions import EntityError
+from digitalhub.utils.uri_utils import map_uri_scheme
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.dataitem._base.spec import DataitemSpec
+    from digitalhub.entities.dataitem._base.status import DataitemStatus
+
+
+class Dataitem(MaterialEntity):
+    """
+    A class representing a dataitem.
+    """
+
+    ENTITY_TYPE = EntityTypes.DATAITEM.value
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: DataitemSpec,
+        status: DataitemStatus,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+        self.spec: DataitemSpec
+        self.status: DataitemStatus
+
+    ##############################
+    #  Private helper methods
+    ##############################
+
+    @staticmethod
+    def _get_extension(path: str, file_format: str | None = None) -> str:
+        """
+        Get extension of path.
+
+        Parameters
+        ----------
+        path : str
+            Path to get extension from.
+        file_format : str
+            File format.
+
+        Returns
+        -------
+        str
+            File extension.
+
+        Raises
+        ------
+        EntityError
+            If file format is not supported.
+        """
+        if file_format is not None:
+            return file_format
+
+        scheme = map_uri_scheme(path)
+        if scheme == "sql":
+            return "parquet"
+
+        ext = Path(path).suffix[1:]
+        if ext is not None:
+            return ext
+        raise EntityError("Unknown file format. Only csv and parquet are supported.")

digitalhub/entities/dataitem/_base/spec.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.material.spec import MaterialSpec, MaterialValidator
+
+
+class DataitemSpec(MaterialSpec):
+    """
+    DataitemSpec specifications.
+    """
+
+
+class DataitemValidator(MaterialValidator):
+    """
+    DataitemValidator validator.
+    """

digitalhub/entities/dataitem/_base/status.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.material.status import MaterialStatus
+
+
+class DataitemStatus(MaterialStatus):
+    """
+    DataitemStatus status.
+    """
+
+    def __init__(
+        self,
+        state: str,
+        message: str | None = None,
+        files: list[dict] | None = None,
+        preview: dict | None = None,
+        **kwargs,
+    ) -> None:
+        super().__init__(state, message, files)
+        self.preview = preview