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

digitalhub/entities/_base/{spec/material.py → material/spec.py}

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.spec.base import Spec, SpecParams
+from digitalhub.entities._base.entity.spec import Spec, SpecValidator
 
 
 class MaterialSpec(Spec):
     """
-    Material specification class.
+    Material specifications.class.
     """
 
     def __init__(self, path: str, **kwargs) -> None:
@@ -13,7 +13,7 @@ class MaterialSpec(Spec):
         self.path = path
 
 
-class MaterialParams(SpecParams):
+class MaterialValidator(SpecValidator):
     """
     Material parameters class.
     """

digitalhub/entities/_base/{status/material.py → material/status.py}

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

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

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.entity.context import ContextEntity
+from digitalhub.entities._base.context.entity import ContextEntity
 from digitalhub.entities._builders.metadata import build_metadata
 from digitalhub.entities._builders.spec import build_spec
 from digitalhub.entities._builders.status import build_status
@@ -10,9 +10,9 @@ from digitalhub.entities._builders.uuid import build_uuid
 from digitalhub.utils.io_utils import write_yaml
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities._base.spec.base import Spec
-    from digitalhub.entities._base.status.base import Status
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.status import Status
 
 
 class UnversionedEntity(ContextEntity):

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

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.entity.context import ContextEntity
+from digitalhub.entities._base.context.entity import ContextEntity
 from digitalhub.entities._builders.metadata import build_metadata
 from digitalhub.entities._builders.name import build_name
 from digitalhub.entities._builders.spec import build_spec
@@ -11,9 +11,9 @@ from digitalhub.entities._builders.uuid import build_uuid
 from digitalhub.utils.io_utils import write_yaml
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities._base.spec.base import Spec
-    from digitalhub.entities._base.status.base import Status
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.status import Status
 
 
 class VersionedEntity(ContextEntity):

digitalhub/entities/_builders/entity.py

@@ -0,0 +1,148 @@
+from __future__ import annotations
+
+import typing
+from abc import ABCMeta, abstractmethod
+
+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
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.entity import Entity
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec, SpecValidator
+    from digitalhub.entities._base.entity.status import Status
+
+
+class EntityBuilder(metaclass=ABCMeta):
+    """
+    Builder class for building entities.
+    """
+
+    # Class variables
+    ENTITY_CLASS: Entity = None
+    ENTITY_SPEC_CLASS: Spec = None
+    ENTITY_SPEC_VALIDATOR: SpecValidator = None
+    ENTITY_STATUS_CLASS: Status = None
+
+    def __init__(self) -> None:
+        if self.ENTITY_CLASS is None:
+            raise ValueError("ENTITY_CLASS must be set")
+        if self.ENTITY_SPEC_CLASS is None:
+            raise ValueError("ENTITY_SPEC_CLASS must be set")
+        if self.ENTITY_SPEC_VALIDATOR is None:
+            raise ValueError("ENTITY_SPEC_VALIDATOR must be set")
+        if self.ENTITY_STATUS_CLASS is None:
+            raise ValueError("ENTITY_STATUS_CLASS must be set")
+
+    def build_name(self, name: str) -> str:
+        """
+        Build entity name.
+
+        Parameters
+        ----------
+        name : str
+            Entity name.
+
+        Returns
+        -------
+        str
+            Entity name.
+        """
+        return build_name(name)
+
+    def build_uuid(self, uuid: str) -> str:
+        """
+        Build entity uuid.
+
+        Parameters
+        ----------
+        uuid : str
+            Entity uuid.
+
+        Returns
+        -------
+        str
+            Entity uuid.
+        """
+        return build_uuid(uuid)
+
+    def build_metadata(self, kind: str, **kwargs) -> Metadata:
+        """
+        Build entity metadata object.
+
+        Parameters
+        ----------
+        kind : str
+            Registry entry kind.
+        **kwargs : dict
+            Keyword arguments for the constructor.
+
+        Returns
+        -------
+        Metadata
+            Metadata object.
+        """
+        return build_metadata(kind, **kwargs)
+
+    def build_spec(self, kind: str, **kwargs) -> Spec:
+        """
+        Build entity spec object.
+
+        Parameters
+        ----------
+        kind : str
+            Registry entry kind.
+        **kwargs : dict
+            Keyword arguments for the constructor.
+
+        Returns
+        -------
+        Spec
+            Spec object.
+        """
+        return build_spec(kind, **kwargs)
+
+    def build_status(self, kind: str, **kwargs) -> Status:
+        """
+        Build entity status object.
+
+        Parameters
+        ----------
+        kind : str
+            Registry entry kind.
+        **kwargs : dict
+            Keyword arguments for the constructor.
+
+        Returns
+        -------
+        Status
+            Status object.
+        """
+        return build_status(kind, **kwargs)
+
+    @abstractmethod
+    def build(self, _validate: bool = True, **kwargs) -> Entity:
+        """
+        Build entity object.
+        """
+
+    def from_dict(self, obj: dict, validate: bool = True) -> Entity:
+        """
+        Build entity from dictionary.
+
+        Parameters
+        ----------
+        obj : dict
+            Dictionary to build the entity from.
+        validate : bool
+            Whether to validate the entity.
+
+        Returns
+        -------
+        ArtifactArtifact
+            Entity built from the dictionary.
+        """
+        return self.build(**obj, _validate=validate)

digitalhub/entities/_builders/factory.py

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+import typing
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.entity import Entity
+
+
+class EntityFactory:
+    """
+    Factory class for building entities.
+    """
+
+    def __init__(self):
+        self._builders = {}
+
+    def add_builder(self, name: str, builder):
+        self._builders[name] = builder
+
+    def build(self, entity_type: str, **kwargs) -> Entity:
+        """
+        Build entity object. The builder takes as input
+        the type of entity's object to build and the keyword
+        arguments to pass to the various entity's constructor.
+        The specific Entity 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
+        ----------
+        entity_type : str
+            Registry entry kind.
+        **kwargs : dict
+            Keyword arguments for the constructor.
+
+        Returns
+        -------
+        Entity
+            Entity object.
+        """
+        if entity_type not in self._builders:
+            raise ValueError(f"Entity type {entity_type} not found")
+        return self._builders[entity_type](**kwargs)

digitalhub/entities/_builders/metadata.py

@@ -1,15 +1,8 @@
 from __future__ import annotations
 
-import typing
-
-from digitalhub.registry.registry import registry
-from digitalhub.registry.utils import import_class
+from digitalhub.entities._base.entity.metadata import Metadata
 from digitalhub.utils.generic_utils import get_timestamp
 
-if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.registry.models import RegistryEntry
-
 
 def build_metadata(kind: str, **kwargs) -> Metadata:
     """
@@ -33,10 +26,8 @@ def build_metadata(kind: str, **kwargs) -> Metadata:
     Metadata
         Metadata object.
     """
-    infos: RegistryEntry = getattr(registry, kind)
-    metadata = import_class(infos.metadata.module, infos.metadata.class_name)
     kwargs = parse_arguments(**kwargs)
-    return metadata(**kwargs)
+    return Metadata(**kwargs)
 
 
 def parse_arguments(**kwargs) -> dict:

digitalhub/entities/_builders/spec.py

@@ -6,7 +6,7 @@ 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.entities._base.entity.spec import Spec
     from digitalhub.registry.models import RegistryEntry
 
 

digitalhub/entities/_builders/status.py

@@ -2,12 +2,12 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.state import State
+from digitalhub.entities.utils.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.entities._base.entity.status import Status
     from digitalhub.registry.models import RegistryEntry
 
 

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

@@ -2,13 +2,13 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.entity.material import MaterialEntity
-from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.entities._base.material.entity import MaterialEntity
+from digitalhub.entities.utils.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
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.artifact._base.spec import ArtifactSpec
+    from digitalhub.entities.artifact._base.status import ArtifactStatus
 
 
 class Artifact(MaterialEntity):

digitalhub/entities/artifact/_base/spec.py

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

digitalhub/entities/artifact/_base/status.py

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

digitalhub/entities/artifact/artifact/entity.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities.artifact._base.entity import Artifact
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.artifact.artifact.spec import ArtifactSpecArtifact
+    from digitalhub.entities.artifact.artifact.status import ArtifactStatusArtifact
+
+
+class ArtifactArtifact(Artifact):
+    """
+    ArtifactArtifact class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: ArtifactSpecArtifact,
+        status: ArtifactStatusArtifact,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: ArtifactSpecArtifact
+        self.status: ArtifactStatusArtifact

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

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

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

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

digitalhub/entities/artifact/builder.py

@@ -10,13 +10,13 @@ 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
+    from digitalhub.entities.artifact._base.entity import Artifact
 
 # Manage class mapper
 cls_mapper = {}
 
 try:
-    from digitalhub.entities.artifact.entity.artifact import ArtifactArtifact
+    from digitalhub.entities.artifact.artifact.entity import ArtifactArtifact
 
     cls_mapper["artifact"] = ArtifactArtifact
 except ImportError:

digitalhub/entities/artifact/crud.py

@@ -11,13 +11,13 @@ from digitalhub.entities._base.crud import (
 )
 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.entities.utils.entity_types import EntityTypes
+from digitalhub.entities.utils.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
+    from digitalhub.entities.artifact._base.entity import Artifact
 
 
 ENTITY_TYPE = EntityTypes.ARTIFACT.value

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

@@ -3,15 +3,15 @@ from __future__ import annotations
 import typing
 from pathlib import Path
 
-from digitalhub.entities._base.entity.material import MaterialEntity
-from digitalhub.entities.entity_types import EntityTypes
+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.metadata import Metadata
-    from digitalhub.entities.dataitem.spec import DataitemSpec
-    from digitalhub.entities.dataitem.status import DataitemStatus
+    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):

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

digitalhub/entities/dataitem/builder.py

@@ -10,24 +10,24 @@ 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
+    from digitalhub.entities.dataitem._base.entity import Dataitem
 
 # Manage class mapper
 cls_mapper = {}
 try:
-    from digitalhub.entities.dataitem.entity.dataitem import DataitemDataitem
+    from digitalhub.entities.dataitem.dataitem.entity import DataitemDataitem
 
     cls_mapper["dataitem"] = DataitemDataitem
 except ImportError:
     ...
 try:
-    from digitalhub.entities.dataitem.entity.table import DataitemTable
+    from digitalhub.entities.dataitem.table.entity import DataitemTable
 
     cls_mapper["table"] = DataitemTable
 except ImportError:
     ...
 try:
-    from digitalhub.entities.dataitem.entity.iceberg import DataitemIceberg
+    from digitalhub.entities.dataitem.iceberg.entity import DataitemIceberg
 
     cls_mapper["iceberg"] = DataitemIceberg
 except ImportError:

digitalhub/entities/dataitem/crud.py

@@ -14,15 +14,16 @@ from digitalhub.entities._base.crud import (
 )
 from digitalhub.entities._builders.uuid import build_uuid
 from digitalhub.entities.dataitem.builder import dataitem_from_dict, dataitem_from_parameters
-from digitalhub.entities.entity_types import EntityTypes
-from digitalhub.entities.utils import build_log_path_from_filename, build_log_path_from_source, eval_local_source
+from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.entities.utils.utils import build_log_path_from_filename, build_log_path_from_source, eval_local_source
 from digitalhub.readers.builder import get_reader_by_object
 from digitalhub.stores.builder import get_store
 from digitalhub.utils.exceptions import EntityAlreadyExistsError
+from digitalhub.utils.generic_utils import sanitize_filename
 from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.dataitem.entity._base import Dataitem
+    from digitalhub.entities.dataitem._base.entity import Dataitem
 
 
 ENTITY_TYPE = EntityTypes.DATAITEM.value
@@ -152,10 +153,12 @@ def log_dataitem(
 
     # Case where data is provided
     else:
+        extension = extension if extension is not None else "parquet"
         if path is None:
             uuid = build_uuid()
             kwargs["uuid"] = uuid
-            path = build_log_path_from_filename(project, ENTITY_TYPE, name, uuid, "data.parquet")
+            slug = sanitize_filename(name) + f".{extension}"
+            path = build_log_path_from_filename(project, ENTITY_TYPE, name, uuid, slug)
 
         obj = dataitem_from_parameters(project=project, name=name, kind=kind, path=path, **kwargs)
         if kind == "table":

digitalhub/entities/dataitem/dataitem/entity.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities.dataitem._base.entity import Dataitem
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.dataitem.dataitem.spec import DataitemSpecDataitem
+    from digitalhub.entities.dataitem.dataitem.status import DataitemStatusDataitem
+
+
+class DataitemDataitem(Dataitem):
+    """
+    DataitemDataitem class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: DataitemSpecDataitem,
+        status: DataitemStatusDataitem,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: DataitemSpecDataitem
+        self.status: DataitemStatusDataitem