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

digitalhub/entities/secret/crud.py

@@ -8,7 +8,7 @@ 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.entities._processors.processors import context_processor
 from digitalhub.utils.exceptions import EntityNotExistsError
 
 if typing.TYPE_CHECKING:
@@ -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
     -------
@@ -105,9 +102,7 @@ def get_secret(
     Examples
     --------
     Using entity key:
-    >>> obj = get_secret(
-    ...     "store://my-secret-key"
-    ... )
+    >>> obj = get_secret("store://my-secret-key")
 
     Using entity name:
     >>> obj = get_secret("my-secret-name"
@@ -117,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.
@@ -146,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
     -------
@@ -157,23 +148,20 @@ def get_secret_versions(
     Examples
     --------
     Using entity key:
-    >>> objs = get_secret_versions(
-    ...     "store://my-secret-key"
-    ... )
+    >>> objs = get_secret_versions("store://my-secret-key")
 
     Using entity name:
     >>> objs = get_secret_versions("my-secret-name",
     >>>                            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.
 
@@ -181,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
     -------
@@ -191,14 +177,11 @@ def list_secrets(project: str, **kwargs) -> list[Secret]:
 
     Examples
     --------
-    >>> objs = list_secrets(
-    ...     project="my-project"
-    ... )
+    >>> objs = list_secrets(project="my-project")
     """
     return context_processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
-        **kwargs,
     )
 
 
@@ -229,9 +212,7 @@ def import_secret(
 
     Examples
     --------
-    >>> obj = import_secret(
-    ...     "my-secret.yaml"
-    ... )
+    >>> obj = import_secret("my-secret.yaml")
     """
     return context_processor.import_context_entity(
         file,
@@ -257,9 +238,7 @@ def load_secret(file: str) -> Secret:
 
     Examples
     --------
-    >>> obj = load_secret(
-    ...     "my-secret.yaml"
-    ... )
+    >>> obj = load_secret("my-secret.yaml")
     """
     return context_processor.load_context_entity(file)
 
@@ -280,9 +259,7 @@ def update_secret(entity: Secret) -> Secret:
 
     Examples
     --------
-    >>> obj = update_secret(
-    ...     obj
-    ... )
+    >>> obj = update_secret(obj)
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -297,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.
@@ -311,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
     -------
@@ -323,9 +298,7 @@ def delete_secret(
     Examples
     --------
     If delete_all_versions is False:
-    >>> obj = delete_secret(
-    ...     "store://my-secret-key"
-    ... )
+    >>> obj = delete_secret("store://my-secret-key")
 
     Otherwise:
     >>> obj = delete_secret("my-secret-name"
@@ -338,5 +311,4 @@ def delete_secret(
         project=project,
         entity_id=entity_id,
         delete_all_versions=delete_all_versions,
-        **kwargs,
     )

digitalhub/entities/task/_base/builder.py

@@ -85,10 +85,6 @@ class TaskBuilder(UnversionedBuilder, RuntimeEntityBuilder):
         ----------
         executable : str
             Executable string.
-
-        Returns
-        -------
-        None
         """
         exec_kind = executable.split("://")[0]
         if self.EXECUTABLE_KIND != exec_kind:

digitalhub/entities/task/_base/entity.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.entities._base.unversioned.entity import UnversionedEntity
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.factory.entity import entity_factory
 
 if typing.TYPE_CHECKING:

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.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.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
     -------
@@ -94,23 +89,31 @@ def get_task(
     Examples
     --------
     Using entity key:
-    >>> obj = get_task(
-    ...     "store://my-task-key"
-    ... )
+    >>> obj = get_task("store://my-task-key")
 
     Using entity ID:
     >>> obj = get_task("my-task-id"
     >>>               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.
 
@@ -118,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
     -------
@@ -128,14 +147,20 @@ def list_tasks(project: str, **kwargs) -> list[Task]:
 
     Examples
     --------
-    >>> objs = list_tasks(
-    ...     project="my-project"
-    ... )
+    >>> objs = list_tasks(project="my-project")
     """
     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,
     )
 
 
@@ -166,9 +191,7 @@ def import_task(
 
     Example
     -------
-    >>> obj = import_task(
-    ...     "my-task.yaml"
-    ... )
+    >>> obj = import_task("my-task.yaml")
     """
     return context_processor.import_context_entity(
         file,
@@ -194,9 +217,7 @@ def load_task(file: str) -> Task:
 
     Examples
     --------
-    >>> obj = load_task(
-    ...     "my-task.yaml"
-    ... )
+    >>> obj = load_task("my-task.yaml")
     """
     return context_processor.load_context_entity(file)
 
@@ -217,9 +238,7 @@ def update_task(entity: Task) -> Task:
 
     Examples
     --------
-    >>> obj = update_task(
-    ...     obj
-    ... )
+    >>> obj = update_task(obj)
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -233,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.
@@ -248,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
@@ -262,24 +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)
+    >>> obj = delete_task("store://my-task-key")
     """
-    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/_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
@@ -41,9 +41,5 @@ class Trigger(VersionedEntity):
     def stop(self) -> None:
         """
         Stop trigger.
-
-        Returns
-        -------
-        None
         """
         return context_processor.stop_entity(self.project, self.ENTITY_TYPE, self.id)

digitalhub/entities/trigger/crud.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import typing
 
 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.trigger._base.entity import Trigger
@@ -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
     -------
@@ -115,9 +112,7 @@ def get_trigger(
     Examples
     --------
     Using entity key:
-    >>> obj = get_trigger(
-    ...     "store://my-trigger-key"
-    ... )
+    >>> obj = get_trigger("store://my-trigger-key")
 
     Using entity name:
     >>> obj = get_trigger("my-trigger-name"
@@ -125,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.
@@ -147,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
     -------
@@ -158,23 +149,31 @@ def get_trigger_versions(
     Examples
     --------
     Using entity key:
-    >>> objs = get_trigger_versions(
-    ...     "store://my-trigger-key"
-    ... )
+    >>> objs = get_trigger_versions("store://my-trigger-key")
 
     Using entity name:
     >>> objs = get_trigger_versions("my-trigger-name",
     >>>                            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.
 
@@ -182,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
     -------
@@ -192,14 +207,20 @@ def list_triggers(project: str, **kwargs) -> list[Trigger]:
 
     Examples
     --------
-    >>> objs = list_triggers(
-    ...     project="my-project"
-    ... )
+    >>> objs = list_triggers(project="my-project")
     """
     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,
     )
 
 
@@ -230,9 +251,7 @@ def import_trigger(
 
     Examples
     --------
-    >>> obj = import_trigger(
-    ...     "my-trigger.yaml"
-    ... )
+    >>> obj = import_trigger("my-trigger.yaml")
     """
     return context_processor.import_context_entity(
         file,
@@ -258,9 +277,7 @@ def load_trigger(file: str) -> Trigger:
 
     Examples
     --------
-    >>> obj = load_trigger(
-    ...     "my-trigger.yaml"
-    ... )
+    >>> obj = load_trigger("my-trigger.yaml")
     """
     return context_processor.load_context_entity(file)
 
@@ -281,11 +298,7 @@ def update_trigger(entity: Trigger) -> Trigger:
 
     Examples
     --------
-    >>> obj = (
-    ...     update_trigger(
-    ...         obj
-    ...     )
-    ... )
+    >>> obj = update_trigger(obj)
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -300,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.
@@ -314,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
     -------
@@ -326,9 +337,7 @@ def delete_trigger(
     Examples
     --------
     If delete_all_versions is False:
-    >>> obj = delete_trigger(
-    ...     "store://my-trigger-key"
-    ... )
+    >>> obj = delete_trigger("store://my-trigger-key")
 
     Otherwise:
     >>> obj = delete_trigger("my-trigger-name"
@@ -341,5 +350,4 @@ def delete_trigger(
         project=project,
         entity_id=entity_id,
         delete_all_versions=delete_all_versions,
-        **kwargs,
     )