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

digitalhub/context/builder.py

@@ -82,10 +82,6 @@ class ContextBuilder:
         ----------
         project : str
             The name of the project whose context should be removed.
-
-        Returns
-        -------
-        None
             This method does not return anything.
 
         Notes

digitalhub/context/context.py

@@ -4,9 +4,12 @@
 
 from __future__ import annotations
 
+import os
 import typing
 from pathlib import Path
 
+from digitalhub.runtimes.enums import RuntimeEnvVar
+
 if typing.TYPE_CHECKING:
     from digitalhub.entities.project._base.entity import Project
     from digitalhub.stores.client._base.client import Client
@@ -47,6 +50,15 @@ class Context:
 
         self.is_running: bool = False
         self._run_ctx: str | None = None
+        self._search_run_ctx()
+
+    def _search_run_ctx(self) -> None:
+        """
+        Search for an existing run id in env.
+        """
+        run_id = os.getenv(RuntimeEnvVar.RUN_ID.value)
+        if run_id is not None:
+            self.set_run(run_id)
 
     def set_run(self, run_ctx: str) -> None:
         """
@@ -56,10 +68,6 @@ class Context:
         ----------
         run_ctx : str
             The run key to set.
-
-        Returns
-        -------
-        None
         """
         self.is_running = True
         self._run_ctx = run_ctx
@@ -67,10 +75,6 @@ class Context:
     def unset_run(self) -> None:
         """
         Clear the current run key and reset running state.
-
-        Returns
-        -------
-        None
         """
         self.is_running = False
         self._run_ctx = None

digitalhub/entities/_base/_base/entity.py

@@ -54,10 +54,6 @@ class Base:
         ----------
         **kwargs : dict
             Keyword arguments to be set as attributes.
-
-        Returns
-        -------
-        None
         """
         for k, v in kwargs.items():
             if k not in self.__dict__:

digitalhub/entities/_base/context/entity.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.context.api import get_context
 from digitalhub.entities._base.entity.entity import Entity
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.utils.generic_utils import get_timestamp
 from digitalhub.utils.io_utils import write_yaml
 

digitalhub/entities/_base/entity/entity.py

@@ -67,10 +67,6 @@ class Entity(Base):
         ----------
         obj : dict
             Mapping representation of object.
-
-        Returns
-        -------
-        None
         """
         self.metadata = obj.metadata
         self.spec = obj.spec
@@ -95,10 +91,6 @@ class Entity(Base):
             The target entity.
         source : str
             The source entity.
-
-        Returns
-        -------
-        None
         """
         if self.metadata.relationships is None:
             self.metadata.relationships = []

digitalhub/entities/_base/executable/entity.py

@@ -9,7 +9,7 @@ from abc import abstractmethod
 
 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
 from digitalhub.entities.run.crud import list_runs
 from digitalhub.entities.task.crud import delete_task, list_tasks
 from digitalhub.entities.trigger.crud import list_triggers
@@ -94,10 +94,6 @@ class ExecutableEntity(VersionedEntity):
         ----------
         tasks : list[dict]
             List of tasks to import.
-
-        Returns
-        -------
-        None
         """
         # Loop over tasks list, in the case where the function
         # is imported from local file.
@@ -295,10 +291,6 @@ class ExecutableEntity(VersionedEntity):
         kind : str
             Kind the object.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         EntityError
@@ -316,10 +308,6 @@ class ExecutableEntity(VersionedEntity):
         kind : str
             Kind the object.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         EntityError
@@ -361,14 +349,10 @@ class ExecutableEntity(VersionedEntity):
         Examples
         --------
         Using entity key:
-        >>> obj = executable.get_run(
-        ...     "store://my-secret-key"
-        ... )
+        >>> obj = executable.get_run("store://my-secret-key")
 
         Using entity ID:
-        >>> obj = executable.get_run(
-        ...     "123"
-        ... )
+        >>> obj = executable.get_run("123")
         """
         entities = self.list_runs(**kwargs)
         for entity in entities:
@@ -472,14 +456,10 @@ class ExecutableEntity(VersionedEntity):
         Examples
         --------
         Using entity key:
-        >>> obj = executable.get_trigger(
-        ...     "store://my-trigger-key"
-        ... )
+        >>> obj = executable.get_trigger("store://my-trigger-key")
 
         Using entity ID:
-        >>> obj = executable.get_trigger(
-        ...     "123"
-        ... )
+        >>> obj = executable.get_trigger("123")
         """
         entities = self.list_triggers(**kwargs)
         for entity in entities:

digitalhub/entities/_base/material/entity.py

@@ -8,7 +8,7 @@ import typing
 from pathlib import Path
 
 from digitalhub.entities._base.versioned.entity import VersionedEntity
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.stores.data.api import get_store
 from digitalhub.utils.types import SourcesOrListOfSources
 
@@ -142,24 +142,16 @@ class MaterialEntity(VersionedEntity):
         source : str | list[str]
             Local filepath, directory or list of filepaths.
 
-        Returns
-        -------
-        None
-
         Examples
         --------
         Upload a single file:
 
         >>> entity.spec.path = "s3://bucket/data.csv"
-        >>> entity.upload(
-        ...     "./data.csv"
-        ... )
+        >>> entity.upload("./data.csv")
 
         Upload a folder:
         >>> entity.spec.path = "s3://bucket/data/"
-        >>> entity.upload(
-        ...     "./data"
-        ... )
+        >>> entity.upload("./data")
         """
         # Get store and upload object
         store = get_store(self.spec.path)
@@ -181,10 +173,6 @@ class MaterialEntity(VersionedEntity):
         ----------
         files : list[dict]
             Files to add.
-
-        Returns
-        -------
-        None
         """
         available = 100 - len(self.status.files)
         if len(files) > available:
@@ -218,10 +206,6 @@ class MaterialEntity(VersionedEntity):
         ----------
         files_info : list[dict] | None
             Files info.
-
-        Returns
-        -------
-        None
         """
         if files_info is None:
             return
@@ -233,10 +217,6 @@ class MaterialEntity(VersionedEntity):
     def _get_files_info(self) -> None:
         """
         Get files info from backend.
-
-        Returns
-        -------
-        None
         """
         if not self._context().local and not self.status.files:
             files = context_processor.read_files_info(

digitalhub/entities/_base/unversioned/entity.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
-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

digitalhub/entities/_base/versioned/entity.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
-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

digitalhub/entities/_processors/base/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0

digitalhub/entities/_processors/{base.py → base/crud.py}

@@ -5,34 +5,25 @@
 from __future__ import annotations
 
 import typing
-from warnings import warn
 
 from digitalhub.context.api import delete_context
 from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
 from digitalhub.factory.entity import entity_factory
 from digitalhub.stores.client.api import get_client
-from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError, EntityNotExistsError
-from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.project._base.entity import Project
     from digitalhub.stores.client._base.client import Client
 
 
-class BaseEntityOperationsProcessor:
+class BaseEntityCRUDProcessor:
     """
-    Processor for base entity operations.
+    Processor for core CRUD operations on base entities.
 
-    This class handles CRUD operations and other entity management tasks
-    for base-level entities (primarily projects). It interacts with the
-    client layer to perform backend operations and manages entity lifecycle
-    including creation, reading, updating, deletion, and sharing.
+    Handles creation, reading, updating, deletion, and listing of
+    base-level entities (primarily projects) within the backend.
     """
 
-    ##############################
-    # CRUD base entity
-    ##############################
-
     def _create_base_entity(
         self,
         client: Client,
@@ -174,97 +165,6 @@ class BaseEntityOperationsProcessor:
         obj["local"] = client.is_local()
         return entity_factory.build_entity_from_dict(obj)
 
-    def import_project_entity(
-        self,
-        file: str,
-        **kwargs,
-    ) -> Project:
-        """
-        Import a project entity from a YAML file and create it in the backend.
-
-        Reads project configuration from a YAML file, creates a new project
-        entity in the backend, and imports any related entities defined
-        in the file. Raises an error if the project already exists.
-
-        Parameters
-        ----------
-        file : str
-            Path to the YAML file containing project configuration.
-        **kwargs : dict
-            Additional parameters including 'local' and 'reset_id' flags.
-
-        Returns
-        -------
-        Project
-            The imported and created project entity.
-
-        Raises
-        ------
-        EntityError
-            If the project already exists in the backend.
-        """
-        client = get_client(kwargs.pop("local", False))
-        obj: dict = read_yaml(file)
-        obj["status"] = {}
-        obj["local"] = client.is_local()
-        ent: Project = entity_factory.build_entity_from_dict(obj)
-        reset_id = kwargs.pop("reset_id", False)
-
-        try:
-            self._create_base_entity(ent._client, ent.ENTITY_TYPE, ent.to_dict())
-        except EntityAlreadyExistsError:
-            msg = f"Entity {ent.name} already exists."
-            if reset_id:
-                ent._import_entities(obj, reset_id=reset_id)
-                warn(f"{msg} Other entities ids have been imported.")
-                ent.refresh()
-                return ent
-            raise EntityError(f"{msg} If you want to update it, use load instead.")
-
-        # Import related entities
-        ent._import_entities(obj, reset_id=reset_id)
-        ent.refresh()
-        return ent
-
-    def load_project_entity(
-        self,
-        file: str,
-        **kwargs,
-    ) -> Project:
-        """
-        Load a project entity from a YAML file and update it in the backend.
-
-        Reads project configuration from a YAML file and updates an existing
-        project in the backend. If the project doesn't exist, it creates a
-        new one. Also loads any related entities defined in the file.
-
-        Parameters
-        ----------
-        file : str
-            Path to the YAML file containing project configuration.
-        **kwargs : dict
-            Additional parameters including 'local' flag.
-
-        Returns
-        -------
-        Project
-            The loaded and updated project entity.
-        """
-        client = get_client(kwargs.pop("local", False))
-        obj: dict = read_yaml(file)
-        obj["local"] = client.is_local()
-        ent: Project = entity_factory.build_entity_from_dict(obj)
-
-        try:
-            self._update_base_entity(ent._client, ent.ENTITY_TYPE, ent.name, ent.to_dict())
-        except EntityNotExistsError:
-            self._create_base_entity(ent._client, ent.ENTITY_TYPE, ent.to_dict())
-
-        # Load related entities
-        ent._load_entities(obj)
-        ent.refresh()
-        return ent
-
     def _list_base_entities(
         self,
         client: Client,
@@ -464,6 +364,8 @@ class BaseEntityOperationsProcessor:
 
         Parameters
         ----------
+        crud_processor : BaseEntityCRUDProcessor
+            The CRUD processor instance for entity operations.
         entity_type : str
             The type of entity to delete (typically 'project').
         entity_name : str
@@ -486,125 +388,3 @@ class BaseEntityOperationsProcessor:
             entity_name,
             **kwargs,
         )
-
-    ##############################
-    # Base entity operations
-    ##############################
-
-    def _build_base_entity_key(
-        self,
-        client: Client,
-        entity_id: str,
-    ) -> str:
-        """
-        Build a storage key for a base entity.
-
-        Creates a standardized key string that can be used to identify
-        and store the entity in various contexts.
-
-        Parameters
-        ----------
-        client : Client
-            The client instance to use for key building.
-        entity_id : str
-            The unique identifier of the entity.
-
-        Returns
-        -------
-        str
-            The constructed entity key string.
-        """
-        return client.build_key(ApiCategories.BASE.value, entity_id)
-
-    def build_project_key(
-        self,
-        entity_id: str,
-        **kwargs,
-    ) -> str:
-        """
-        Build a storage key for a project entity.
-
-        Creates a standardized key string for project identification
-        and storage, handling both local and remote client contexts.
-
-        Parameters
-        ----------
-        entity_id : str
-            The unique identifier of the project entity.
-        **kwargs : dict
-            Additional parameters including 'local' flag.
-
-        Returns
-        -------
-        str
-            The constructed project entity key string.
-        """
-        client = get_client(kwargs.pop("local", False))
-        return self._build_base_entity_key(client, entity_id)
-
-    def share_project_entity(
-        self,
-        entity_type: str,
-        entity_name: str,
-        **kwargs,
-    ) -> None:
-        """
-        Share or unshare a project entity with a user.
-
-        Manages project access permissions by sharing the project with
-        a specified user or removing user access. Handles both sharing
-        and unsharing operations based on the 'unshare' parameter.
-
-        Parameters
-        ----------
-        entity_type : str
-            The type of entity to share (typically 'project').
-        entity_name : str
-            The name identifier of the project to share.
-        **kwargs : dict
-            Additional parameters including:
-            - 'user': username to share with/unshare from
-            - 'unshare': boolean flag for unsharing (default False)
-            - 'local': boolean flag for local backend
-
-        Returns
-        -------
-        None
-
-        Raises
-        ------
-        ValueError
-            If trying to unshare from a user who doesn't have access.
-        """
-        client = get_client(kwargs.pop("local", False))
-        api = client.build_api(
-            ApiCategories.BASE.value,
-            BackendOperations.SHARE.value,
-            entity_type=entity_type,
-            entity_name=entity_name,
-        )
-
-        user = kwargs.pop("user", None)
-        if unshare := kwargs.pop("unshare", False):
-            users = client.read_object(api, **kwargs)
-            for u in users:
-                if u["user"] == user:
-                    kwargs["id"] = u["id"]
-                break
-            else:
-                raise ValueError(f"User '{user}' does not have access to project.")
-
-        kwargs = client.build_parameters(
-            ApiCategories.BASE.value,
-            BackendOperations.SHARE.value,
-            unshare=unshare,
-            user=user,
-            **kwargs,
-        )
-        if unshare:
-            client.delete_object(api, **kwargs)
-            return
-        client.create_object(api, obj={}, **kwargs)
-
-
-base_processor = BaseEntityOperationsProcessor()

digitalhub/entities/_processors/base/import_export.py

@@ -0,0 +1,122 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+import typing
+from warnings import warn
+
+from digitalhub.factory.entity import entity_factory
+from digitalhub.stores.client.api import get_client
+from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError, EntityNotExistsError
+from digitalhub.utils.io_utils import read_yaml
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.project._base.entity import Project
+
+
+class BaseEntityImportExportProcessor:
+    """
+    Processor for import and export operations on base entities.
+
+    Handles loading entities from YAML files and importing/exporting
+    entity configurations between local files and the backend.
+    """
+
+    def import_project_entity(
+        self,
+        crud_processor,
+        file: str,
+        **kwargs,
+    ) -> Project:
+        """
+        Import a project entity from a YAML file and create it in the backend.
+
+        Reads project configuration from a YAML file, creates a new project
+        entity in the backend, and imports any related entities defined
+        in the file. Raises an error if the project already exists.
+
+        Parameters
+        ----------
+        crud_processor : BaseEntityCRUDProcessor
+            The CRUD processor instance for entity operations.
+        file : str
+            Path to the YAML file containing project configuration.
+        **kwargs : dict
+            Additional parameters including 'local' and 'reset_id' flags.
+
+        Returns
+        -------
+        Project
+            The imported and created project entity.
+
+        Raises
+        ------
+        EntityError
+            If the project already exists in the backend.
+        """
+        client = get_client(kwargs.pop("local", False))
+        obj: dict = read_yaml(file)
+        obj["status"] = {}
+        obj["local"] = client.is_local()
+        ent: Project = entity_factory.build_entity_from_dict(obj)
+        reset_id = kwargs.pop("reset_id", False)
+
+        try:
+            crud_processor._create_base_entity(ent._client, ent.ENTITY_TYPE, ent.to_dict())
+        except EntityAlreadyExistsError:
+            msg = f"Entity {ent.name} already exists."
+            if reset_id:
+                ent._import_entities(obj, reset_id=reset_id)
+                warn(f"{msg} Other entities ids have been imported.")
+                ent.refresh()
+                return ent
+            raise EntityError(f"{msg} If you want to update it, use load instead.")
+
+        # Import related entities
+        ent._import_entities(obj, reset_id=reset_id)
+        ent.refresh()
+        return ent
+
+    def load_project_entity(
+        self,
+        crud_processor,
+        file: str,
+        **kwargs,
+    ) -> Project:
+        """
+        Load a project entity from a YAML file and update it in the backend.
+
+        Reads project configuration from a YAML file and updates an existing
+        project in the backend. If the project doesn't exist, it creates a
+        new one. Also loads any related entities defined in the file.
+
+        Parameters
+        ----------
+        crud_processor : BaseEntityCRUDProcessor
+            The CRUD processor instance for entity operations.
+        file : str
+            Path to the YAML file containing project configuration.
+        **kwargs : dict
+            Additional parameters including 'local' flag.
+
+        Returns
+        -------
+        Project
+            The loaded and updated project entity.
+        """
+        client = get_client(kwargs.pop("local", False))
+        obj: dict = read_yaml(file)
+        obj["local"] = client.is_local()
+        ent: Project = entity_factory.build_entity_from_dict(obj)
+
+        try:
+            crud_processor._update_base_entity(ent._client, ent.ENTITY_TYPE, ent.name, ent.to_dict())
+        except EntityNotExistsError:
+            crud_processor._create_base_entity(ent._client, ent.ENTITY_TYPE, ent.to_dict())
+
+        # Load related entities
+        ent._load_entities(obj)
+        ent.refresh()
+        return ent