digitalhub 0.8.0__py3-none-any.whl → 0.8.0b1__py3-none-any.whl

digitalhub/entities/_builders/spec.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.registry.registry import registry
+from digitalhub.registry.utils import import_class
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.spec.base import Spec
+    from digitalhub.registry.models import RegistryEntry
+
+
+def build_spec(kind: str, validate: bool = True, **kwargs) -> Spec:
+    """
+    Build entity spec object. The builder takes as input
+    the kind of spec's object to build, a validation flag
+    and the keyword arguments to pass to the spec's constructor.
+    The specific Spec class is searched in the global registry,
+    where lies info about where to find the class.
+    If the validation flag is set to True, the arguments are
+    validated against a pydantic schema and then passed to the
+    constructor.
+
+    Parameters
+    ----------
+    kind : str
+        Registry entry kind.
+    validate : bool
+        Flag to determine if validate kwargs.
+    **kwargs : dict
+        Keyword arguments for the constructor.
+
+    Returns
+    -------
+    Spec
+        Spec object.
+    """
+    infos: RegistryEntry = getattr(registry, kind)
+    spec = import_class(infos.spec.module, infos.spec.class_name)
+    if validate:
+        validator = import_class(infos.spec.module, infos.spec.parameters_validator)
+        kwargs = validator(**kwargs).dict(by_alias=True, exclude_none=True)
+    return spec(**kwargs)

digitalhub/entities/_builders/status.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.state import State
+from digitalhub.registry.registry import registry
+from digitalhub.registry.utils import import_class
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.status.base import Status
+    from digitalhub.registry.models import RegistryEntry
+
+
+def build_status(kind: str, **kwargs) -> Status:
+    """
+    Build entity status object. The builder takes as input
+    the kind of status's object to build and the keyword
+    arguments to pass to the status's constructor.
+    The specific Status class is searched in the global
+    registry, where lies info about where to find the class.
+    The arguments are parsed, eventually adding default values,
+    and then passed to the constructor.
+
+    Parameters
+    ----------
+    kind : str
+        Registry entry kind.
+    **kwargs : dict
+        Keyword arguments for the constructor.
+
+    Returns
+    -------
+    Status
+        Status object.
+    """
+    infos: RegistryEntry = getattr(registry, kind)
+    status = import_class(infos.status.module, infos.status.class_name)
+    kwargs = parse_arguments(**kwargs)
+    return status(**kwargs)
+
+
+def parse_arguments(**kwargs) -> dict:
+    """
+    Parse keyword arguments and add default values if necessary.
+
+    Parameters
+    ----------
+    **kwargs : dict
+        Keyword arguments.
+
+    Returns
+    -------
+    dict
+        Keyword arguments with default values.
+    """
+    state = kwargs.get("state")
+    if state is None:
+        kwargs["state"] = State.CREATED.value
+    else:
+        if kwargs["state"] not in State.__members__:
+            raise ValueError(f"Invalid state: {state}")
+    return kwargs

digitalhub/entities/{_base/entity/_constructors → _builders}/uuid.py

@@ -2,7 +2,15 @@ from __future__ import annotations
 
 from uuid import uuid4
 
-from digitalhub.utils.generic_utils import slugify_string
+from pydantic import UUID4, BaseModel
+
+
+class UUIDValidator(BaseModel):
+    """
+    Validate UUID format.
+    """
+
+    uuid: UUID4
 
 
 def build_uuid(uuid: str | None = None) -> str:
@@ -12,7 +20,7 @@ def build_uuid(uuid: str | None = None) -> str:
     Parameters
     ----------
     uuid : str
-        ID of the object.
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
 
     Returns
     -------
@@ -20,7 +28,6 @@ def build_uuid(uuid: str | None = None) -> str:
         Validated UUID4.
     """
     if uuid is not None:
-        if slugify_string(uuid) != uuid:
-            raise ValueError(f"Invalid ID: {uuid}. Must pass slugified ID.")
+        UUIDValidator(uuid=uuid)
         return uuid
     return str(uuid4())

digitalhub/entities/artifact/builder.py

@@ -0,0 +1,133 @@
+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.artifact.entity._base import Artifact
+
+# Manage class mapper
+cls_mapper = {}
+
+try:
+    from digitalhub.entities.artifact.entity.artifact import ArtifactArtifact
+
+    cls_mapper["artifact"] = ArtifactArtifact
+except ImportError:
+    pass
+
+
+def _choose_artifact_type(kind: str) -> type[Artifact]:
+    """
+    Choose class based on kind.
+
+    Parameters
+    ----------
+    kind : str
+        Kind the object.
+
+    Returns
+    -------
+    type[Artifact]
+        Class of the artifact.
+    """
+    try:
+        return cls_mapper[kind]
+    except KeyError:
+        raise EntityError(f"Unknown artifact kind: {kind}")
+
+
+def artifact_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,
+) -> 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.
+    """
+    if path is None:
+        raise EntityError("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_artifact_type(kind)
+    return cls(
+        project=project,
+        name=name,
+        uuid=uuid,
+        kind=kind,
+        metadata=metadata,
+        spec=spec,
+        status=status,
+    )
+
+
+def artifact_from_dict(obj: dict) -> Artifact:
+    """
+    Create a new object from dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary to create object from.
+
+    Returns
+    -------
+    Artifact
+        Object instance.
+    """
+    kind = obj.get("kind")
+    cls = _choose_artifact_type(kind)
+    return cls.from_dict(obj)

digitalhub/entities/artifact/crud.py

@@ -2,21 +2,22 @@ from __future__ import annotations
 
 import typing
 
+from digitalhub.context.builder import check_context
 from digitalhub.entities._base.crud import (
-    delete_entity,
-    get_material_entity,
-    get_material_entity_versions,
-    import_context_entity,
-    list_material_entities,
-    new_context_entity,
+    delete_entity_api_ctx,
+    list_entity_api_ctx,
+    read_entity_api_ctx,
+    read_entity_api_ctx_versions,
 )
-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
+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._base.entity import Artifact
+    from digitalhub.entities.artifact.entity._base import Artifact
 
 
 ENTITY_TYPE = EntityTypes.ARTIFACT.value
@@ -29,7 +30,7 @@ def new_artifact(
     uuid: str | None = None,
     description: str | None = None,
     labels: list[str] | None = None,
-    embedded: bool = False,
+    embedded: bool = True,
     path: str | None = None,
     **kwargs,
 ) -> Artifact:
@@ -45,7 +46,7 @@ def new_artifact(
     kind : str
         Kind the object.
     uuid : str
-        ID of the object.
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
     description : str
         Description of the object (human readable).
     labels : list[str]
@@ -69,7 +70,8 @@ def new_artifact(
     >>>                    kind="artifact",
     >>>                    path="s3://my-bucket/my-key")
     """
-    return new_context_entity(
+    check_context(project)
+    obj = artifact_from_parameters(
         project=project,
         name=name,
         kind=kind,
@@ -80,6 +82,8 @@ def new_artifact(
         path=path,
         **kwargs,
     )
+    obj.save()
+    return obj
 
 
 def log_artifact(
@@ -167,13 +171,16 @@ def get_artifact(
     >>>                    project="my-project",
     >>>                    entity_id="my-artifact-id")
     """
-    return get_material_entity(
-        identifier=identifier,
-        entity_type=ENTITY_TYPE,
+    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(
@@ -207,12 +214,18 @@ def get_artifact_versions(
     >>> obj = get_artifact_versions("my-artifact-name"
     >>>                             project="my-project")
     """
-    return get_material_entity_versions(
-        identifier=identifier,
+    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]:
@@ -235,11 +248,17 @@ def list_artifacts(project: str, **kwargs) -> list[Artifact]:
     --------
     >>> objs = list_artifacts(project="my-project")
     """
-    return list_material_entities(
+    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:
@@ -260,7 +279,14 @@ def import_artifact(file: str) -> Artifact:
     --------
     >>> obj = import_artifact("my-artifact.yaml")
     """
-    return import_context_entity(file)
+    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:
@@ -322,7 +348,7 @@ def delete_artifact(
     >>>                  project="my-project",
     >>>                  delete_all_versions=True)
     """
-    return delete_entity(
+    return delete_entity_api_ctx(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

digitalhub/entities/artifact/{_base/entity.py → entity/_base.py}

@@ -2,13 +2,13 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.material.entity import MaterialEntity
-from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.entities._base.entity.material import MaterialEntity
+from digitalhub.entities.entity_types import EntityTypes
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.entity.metadata import Metadata
-    from digitalhub.entities.artifact._base.spec import ArtifactSpec
-    from digitalhub.entities.artifact._base.status import ArtifactStatus
+    from digitalhub.entities._base.metadata import Metadata
+    from digitalhub.entities.artifact.spec import ArtifactSpec
+    from digitalhub.entities.artifact.status import ArtifactStatus
 
 
 class Artifact(MaterialEntity):

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/{artifact/spec.py → spec.py}

@@ -1,11 +1,23 @@
 from __future__ import annotations
 
-from digitalhub.entities.artifact._base.spec import ArtifactSpec, ArtifactValidator
+from digitalhub.entities._base.spec.material import MaterialParams, MaterialSpec
+
+
+class ArtifactSpec(MaterialSpec):
+    """
+    Artifact specification.
+    """
+
+
+class ArtifactParams(MaterialParams):
+    """
+    Artifact base parameters.
+    """
 
 
 class ArtifactSpecArtifact(ArtifactSpec):
     """
-    ArtifactSpecArtifact specifications.
+    Artifact specification.
     """
 
     def __init__(
@@ -18,9 +30,9 @@ class ArtifactSpecArtifact(ArtifactSpec):
         self.src_path = src_path
 
 
-class ArtifactValidatorArtifact(ArtifactValidator):
+class ArtifactParamsArtifact(ArtifactParams):
     """
-    ArtifactValidatorArtifact validator.
+    Artifact parameters.
     """
 
     src_path: str = None

digitalhub/entities/artifact/{artifact/status.py → status.py}

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.material.status import MaterialStatus
+from digitalhub.entities._base.status.material import MaterialStatus
 
 
 class ArtifactStatus(MaterialStatus):

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)