digitalhub 0.10.0b5__py3-none-any.whl → 0.10.0b6__py3-none-any.whl

digitalhub/entities/_processors/utils.py

@@ -0,0 +1,158 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.client.api import get_client
+from digitalhub.context.api import get_context
+from digitalhub.entities._commons.enums import ApiCategories, BackendOperations, EntityTypes
+from digitalhub.entities._commons.utils import get_project_from_key, parse_entity_key
+from digitalhub.factory.api import build_entity_from_dict
+from digitalhub.utils.exceptions import ContextError, EntityError, EntityNotExistsError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.client._base.client import Client
+    from digitalhub.context.context import Context
+
+
+def parse_identifier(
+    identifier: str,
+    project: str | None = None,
+    entity_type: str | None = None,
+    entity_kind: str | None = None,
+    entity_id: str | None = None,
+) -> tuple[str, str, str | None, str | None, str | None]:
+    """
+    Parse entity identifier.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+
+    Returns
+    -------
+    tuple[str, str, str | None, str | None, str | None]
+        Project name, entity type, entity kind, entity name, entity ID.
+    """
+    if not identifier.startswith("store://"):
+        if project is None or entity_type is None:
+            raise ValueError("Project and entity type must be specified.")
+        return project, entity_type, entity_kind, identifier, entity_id
+    return parse_entity_key(identifier)
+
+
+def get_context_from_identifier(
+    identifier: str,
+    project: str | None = None,
+) -> Context:
+    """
+    Get context from project.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+
+    Returns
+    -------
+    Context
+        Context.
+    """
+    if not identifier.startswith("store://"):
+        if project is None:
+            raise EntityError("Specify project if you do not specify entity key.")
+    else:
+        project = get_project_from_key(identifier)
+
+    return get_context_from_project(project)
+
+
+def get_context_from_project(
+    project: str,
+) -> Context:
+    """
+    Check if the given project is in the context.
+    Otherwise try to get the project from remote.
+    Finally return the client.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+
+    Returns
+    -------
+    Context
+        Context.
+    """
+    try:
+        return get_context(project)
+    except ContextError:
+        return get_context_from_remote(project)
+
+
+def get_context_from_remote(
+    project: str,
+) -> Client:
+    """
+    Get context from remote.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+
+    Returns
+    -------
+    Client
+        Client.
+    """
+    try:
+        client = get_client()
+        obj = _read_base_entity(client, EntityTypes.PROJECT.value, project)
+        build_entity_from_dict(obj)
+        return get_context(project)
+    except EntityNotExistsError:
+        raise ContextError(f"Project '{project}' not found.")
+
+
+def _read_base_entity(
+    client: Client,
+    entity_type: str,
+    entity_name: str,
+    **kwargs,
+) -> dict:
+    """
+    Read object from backend.
+
+    Parameters
+    ----------
+    client : Client
+        Client instance.
+    entity_type : str
+        Entity type.
+    entity_name : str
+        Entity name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    dict
+        Object instance.
+    """
+    api = client.build_api(
+        ApiCategories.BASE.value,
+        BackendOperations.READ.value,
+        entity_type=entity_type,
+        entity_name=entity_name,
+    )
+    return client.read_object(api, **kwargs)

digitalhub/entities/artifact/crud.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.entities.artifact._base.entity import Artifact
 from digitalhub.entities.artifact.utils import eval_source, process_kwargs
 from digitalhub.utils.types import SourcesOrListOfSources
@@ -62,7 +62,7 @@ def new_artifact(
     >>>                    kind="artifact",
     >>>                    path="s3://my-bucket/my-key")
     """
-    return processor.create_context_entity(
+    return context_processor.create_context_entity(
         project=project,
         name=name,
         kind=kind,
@@ -115,7 +115,7 @@ def log_artifact(
     """
     eval_source(source)
     kwargs = process_kwargs(project, name, source=source, path=path, **kwargs)
-    return processor.log_material_entity(
+    return context_processor.log_material_entity(
         source=source,
         project=project,
         name=name,
@@ -159,7 +159,7 @@ def get_artifact(
     >>>                    project="my-project",
     >>>                    entity_id="my-artifact-id")
     """
-    return processor.read_context_entity(
+    return context_processor.read_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -199,7 +199,7 @@ def get_artifact_versions(
     >>> obj = get_artifact_versions("my-artifact-name"
     >>>                             project="my-project")
     """
-    return processor.read_context_entity_versions(
+    return context_processor.read_context_entity_versions(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -227,7 +227,7 @@ def list_artifacts(project: str, **kwargs) -> list[Artifact]:
     --------
     >>> objs = list_artifacts(project="my-project")
     """
-    return processor.list_context_entities(
+    return context_processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
@@ -252,7 +252,7 @@ def import_artifact(file: str) -> Artifact:
     --------
     >>> obj = import_artifact("my-artifact.yaml")
     """
-    return processor.import_context_entity(file)
+    return context_processor.import_context_entity(file)
 
 
 def load_artifact(file: str) -> Artifact:
@@ -273,7 +273,7 @@ def load_artifact(file: str) -> Artifact:
     --------
     >>> obj = load_artifact("my-artifact.yaml")
     """
-    return processor.load_context_entity(file)
+    return context_processor.load_context_entity(file)
 
 
 def update_artifact(entity: Artifact) -> Artifact:
@@ -294,7 +294,7 @@ def update_artifact(entity: Artifact) -> Artifact:
     --------
     >>> obj = update_artifact(obj)
     """
-    return processor.update_context_entity(
+    return context_processor.update_context_entity(
         project=entity.project,
         entity_type=entity.ENTITY_TYPE,
         entity_id=entity.id,
@@ -340,7 +340,7 @@ def delete_artifact(
     >>>                  project="my-project",
     >>>                  delete_all_versions=True)
     """
-    return processor.delete_context_entity(
+    return context_processor.delete_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

digitalhub/entities/dataitem/crud.py

@@ -4,7 +4,7 @@ import typing
 from typing import Any
 
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.entities.dataitem.utils import clean_tmp_path, eval_data, eval_source, post_process, process_kwargs
 from digitalhub.utils.types import SourcesOrListOfSources
 
@@ -62,7 +62,7 @@ def new_dataitem(
     >>>                    kind="dataitem",
     >>>                    path="s3://my-bucket/my-key")
     """
-    return processor.create_context_entity(
+    return context_processor.create_context_entity(
         project=project,
         name=name,
         kind=kind,
@@ -129,7 +129,7 @@ def log_dataitem(
     source = eval_source(source, data, kind, name, project)
     data = eval_data(project, kind, source, data, file_format, engine)
     kwargs = process_kwargs(project, name, kind, source=source, data=data, path=path, **kwargs)
-    obj = processor.log_material_entity(
+    obj = context_processor.log_material_entity(
         source=source,
         project=project,
         name=name,
@@ -177,7 +177,7 @@ def get_dataitem(
     >>>                    project="my-project",
     >>>                    entity_id="my-dataitem-id")
     """
-    return processor.read_context_entity(
+    return context_processor.read_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -217,7 +217,7 @@ def get_dataitem_versions(
     >>> objs = get_dataitem_versions("my-dataitem-name",
     >>>                              project="my-project")
     """
-    return processor.read_context_entity_versions(
+    return context_processor.read_context_entity_versions(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -245,7 +245,7 @@ def list_dataitems(project: str, **kwargs) -> list[Dataitem]:
     --------
     >>> objs = list_dataitems(project="my-project")
     """
-    return processor.list_context_entities(
+    return context_processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
@@ -270,7 +270,7 @@ def import_dataitem(file: str) -> Dataitem:
     --------
     >>> obj = import_dataitem("my-dataitem.yaml")
     """
-    return processor.import_context_entity(file)
+    return context_processor.import_context_entity(file)
 
 
 def load_dataitem(file: str) -> Dataitem:
@@ -291,7 +291,7 @@ def load_dataitem(file: str) -> Dataitem:
     --------
     >>> obj = load_dataitem("my-dataitem.yaml")
     """
-    return processor.load_context_entity(file)
+    return context_processor.load_context_entity(file)
 
 
 def update_dataitem(entity: Dataitem) -> Dataitem:
@@ -312,7 +312,7 @@ def update_dataitem(entity: Dataitem) -> Dataitem:
     --------
     >>> obj = update_dataitem(obj)
     """
-    return processor.update_context_entity(
+    return context_processor.update_context_entity(
         project=entity.project,
         entity_type=entity.ENTITY_TYPE,
         entity_id=entity.id,
@@ -358,7 +358,7 @@ def delete_dataitem(
     >>>                       project="my-project",
     >>>                       delete_all_versions=True)
     """
-    return processor.delete_context_entity(
+    return context_processor.delete_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

digitalhub/entities/function/crud.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.function._base.entity import Function
@@ -56,7 +56,7 @@ def new_function(
     >>>                    code_src="function.py",
     >>>                    handler="function-handler")
     """
-    return processor.create_context_entity(
+    return context_processor.create_context_entity(
         project=project,
         name=name,
         kind=kind,
@@ -103,7 +103,7 @@ def get_function(
     >>>                    project="my-project",
     >>>                    entity_id="my-function-id")
     """
-    return processor.read_context_entity(
+    return context_processor.read_context_entity(
         identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -143,7 +143,7 @@ def get_function_versions(
     >>> obj = get_function_versions("my-function-name"
     >>>                             project="my-project")
     """
-    return processor.read_context_entity_versions(
+    return context_processor.read_context_entity_versions(
         identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -171,7 +171,7 @@ def list_functions(project: str, **kwargs) -> list[Function]:
     --------
     >>> objs = list_functions(project="my-project")
     """
-    return processor.list_context_entities(
+    return context_processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
@@ -196,7 +196,7 @@ def import_function(file: str) -> Function:
     --------
     >>> obj = import_function("my-function.yaml")
     """
-    return processor.import_executable_entity(file)
+    return context_processor.import_executable_entity(file)
 
 
 def load_function(file: str) -> Function:
@@ -217,7 +217,7 @@ def load_function(file: str) -> Function:
     --------
     >>> obj = load_function("my-function.yaml")
     """
-    return processor.load_executable_entity(file)
+    return context_processor.load_executable_entity(file)
 
 
 def update_function(entity: Function) -> Function:
@@ -238,7 +238,7 @@ def update_function(entity: Function) -> Function:
     --------
     >>> obj = update_function(obj)
     """
-    return processor.update_context_entity(
+    return context_processor.update_context_entity(
         project=entity.project,
         entity_type=entity.ENTITY_TYPE,
         entity_id=entity.id,
@@ -287,7 +287,7 @@ def delete_function(
     >>>                       project="my-project",
     >>>                       delete_all_versions=True)
     """
-    return processor.delete_context_entity(
+    return context_processor.delete_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,

digitalhub/entities/model/_base/entity.py

@@ -4,8 +4,8 @@ import typing
 
 from digitalhub.entities._base.material.entity import MaterialEntity
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._commons.utils import validate_metric_value
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._commons.metrics import MetricType, set_metrics, validate_metric_value
+from digitalhub.entities._processors.context import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -35,9 +35,6 @@ class Model(MaterialEntity):
         self.spec: ModelSpec
         self.status: ModelStatus
 
-        # Initialize metrics
-        self._init_metrics()
-
     def save(self, update: bool = False) -> Model:
         """
         Save entity into backend.
@@ -59,7 +56,7 @@ class Model(MaterialEntity):
     def log_metric(
         self,
         key: str,
-        value: list[float | int] | float | int,
+        value: MetricType,
         overwrite: bool = False,
         single_value: bool = False,
     ) -> None:
@@ -73,7 +70,7 @@ class Model(MaterialEntity):
         ----------
         key : str
             Key of the metric.
-        value : list[float | int] | float | int
+        value : MetricType
             Value of the metric.
         overwrite : bool
             If True, overwrite existing metric.
@@ -101,32 +98,13 @@ class Model(MaterialEntity):
         Log a list of values and overwrite existing metric:
         >>> entity.log_metric("accuracy", [0.8, 0.9], overwrite=True)
         """
-        value = validate_metric_value(value)
-
-        if isinstance(value, list):
-            self._handle_metric_list(key, value, overwrite)
-        elif single_value:
-            self._handle_metric_single(key, value, overwrite)
-        else:
-            self._handle_metric_list_append(key, value, overwrite)
-
-        processor.update_metric(self.project, self.ENTITY_TYPE, self.id, key, self.status.metrics[key])
+        self._set_metrics(key, value, overwrite, single_value)
+        context_processor.update_metric(self.project, self.ENTITY_TYPE, self.id, key, self.status.metrics[key])
 
     ##############################
     # Helper methods
     ##############################
 
-    def _init_metrics(self) -> None:
-        """
-        Initialize metrics.
-
-        Returns
-        -------
-        None
-        """
-        if self.status.metrics is None:
-            self.status.metrics = {}
-
     def _get_metrics(self) -> None:
         """
         Get model metrics from backend.
@@ -135,72 +113,42 @@ class Model(MaterialEntity):
         -------
         None
         """
-        self.status.metrics = processor.read_metrics(
+        self.status.metrics = context_processor.read_metrics(
             project=self.project,
             entity_type=self.ENTITY_TYPE,
             entity_id=self.id,
         )
 
-    def _handle_metric_single(self, key: str, value: float | int, overwrite: bool = False) -> None:
-        """
-        Handle metric single value.
-
-        Parameters
-        ----------
-        key : str
-            Key of the metric.
-        value : float
-            Value of the metric.
-        overwrite : bool
-            If True, overwrite existing metric.
-
-        Returns
-        -------
-        None
-        """
-        if key not in self.status.metrics or overwrite:
-            self.status.metrics[key] = value
-
-    def _handle_metric_list_append(self, key: str, value: float | int, overwrite: bool = False) -> None:
-        """
-        Handle metric list append.
-
-        Parameters
-        ----------
-        key : str
-            Key of the metric.
-        value : float
-            Value of the metric.
-        overwrite : bool
-            If True, overwrite existing metric.
-
-        Returns
-        -------
-        None
-        """
-        if key not in self.status.metrics or overwrite:
-            self.status.metrics[key] = [value]
-        else:
-            self.status.metrics[key].append(value)
-
-    def _handle_metric_list(self, key: str, value: list[int | float], overwrite: bool = False) -> None:
+    def _set_metrics(
+        self,
+        key: str,
+        value: MetricType,
+        overwrite: bool,
+        single_value: bool,
+    ) -> None:
         """
-        Handle metric list.
+        Set model metrics.
 
         Parameters
         ----------
         key : str
             Key of the metric.
-        value : list[int | float]
+        value : MetricType
             Value of the metric.
         overwrite : bool
             If True, overwrite existing metric.
+        single_value : bool
+            If True, value is a single value.
 
         Returns
         -------
         None
         """
-        if key not in self.status.metrics or overwrite:
-            self.status.metrics[key] = value
-        else:
-            self.status.metrics[key].extend(value)
+        value = validate_metric_value(value)
+        self.status.metrics = set_metrics(
+            self.status.metrics,
+            key,
+            value,
+            overwrite,
+            single_value,
+        )

digitalhub/entities/model/_base/status.py

@@ -16,4 +16,4 @@ class ModelStatus(MaterialStatus):
         metrics: dict | None = None,
     ):
         super().__init__(state, message, files)
-        self.metrics = metrics
+        self.metrics = metrics if metrics is not None else {}

digitalhub/entities/model/crud.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.entities.artifact.utils import eval_source, process_kwargs
 from digitalhub.utils.types import SourcesOrListOfSources
 
@@ -61,7 +61,7 @@ def new_model(
     >>>                    kind="model",
     >>>                    path="s3://my-bucket/my-key")
     """
-    return processor.create_context_entity(
+    return context_processor.create_context_entity(
         project=project,
         name=name,
         kind=kind,
@@ -114,7 +114,7 @@ def log_model(
     """
     eval_source(source)
     kwargs = process_kwargs(project, name, source=source, path=path, **kwargs)
-    return processor.log_material_entity(
+    return context_processor.log_material_entity(
         source=source,
         project=project,
         name=name,
@@ -158,7 +158,7 @@ def get_model(
     >>>                 project="my-project",
     >>>                 entity_id="my-model-id")
     """
-    return processor.read_context_entity(
+    return context_processor.read_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -198,7 +198,7 @@ def get_model_versions(
     >>> objs = get_model_versions("my-model-name",
     >>>                           project="my-project")
     """
-    return processor.read_context_entity_versions(
+    return context_processor.read_context_entity_versions(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
@@ -226,7 +226,7 @@ def list_models(project: str, **kwargs) -> list[Model]:
     --------
     >>> objs = list_models(project="my-project")
     """
-    return processor.list_context_entities(
+    return context_processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
         **kwargs,
@@ -251,7 +251,7 @@ def import_model(file: str) -> Model:
     --------
     >>> obj = import_model("my-model.yaml")
     """
-    return processor.import_context_entity(file)
+    return context_processor.import_context_entity(file)
 
 
 def load_model(file: str) -> Model:
@@ -272,7 +272,7 @@ def load_model(file: str) -> Model:
     --------
     >>> obj = load_model("my-model.yaml")
     """
-    return processor.load_context_entity(file)
+    return context_processor.load_context_entity(file)
 
 
 def update_model(entity: Model) -> Model:
@@ -293,7 +293,7 @@ def update_model(entity: Model) -> Model:
     --------
     >>> obj = get_model("store://my-model-key")
     """
-    return processor.update_context_entity(
+    return context_processor.update_context_entity(
         project=entity.project,
         entity_type=entity.ENTITY_TYPE,
         entity_id=entity.id,
@@ -339,7 +339,7 @@ def delete_model(
     >>>                    project="my-project",
     >>>                    delete_all_versions=True)
     """
-    return processor.delete_context_entity(
+    return context_processor.delete_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,