digitalhub 0.13.0b3__py3-none-any.whl → 0.14.9__py3-none-any.whl

digitalhub/entities/project/_base/spec.py

@@ -17,7 +17,7 @@ class ProjectSpec(Spec):
 
     def __init__(
         self,
-        context: str | None = None,
+        source: str | None = None,
         functions: list | None = None,
         artifacts: list | None = None,
         workflows: list | None = None,
@@ -26,7 +26,7 @@ class ProjectSpec(Spec):
         config: dict | None = None,
         **kwargs,
     ) -> None:
-        self.context = context if context is not None else "./"
+        self.source = source if source is not None else "./"
         self.functions = functions if functions is not None else []
         self.artifacts = artifacts if artifacts is not None else []
         self.workflows = workflows if workflows is not None else []
@@ -40,8 +40,8 @@ class ProjectValidator(SpecValidator):
     ProjectValidator validator.
     """
 
-    context: Optional[str] = None
-    """The project's context."""
+    source: Optional[str] = None
+    """The project's source."""
 
     functions: Optional[list] = None
     """List of project's functions."""

digitalhub/entities/project/crud.py

@@ -6,9 +6,8 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._processors.base import base_processor
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._commons.enums import EntityKinds, EntityTypes
+from digitalhub.entities._processors.processors import base_processor, context_processor
 from digitalhub.entities.project.utils import setup_project
 from digitalhub.utils.exceptions import BackendError
 
@@ -24,11 +23,9 @@ def new_project(
     name: str,
     description: str | None = None,
     labels: list[str] | None = None,
-    local: bool = False,
     config: dict | None = None,
-    context: str | None = None,
+    source: str | None = None,
     setup_kwargs: dict | None = None,
-    **kwargs,
 ) -> Project:
     """
     Create a new object.
@@ -41,16 +38,12 @@ def new_project(
         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.
     config : dict
         DHCore environment configuration.
-    context : str
+    source : str
         The context local folder of the project.
     setup_kwargs : dict
         Setup keyword arguments passed to setup_project() function.
-    **kwargs : dict
-        Keyword arguments.
 
     Returns
     -------
@@ -61,26 +54,22 @@ def new_project(
     --------
     >>> obj = new_project("my-project")
     """
-    if context is None:
-        context = "./"
+    if source is None:
+        source = "./"
     obj = base_processor.create_project_entity(
         name=name,
-        kind="project",
+        kind=EntityKinds.PROJECT_PROJECT.value,
         description=description,
         labels=labels,
-        local=local,
         config=config,
-        context=context,
-        **kwargs,
+        source=source,
     )
     return setup_project(obj, setup_kwargs)
 
 
 def get_project(
     name: str,
-    local: bool = False,
     setup_kwargs: dict | None = None,
-    **kwargs,
 ) -> Project:
     """
     Retrieves project details from backend.
@@ -89,12 +78,8 @@ def get_project(
     ----------
     name : str
         The Project name.
-    local : bool
-        Flag to determine if backend is local.
     setup_kwargs : dict
         Setup keyword arguments passed to setup_project() function.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -108,16 +93,14 @@ def get_project(
     obj = base_processor.read_project_entity(
         entity_type=ENTITY_TYPE,
         entity_name=name,
-        local=local,
-        **kwargs,
     )
     return setup_project(obj, setup_kwargs)
 
 
 def import_project(
     file: str,
-    local: bool = False,
     setup_kwargs: dict | None = None,
+    reset_id: bool = False,
 ) -> Project:
     """
     Import object from a YAML file and create a new object into the backend.
@@ -126,10 +109,10 @@ def import_project(
     ----------
     file : str
         Path to YAML file.
-    local : bool
-        Flag to determine if backend is local.
     setup_kwargs : dict
         Setup keyword arguments passed to setup_project() function.
+    reset_id : bool
+        Flag to determine if the ID of project entities should be reset.
 
     Returns
     -------
@@ -140,13 +123,15 @@ def import_project(
     --------
     >>> obj = import_project("my-project.yaml")
     """
-    obj = base_processor.import_project_entity(file=file, local=local)
+    obj = base_processor.import_project_entity(
+        file=file,
+        reset_id=reset_id,
+    )
     return setup_project(obj, setup_kwargs)
 
 
 def load_project(
     file: str,
-    local: bool = False,
     setup_kwargs: dict | None = None,
 ) -> Project:
     """
@@ -156,8 +141,6 @@ def load_project(
     ----------
     file : str
         Path to YAML file.
-    local : bool
-        Flag to determine if backend is local.
     setup_kwargs : dict
         Setup keyword arguments passed to setup_project() function.
 
@@ -170,36 +153,30 @@ def load_project(
     --------
     >>> obj = load_project("my-project.yaml")
     """
-    obj = base_processor.load_project_entity(file=file, local=local)
+    obj = base_processor.load_project_entity(file=file)
     return setup_project(obj, setup_kwargs)
 
 
-def list_projects(local: bool = False, **kwargs) -> list[Project]:
+def list_projects() -> list[Project]:
     """
     List projects in backend.
 
-    Parameters
-    ----------
-    local : bool
-        Flag to determine if backend is local.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
     list
         List of objects.
     """
-    return base_processor.list_project_entities(local=local, **kwargs)
+    return base_processor.list_project_entities(ENTITY_TYPE)
 
 
 def get_or_create_project(
     name: str,
-    local: bool = False,
+    description: str | None = None,
+    labels: list[str] | None = None,
     config: dict | None = None,
     context: str | None = None,
     setup_kwargs: dict | None = None,
-    **kwargs,
 ) -> Project:
     """
     Try to get project. If not exists, create it.
@@ -208,8 +185,6 @@ def get_or_create_project(
     ----------
     name : str
         Project name.
-    local : bool
-        Flag to determine if backend is local.
     config : dict
         DHCore environment configuration.
     context : str
@@ -227,22 +202,20 @@ def get_or_create_project(
     try:
         return get_project(
             name,
-            local=local,
             setup_kwargs=setup_kwargs,
-            **kwargs,
         )
     except BackendError:
         return new_project(
             name,
-            local=local,
+            description=description,
+            labels=labels,
             config=config,
             setup_kwargs=setup_kwargs,
-            context=context,
-            **kwargs,
+            source=context,
         )
 
 
-def update_project(entity: Project, **kwargs) -> Project:
+def update_project(entity: Project) -> Project:
     """
     Update object. Note that object spec are immutable.
 
@@ -250,8 +223,6 @@ def update_project(entity: Project, **kwargs) -> Project:
     ----------
     entity : Project
         Object to update.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -266,8 +237,6 @@ def update_project(entity: Project, **kwargs) -> Project:
         entity_type=entity.ENTITY_TYPE,
         entity_name=entity.name,
         entity_dict=entity.to_dict(),
-        local=entity._client.is_local(),
-        **kwargs,
     )
 
 
@@ -275,8 +244,6 @@ def delete_project(
     name: str,
     cascade: bool = True,
     clean_context: bool = True,
-    local: bool = False,
-    **kwargs,
 ) -> dict:
     """
     Delete a project.
@@ -289,10 +256,6 @@ def delete_project(
         Flag to determine if delete is cascading.
     clean_context : bool
         Flag to determine if context will be deleted.
-    local : bool
-        Flag to determine if backend is local.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -306,10 +269,8 @@ def delete_project(
     return base_processor.delete_project_entity(
         entity_type=ENTITY_TYPE,
         entity_name=name,
-        local=local,
         cascade=cascade,
         clean_context=clean_context,
-        **kwargs,
     )
 
 
@@ -323,7 +284,6 @@ def search_entity(
     updated: str | None = None,
     description: str | None = None,
     labels: list[str] | None = None,
-    **kwargs,
 ) -> list[ContextEntity]:
     """
     Search objects from backend.
@@ -348,13 +308,11 @@ def search_entity(
         Entity description.
     labels : list[str]
         Entity labels.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
-        Returns
-        -------
-        list[ContextEntity]
-            List of object instances.
+    Returns
+    -------
+    list[ContextEntity]
+        List of object instances.
     """
     return context_processor.search_entity(
         project_name,
@@ -366,5 +324,4 @@ def search_entity(
         updated=updated,
         description=description,
         labels=labels,
-        **kwargs,
     )

digitalhub/entities/project/utils.py

@@ -12,6 +12,10 @@ from digitalhub.utils.generic_utils import import_function
 if typing.TYPE_CHECKING:
     from digitalhub.entities.project._base.entity import Project
 
+CHECK_FILENAME = ".CHECK"
+SETUP_MODULE = "setup_project.py"
+SETUP_FUNCTION = "setup"
+
 
 def setup_project(project: Project, setup_kwargs: dict | None = None) -> Project:
     """
@@ -30,10 +34,10 @@ def setup_project(project: Project, setup_kwargs: dict | None = None) -> Project
         Set up project.
     """
     setup_kwargs = setup_kwargs if setup_kwargs is not None else {}
-    check_pth = Path(project.spec.context, ".CHECK")
-    setup_pth = Path(project.spec.context, "setup_project.py")
+    check_pth = Path(project.spec.source, CHECK_FILENAME)
+    setup_pth = Path(project.spec.source, SETUP_MODULE)
     if setup_pth.exists() and not check_pth.exists():
-        setup_fnc = import_function(setup_pth, "setup")
+        setup_fnc = import_function(setup_pth, SETUP_FUNCTION)
         project = setup_fnc(project, **setup_kwargs)
         check_pth.touch()
     return project

digitalhub/entities/run/_base/builder.py

@@ -90,10 +90,6 @@ class RunBuilder(UnversionedBuilder, RuntimeEntityBuilder):
         ----------
         task : str
             Task string.
-
-        Returns
-        -------
-        None
         """
         task_kind = task.split("://")[0]
         if task_kind not in self.get_all_kinds():

digitalhub/entities/run/_base/entity.py

@@ -10,8 +10,9 @@ import typing
 from digitalhub.entities._base.unversioned.entity import UnversionedEntity
 from digitalhub.entities._commons.enums import EntityTypes, State
 from digitalhub.entities._commons.metrics import MetricType, set_metrics, validate_metric_value
-from digitalhub.entities._processors.context import context_processor
-from digitalhub.factory.factory import factory
+from digitalhub.entities._processors.processors import context_processor
+from digitalhub.factory.entity import entity_factory
+from digitalhub.factory.runtime import runtime_factory
 from digitalhub.utils.exceptions import EntityError
 from digitalhub.utils.logger import LOGGER
 
@@ -51,15 +52,11 @@ class Run(UnversionedEntity):
     def build(self) -> None:
         """
         Build run.
-
-        Returns
-        -------
-        None
         """
         executable = self._get_executable()
         task = self._get_task()
         new_spec = self._get_runtime().build(executable, task, self.to_dict())
-        self.spec = factory.build_spec(self.kind, **new_spec)
+        self.spec = entity_factory.build_spec(self.kind, **new_spec)
         self._set_state(State.BUILT.value)
         self.save(update=True)
 
@@ -141,10 +138,6 @@ class Run(UnversionedEntity):
     def stop(self) -> None:
         """
         Stop run.
-
-        Returns
-        -------
-        None
         """
         if not self.spec.local_execution:
             return context_processor.stop_entity(self.project, self.ENTITY_TYPE, self.id)
@@ -152,10 +145,6 @@ class Run(UnversionedEntity):
     def resume(self) -> None:
         """
         Resume run.
-
-        Returns
-        -------
-        None
         """
         if not self.spec.local_execution:
             return context_processor.resume_entity(self.project, self.ENTITY_TYPE, self.id)
@@ -184,10 +173,6 @@ class Run(UnversionedEntity):
         single_value : bool
             If True, value is a single value.
 
-        Returns
-        -------
-        None
-
         Examples
         --------
         Log a new value in a list
@@ -197,13 +182,27 @@ class Run(UnversionedEntity):
         >>> entity.log_metric("loss", 0.0019)
 
         Log a list of values and append them to existing metric:
-        >>> entity.log_metric("loss", [0.0018, 0.0015])
+        >>> entity.log_metric(
+        ...     "loss",
+        ...     [
+        ...         0.0018,
+        ...         0.0015,
+        ...     ],
+        ... )
 
         Log a single value (not represented as list):
-        >>> entity.log_metric("accuracy", 0.9, single_value=True)
+        >>> entity.log_metric(
+        ...     "accuracy",
+        ...     0.9,
+        ...     single_value=True,
+        ... )
 
         Log a list of values and overwrite existing metric:
-        >>> entity.log_metric("accuracy", [0.8, 0.9], overwrite=True)
+        >>> entity.log_metric(
+        ...     "accuracy",
+        ...     [0.8, 0.9],
+        ...     overwrite=True,
+        ... )
         """
         self._set_metrics(key, value, overwrite, single_value)
         context_processor.update_metric(self.project, self.ENTITY_TYPE, self.id, key, self.status.metrics[key])
@@ -224,19 +223,59 @@ class Run(UnversionedEntity):
         overwrite : bool
             If True, overwrite existing metrics.
 
-        Returns
-        -------
-        None
+        Examples
+        --------
+        Log multiple metrics at once
+        >>> entity.log_metrics(
+        ...     {
+        ...         "loss": 0.002,
+        ...         "accuracy": 0.95,
+        ...     }
+        ... )
+
+        Log metrics with lists and single values
+        >>> entity.log_metrics(
+        ...     {
+        ...         "loss": [
+        ...             0.1,
+        ...             0.05,
+        ...         ],
+        ...         "epoch": 10,
+        ...     }
+        ... )
+
+        Append to existing metrics (default behavior)
+        >>> entity.log_metrics(
+        ...     {
+        ...         "loss": 0.001,
+        ...         "accuracy": 0.96,
+        ...     }
+        ... )  # Appends to existing
+
+        Overwrite existing metrics
+        >>> entity.log_metrics(
+        ...     {
+        ...         "loss": 0.0005,
+        ...         "accuracy": 0.98,
+        ...     },
+        ...     overwrite=True,
+        ... )
 
         See also
         --------
         log_metric
         """
         for key, value in metrics.items():
+            # For lists, use log_metric which handles appending correctly
             if isinstance(value, list):
                 self.log_metric(key, value, overwrite)
+
+            # For single values, check if we should append or create new
             else:
-                self.log_metric(key, value, overwrite, single_value=True)
+                if not overwrite and key in self.status.metrics:
+                    self.log_metric(key, value)
+                else:
+                    self.log_metric(key, value, overwrite, single_value=True)
 
     ##############################
     #  Helpers
@@ -245,19 +284,11 @@ class Run(UnversionedEntity):
     def _setup_execution(self) -> None:
         """
         Setup run execution.
-
-        Returns
-        -------
-        None
         """
 
     def _start_execution(self) -> None:
         """
         Start run execution.
-
-        Returns
-        -------
-        None
         """
         self._context().set_run(f"{self.key}:{self.id}")
         if self.spec.local_execution:
@@ -269,10 +300,6 @@ class Run(UnversionedEntity):
     def _finish_execution(self) -> None:
         """
         Finish run execution.
-
-        Returns
-        -------
-        None
         """
         self._context().unset_run()
 
@@ -285,7 +312,7 @@ class Run(UnversionedEntity):
         bool
             True if run is in runnable state, False otherwise.
         """
-        return (self.status.state == State.BUILT.value) or (self.status.state == State.STOPPED.value)
+        return self.status.state in (State.BUILT.value, State.STOPPED.value)
 
     def _set_status(self, status: dict) -> None:
         """
@@ -295,12 +322,8 @@ class Run(UnversionedEntity):
         ----------
         status : dict
             Status to set.
-
-        Returns
-        -------
-        None
         """
-        self.status: RunStatus = factory.build_status(self.kind, **status)
+        self.status: RunStatus = entity_factory.build_status(self.kind, **status)
 
     def _set_state(self, state: str) -> None:
         """
@@ -310,10 +333,6 @@ class Run(UnversionedEntity):
         ----------
         state : str
             State to set.
-
-        Returns
-        -------
-        None
         """
         self.status.state = state
 
@@ -325,10 +344,6 @@ class Run(UnversionedEntity):
         ----------
         message : str
             Message to set.
-
-        Returns
-        -------
-        None
         """
         self.status.message = message
 
@@ -341,7 +356,7 @@ class Run(UnversionedEntity):
         Runtime
             Runtime object.
         """
-        return factory.build_runtime(self.kind, self.project)
+        return runtime_factory.build_runtime(self.kind, self.project)
 
     def _get_executable(self) -> dict:
         """
@@ -353,8 +368,8 @@ class Run(UnversionedEntity):
         dict
             Executable (function or workflow) from backend.
         """
-        exec_kind = factory.get_executable_kind(self.kind)
-        exec_type = factory.get_entity_type_from_kind(exec_kind)
+        exec_kind = entity_factory.get_executable_kind(self.kind)
+        exec_type = entity_factory.get_entity_type_from_kind(exec_kind)
         string_to_split = getattr(self.spec, exec_type)
         exec_name, exec_id = string_to_split.split("://")[-1].split("/")[-1].split(":")
         return context_processor.read_context_entity(
@@ -384,10 +399,6 @@ class Run(UnversionedEntity):
     def _get_metrics(self) -> None:
         """
         Get model metrics from backend.
-
-        Returns
-        -------
-        None
         """
         self.status.metrics = context_processor.read_metrics(
             project=self.project,
@@ -415,10 +426,6 @@ class Run(UnversionedEntity):
             If True, overwrite existing metric.
         single_value : bool
             If True, value is a single value.
-
-        Returns
-        -------
-        None
         """
         value = validate_metric_value(value)
         self.status.metrics = set_metrics(