digitalhub 0.14.0b3__py3-none-any.whl → 0.14.0b5__py3-none-any.whl

digitalhub/entities/project/crud.py

@@ -79,7 +79,6 @@ def get_project(
     name: str,
     local: bool = False,
     setup_kwargs: dict | None = None,
-    **kwargs,
 ) -> Project:
     """
     Retrieves project details from backend.
@@ -92,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
     -------
@@ -108,7 +105,6 @@ def get_project(
         entity_type=ENTITY_TYPE,
         entity_name=name,
         local=local,
-        **kwargs,
     )
     return setup_project(obj, setup_kwargs)
 
@@ -180,7 +176,7 @@ def load_project(
     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.
 
@@ -188,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(
@@ -282,7 +276,6 @@ def delete_project(
     cascade: bool = True,
     clean_context: bool = True,
     local: bool = False,
-    **kwargs,
 ) -> dict:
     """
     Delete a project.
@@ -297,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
     -------
@@ -315,7 +306,6 @@ def delete_project(
         local=local,
         cascade=cascade,
         clean_context=clean_context,
-        **kwargs,
     )
 
 
@@ -329,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.
@@ -354,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,
@@ -372,5 +359,4 @@ def search_entity(
         updated=updated,
         description=description,
         labels=labels,
-        **kwargs,
     )

digitalhub/entities/run/_base/entity.py

@@ -312,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:
         """

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.processors import context_processor
-from digitalhub.utils.exceptions import EntityError
 
 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
     -------
@@ -101,14 +96,26 @@ def get_run(
     >>>               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.
 
@@ -116,23 +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")
     """
-    # 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,
     )
 
 
@@ -223,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.
@@ -231,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
     -------
@@ -250,12 +286,9 @@ def delete_run(
     ...     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/crud.py

@@ -81,7 +81,6 @@ def get_secret(
     identifier: str,
     project: str | None = None,
     entity_id: str | None = None,
-    **kwargs,
 ) -> Secret:
     """
     Get object from backend.
@@ -94,8 +93,6 @@ def get_secret(
         Project name.
     entity_id : str
         Entity ID.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -115,25 +112,23 @@ def get_secret(
     if not is_valid_key(identifier):
         if project is None:
             raise ValueError("Project must be provided.")
-        secrets = list_secrets(project=project, **kwargs)
+        secrets = list_secrets(project=project)
         for secret in secrets:
             if secret.name == identifier:
                 return secret
         else:
             raise EntityNotExistsError(f"Secret {identifier} not found.")
     return context_processor.read_context_entity(
-        identifier,
+        identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
         entity_id=entity_id,
-        **kwargs,
     )
 
 
 def get_secret_versions(
     identifier: str,
     project: str | None = None,
-    **kwargs,
 ) -> list[Secret]:
     """
     Get object versions from backend.
@@ -144,8 +139,6 @@ def get_secret_versions(
         Entity key (store://...) or entity name.
     project : str
         Project name.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -162,14 +155,13 @@ def get_secret_versions(
     >>>                            project="my-project")
     """
     return context_processor.read_context_entity_versions(
-        identifier,
+        identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
-        **kwargs,
     )
 
 
-def list_secrets(project: str, **kwargs) -> list[Secret]:
+def list_secrets(project: str) -> list[Secret]:
     """
     List all latest version objects from backend.
 
@@ -177,8 +169,6 @@ def list_secrets(project: str, **kwargs) -> list[Secret]:
     ----------
     project : str
         Project name.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -192,7 +182,6 @@ def list_secrets(project: str, **kwargs) -> list[Secret]:
     return context_processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
-        **kwargs,
     )
 
 
@@ -285,7 +274,6 @@ def delete_secret(
     project: str | None = None,
     entity_id: str | None = None,
     delete_all_versions: bool = False,
-    **kwargs,
 ) -> dict:
     """
     Delete object from backend.
@@ -299,9 +287,8 @@ def delete_secret(
     entity_id : str
         Entity ID.
     delete_all_versions : bool
-        Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
-    **kwargs : dict
-        Parameters to pass to the API call.
+        Delete all versions of the named entity.
+        If True, use entity name instead of entity key as identifier.
 
     Returns
     -------
@@ -324,5 +311,4 @@ def delete_secret(
         project=project,
         entity_id=entity_id,
         delete_all_versions=delete_all_versions,
-        **kwargs,
     )

digitalhub/entities/task/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.processors import context_processor
-from digitalhub.utils.exceptions import EntityError
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.task._base.entity import Task
@@ -72,7 +70,6 @@ def new_task(
 def get_task(
     identifier: str,
     project: str | None = None,
-    **kwargs,
 ) -> Task:
     """
     Get object from backend.
@@ -83,8 +80,6 @@ def get_task(
         Entity key (store://...) or entity ID.
     project : str
         Project name.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -101,14 +96,24 @@ def get_task(
     >>>               project="my-project")
     """
     return context_processor.read_unversioned_entity(
-        identifier,
+        identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
-        **kwargs,
     )
 
 
-def list_tasks(project: str, **kwargs) -> list[Task]:
+def list_tasks(
+    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,
+) -> list[Task]:
     """
     List all latest version objects from backend.
 
@@ -116,8 +121,24 @@ def list_tasks(project: str, **kwargs) -> list[Task]:
     ----------
     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.
 
     Returns
     -------
@@ -131,7 +152,15 @@ def list_tasks(project: str, **kwargs) -> list[Task]:
     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,
     )
 
 
@@ -223,9 +252,7 @@ def delete_task(
     identifier: str,
     project: str | None = None,
     entity_id: str | None = None,
-    delete_all_versions: bool = False,
     cascade: bool = True,
-    **kwargs,
 ) -> dict:
     """
     Delete object from backend.
@@ -238,8 +265,6 @@ def delete_task(
         Project name.
     entity_id : str
         Entity ID.
-    delete_all_versions : bool
-        Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
     cascade : bool
         Cascade delete.
     **kwargs : dict
@@ -252,22 +277,12 @@ def delete_task(
 
     Examples
     --------
-    If delete_all_versions is False:
     >>> obj = delete_task("store://my-task-key")
-
-    Otherwise:
-    >>> obj = delete_task("task-name",
-    >>>                  project="my-project",
-    >>>                  delete_all_versions=True)
     """
-    if not is_valid_key(identifier):
-        raise EntityError("Task has no name. Use key instead.")
     return context_processor.delete_context_entity(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
         entity_id=entity_id,
-        delete_all_versions=delete_all_versions,
         cascade=cascade,
-        **kwargs,
     )

digitalhub/entities/trigger/crud.py

@@ -91,7 +91,6 @@ def get_trigger(
     identifier: str,
     project: str | None = None,
     entity_id: str | None = None,
-    **kwargs,
 ) -> Trigger:
     """
     Get object from backend.
@@ -104,8 +103,6 @@ def get_trigger(
         Project name.
     entity_id : str
         Entity ID.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -123,18 +120,16 @@ def get_trigger(
     >>>                  entity_id="my-trigger-id")
     """
     return context_processor.read_context_entity(
-        identifier,
+        identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
         entity_id=entity_id,
-        **kwargs,
     )
 
 
 def get_trigger_versions(
     identifier: str,
     project: str | None = None,
-    **kwargs,
 ) -> list[Trigger]:
     """
     Get object versions from backend.
@@ -145,8 +140,6 @@ def get_trigger_versions(
         Entity key (store://...) or entity name.
     project : str
         Project name.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -163,14 +156,24 @@ def get_trigger_versions(
     >>>                            project="my-project")
     """
     return context_processor.read_context_entity_versions(
-        identifier,
+        identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
-        **kwargs,
     )
 
 
-def list_triggers(project: str, **kwargs) -> list[Trigger]:
+def list_triggers(
+    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,
+    version: str | None = None,
+    task: str | None = None,
+) -> list[Trigger]:
     """
     List all latest version objects from backend.
 
@@ -178,8 +181,24 @@ def list_triggers(project: str, **kwargs) -> list[Trigger]:
     ----------
     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.
+    version : str
+        Object version, default is latest.
+    task : str
+        Task string filter.
 
     Returns
     -------
@@ -193,7 +212,15 @@ def list_triggers(project: str, **kwargs) -> list[Trigger]:
     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,
+        version=version,
+        task=task,
     )
 
 
@@ -286,7 +313,6 @@ def delete_trigger(
     project: str | None = None,
     entity_id: str | None = None,
     delete_all_versions: bool = False,
-    **kwargs,
 ) -> dict:
     """
     Delete object from backend.
@@ -300,9 +326,8 @@ def delete_trigger(
     entity_id : str
         Entity ID.
     delete_all_versions : bool
-        Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
-    **kwargs : dict
-        Parameters to pass to the API call.
+        Delete all versions of the named entity.
+        If True, use entity name instead of entity key as identifier.
 
     Returns
     -------
@@ -325,5 +350,4 @@ def delete_trigger(
         project=project,
         entity_id=entity_id,
         delete_all_versions=delete_all_versions,
-        **kwargs,
     )