digitalhub 0.9.1__py3-none-any.whl → 0.10.0__py3-none-any.whl

digitalhub/entities/_base/_base/entity.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from digitalhub.utils.generic_utils import dict_to_json
+from digitalhub.utils.generic_utils import dump_json
 
 
 class Base:
@@ -40,7 +40,7 @@ class Base:
         str
             A json string containing the attributes of the entity instance.
         """
-        return dict_to_json(self.to_dict())
+        return dump_json(self.to_dict())
 
     def _any_setter(self, **kwargs) -> None:
         """

digitalhub/entities/_base/context/entity.py

@@ -4,7 +4,7 @@ import typing
 
 from digitalhub.context.api import get_context
 from digitalhub.entities._base.entity.entity import Entity
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.utils.generic_utils import get_timestamp
 from digitalhub.utils.io_utils import write_yaml
 
@@ -64,7 +64,7 @@ class ContextEntity(Entity):
         ContextEntity
             Entity saved.
         """
-        new_obj = processor.create_context_entity(_entity=self)
+        new_obj = context_processor.create_context_entity(_entity=self)
         self._update_attributes(new_obj)
         return self
 
@@ -79,7 +79,7 @@ class ContextEntity(Entity):
         """
         if self._context().local:
             self.metadata.updated = self.metadata.updated = get_timestamp()
-        new_obj = processor.update_context_entity(self.project, self.ENTITY_TYPE, self.id, self.to_dict())
+        new_obj = context_processor.update_context_entity(self.project, self.ENTITY_TYPE, self.id, self.to_dict())
         self._update_attributes(new_obj)
         return self
 
@@ -106,7 +106,7 @@ class ContextEntity(Entity):
         ContextEntity
             Entity refreshed.
         """
-        new_obj = processor.read_context_entity(self.key)
+        new_obj = context_processor.read_context_entity(self.key)
         self._update_attributes(new_obj)
         return self
 

digitalhub/entities/_base/entity/builder.py

@@ -24,10 +24,10 @@ class EntityBuilder:
 
     # Class variables
     ENTITY_TYPE: str = None
-    ENTITY_CLASS: Entity = None
-    ENTITY_SPEC_CLASS: Spec = None
-    ENTITY_SPEC_VALIDATOR: SpecValidator = None
-    ENTITY_STATUS_CLASS: Status = None
+    ENTITY_CLASS: type[Entity] = None
+    ENTITY_SPEC_CLASS: type[Spec] = None
+    ENTITY_SPEC_VALIDATOR: type[SpecValidator] = None
+    ENTITY_STATUS_CLASS: type[Status] = None
     ENTITY_KIND: str = None
 
     def __init__(self) -> None:
@@ -60,7 +60,7 @@ class EntityBuilder:
         """
         return build_name(name)
 
-    def build_uuid(self, uuid: str) -> str:
+    def build_uuid(self, uuid: str | None = None) -> str:
         """
         Build entity uuid.
 

digitalhub/entities/_base/executable/entity.py

@@ -4,7 +4,7 @@ import typing
 
 from digitalhub.entities._base.versioned.entity import VersionedEntity
 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.run.crud import delete_run, get_run, list_runs
 from digitalhub.entities.task.crud import delete_task
 from digitalhub.factory.api import build_entity_from_dict, build_entity_from_params
@@ -247,7 +247,7 @@ class ExecutableEntity(VersionedEntity):
             Response from backend.
         """
         params = {self.ENTITY_TYPE: self._get_executable_string(), "kind": kind}
-        return processor.list_context_entities(self.project, EntityTypes.TASK.value, params=params)
+        return context_processor.list_context_entities(self.project, EntityTypes.TASK.value, params=params)
 
     def _check_task_in_backend(self, kind: str) -> bool:
         """

digitalhub/entities/_base/material/entity.py

@@ -4,8 +4,9 @@ import typing
 from pathlib import Path
 
 from digitalhub.entities._base.versioned.entity import VersionedEntity
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 from digitalhub.stores.api import get_store
+from digitalhub.utils.types import SourcesOrListOfSources
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -58,7 +59,7 @@ class MaterialEntity(VersionedEntity):
 
         # Handle files info
         if files is not None:
-            processor.update_files_info(self.project, self.ENTITY_TYPE, self.id, files)
+            context_processor.update_files_info(self.project, self.ENTITY_TYPE, self.id, files)
             self.add_files_info(files)
 
         return obj
@@ -77,7 +78,7 @@ class MaterialEntity(VersionedEntity):
         list[str]
             List of file paths.
         """
-        store = get_store(self.spec.path)
+        store = get_store(self.project, self.spec.path)
         paths = self.get_file_paths()
         dst = store._build_temp()
         return store.download(self.spec.path, dst=dst, src=paths)
@@ -126,7 +127,7 @@ class MaterialEntity(VersionedEntity):
         >>> print(path)
         dataitem/data.csv
         """
-        store = get_store(self.spec.path)
+        store = get_store(self.project, self.spec.path)
         paths = self.get_file_paths()
 
         if destination is None:
@@ -136,7 +137,7 @@ class MaterialEntity(VersionedEntity):
 
         return store.download(self.spec.path, dst=dst, src=paths, overwrite=overwrite)
 
-    def upload(self, source: str | list[str]) -> None:
+    def upload(self, source: SourcesOrListOfSources) -> None:
         """
         Upload object from given local path to spec path destination.
         Source must be a local path. If the path is a folder, destination
@@ -164,7 +165,7 @@ class MaterialEntity(VersionedEntity):
         >>> entity.upload('./data')
         """
         # Get store and upload object
-        store = get_store(self.spec.path)
+        store = get_store(self.project, self.spec.path)
         paths = store.upload(source, self.spec.path)
 
         # Update files info
@@ -193,17 +194,15 @@ class MaterialEntity(VersionedEntity):
             if f.get("path") not in path_list:
                 self.status.files.append(f)
 
-    def get_file_paths(self) -> list[str]:
+    def get_file_paths(self) -> list:
         """
         Get the paths of the files in the status.
 
         Returns
         -------
-        list[str]
+        list
             Paths of the files in the status.
         """
-        if self.status.files is None:
-            self.status.files = []
         return [f.get("path") for f in self.status.files]
 
     ##############################
@@ -225,7 +224,8 @@ class MaterialEntity(VersionedEntity):
         """
         if files_info is None:
             return
-        self.refresh()
+        if self.status.files:
+            self.refresh()
         self.add_files_info(files_info)
         self.save(update=True)
 
@@ -238,7 +238,7 @@ class MaterialEntity(VersionedEntity):
         None
         """
         if not self._context().local and not self.status.files:
-            files = processor.read_files_info(
+            files = context_processor.read_files_info(
                 project=self.project,
                 entity_type=self.ENTITY_TYPE,
                 entity_id=self.id,

digitalhub/entities/_base/material/status.py

@@ -15,4 +15,4 @@ class MaterialStatus(Status):
         files: list[dict] | None = None,
     ) -> None:
         super().__init__(state, message)
-        self.files = files
+        self.files = files if files is not None else []

digitalhub/entities/_base/material/utils.py

@@ -2,8 +2,8 @@ from __future__ import annotations
 
 from pathlib import Path
 
+from digitalhub.stores.s3.utils import get_s3_bucket_from_env
 from digitalhub.utils.file_utils import eval_zip_type
-from digitalhub.utils.s3_utils import get_s3_bucket
 from digitalhub.utils.uri_utils import S3Schemes, has_local_scheme
 
 
@@ -91,7 +91,7 @@ def build_log_path_from_source(
         Log path.
     """
     scheme = eval_zip_sources(source)
-    path = f"{scheme}://{get_s3_bucket()}/{project}/{entity_type}/{name}/{uuid}"
+    path = f"{scheme}://{get_s3_bucket_from_env()}/{project}/{entity_type}/{name}/{uuid}"
 
     if isinstance(source, list) and len(source) >= 1:
         if len(source) > 1:

digitalhub/entities/_base/unversioned/entity.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -25,4 +25,4 @@ class UnversionedEntity(ContextEntity):
         super().__init__(project, kind, metadata, spec, status, user)
         self.id = uuid
         self.name = uuid
-        self.key = processor.build_context_entity_key(project, self.ENTITY_TYPE, kind, uuid)
+        self.key = context_processor.build_context_entity_key(project, self.ENTITY_TYPE, kind, uuid)

digitalhub/entities/_base/versioned/entity.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
-from digitalhub.entities._operations.processor import processor
+from digitalhub.entities._processors.context import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -26,4 +26,4 @@ class VersionedEntity(ContextEntity):
         super().__init__(project, kind, metadata, spec, status, user)
         self.name = name
         self.id = uuid
-        self.key = processor.build_context_entity_key(project, self.ENTITY_TYPE, kind, name, uuid)
+        self.key = context_processor.build_context_entity_key(project, self.ENTITY_TYPE, kind, name, uuid)

digitalhub/entities/_commons/enums.py

@@ -73,6 +73,7 @@ class BackendOperations(Enum):
 
     CREATE = "create"
     READ = "read"
+    READ_ALL_VERSIONS = "read_all_versions"
     UPDATE = "update"
     DELETE = "delete"
     LIST = "list"
@@ -84,6 +85,7 @@ class BackendOperations(Enum):
     LOGS = "logs"
     SEARCH = "search"
     SHARE = "share"
+    METRICS = "metrics"
 
 
 class EntityKinds(Enum):

digitalhub/entities/_commons/metrics.py

@@ -0,0 +1,164 @@
+from __future__ import annotations
+
+from typing import Any, Union
+
+from pydantic import BaseModel, ValidationError
+
+MetricType = Union[float, int, list[Union[float, int]]]
+
+
+class Metric(BaseModel):
+    """
+    Metric.
+    """
+
+    value: MetricType
+
+
+def validate_metric_value(value: Any) -> MetricType:
+    """
+    Validate metric value.
+
+    Parameters
+    ----------
+    value : Any
+        The value to validate.
+
+    Returns
+    -------
+    MetricType
+        The validated value.
+    """
+    try:
+        return Metric(value=value).value
+    except ValidationError as e:
+        raise ValueError("Invalid metric value. Must be a list of floats or ints or a float or an int.") from e
+
+
+def set_metrics(
+    metrics: dict[str, MetricType],
+    key: str,
+    value: Any,
+    overwrite: bool,
+    single_value: bool,
+) -> dict[str, MetricType]:
+    """
+    Set metric value.
+
+    Parameters
+    ----------
+    metrics : dict[str, MetricType]
+        The metrics dictionary.
+    key : str
+        The key of the entity.
+    value : Any
+        The value to set.
+    overwrite : bool
+        Whether to overwrite the metric.
+
+    Returns
+    -------
+    dict[str, MetricType]
+        The metrics dictionary.
+    """
+    if isinstance(value, list):
+        return handle_metric_list(metrics, key, value, overwrite)
+    elif single_value:
+        return handle_metric_single(metrics, key, value, overwrite)
+    return handle_metric_list_append(metrics, key, value, overwrite)
+
+
+def handle_metric_single(
+    metrics: dict[str, MetricType],
+    key: str,
+    value: float | int,
+    overwrite: bool,
+) -> dict:
+    """
+    Handle metric single value.
+
+    Parameters
+    ----------
+    metrics : dict[str, MetricType]
+        Metrics dictionary.
+    key : str
+        Key of the metric.
+    value : float
+        Value of the metric.
+    overwrite : bool
+        If True, overwrite existing metric.
+
+    Returns
+    -------
+    dict
+        Metrics dictionary.
+    """
+    if key not in metrics or overwrite:
+        metrics[key] = value
+    return metrics
+
+
+def handle_metric_list_append(
+    metrics: dict[str, MetricType],
+    key: str,
+    value: float | int,
+    overwrite: bool,
+) -> dict:
+    """
+    Handle metric list append.
+
+    Parameters
+    ----------
+    metrics : dict[str, MetricType]
+        Metrics dictionary.
+    key : str
+        Key of the metric.
+    value : float
+        Value of the metric.
+    overwrite : bool
+        If True, overwrite existing metric.
+
+    Returns
+    -------
+    dict
+        Metrics dictionary.
+    """
+    if key not in metrics or overwrite:
+        metrics[key] = [value]
+    elif isinstance(metrics[key], list):
+        metrics[key].append(value)
+    else:
+        metrics[key] = [metrics[key], value]
+    return metrics
+
+
+def handle_metric_list(
+    metrics: dict[str, MetricType],
+    key: str,
+    value: list[int | float],
+    overwrite: bool,
+) -> dict:
+    """
+    Handle metric list.
+
+    Parameters
+    ----------
+    metrics : dict[str, MetricType]
+        Metrics dictionary.
+    key : str
+        Key of the metric.
+    value : list[int | float]
+        Value of the metric.
+    overwrite : bool
+        If True, overwrite existing metric.
+
+    Returns
+    -------
+    dict
+        Metrics dictionary.
+    """
+    if key not in metrics or overwrite:
+        metrics[key] = value
+    else:
+        metrics[key].extend(value)
+    return metrics

digitalhub/entities/_commons/types.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from typing import Union
+
+MetricType = Union[float, int, list[Union[float, int]]]

digitalhub/entities/_commons/utils.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from digitalhub.entities._commons.enums import EntityTypes
 
 
-def parse_entity_key(key: str) -> tuple[str]:
+def parse_entity_key(key: str) -> tuple[str, str, str, str | None, str]:
     """
     Parse the entity key. Returns project, entity type, kind, name and uuid.
 
@@ -14,7 +14,7 @@ def parse_entity_key(key: str) -> tuple[str]:
 
     Returns
     -------
-    tuple[str]
+    tuple[str, str, str, str | None, str]
         Project, entity type, kind, name and uuid.
     """
     try: