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

digitalhub/entities/artifact/_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.artifact._base.entity import Artifact
+
+
+class ArtifactBuilder(VersionedBuilder):
+    """
+    Artifact builder.
+    """
+
+    ENTITY_TYPE = EntityTypes.ARTIFACT.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,
+    ) -> 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.
+        """
+        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/artifact/artifact/builder.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from digitalhub.entities.artifact._base.builder import ArtifactBuilder
+from digitalhub.entities.artifact.artifact.entity import ArtifactArtifact
+from digitalhub.entities.artifact.artifact.spec import ArtifactSpecArtifact, ArtifactValidatorArtifact
+from digitalhub.entities.artifact.artifact.status import ArtifactStatusArtifact
+
+
+class ArtifactArtifactBuilder(ArtifactBuilder):
+    """
+    ArtifactArtifact builder.
+    """
+
+    ENTITY_CLASS = ArtifactArtifact
+    ENTITY_SPEC_CLASS = ArtifactSpecArtifact
+    ENTITY_SPEC_VALIDATOR = ArtifactValidatorArtifact
+    ENTITY_STATUS_CLASS = ArtifactStatusArtifact
+    ENTITY_KIND = "artifact"

digitalhub/entities/artifact/builder.py

@@ -2,116 +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.artifact._base.entity import Artifact
 
-# Manage class mapper
-cls_mapper = {}
 
-try:
-    from digitalhub.entities.artifact.artifact.entity 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:
+def artifact_from_parameters(**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.
+    **kwargs
+        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,
-    )
+    try:
+        kind = kwargs["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    return factory.build_entity_from_params(kind, **kwargs)
 
 
 def artifact_from_dict(obj: dict) -> Artifact:
@@ -128,6 +44,8 @@ def artifact_from_dict(obj: dict) -> Artifact:
     Artifact
         Object instance.
     """
-    kind = obj.get("kind")
-    cls = _choose_artifact_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/artifact/crud.py

@@ -46,7 +46,7 @@ def new_artifact(
     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]

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

@@ -19,7 +19,7 @@ from digitalhub.entities.utils.utils import build_log_path_from_filename, build_
 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.generic_utils import slugify_string
 from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
@@ -52,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]
@@ -157,7 +157,7 @@ def log_dataitem(
         if path is None:
             uuid = build_uuid()
             kwargs["uuid"] = uuid
-            slug = sanitize_filename(name) + f".{extension}"
+            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)

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/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/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"