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

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 = 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.
+        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/{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

@@ -2,127 +2,32 @@ 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
+from digitalhub.factory.factory import factory
+from digitalhub.utils.exceptions import BuilderError
 
 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
 
-    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:
+def dataitem_from_parameters(**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.
+    **kwargs
+        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,
-    )
+    try:
+        kind = kwargs["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    return factory.build_entity_from_params(kind, **kwargs)
 
 
 def dataitem_from_dict(obj: dict) -> Dataitem:
@@ -139,6 +44,8 @@ def dataitem_from_dict(obj: dict) -> Dataitem:
     Dataitem
         Object instance.
     """
-    kind = obj.get("kind")
-    cls = _choose_dataitem_type(kind)
-    return cls.from_dict(obj)
+    try:
+        kind = obj["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    return factory.build_entity_from_dict(kind, obj)

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 slugify_string
 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
@@ -51,7 +52,7 @@ def new_dataitem(
     kind : str
         Kind the object.
     uuid : str
-        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+        ID of the object.
     description : str
         Description of the object (human readable).
     labels : list[str]
@@ -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 = slugify_string(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/builder.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from digitalhub.entities.dataitem._base.builder import DataitemBuilder
+from digitalhub.entities.dataitem.dataitem.entity import DataitemDataitem
+from digitalhub.entities.dataitem.dataitem.spec import DataitemSpecDataitem, DataitemValidatorDataitem
+from digitalhub.entities.dataitem.dataitem.status import DataitemStatusDataitem
+
+
+class DataitemDataitemBuilder(DataitemBuilder):
+    """
+    DataitemDataitem builder.
+    """
+
+    ENTITY_CLASS = DataitemDataitem
+    ENTITY_SPEC_CLASS = DataitemSpecDataitem
+    ENTITY_SPEC_VALIDATOR = DataitemValidatorDataitem
+    ENTITY_STATUS_CLASS = DataitemStatusDataitem
+    ENTITY_KIND = "dataitem"

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

digitalhub/entities/dataitem/dataitem/spec.py

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

digitalhub/entities/dataitem/dataitem/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities.dataitem._base.status import DataitemStatus
+
+
+class DataitemStatusDataitem(DataitemStatus):
+    """
+    DataitemStatusDataitem status.
+    """

digitalhub/entities/dataitem/iceberg/builder.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from digitalhub.entities.dataitem._base.builder import DataitemBuilder
+from digitalhub.entities.dataitem.iceberg.entity import DataitemIceberg
+from digitalhub.entities.dataitem.iceberg.spec import DataitemSpecIceberg, DataitemValidatorIceberg
+from digitalhub.entities.dataitem.iceberg.status import DataitemStatusIceberg
+
+
+class DataitemIcebergBuilder(DataitemBuilder):
+    """
+    DataitemIceberg builder.
+    """
+
+    ENTITY_CLASS = DataitemIceberg
+    ENTITY_SPEC_CLASS = DataitemSpecIceberg
+    ENTITY_SPEC_VALIDATOR = DataitemValidatorIceberg
+    ENTITY_STATUS_CLASS = DataitemStatusIceberg
+    ENTITY_KIND = "iceberg"

digitalhub/entities/dataitem/iceberg/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.iceberg.spec import DataitemSpecIceberg
+    from digitalhub.entities.dataitem.iceberg.status import DataitemStatusIceberg
+
+
+class DataitemIceberg(Dataitem):
+    """
+    DataitemIceberg class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: DataitemSpecIceberg,
+        status: DataitemStatusIceberg,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: DataitemSpecIceberg
+        self.status: DataitemStatusIceberg

digitalhub/entities/dataitem/iceberg/spec.py

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

digitalhub/entities/dataitem/iceberg/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities.dataitem._base.status import DataitemStatus
+
+
+class DataitemStatusIceberg(DataitemStatus):
+    """
+    DataitemStatusIceberg status.
+    """

digitalhub/entities/dataitem/table/builder.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from digitalhub.entities.dataitem._base.builder import DataitemBuilder
+from digitalhub.entities.dataitem.table.entity import DataitemTable
+from digitalhub.entities.dataitem.table.spec import DataitemSpecTable, DataitemValidatorTable
+from digitalhub.entities.dataitem.table.status import DataitemStatusTable
+
+
+class DataitemTableBuilder(DataitemBuilder):
+    """
+    DataitemTable builder.
+    """
+
+    ENTITY_CLASS = DataitemTable
+    ENTITY_SPEC_CLASS = DataitemSpecTable
+    ENTITY_SPEC_VALIDATOR = DataitemValidatorTable
+    ENTITY_STATUS_CLASS = DataitemStatusTable
+    ENTITY_KIND = "table"

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

@@ -1,20 +1,41 @@
 from __future__ import annotations
 
 import shutil
+import typing
 from pathlib import Path
 from typing import Any
 
 from digitalhub.datastores.builder import get_datastore
-from digitalhub.entities.dataitem.entity._base import Dataitem
+from digitalhub.entities.dataitem._base.entity import Dataitem
 from digitalhub.utils.uri_utils import check_local_path
 
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.dataitem.table.spec import DataitemSpecTable
+    from digitalhub.entities.dataitem.table.status import DataitemStatusTable
 
-class DataitemTable(Dataitem):
 
+class DataitemTable(Dataitem):
     """
-    Table dataitem.
+    DataitemTable class.
     """
 
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: DataitemSpecTable,
+        status: DataitemStatusTable,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: DataitemSpecTable
+        self.status: DataitemStatusTable
+
     def as_df(
         self,
         file_format: str | None = None,

digitalhub/entities/dataitem/table/spec.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from pydantic import Field
+
+from digitalhub.entities.dataitem._base.spec import DataitemSpec, DataitemValidator
+from digitalhub.entities.dataitem.table.models import TableSchema
+
+
+class DataitemSpecTable(DataitemSpec):
+    """
+    DataitemSpecTable specifications.
+    """
+
+    def __init__(self, path: str, schema: dict | None = None) -> None:
+        super().__init__(path)
+        self.schema = schema
+
+
+class DataitemValidatorTable(DataitemValidator):
+    """
+    DataitemValidatorTable validator.
+    """
+
+    schema_: TableSchema = Field(default=None, alias="schema")
+    """The schema of the dataitem in table schema format."""

digitalhub/entities/dataitem/table/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities.dataitem._base.status import DataitemStatus
+
+
+class DataitemStatusTable(DataitemStatus):
+    """
+    DataitemStatusTable status.
+    """