digitalhub 0.8.0b0__py3-none-any.whl → 0.8.0b2__py3-none-any.whl

digitalhub/entities/artifact/crud.py

@@ -0,0 +1,358 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.context.builder import check_context
+from digitalhub.entities._base.crud import (
+    delete_entity_api_ctx,
+    list_entity_api_ctx,
+    read_entity_api_ctx,
+    read_entity_api_ctx_versions,
+)
+from digitalhub.entities._builders.uuid import build_uuid
+from digitalhub.entities.artifact.builder import artifact_from_dict, artifact_from_parameters
+from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.entities.utils import build_log_path_from_source, eval_local_source
+from digitalhub.utils.exceptions import EntityAlreadyExistsError
+from digitalhub.utils.io_utils import read_yaml
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.artifact.entity._base 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 = True,
+    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 (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+    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")
+    """
+    check_context(project)
+    obj = artifact_from_parameters(
+        project=project,
+        name=name,
+        kind=kind,
+        uuid=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+        path=path,
+        **kwargs,
+    )
+    obj.save()
+    return obj
+
+
+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")
+    """
+    obj = read_entity_api_ctx(
+        identifier,
+        ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        **kwargs,
+    )
+    entity = artifact_from_dict(obj)
+    entity._get_files_info()
+    return entity
+
+
+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")
+    """
+    objs = read_entity_api_ctx_versions(
+        identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        **kwargs,
+    )
+    objects = []
+    for o in objs:
+        entity = artifact_from_dict(o)
+        entity._get_files_info()
+        objects.append(entity)
+    return objects
+
+
+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")
+    """
+    objs = list_entity_api_ctx(
+        project=project,
+        entity_type=ENTITY_TYPE,
+        **kwargs,
+    )
+    objects = []
+    for o in objs:
+        entity = artifact_from_dict(o)
+        entity._get_files_info()
+        objects.append(entity)
+    return objects
+
+
+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")
+    """
+    dict_obj: dict = read_yaml(file)
+    obj = artifact_from_dict(dict_obj)
+    try:
+        obj.save()
+    except EntityAlreadyExistsError:
+        pass
+    finally:
+        return obj
+
+
+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_api_ctx(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        delete_all_versions=delete_all_versions,
+        **kwargs,
+    )

digitalhub/entities/artifact/entity/_base.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.entity.material import MaterialEntity
+from digitalhub.entities.entity_types import EntityTypes
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.metadata import Metadata
+    from digitalhub.entities.artifact.spec import ArtifactSpec
+    from digitalhub.entities.artifact.status import ArtifactStatus
+
+
+class Artifact(MaterialEntity):
+    """
+    A class representing a artifact.
+
+    Artifacts are (binary) objects stored in one of the artifact
+    stores of the platform, and available to every process, module
+    and component as files.
+    """
+
+    ENTITY_TYPE = EntityTypes.ARTIFACT.value
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: ArtifactSpec,
+        status: ArtifactStatus,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: ArtifactSpec
+        self.status: ArtifactStatus

digitalhub/entities/artifact/entity/artifact.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities.artifact.entity._base import Artifact
+
+
+class ArtifactArtifact(Artifact):
+    """
+    Artifact class.
+    """

digitalhub/entities/artifact/spec.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.spec.material import MaterialParams, MaterialSpec
+
+
+class ArtifactSpec(MaterialSpec):
+    """
+    Artifact specification.
+    """
+
+
+class ArtifactParams(MaterialParams):
+    """
+    Artifact base parameters.
+    """
+
+
+class ArtifactSpecArtifact(ArtifactSpec):
+    """
+    Artifact specification.
+    """
+
+    def __init__(
+        self,
+        path: str,
+        src_path: str | None = None,
+        **kwargs,
+    ) -> None:
+        super().__init__(path, **kwargs)
+        self.src_path = src_path
+
+
+class ArtifactParamsArtifact(ArtifactParams):
+    """
+    Artifact parameters.
+    """
+
+    src_path: str = None
+    """Source path of the artifact."""

digitalhub/entities/artifact/status.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.status.material import MaterialStatus
+
+
+class ArtifactStatus(MaterialStatus):
+    """
+    Status class for artifact entities.
+    """
+
+
+class ArtifactStatusArtifact(ArtifactStatus):
+    """
+    Status class for artifact entities.
+    """

digitalhub/entities/dataitem/builder.py

@@ -0,0 +1,144 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._builders.metadata import build_metadata
+from digitalhub.entities._builders.name import build_name
+from digitalhub.entities._builders.spec import build_spec
+from digitalhub.entities._builders.status import build_status
+from digitalhub.entities._builders.uuid import build_uuid
+from digitalhub.utils.exceptions import EntityError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.dataitem.entity._base import Dataitem
+
+# Manage class mapper
+cls_mapper = {}
+try:
+    from digitalhub.entities.dataitem.entity.dataitem import DataitemDataitem
+
+    cls_mapper["dataitem"] = DataitemDataitem
+except ImportError:
+    ...
+try:
+    from digitalhub.entities.dataitem.entity.table import DataitemTable
+
+    cls_mapper["table"] = DataitemTable
+except ImportError:
+    ...
+try:
+    from digitalhub.entities.dataitem.entity.iceberg import DataitemIceberg
+
+    cls_mapper["iceberg"] = DataitemIceberg
+except ImportError:
+    pass
+
+
+def _choose_dataitem_type(kind: str) -> type[Dataitem]:
+    """
+    Choose class based on kind.
+
+    Parameters
+    ----------
+    kind : str
+        Kind the object.
+
+    Returns
+    -------
+    type[Dataitem]
+        Class of the dataitem.
+    """
+    try:
+        return cls_mapper[kind]
+    except KeyError:
+        raise EntityError(f"Unknown dataitem kind: {kind}")
+
+
+def dataitem_from_parameters(
+    project: str,
+    name: str,
+    kind: str,
+    uuid: str | None = None,
+    description: str | None = None,
+    labels: list[str] | None = None,
+    embedded: bool = True,
+    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 (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+    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("Dataitem path must be provided")
+    name = build_name(name)
+    uuid = build_uuid(uuid)
+    metadata = build_metadata(
+        kind,
+        project=project,
+        name=name,
+        version=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+    )
+    spec = build_spec(
+        kind,
+        path=path,
+        **kwargs,
+    )
+    status = build_status(kind)
+    cls = _choose_dataitem_type(kind)
+    return cls(
+        project=project,
+        name=name,
+        uuid=uuid,
+        kind=kind,
+        metadata=metadata,
+        spec=spec,
+        status=status,
+    )
+
+
+def dataitem_from_dict(obj: dict) -> Dataitem:
+    """
+    Create a new object from dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary to create object from.
+
+    Returns
+    -------
+    Dataitem
+        Object instance.
+    """
+    kind = obj.get("kind")
+    cls = _choose_dataitem_type(kind)
+    return cls.from_dict(obj)