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

digitalhub/entities/run/crud.py

@@ -7,8 +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.utils.exceptions import EntityError
+from digitalhub.entities._processors.processors import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.run._base.entity import Run
@@ -71,7 +70,6 @@ def new_run(
 def get_run(
     identifier: str,
     project: str | None = None,
-    **kwargs,
 ) -> Run:
     """
     Get object from backend.
@@ -82,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
     -------
@@ -100,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.
 
@@ -115,34 +123,74 @@ 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,
     )
 
 
-def import_run(file: str) -> Run:
+def import_run(
+    file: str | None = None,
+    key: str | None = None,
+    reset_id: bool = False,
+    context: str | None = None,
+) -> Run:
     """
-    Import object from a YAML file and create a new object into the backend.
+    Import an object from a YAML file or from a storage key.
 
     Parameters
     ----------
     file : str
-        Path to YAML file.
+        Path to the YAML file.
+    key : str
+        Entity key (store://...).
+    reset_id : bool
+        Flag to determine if the ID of executable entities should be reset.
+    context : str
+        Project name to use for context resolution.
 
     Returns
     -------
@@ -153,7 +201,12 @@ def import_run(file: str) -> Run:
     -------
     >>> obj = import_run("my-run.yaml")
     """
-    return context_processor.import_context_entity(file)
+    return context_processor.import_context_entity(
+        file,
+        key,
+        reset_id,
+        context,
+    )
 
 
 def load_run(file: str) -> Run:
@@ -206,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.
@@ -214,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
     -------
@@ -228,14 +281,14 @@ def delete_run(
     Examples
     --------
     >>> obj = delete_run("store://my-run-key")
-    >>> obj = delete_run("my-run-id", project="my-project")
+    >>> obj = delete_run(
+    ...     "my-run-id",
+    ...     project="my-project",
+    ... )
     """
-    if not identifier.startswith("store://") 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)

digitalhub/entities/secret/crud.py

@@ -6,8 +6,9 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._commons.enums import EntityKinds, EntityTypes
+from digitalhub.entities._commons.utils import is_valid_key
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.utils.exceptions import EntityNotExistsError
 
 if typing.TYPE_CHECKING:
@@ -65,7 +66,7 @@ def new_secret(
     obj: Secret = context_processor.create_context_entity(
         project=project,
         name=name,
-        kind="secret",
+        kind=EntityKinds.SECRET_SECRET.value,
         uuid=uuid,
         description=description,
         labels=labels,
@@ -80,7 +81,6 @@ def get_secret(
     identifier: str,
     project: str | None = None,
     entity_id: str | None = None,
-    **kwargs,
 ) -> Secret:
     """
     Get object from backend.
@@ -93,8 +93,6 @@ def get_secret(
         Project name.
     entity_id : str
         Entity ID.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -111,28 +109,26 @@ def get_secret(
     >>>                  project="my-project",
     >>>                  entity_id="my-secret-id")
     """
-    if not identifier.startswith("store://"):
+    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.
@@ -143,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
     -------
@@ -161,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.
 
@@ -176,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,18 +182,28 @@ def list_secrets(project: str, **kwargs) -> list[Secret]:
     return context_processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
-        **kwargs,
     )
 
 
-def import_secret(file: str) -> Secret:
+def import_secret(
+    file: str | None = None,
+    key: str | None = None,
+    reset_id: bool = False,
+    context: str | None = None,
+) -> Secret:
     """
-    Import object from a YAML file and create a new object into the backend.
+    Import an object from a YAML file or from a storage key.
 
     Parameters
     ----------
     file : str
-        Path to YAML file.
+        Path to the YAML file.
+    key : str
+        Entity key (store://...).
+    reset_id : bool
+        Flag to determine if the ID of executable entities should be reset.
+    context : str
+        Project name to use for context resolution.
 
     Returns
     -------
@@ -213,7 +214,12 @@ def import_secret(file: str) -> Secret:
     --------
     >>> obj = import_secret("my-secret.yaml")
     """
-    return context_processor.import_context_entity(file)
+    return context_processor.import_context_entity(
+        file,
+        key,
+        reset_id,
+        context,
+    )
 
 
 def load_secret(file: str) -> Secret:
@@ -268,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.
@@ -282,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
     -------
@@ -307,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,8 +8,8 @@ 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.factory.factory import factory
+from digitalhub.entities._processors.processors import context_processor
+from digitalhub.factory.entity import entity_factory
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -67,8 +67,8 @@ class Task(UnversionedEntity):
         Run
             Run object.
         """
-        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)
         kwargs[exec_type] = getattr(self.spec, exec_type)
         return self.new_run(
             save=save,
@@ -112,7 +112,7 @@ class Task(UnversionedEntity):
         """
         if save:
             return context_processor.create_context_entity(**kwargs)
-        return factory.build_entity_from_params(**kwargs)
+        return entity_factory.build_entity_from_params(**kwargs)
 
     def get_run(self, entity_key: str) -> Run:
         """

digitalhub/entities/task/_base/models.py

@@ -18,6 +18,7 @@ class VolumeType(Enum):
     PERSISTENT_VOLUME_CLAIM = "persistent_volume_claim"
     EMPTY_DIR = "empty_dir"
     EPHEMERAL = "ephemeral"
+    SHARED_VOLUME = "shared_volume"
 
 
 class SpecEmptyDir(BaseModel):
@@ -46,6 +47,14 @@ class SpecEphemeral(BaseModel):
     size: Optional[str] = None
 
 
+class SharedVolumeSpec(BaseModel):
+    """
+    Shared volume spec model.
+    """
+
+    size: Optional[str] = None
+
+
 class Volume(BaseModel):
     """
     Volume model.
@@ -62,7 +71,7 @@ class Volume(BaseModel):
     mount_path: str
     """Volume mount path inside the container."""
 
-    spec: Optional[Union[SpecEmptyDir, SpecPVC, SpecEphemeral]] = None
+    spec: Optional[Union[SpecEmptyDir, SpecPVC, SpecEphemeral, SharedVolumeSpec]] = None
     """Volume spec."""
 
 
@@ -78,30 +87,18 @@ class NodeSelector(BaseModel):
     """Node selector value."""
 
 
-class ResourceItem(BaseModel):
-    """
-    Resource item model.
-    """
-
-    requests: str = Field(default=None, pattern=r"[\d]+|^([0-9])+([a-zA-Z])+$")
-    """Resource requests."""
-
-    limits: str = Field(default=None, pattern=r"[\d]+|^([0-9])+([a-zA-Z])+$")
-    """Resource limits."""
-
-
 class Resource(BaseModel):
     """
     Resource model.
     """
 
-    cpu: Optional[ResourceItem] = None
+    cpu: Optional[str] = Field(default=None, pattern=r"[\d]+|^([0-9])+([a-zA-Z])+$")
     """CPU resource model."""
 
-    mem: Optional[ResourceItem] = None
+    mem: Optional[str] = Field(default=None, pattern=r"[\d]+|^([0-9])+([a-zA-Z])+$")
     """Memory resource model."""
 
-    gpu: Optional[ResourceItem] = None
+    gpu: Optional[str] = Field(default=None, pattern=r"[\d]+|^([0-9])+([a-zA-Z])+$")
     """GPU resource model."""
 
 

digitalhub/entities/task/crud.py

@@ -7,8 +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.utils.exceptions import EntityError
+from digitalhub.entities._processors.processors import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.task._base.entity import Task
@@ -71,7 +70,6 @@ def new_task(
 def get_task(
     identifier: str,
     project: str | None = None,
-    **kwargs,
 ) -> Task:
     """
     Get object from backend.
@@ -82,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
     -------
@@ -100,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.
 
@@ -115,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
     -------
@@ -130,18 +152,37 @@ 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,
     )
 
 
-def import_task(file: str) -> Task:
+def import_task(
+    file: str | None = None,
+    key: str | None = None,
+    reset_id: bool = False,
+    context: str | None = None,
+) -> Task:
     """
-    Import object from a YAML file and create a new object into the backend.
+    Import an object from a YAML file or from a storage key.
 
     Parameters
     ----------
     file : str
-        Path to YAML file.
+        Path to the YAML file.
+    key : str
+        Entity key (store://...).
+    reset_id : bool
+        Flag to determine if the ID of executable entities should be reset.
+    context : str
+        Project name to use for context resolution.
 
     Returns
     -------
@@ -152,7 +193,12 @@ def import_task(file: str) -> Task:
     -------
     >>> obj = import_task("my-task.yaml")
     """
-    return context_processor.import_context_entity(file)
+    return context_processor.import_context_entity(
+        file,
+        key,
+        reset_id,
+        context,
+    )
 
 
 def load_task(file: str) -> Task:
@@ -206,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.
@@ -221,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
@@ -235,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 identifier.startswith("store://"):
-        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)