digitalhub 0.14.0b2__py3-none-any.whl → 0.14.0b4__py3-none-any.whl

digitalhub/entities/project/crud.py

@@ -7,8 +7,7 @@ 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._processors.processors import base_processor, context_processor
 from digitalhub.entities.project.utils import setup_project
 from digitalhub.utils.exceptions import BackendError
 
@@ -59,9 +58,7 @@ def new_project(
 
     Examples
     --------
-    >>> obj = new_project(
-    ...     "my-project"
-    ... )
+    >>> obj = new_project("my-project")
     """
     if context is None:
         context = "./"
@@ -82,7 +79,6 @@ def get_project(
     name: str,
     local: bool = False,
     setup_kwargs: dict | None = None,
-    **kwargs,
 ) -> Project:
     """
     Retrieves project details from backend.
@@ -95,8 +91,6 @@ def get_project(
         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
     -------
@@ -105,15 +99,12 @@ def get_project(
 
     Examples
     --------
-    >>> obj = get_project(
-    ...     "my-project"
-    ... )
+    >>> obj = get_project("my-project")
     """
     obj = base_processor.read_project_entity(
         entity_type=ENTITY_TYPE,
         entity_name=name,
         local=local,
-        **kwargs,
     )
     return setup_project(obj, setup_kwargs)
 
@@ -145,9 +136,7 @@ def import_project(
 
     Examples
     --------
-    >>> obj = import_project(
-    ...     "my-project.yaml"
-    ... )
+    >>> obj = import_project("my-project.yaml")
     """
     obj = base_processor.import_project_entity(
         file=file,
@@ -181,15 +170,13 @@ def load_project(
 
     Examples
     --------
-    >>> obj = load_project(
-    ...     "my-project.yaml"
-    ... )
+    >>> obj = load_project("my-project.yaml")
     """
     obj = base_processor.load_project_entity(file=file, local=local)
     return setup_project(obj, setup_kwargs)
 
 
-def list_projects(local: bool = False, **kwargs) -> list[Project]:
+def list_projects(local: bool = False) -> list[Project]:
     """
     List projects in backend.
 
@@ -197,15 +184,13 @@ def list_projects(local: bool = False, **kwargs) -> list[Project]:
     ----------
     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(local=local)
 
 
 def get_or_create_project(
@@ -275,11 +260,7 @@ def update_project(entity: Project, **kwargs) -> Project:
 
     Examples
     --------
-    >>> obj = (
-    ...     update_project(
-    ...         obj
-    ...     )
-    ... )
+    >>> obj = update_project(obj)
     """
     return base_processor.update_project_entity(
         entity_type=entity.ENTITY_TYPE,
@@ -295,7 +276,6 @@ def delete_project(
     cascade: bool = True,
     clean_context: bool = True,
     local: bool = False,
-    **kwargs,
 ) -> dict:
     """
     Delete a project.
@@ -310,8 +290,6 @@ def delete_project(
         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
     -------
@@ -320,9 +298,7 @@ def delete_project(
 
     Examples
     --------
-    >>> delete_project(
-    ...     "my-project"
-    ... )
+    >>> delete_project("my-project")
     """
     return base_processor.delete_project_entity(
         entity_type=ENTITY_TYPE,
@@ -330,7 +306,6 @@ def delete_project(
         local=local,
         cascade=cascade,
         clean_context=clean_context,
-        **kwargs,
     )
 
 
@@ -344,7 +319,6 @@ def search_entity(
     updated: str | None = None,
     description: str | None = None,
     labels: list[str] | None = None,
-    **kwargs,
 ) -> list[ContextEntity]:
     """
     Search objects from backend.
@@ -369,13 +343,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,
@@ -387,5 +359,4 @@ def search_entity(
         updated=updated,
         description=description,
         labels=labels,
-        **kwargs,
     )

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,7 +10,7 @@ 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.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
@@ -52,10 +52,6 @@ class Run(UnversionedEntity):
     def build(self) -> None:
         """
         Build run.
-
-        Returns
-        -------
-        None
         """
         executable = self._get_executable()
         task = self._get_task()
@@ -142,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)
@@ -153,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)
@@ -185,21 +173,13 @@ class Run(UnversionedEntity):
         single_value : bool
             If True, value is a single value.
 
-        Returns
-        -------
-        None
-
         Examples
         --------
         Log a new value in a list
-        >>> entity.log_metric(
-        ...     "loss", 0.002
-        ... )
+        >>> entity.log_metric("loss", 0.002)
 
         Append a new value in a list
-        >>> entity.log_metric(
-        ...     "loss", 0.0019
-        ... )
+        >>> entity.log_metric("loss", 0.0019)
 
         Log a list of values and append them to existing metric:
         >>> entity.log_metric(
@@ -243,10 +223,6 @@ class Run(UnversionedEntity):
         overwrite : bool
             If True, overwrite existing metrics.
 
-        Returns
-        -------
-        None
-
         Examples
         --------
         Log multiple metrics at once
@@ -308,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:
@@ -332,10 +300,6 @@ class Run(UnversionedEntity):
     def _finish_execution(self) -> None:
         """
         Finish run execution.
-
-        Returns
-        -------
-        None
         """
         self._context().unset_run()
 
@@ -348,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:
         """
@@ -358,10 +322,6 @@ class Run(UnversionedEntity):
         ----------
         status : dict
             Status to set.
-
-        Returns
-        -------
-        None
         """
         self.status: RunStatus = entity_factory.build_status(self.kind, **status)
 
@@ -373,10 +333,6 @@ class Run(UnversionedEntity):
         ----------
         state : str
             State to set.
-
-        Returns
-        -------
-        None
         """
         self.status.state = state
 
@@ -388,10 +344,6 @@ class Run(UnversionedEntity):
         ----------
         message : str
             Message to set.
-
-        Returns
-        -------
-        None
         """
         self.status.message = message
 
@@ -447,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,
@@ -478,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(

digitalhub/entities/run/crud.py

@@ -7,9 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._commons.utils import is_valid_key
-from digitalhub.entities._processors.context import context_processor
-from digitalhub.utils.exceptions import EntityError
+from digitalhub.entities._processors.processors import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.run._base.entity import Run
@@ -72,7 +70,6 @@ def new_run(
 def get_run(
     identifier: str,
     project: str | None = None,
-    **kwargs,
 ) -> Run:
     """
     Get object from backend.
@@ -83,8 +80,6 @@ def get_run(
         Entity key (store://...) or entity ID.
     project : str
         Project name.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -94,23 +89,33 @@ def get_run(
     Examples
     --------
     Using entity key:
-    >>> obj = get_run(
-    ...     "store://my-run-key"
-    ... )
+    >>> obj = get_run("store://my-run-key")
 
     Using entity ID:
     >>> obj = get_run("my-run-id"
     >>>               project="my-project")
     """
     return context_processor.read_unversioned_entity(
-        identifier,
+        identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
-        **kwargs,
     )
 
 
-def list_runs(project: str, **kwargs) -> list[Run]:
+def list_runs(
+    project: str,
+    q: str | None = None,
+    name: str | None = None,
+    kind: str | None = None,
+    user: str | None = None,
+    state: str | None = None,
+    created: str | None = None,
+    updated: str | None = None,
+    function: str | None = None,
+    workflow: str | None = None,
+    task: str | None = None,
+    action: str | None = None,
+) -> list[Run]:
     """
     List all latest version objects from backend.
 
@@ -118,25 +123,52 @@ def list_runs(project: str, **kwargs) -> list[Run]:
     ----------
     project : str
         Project name.
-    **kwargs : dict
-        Parameters to pass to the API call.
+    q : str
+        Query string to filter objects.
+    name : str
+        Object name.
+    kind : str
+        Kind of the object.
+    user : str
+        User that created the object.
+    state : str
+        Object state.
+    created : str
+        Creation date filter.
+    updated : str
+        Update date filter.
+    function : str
+        Function key filter.
+    workflow : str
+        Workflow key filter.
+    task : str
+        Task string filter.
+    action : str
+        Action name filter.
 
     Returns
     -------
-    list[Run]
+    list[Model]
         List of object instances.
 
     Examples
     --------
-    >>> objs = list_runs(
-    ...     project="my-project"
-    ... )
+    >>> objs = list_runs(project="my-project")
     """
-    # TODO more examples: search by function, latest for task and function
     return context_processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
-        **kwargs,
+        q=q,
+        name=name,
+        kind=kind,
+        user=user,
+        state=state,
+        created=created,
+        updated=updated,
+        function=function,
+        workflow=workflow,
+        task=task,
+        action=action,
     )
 
 
@@ -167,9 +199,7 @@ def import_run(
 
     Example
     -------
-    >>> obj = import_run(
-    ...     "my-run.yaml"
-    ... )
+    >>> obj = import_run("my-run.yaml")
     """
     return context_processor.import_context_entity(
         file,
@@ -195,9 +225,7 @@ def load_run(file: str) -> Run:
 
     Examples
     --------
-    >>> obj = load_run(
-    ...     "my-run.yaml"
-    ... )
+    >>> obj = load_run("my-run.yaml")
     """
     return context_processor.load_context_entity(file)
 
@@ -218,9 +246,7 @@ def update_run(entity: Run) -> Run:
 
     Examples
     --------
-    >>> obj = update_run(
-    ...     obj
-    ... )
+    >>> obj = update_run(obj)
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -233,7 +259,7 @@ def update_run(entity: Run) -> Run:
 def delete_run(
     identifier: str,
     project: str | None = None,
-    **kwargs,
+    entity_id: str | None = None,
 ) -> dict:
     """
     Delete object from backend.
@@ -241,11 +267,11 @@ def delete_run(
     Parameters
     ----------
     identifier : str
-        Entity key (store://...) or entity ID.
+        Entity key (store://...) or entity name.
     project : str
         Project name.
-    **kwargs : dict
-        Parameters to pass to the API call.
+    entity_id : str
+        Entity ID.
 
     Returns
     -------
@@ -254,20 +280,15 @@ def delete_run(
 
     Examples
     --------
-    >>> obj = delete_run(
-    ...     "store://my-run-key"
-    ... )
+    >>> obj = delete_run("store://my-run-key")
     >>> obj = delete_run(
     ...     "my-run-id",
     ...     project="my-project",
     ... )
     """
-    if not is_valid_key(identifier) and project is None:
-        raise EntityError("Specify entity key or entity ID combined with project")
     return context_processor.delete_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
-        entity_id=identifier,
-        **kwargs,
+        entity_id=entity_id,
     )

digitalhub/entities/secret/_base/entity.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -50,10 +50,6 @@ class Secret(VersionedEntity):
         ----------
         value : str
             Value of the secret.
-
-        Returns
-        -------
-        None
         """
         obj = {self.name: value}
         context_processor.update_secret_data(self.project, self.ENTITY_TYPE, obj)