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

digitalhub/entities/project/builder.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+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.project.entity import Project
+
+
+def project_from_parameters(
+    name: str,
+    kind: str,
+    description: str | None = None,
+    labels: list[str] | None = None,
+    local: bool = False,
+    context: str | None = None,
+    **kwargs,
+) -> Project:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    name : str
+        Object name.
+    kind : str
+        Kind the object.
+    description : str
+        Description of the object (human readable).
+    labels : list[str]
+        List of labels.
+    local : bool
+        If True, use local backend, if False use DHCore backend. Default to False.
+    context : str
+        The context local folder of the project.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Project
+        Object instance.
+    """
+    name = build_name(name)
+    spec = build_spec(
+        kind,
+        context=context,
+        **kwargs,
+    )
+    metadata = build_metadata(
+        kind,
+        project=name,
+        name=name,
+        description=description,
+        labels=labels,
+    )
+    status = build_status(kind)
+    return Project(
+        name=name,
+        kind=kind,
+        metadata=metadata,
+        spec=spec,
+        status=status,
+        local=local,
+    )
+
+
+def project_from_dict(obj: dict) -> Project:
+    """
+    Create a new object from dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary to create object from.
+
+    Returns
+    -------
+    Project
+        Object instance.
+    """
+    return Project.from_dict(obj)

digitalhub/entities/project/crud.py

@@ -4,16 +4,16 @@ import importlib.util as imputil
 import typing
 from pathlib import Path
 
-from digitalhub.client.api import build_client, get_client
-from digitalhub.context.api import delete_context
-from digitalhub.entities._base.api_utils import delete_entity_api_base, read_entity_api_base, update_entity_api_base
-from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.factory.api import build_entity_from_dict, build_entity_from_params
-from digitalhub.utils.exceptions import BackendError, EntityAlreadyExistsError, EntityError
+from digitalhub.client.builder import build_client, get_client
+from digitalhub.context.builder import delete_context
+from digitalhub.entities._base.crud import delete_entity_api_base, read_entity_api_base, update_entity_api_base
+from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.entities.project.builder import project_from_dict, project_from_parameters
+from digitalhub.utils.exceptions import BackendError, EntityError
 from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.project._base.entity import Project
+    from digitalhub.entities.project.entity import Project
 
 
 ENTITY_TYPE = EntityTypes.PROJECT.value
@@ -63,7 +63,7 @@ def new_project(
     build_client(local, config)
     if context is None:
         context = name
-    obj = build_entity_from_params(
+    obj = project_from_parameters(
         name=name,
         kind="project",
         description=description,
@@ -112,7 +112,7 @@ def get_project(
     client = get_client(local)
     obj = read_entity_api_base(client, ENTITY_TYPE, name, **kwargs)
     obj["local"] = local
-    project = build_entity_from_dict(obj)
+    project = project_from_dict(obj)
     return _setup_project(project, setup_kwargs)
 
 
@@ -148,18 +148,11 @@ def import_project(
     build_client(local, config)
     dict_obj: dict = read_yaml(file)
     dict_obj["local"] = local
-    obj = build_entity_from_dict(dict_obj)
+    obj = project_from_dict(dict_obj)
     obj = _setup_project(obj, setup_kwargs)
 
-    try:
-        obj.save()
-    except EntityAlreadyExistsError:
-        pass
-
     # Import related entities
-    obj._import_entities(dict_obj)
-
-    obj.refresh()
+    obj._import_entities()
 
     return obj
 
@@ -285,7 +278,7 @@ def update_project(entity: Project, local: bool = False, **kwargs) -> Project:
     """
     client = get_client(local)
     obj = update_entity_api_base(client, ENTITY_TYPE, entity.name, entity.to_dict(), **kwargs)
-    return build_entity_from_dict(obj)
+    return project_from_dict(obj)
 
 
 def delete_project(

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

@@ -4,17 +4,21 @@ import typing
 from pathlib import Path
 from typing import Any
 
-from digitalhub.client.api import get_client
-from digitalhub.context.api import set_context
-from digitalhub.entities._base.api_utils import (
+from digitalhub.client.builder import get_client
+from digitalhub.context.builder import set_context
+from digitalhub.entities._base.crud import (
     create_entity_api_base,
     read_entity_api_base,
     read_entity_api_ctx,
     update_entity_api_base,
 )
-from digitalhub.entities._base.crud import import_context_entity, import_executable_entity
-from digitalhub.entities._base.entity.entity import Entity
+from digitalhub.entities._base.entity.base import Entity
+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.artifact.crud import (
+    artifact_from_dict,
     delete_artifact,
     get_artifact,
     get_artifact_versions,
@@ -25,6 +29,7 @@ from digitalhub.entities.artifact.crud import (
     update_artifact,
 )
 from digitalhub.entities.dataitem.crud import (
+    dataitem_from_dict,
     delete_dataitem,
     get_dataitem,
     get_dataitem_versions,
@@ -34,8 +39,10 @@ from digitalhub.entities.dataitem.crud import (
     new_dataitem,
     update_dataitem,
 )
+from digitalhub.entities.entity_types import EntityTypes
 from digitalhub.entities.function.crud import (
     delete_function,
+    function_from_dict,
     get_function,
     get_function_versions,
     import_function,
@@ -50,6 +57,7 @@ from digitalhub.entities.model.crud import (
     import_model,
     list_models,
     log_model,
+    model_from_dict,
     new_model,
     update_model,
 )
@@ -63,7 +71,6 @@ from digitalhub.entities.secret.crud import (
     new_secret,
     update_secret,
 )
-from digitalhub.entities.utils.entity_types import EntityTypes
 from digitalhub.entities.workflow.crud import (
     delete_workflow,
     get_workflow,
@@ -72,24 +79,49 @@ from digitalhub.entities.workflow.crud import (
     list_workflows,
     new_workflow,
     update_workflow,
+    workflow_from_dict,
 )
-from digitalhub.factory.api import build_entity_from_dict
 from digitalhub.utils.exceptions import BackendError, EntityAlreadyExistsError, EntityError
 from digitalhub.utils.generic_utils import get_timestamp
 from digitalhub.utils.io_utils import write_yaml
 from digitalhub.utils.uri_utils import map_uri_scheme
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.entity.metadata import Metadata
-    from digitalhub.entities.artifact._base.entity import Artifact
-    from digitalhub.entities.dataitem._base.entity import Dataitem
-    from digitalhub.entities.function._base.entity import Function
-    from digitalhub.entities.model._base.entity import Model
-    from digitalhub.entities.project._base.spec import ProjectSpec
-    from digitalhub.entities.project._base.status import ProjectStatus
-    from digitalhub.entities.run._base.entity import Run
-    from digitalhub.entities.secret._base.entity import Secret
-    from digitalhub.entities.workflow._base.entity import Workflow
+    from digitalhub.entities._base.metadata import Metadata
+    from digitalhub.entities.artifact.entity._base import Artifact
+    from digitalhub.entities.dataitem.entity._base import Dataitem
+    from digitalhub.entities.function.entity import Function
+    from digitalhub.entities.model.entity._base import Model
+    from digitalhub.entities.project.spec import ProjectSpec
+    from digitalhub.entities.project.status import ProjectStatus
+    from digitalhub.entities.run.entity import Run
+    from digitalhub.entities.secret.entity import Secret
+    from digitalhub.entities.workflow.entity import Workflow
+
+
+ARTIFACTS = EntityTypes.ARTIFACT.value + "s"
+FUNCTIONS = EntityTypes.FUNCTION.value + "s"
+WORKFLOWS = EntityTypes.WORKFLOW.value + "s"
+DATAITEMS = EntityTypes.DATAITEM.value + "s"
+MODELS = EntityTypes.MODEL.value + "s"
+
+CTX_ENTITIES = [ARTIFACTS, FUNCTIONS, WORKFLOWS, DATAITEMS, MODELS]
+
+FROM_DICT_MAP = {
+    ARTIFACTS: artifact_from_dict,
+    FUNCTIONS: function_from_dict,
+    WORKFLOWS: workflow_from_dict,
+    DATAITEMS: dataitem_from_dict,
+    MODELS: model_from_dict,
+}
+
+IMPORT_MAP = {
+    ARTIFACTS: import_artifact,
+    FUNCTIONS: import_function,
+    WORKFLOWS: import_workflow,
+    DATAITEMS: import_dataitem,
+    MODELS: import_model,
+}
 
 
 class Project(Entity):
@@ -192,7 +224,6 @@ class Project(Entity):
             filename = f"{self.kind}_{self.name}.yml"
         pth = Path(self.spec.context) / filename
         pth.parent.mkdir(parents=True, exist_ok=True)
-
         obj = self._export_not_embedded(obj)
         write_yaml(pth, obj)
         return str(pth)
@@ -226,16 +257,16 @@ class Project(Entity):
             Updatated project object in dictionary format with referenced entities.
         """
         # Cycle over entity types
-        for entity_type in self._get_entity_types():
+        for entity_type in CTX_ENTITIES:
             # Entity types are stored as a list of entities
             for idx, entity in enumerate(obj.get("spec", {}).get(entity_type, [])):
                 # Export entity if not embedded is in metadata, else do nothing
-                if not self._is_embedded(entity):
+                if not entity["metadata"]["embedded"]:
                     # Get entity object from backend
                     obj_dict: dict = read_entity_api_ctx(entity["key"])
 
                     # Create from dict (not need to new method, we do not save to backend)
-                    ent = build_entity_from_dict(obj_dict)
+                    ent = FROM_DICT_MAP[entity_type](obj_dict)
 
                     # Export and stor ref in object metadata inside project
                     pth = ent.export()
@@ -244,121 +275,76 @@ class Project(Entity):
         # Return updated object
         return obj
 
-    def _import_entities(self, obj: dict) -> None:
+    def _import_entities(self) -> None:
         """
         Import project entities.
 
-        Parameters
-        ----------
-        obj : dict
-            Project object in dictionary format.
-
         Returns
         -------
         None
         """
-        entity_types = self._get_entity_types()
-
         # Cycle over entity types
-        for entity_type in entity_types:
+        for entity_type in CTX_ENTITIES:
             # Entity types are stored as a list of entities
-            for entity in obj.get("spec", {}).get(entity_type, []):
-                embedded = self._is_embedded(entity)
-                ref = entity["metadata"].get("ref")
+            for entity in getattr(self.spec, entity_type, []):
+                entity_metadata = entity["metadata"]
+                embedded = entity_metadata.get("embedded", False)
+                ref = entity_metadata.get("ref", None)
 
-                # Import entity if not embedded and there is a ref
+                # Import entity if not embedded
                 if not embedded and ref is not None:
                     # Import entity from local ref
                     if map_uri_scheme(ref) == "local":
                         try:
-                            # Artifacts, Dataitems and Models
-                            if entity_type in entity_types[:3]:
-                                import_context_entity(ref)
-
-                            # Functions and Workflows
-                            elif entity_type in entity_types[3:]:
-                                import_executable_entity(ref)
-
+                            IMPORT_MAP[entity_type](ref)
                         except FileNotFoundError:
                             msg = f"File not found: {ref}."
                             raise EntityError(msg)
 
                 # If entity is embedded, create it and try to save
                 elif embedded:
-                    # It's possible that embedded field in metadata is not shown
-                    if entity["metadata"].get("embedded") is None:
-                        entity["metadata"]["embedded"] = True
-
                     try:
-                        build_entity_from_dict(entity).save()
+                        FROM_DICT_MAP[entity_type](entity).save()
                     except EntityAlreadyExistsError:
                         pass
 
-    def _is_embedded(self, entity: dict) -> bool:
-        """
-        Check if entity is embedded.
-
-        Parameters
-        ----------
-        entity : dict
-            Entity in dictionary format.
-
-        Returns
-        -------
-        bool
-            True if entity is embedded.
-        """
-        metadata_embedded = entity["metadata"].get("embedded", False)
-        no_status = entity.get("status", None) is None
-        no_spec = entity.get("spec", None) is None
-        return metadata_embedded or not (no_status and no_spec)
-
-    def _get_entity_types(self) -> list[str]:
-        """
-        Get entity types.
-
-        Returns
-        -------
-        list
-            Entity types.
-        """
-        return [
-            f"{EntityTypes.ARTIFACT.value}s",
-            f"{EntityTypes.DATAITEM.value}s",
-            f"{EntityTypes.MODEL.value}s",
-            f"{EntityTypes.FUNCTION.value}s",
-            f"{EntityTypes.WORKFLOW.value}s",
-        ]
+    ##############################
+    #  Static interface methods
+    ##############################
 
-    def run(self, workflow: str | None = None, **kwargs) -> Run:
+    @staticmethod
+    def _parse_dict(obj: dict, validate: bool = True) -> dict:
         """
-        Run workflow project.
+        Get dictionary and parse it to a valid entity dictionary.
 
         Parameters
         ----------
-        workflow : str
-            Workflow name.
-        **kwargs : dict
-            Keyword arguments passed to workflow.run().
+        entity : str
+            Entity type.
+        obj : dict
+            Dictionary to parse.
 
         Returns
         -------
-        Run
-            Run instance.
-        """
-        self.refresh()
-
-        workflow = workflow if workflow is not None else "main"
-
-        for i in self.spec.workflows:
-            if workflow in [i["name"], i["key"]]:
-                entity = self.get_workflow(i["key"])
-                break
-        else:
-            msg = f"Workflow {workflow} not found."
-            raise EntityError(msg)
-
-        return entity.run(**kwargs)
+        dict
+            A dictionary containing the attributes of the entity instance.
+        """
+        name = build_name(obj.get("name"))
+        kind = obj.get("kind")
+        metadata = build_metadata(kind, **obj.get("metadata", {}))
+        spec = build_spec(kind, validate=validate, **obj.get("spec", {}))
+        status = build_status(kind, **obj.get("status", {}))
+        user = obj.get("user")
+        local = obj.get("local", False)
+        return {
+            "name": name,
+            "kind": kind,
+            "metadata": metadata,
+            "spec": spec,
+            "status": status,
+            "user": user,
+            "local": local,
+        }
 
     ##############################
     #  Artifacts
@@ -371,7 +357,7 @@ class Project(Entity):
         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:
@@ -385,7 +371,7 @@ class Project(Entity):
         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]
@@ -662,7 +648,7 @@ class Project(Entity):
         uuid: str | None = None,
         description: str | None = None,
         labels: list[str] | None = None,
-        embedded: bool = False,
+        embedded: bool = True,
         path: str | None = None,
         **kwargs,
     ) -> Dataitem:
@@ -676,7 +662,7 @@ class Project(Entity):
         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]
@@ -966,7 +952,7 @@ class Project(Entity):
         uuid: str | None = None,
         description: str | None = None,
         labels: list[str] | None = None,
-        embedded: bool = False,
+        embedded: bool = True,
         path: str | None = None,
         **kwargs,
     ) -> Model:
@@ -980,7 +966,7 @@ class Project(Entity):
         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]
@@ -1258,7 +1244,7 @@ class Project(Entity):
         uuid: str | None = None,
         description: str | None = None,
         labels: list[str] | None = None,
-        embedded: bool = False,
+        embedded: bool = True,
         **kwargs,
     ) -> Function:
         """
@@ -1271,7 +1257,7 @@ class Project(Entity):
         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]
@@ -1504,7 +1490,7 @@ class Project(Entity):
         uuid: str | None = None,
         description: str | None = None,
         labels: list[str] | None = None,
-        embedded: bool = False,
+        embedded: bool = True,
         **kwargs,
     ) -> Workflow:
         """
@@ -1517,7 +1503,7 @@ class Project(Entity):
         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]
@@ -1749,7 +1735,7 @@ class Project(Entity):
         uuid: str | None = None,
         description: str | None = None,
         labels: list[str] | None = None,
-        embedded: bool = False,
+        embedded: bool = True,
         secret_value: str | None = None,
         **kwargs,
     ) -> Secret:
@@ -1761,7 +1747,7 @@ class Project(Entity):
         name : str
             Object name.
         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]
@@ -2072,7 +2058,3 @@ class Project(Entity):
             **kwargs,
         )
         self.refresh()
-
-    ##############################
-    #  Project methods
-    ##############################

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

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.entity.spec import Spec, SpecValidator
+from digitalhub.entities._base.spec.base import Spec, SpecParams
 
 
 class ProjectSpec(Spec):
     """
-    ProjectSpec specifications.
+    Project specification.
     """
 
     def __init__(
@@ -26,9 +26,9 @@ class ProjectSpec(Spec):
         self.models = models if models is not None else []
 
 
-class ProjectValidator(SpecValidator):
+class ProjectParams(SpecParams):
     """
-    ProjectValidator validator.
+    Parameters model for project.
     """
 
     context: str = None

digitalhub/entities/project/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.status.base import Status
+
+
+class ProjectStatus(Status):
+    """
+    Status class for project entities.
+    """

digitalhub/entities/registries.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.registry.registry import registry
+from digitalhub.registry.utils import create_info
+
+# Root module
+root = "digitalhub.entities"
+
+# Projects
+entity_type = EntityTypes.PROJECT.value
+prefix = entity_type.capitalize()
+project_info = create_info(root, entity_type, prefix)
+registry.register("project", project_info)
+
+
+# Secrets
+entity_type = EntityTypes.SECRET.value
+prefix = entity_type.capitalize()
+secret_info = create_info(root, entity_type, prefix)
+registry.register("secret", secret_info)
+
+
+# Artifacts
+entity_type = EntityTypes.ARTIFACT.value
+for i in ["artifact"]:
+    prefix = entity_type.capitalize()
+    suffix = i.capitalize()
+    artifact_info = create_info(root, entity_type, prefix, suffix)
+    registry.register(i, artifact_info)
+
+
+# Dataitems
+entity_type = EntityTypes.DATAITEM.value
+for i in ["dataitem", "table"]:
+    prefix = entity_type.capitalize()
+    suffix = i.capitalize()
+    dataitem_info = create_info(root, entity_type, prefix, suffix)
+    registry.register(i, dataitem_info)
+
+
+# Models
+entity_type = EntityTypes.MODEL.value
+for i in ["model", "mlflow", "sklearn", "huggingface"]:
+    prefix = entity_type.capitalize()
+    suffix = i.capitalize()
+    model_info = create_info(root, entity_type, prefix, suffix)
+    registry.register(i, model_info)