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

digitalhub/entities/_processors/context/import_export.py

@@ -0,0 +1,242 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._constructors.uuid import build_uuid
+from digitalhub.entities._processors.utils import get_context, get_context_from_identifier
+from digitalhub.factory.entity import entity_factory
+from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError, EntityNotExistsError
+from digitalhub.utils.io_utils import read_yaml
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.context.entity import ContextEntity
+    from digitalhub.entities._base.executable.entity import ExecutableEntity
+    from digitalhub.entities._processors.context.crud import ContextEntityCRUDProcessor
+
+
+class ContextEntityImportExportProcessor:
+    """
+    Processor for import and export operations on context entities.
+
+    Handles loading entities from YAML files and importing/exporting
+    entity configurations between local files and the backend.
+    """
+
+    def import_context_entity(
+        self,
+        crud_processor: ContextEntityCRUDProcessor,
+        file: str | None = None,
+        key: str | None = None,
+        reset_id: bool = False,
+        context: str | None = None,
+    ) -> ContextEntity:
+        """
+        Import a context entity from a YAML file or from a storage key.
+
+        Parameters
+        ----------
+        crud_processor : ContextEntityCRUDProcessor
+            The CRUD processor instance for entity operations.
+        file : str
+            Path to the YAML file containing entity configuration.
+        key : str
+            Storage key (store://...) to read the entity from.
+        reset_id : bool
+            Flag to determine if the ID of context entities should be reset.
+        context : str
+            Project name to use for context resolution. If None, uses
+            the project specified in the YAML file.
+
+        Returns
+        -------
+        ContextEntity
+            The imported and created context entity.
+
+        Raises
+        ------
+        EntityError
+            If the entity already exists in the backend.
+        """
+        if (file is None) == (key is None):
+            raise ValueError("Provide key or file, not both or none.")
+
+        if file is not None:
+            dict_obj: dict = read_yaml(file)
+        else:
+            ctx = get_context_from_identifier(key)
+            dict_obj: dict = crud_processor._read_context_entity(ctx, key)
+
+        dict_obj["status"] = {}
+
+        if context is None:
+            context = dict_obj["project"]
+
+        ctx = get_context(context)
+        obj = entity_factory.build_entity_from_dict(dict_obj)
+        if reset_id:
+            new_id = build_uuid()
+            obj.id = new_id
+            obj.metadata.version = new_id
+        try:
+            bck_obj = crud_processor._create_context_entity(ctx, obj.ENTITY_TYPE, obj.to_dict())
+            new_obj: ContextEntity = entity_factory.build_entity_from_dict(bck_obj)
+        except EntityAlreadyExistsError:
+            raise EntityError(f"Entity {obj.name} already exists. If you want to update it, use load instead.")
+        return new_obj
+
+    def import_executable_entity(
+        self,
+        crud_processor: ContextEntityCRUDProcessor,
+        file: str | None = None,
+        key: str | None = None,
+        reset_id: bool = False,
+        context: str | None = None,
+    ) -> ExecutableEntity:
+        """
+        Import an executable entity from a YAML file or from a storage key.
+
+        Parameters
+        ----------
+        crud_processor : ContextEntityCRUDProcessor
+            The CRUD processor instance for entity operations.
+        file : str
+            Path to the YAML file containing executable entity configuration.
+            Can contain a single entity or a list with the executable and tasks.
+        key : str
+            Storage key (store://...) to read the entity from.
+        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
+        -------
+        ExecutableEntity
+            The imported and created executable entity.
+
+        Raises
+        ------
+        EntityError
+            If the entity already exists in the backend.
+        """
+        if (file is None) == (key is None):
+            raise ValueError("Provide key or file, not both or none.")
+
+        if file is not None:
+            dict_obj: dict | list[dict] = read_yaml(file)
+        else:
+            ctx = get_context_from_identifier(key)
+            dict_obj: dict = crud_processor._read_context_entity(ctx, key)
+
+        if isinstance(dict_obj, list):
+            exec_dict = dict_obj[0]
+            exec_dict["status"] = {}
+            tsk_dicts = []
+            for i in dict_obj[1:]:
+                i["status"] = {}
+                tsk_dicts.append(i)
+        else:
+            exec_dict = dict_obj
+            exec_dict["status"] = {}
+            tsk_dicts = []
+
+        if context is None:
+            context = exec_dict["project"]
+
+        ctx = get_context(context)
+        obj: ExecutableEntity = entity_factory.build_entity_from_dict(exec_dict)
+
+        if reset_id:
+            new_id = build_uuid()
+            obj.id = new_id
+            obj.metadata.version = new_id
+
+        try:
+            bck_obj = crud_processor._create_context_entity(ctx, obj.ENTITY_TYPE, obj.to_dict())
+            new_obj: ExecutableEntity = entity_factory.build_entity_from_dict(bck_obj)
+        except EntityAlreadyExistsError:
+            raise EntityError(f"Entity {obj.name} already exists. If you want to update it, use load instead.")
+
+        new_obj.import_tasks(tsk_dicts)
+
+        return new_obj
+
+    def load_context_entity(
+        self,
+        crud_processor: ContextEntityCRUDProcessor,
+        file: str,
+    ) -> ContextEntity:
+        """
+        Load a context entity from a YAML file and update it in the backend.
+
+        Reads entity configuration from a YAML file and updates an existing
+        entity in the backend. If the entity doesn't exist, it creates a
+        new one.
+
+        Parameters
+        ----------
+        crud_processor : ContextEntityCRUDProcessor
+            The CRUD processor instance for entity operations.
+        file : str
+            Path to the YAML file containing entity configuration.
+
+        Returns
+        -------
+        ContextEntity
+            The loaded and updated context entity.
+        """
+        dict_obj: dict = read_yaml(file)
+        context = get_context(dict_obj["project"])
+        obj: ContextEntity = entity_factory.build_entity_from_dict(dict_obj)
+        try:
+            crud_processor._update_context_entity(context, obj.ENTITY_TYPE, obj.id, obj.to_dict())
+        except EntityNotExistsError:
+            crud_processor._create_context_entity(context, obj.ENTITY_TYPE, obj.to_dict())
+        return obj
+
+    def load_executable_entity(
+        self,
+        crud_processor: ContextEntityCRUDProcessor,
+        file: str,
+    ) -> ExecutableEntity:
+        """
+        Load an executable entity from a YAML file and update it in the backend.
+
+        Reads executable entity configuration from a YAML file and updates
+        an existing executable entity in the backend. If the entity doesn't
+        exist, it creates a new one. Also handles task imports.
+
+        Parameters
+        ----------
+        crud_processor : ContextEntityCRUDProcessor
+            The CRUD processor instance for entity operations.
+        file : str
+            Path to the YAML file containing executable entity configuration.
+            Can contain a single entity or a list with the executable and tasks.
+
+        Returns
+        -------
+        ExecutableEntity
+            The loaded and updated executable entity.
+        """
+        dict_obj: dict | list[dict] = read_yaml(file)
+        if isinstance(dict_obj, list):
+            exec_dict = dict_obj[0]
+            tsk_dicts = dict_obj[1:]
+        else:
+            exec_dict = dict_obj
+            tsk_dicts = []
+
+        context = get_context(exec_dict["project"])
+        obj: ExecutableEntity = entity_factory.build_entity_from_dict(exec_dict)
+
+        try:
+            crud_processor._update_context_entity(context, obj.ENTITY_TYPE, obj.id, obj.to_dict())
+        except EntityNotExistsError:
+            crud_processor._create_context_entity(context, obj.ENTITY_TYPE, obj.to_dict())
+        obj.import_tasks(tsk_dicts)
+        return obj

digitalhub/entities/_processors/context/material.py

@@ -0,0 +1,123 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._commons.enums import Relationship, State
+from digitalhub.entities._processors.utils import get_context
+from digitalhub.factory.entity import entity_factory
+from digitalhub.utils.exceptions import EntityError
+from digitalhub.utils.types import SourcesOrListOfSources
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.material.entity import MaterialEntity
+    from digitalhub.entities._processors.context.crud import ContextEntityCRUDProcessor
+
+
+class ContextEntityMaterialProcessor:
+    """
+    Processor for material entity operations.
+
+    Handles creation and management of material entities (artifacts,
+    dataitems, models) including file upload operations and status
+    management during uploads.
+    """
+
+    def log_material_entity(
+        self,
+        crud_processor: ContextEntityCRUDProcessor,
+        **kwargs,
+    ) -> MaterialEntity:
+        """
+        Create a material entity in the backend and upload associated files.
+
+        Creates a new material entity (artifact, dataitem, or model) and
+        handles file upload operations. Manages upload state transitions
+        and error handling during the upload process.
+
+        Parameters
+        ----------
+        crud_processor : ContextEntityCRUDProcessor
+            The CRUD processor instance for entity operations.
+        **kwargs : dict
+            Parameters for entity creation including:
+            - 'source': file source(s) to upload
+            - 'project': project name
+            - other entity-specific parameters
+
+        Returns
+        -------
+        MaterialEntity
+            The created material entity with uploaded files.
+
+        Raises
+        ------
+        EntityError
+            If file upload fails during the process.
+        """
+        source: SourcesOrListOfSources = kwargs.pop("source")
+        context = get_context(kwargs["project"])
+        obj = entity_factory.build_entity_from_params(**kwargs)
+        if context.is_running:
+            obj.add_relationship(Relationship.PRODUCEDBY.value, context.get_run_ctx())
+
+        new_obj: MaterialEntity = crud_processor._create_context_entity(context, obj.ENTITY_TYPE, obj.to_dict())
+        new_obj = entity_factory.build_entity_from_dict(new_obj)
+
+        new_obj.status.state = State.UPLOADING.value
+        new_obj = self._update_material_entity(crud_processor, new_obj)
+
+        # Handle file upload
+        try:
+            new_obj.upload(source)
+            uploaded = True
+            msg = None
+        except Exception as e:
+            uploaded = False
+            msg = str(e.args)
+
+        new_obj.status.message = msg
+
+        # Update status after upload
+        if uploaded:
+            new_obj.status.state = State.READY.value
+            new_obj = self._update_material_entity(crud_processor, new_obj)
+        else:
+            new_obj.status.state = State.ERROR.value
+            new_obj = self._update_material_entity(crud_processor, new_obj)
+            raise EntityError(msg)
+
+        return new_obj
+
+    def _update_material_entity(
+        self,
+        crud_processor: ContextEntityCRUDProcessor,
+        new_obj: MaterialEntity,
+    ) -> MaterialEntity:
+        """
+        Update a material entity using a shortcut method.
+
+        Convenience method for updating material entities during
+        file upload operations.
+
+        Parameters
+        ----------
+        crud_processor : ContextEntityCRUDProcessor
+            The CRUD processor instance for entity operations.
+        new_obj : MaterialEntity
+            The material entity object to update.
+
+        Returns
+        -------
+        MaterialEntity
+            The updated material entity.
+        """
+        return crud_processor.update_context_entity(
+            new_obj.project,
+            new_obj.ENTITY_TYPE,
+            new_obj.id,
+            new_obj.to_dict(),
+        )