digitalhub 0.8.1__py3-none-any.whl → 0.9.0__py3-none-any.whl

digitalhub/entities/_base/context/entity.py

@@ -3,9 +3,10 @@ from __future__ import annotations
 import typing
 
 from digitalhub.context.api import get_context
-from digitalhub.entities._base.api_utils import create_entity_api_ctx, read_entity_api_ctx, update_entity_api_ctx
 from digitalhub.entities._base.entity.entity import Entity
+from digitalhub.entities._operations.processor import processor
 from digitalhub.utils.generic_utils import get_timestamp
+from digitalhub.utils.io_utils import write_yaml
 
 if typing.TYPE_CHECKING:
     from digitalhub.context.context import Context
@@ -26,7 +27,11 @@ class ContextEntity(Entity):
     ) -> None:
         super().__init__(kind, metadata, spec, status, user)
         self.project = project
-        self._obj_attr.extend(["project"])
+        self.name: str
+        self.id: str
+
+        # Different behaviour for versioned and unversioned
+        self._obj_attr.extend(["project", "id", "name"])
 
     ##############################
     #  Save / Refresh / Export
@@ -46,49 +51,52 @@ class ContextEntity(Entity):
         ContextEntity
             Entity saved.
         """
-        obj = self.to_dict()
-        if not update:
-            return self._save(obj)
-        return self._update(obj)
+        if update:
+            return self._update()
+        return self._save()
 
-    def _save(self, obj: dict) -> ContextEntity:
+    def _save(self) -> ContextEntity:
         """
         Save entity into backend.
 
-        Parameters
-        ----------
-        obj : dict
-            Object instance as dictionary.
-
         Returns
         -------
         ContextEntity
             Entity saved.
         """
-        new_obj = create_entity_api_ctx(self.project, self.ENTITY_TYPE, obj)
+        new_obj = processor.create_context_entity(_entity=self)
         self._update_attributes(new_obj)
         return self
 
-    def _update(self, obj: dict) -> ContextEntity:
+    def _update(self) -> ContextEntity:
         """
         Update entity in backend.
 
-        Parameters
-        ----------
-        obj : dict
-            Object instance as dictionary.
-
         Returns
         -------
         ContextEntity
             Entity updated.
         """
         if self._context().local:
-            self.metadata.updated = obj["metadata"]["updated"] = get_timestamp()
-        new_obj = update_entity_api_ctx(self.project, self.ENTITY_TYPE, self.id, obj)
+            self.metadata.updated = self.metadata.updated = get_timestamp()
+        new_obj = processor.update_context_entity(self.project, self.ENTITY_TYPE, self.id, self.to_dict())
         self._update_attributes(new_obj)
         return self
 
+    def export(self) -> str:
+        """
+        Export object as a YAML file in the context folder.
+
+        Returns
+        -------
+        str
+            Exported filepath.
+        """
+        obj = self.to_dict()
+        pth = self._context().root / f"{self.ENTITY_TYPE}s-{self.id}.yaml"
+        write_yaml(pth, obj)
+        return str(pth)
+
     def refresh(self) -> ContextEntity:
         """
         Refresh object from backend.
@@ -98,7 +106,7 @@ class ContextEntity(Entity):
         ContextEntity
             Entity refreshed.
         """
-        new_obj = read_entity_api_ctx(self.key)
+        new_obj = processor.read_context_entity(self.key)
         self._update_attributes(new_obj)
         return self
 

digitalhub/entities/_base/entity/_constructors/metadata.py

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.entity.metadata import Metadata
+from pydantic import ValidationError
+
+from digitalhub.entities._base.entity.metadata import Metadata, RelationshipValidator
+from digitalhub.utils.exceptions import BuilderError
 from digitalhub.utils.generic_utils import get_timestamp
 
 
@@ -41,4 +44,12 @@ def parse_arguments(**kwargs) -> dict:
         kwargs["created"] = get_timestamp()
     if "updated" not in kwargs or kwargs["updated"] is None:
         kwargs["updated"] = kwargs["created"]
+    if "relationships" in kwargs:
+        if not isinstance(kwargs["relationships"], list):
+            raise BuilderError("Invalid relationships format. Must be a list of maps.")
+        for relationship in kwargs["relationships"]:
+            try:
+                RelationshipValidator(**relationship)
+            except ValidationError as e:
+                raise BuilderError(f"Malformed relationship: {e}") from e
     return kwargs

digitalhub/entities/_base/entity/_constructors/name.py

@@ -10,7 +10,7 @@ class NameValidator(BaseModel):
     Validate name format.
     """
 
-    name: str = Field(min_length=1, max_length=256, regex=NAME_REGEX)
+    name: str = Field(min_length=1, max_length=256, pattern=NAME_REGEX)
 
 
 def build_name(name: str) -> str:

digitalhub/entities/_base/entity/_constructors/spec.py

@@ -29,5 +29,5 @@ def build_spec(spec_cls: Spec, spec_validator: SpecValidator, validate: bool = T
         Spec object.
     """
     if validate:
-        kwargs = spec_validator(**kwargs).dict(by_alias=True, exclude_none=True)
+        kwargs = spec_validator(**kwargs).to_dict()
     return spec_cls(**kwargs)

digitalhub/entities/_base/entity/_constructors/status.py

@@ -2,7 +2,8 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities.utils.state import State
+from digitalhub.entities._commons.enums import State
+from digitalhub.utils.exceptions import BuilderError
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.status import Status
@@ -48,5 +49,5 @@ def parse_arguments(**kwargs) -> dict:
         kwargs["state"] = State.CREATED.value
     else:
         if kwargs["state"] not in State.__members__:
-            raise ValueError(f"Invalid state: {state}")
+            raise BuilderError(f"Invalid state: {state}")
     return kwargs

digitalhub/entities/_base/entity/builder.py

@@ -106,7 +106,12 @@ class EntityBuilder:
         Spec
             Spec object.
         """
-        return build_spec(self.ENTITY_SPEC_CLASS, self.ENTITY_SPEC_VALIDATOR, validate=validate, **kwargs)
+        return build_spec(
+            self.ENTITY_SPEC_CLASS,
+            self.ENTITY_SPEC_VALIDATOR,
+            validate=validate,
+            **kwargs,
+        )
 
     def build_status(self, **kwargs) -> Status:
         """

digitalhub/entities/_base/entity/entity.py

@@ -1,10 +1,9 @@
 from __future__ import annotations
 
 import typing
-from abc import ABCMeta, abstractmethod
+from abc import abstractmethod
 
 from digitalhub.entities._base._base.entity import Base
-from digitalhub.factory.api import build_entity_from_dict
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -12,7 +11,7 @@ if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.status import Status
 
 
-class Entity(Base, metaclass=ABCMeta):
+class Entity(Base):
     """
     Abstract class for entities.
 
@@ -56,7 +55,7 @@ class Entity(Base, metaclass=ABCMeta):
         Abstract refresh method.
         """
 
-    def _update_attributes(self, obj: dict) -> None:
+    def _update_attributes(self, obj: Entity) -> None:
         """
         Update attributes.
 
@@ -69,18 +68,41 @@ class Entity(Base, metaclass=ABCMeta):
         -------
         None
         """
-        new_obj = build_entity_from_dict(obj)
-        self.metadata = new_obj.metadata
-        self.spec = new_obj.spec
-        self.status = new_obj.status
-        self.user = new_obj.user
+        self.metadata = obj.metadata
+        self.spec = obj.spec
+        self.status = obj.status
+        self.user = obj.user
 
     @abstractmethod
-    def export(self, filename: str | None = None) -> str:
+    def export(self) -> str:
         """
         Abstract export method.
         """
 
+    def add_relationship(self, relation: str, dest: str, source: str | None = None) -> None:
+        """
+        Add relationship to entity metadata.
+
+        Parameters
+        ----------
+        relation : str
+            The type of relationship.
+        dest : str
+            The target entity.
+        source : str
+            The source entity.
+
+        Returns
+        -------
+        None
+        """
+        if self.metadata.relationships is None:
+            self.metadata.relationships = []
+        obj = {"type": relation, "dest": dest}
+        if source is not None:
+            obj["source"] = source
+        self.metadata.relationships.append(obj)
+
     def to_dict(self) -> dict:
         """
         Override default to_dict method to add the possibility to exclude

digitalhub/entities/_base/entity/metadata.py

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
+from pydantic import BaseModel, ConfigDict, Field
+
 from digitalhub.entities._base._base.entity import Base
+from digitalhub.entities._commons.enums import Relationship
 
 
 class Metadata(Base):
@@ -24,6 +27,7 @@ class Metadata(Base):
         updated: str | None = None,
         updated_by: str | None = None,
         embedded: bool | None = None,
+        relationships: list[dict] | None = None,
         ref: str | None = None,
         **kwargs,
     ) -> None:
@@ -37,6 +41,7 @@ class Metadata(Base):
         self.created_by = created_by
         self.updated_by = updated_by
         self.embedded = embedded
+        self.relationships = relationships
         self.ref = ref
 
         self._any_setter(**kwargs)
@@ -57,3 +62,20 @@ class Metadata(Base):
             An entity metadata object.
         """
         return cls(**obj)
+
+
+class RelationshipValidator(BaseModel):
+    """
+    A class representing the relationship of an entity.
+    """
+
+    model_config = ConfigDict(use_enum_values=True)
+
+    type_: Relationship = Field(default=None, alias="type")
+    """The type of relationship."""
+
+    source: str = None
+    """The source entity."""
+
+    dest: str = None
+    """The target entity."""

digitalhub/entities/_base/entity/spec.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 from digitalhub.entities._base._base.entity import Base
 
@@ -30,7 +30,7 @@ class Spec(Base):
         return cls(**obj)
 
 
-class SpecValidator(BaseModel, extra="ignore"):
+class SpecValidator(BaseModel):
     """
     A class representing the parameters of an entity.
     This base class is used to define the parameters of an entity
@@ -38,6 +38,11 @@ class SpecValidator(BaseModel, extra="ignore"):
     to the constructor.
     """
 
+    model_config = ConfigDict(extra="ignore", use_enum_values=True)
+
+    def to_dict(self) -> dict:
+        return self.model_dump(by_alias=True, exclude_none=True)
+
 
 class MaterialSpec(Spec):
     """

digitalhub/entities/_base/executable/entity.py

@@ -2,11 +2,11 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._base.api_utils import list_entity_api_ctx
 from digitalhub.entities._base.versioned.entity import VersionedEntity
+from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._operations.processor import processor
 from digitalhub.entities.run.crud import delete_run, get_run, list_runs
 from digitalhub.entities.task.crud import delete_task
-from digitalhub.entities.utils.entity_types import EntityTypes
 from digitalhub.factory.api import build_entity_from_dict, build_entity_from_params
 from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError
 
@@ -141,7 +141,7 @@ class ExecutableEntity(VersionedEntity):
 
         # Override kwargs
         kwargs["project"] = self.project
-        kwargs["function"] = self._get_executable_string()
+        kwargs[self.ENTITY_TYPE] = self._get_executable_string()
         kwargs["kind"] = task_kind
 
         # Create object instance
@@ -176,7 +176,7 @@ class ExecutableEntity(VersionedEntity):
             resp = self._get_task_from_backend(kind)
             if not resp:
                 raise EntityError(f"Task {kind} is not created")
-            self._tasks[kind] = build_entity_from_dict(resp[0])
+            self._tasks[kind] = resp[0]
             return self._tasks[kind]
 
     def update_task(self, kind: str, **kwargs) -> Task:
@@ -203,7 +203,7 @@ class ExecutableEntity(VersionedEntity):
         # Update kwargs
         kwargs["project"] = self.project
         kwargs["kind"] = kind
-        kwargs["function"] = self._get_executable_string()
+        kwargs[self.ENTITY_TYPE] = self._get_executable_string()
         kwargs["uuid"] = self._tasks[kind].id
 
         # Update task
@@ -246,8 +246,8 @@ class ExecutableEntity(VersionedEntity):
         list
             Response from backend.
         """
-        params = {"function": self._get_executable_string(), "kind": kind}
-        return list_entity_api_ctx(self.project, EntityTypes.TASK.value, params=params)
+        params = {self.ENTITY_TYPE: self._get_executable_string(), "kind": kind}
+        return processor.list_context_entities(self.project, EntityTypes.TASK.value, params=params)
 
     def _check_task_in_backend(self, kind: str) -> bool:
         """
@@ -370,7 +370,7 @@ class ExecutableEntity(VersionedEntity):
         """
         if kwargs is None:
             kwargs = {}
-        kwargs["params"] = {"function": self._get_executable_string()}
+        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
         return list_runs(self.project, **kwargs)
 
     def delete_run(

digitalhub/entities/_base/material/entity.py

@@ -3,8 +3,8 @@ from __future__ import annotations
 import typing
 from pathlib import Path
 
-from digitalhub.entities._base.api_utils import files_info_get_api, files_info_put_api
 from digitalhub.entities._base.versioned.entity import VersionedEntity
+from digitalhub.entities._operations.processor import processor
 from digitalhub.stores.api import get_store
 
 if typing.TYPE_CHECKING:
@@ -48,23 +48,20 @@ class MaterialEntity(VersionedEntity):
         MaterialEntity
             Entity saved.
         """
-        obj = self.to_dict()
-
+        # Evaluate files info list length
         files = None
         if self.status.files is not None and len(self.status.files) > 5 and not self._context().local:
-            files = obj["status"].pop("files")
+            files = self.status.files
+            self.status.files = []
 
-        if not update:
-            new_obj: MaterialEntity = self._save(obj)
-        else:
-            new_obj: MaterialEntity = self._update(obj)
+        obj: MaterialEntity = super().save(update)
 
         # Handle files info
         if files is not None:
-            files_info_put_api(self.project, self.ENTITY_TYPE, self.id, files)
-            self.status.add_files_info(files)
+            processor.update_files_info(self.project, self.ENTITY_TYPE, self.id, files)
+            self.add_files_info(files)
 
-        return new_obj
+        return obj
 
     ##############################
     # I/O Methods
@@ -81,7 +78,7 @@ class MaterialEntity(VersionedEntity):
             List of file paths.
         """
         store = get_store(self.spec.path)
-        paths = self.status.get_file_paths()
+        paths = self.get_file_paths()
         dst = store._build_temp()
         return store.download(self.spec.path, dst=dst, src=paths)
 
@@ -130,7 +127,7 @@ class MaterialEntity(VersionedEntity):
         dataitem/data.csv
         """
         store = get_store(self.spec.path)
-        paths = self.status.get_file_paths()
+        paths = self.get_file_paths()
 
         if destination is None:
             dst = self._context().root / self.ENTITY_TYPE
@@ -171,9 +168,44 @@ class MaterialEntity(VersionedEntity):
         paths = store.upload(source, self.spec.path)
 
         # Update files info
-        files_info = store.get_file_info(paths)
+        files_info = store.get_file_info(self.spec.path, paths)
         self._update_files_info(files_info)
 
+    ##############################
+    #  Public Helpers
+    ##############################
+
+    def add_files_info(self, files: list[dict]) -> None:
+        """
+        Add a file to the status.
+
+        Parameters
+        ----------
+        files : list[dict]
+            Files to add.
+
+        Returns
+        -------
+        None
+        """
+        path_list = self.get_file_paths()
+        for f in files:
+            if f.get("path") not in path_list:
+                self.status.files.append(f)
+
+    def get_file_paths(self) -> list[str]:
+        """
+        Get the paths of the files in the status.
+
+        Returns
+        -------
+        list[str]
+            Paths of the files in the status.
+        """
+        if self.status.files is None:
+            self.status.files = []
+        return [f.get("path") for f in self.status.files]
+
     ##############################
     #  Private Helpers
     ##############################
@@ -194,7 +226,7 @@ class MaterialEntity(VersionedEntity):
         if files_info is None:
             return
         self.refresh()
-        self.status.add_files_info(files_info)
+        self.add_files_info(files_info)
         self.save(update=True)
 
     def _get_files_info(self) -> None:
@@ -206,9 +238,9 @@ class MaterialEntity(VersionedEntity):
         None
         """
         if not self._context().local and not self.status.files:
-            files = files_info_get_api(
+            files = processor.read_files_info(
                 project=self.project,
                 entity_type=self.ENTITY_TYPE,
                 entity_id=self.id,
             )
-            self.status.add_files_info(files)
+            self.add_files_info(files)

digitalhub/entities/_base/material/status.py

@@ -15,35 +15,4 @@ class MaterialStatus(Status):
         files: list[dict] | None = None,
     ) -> None:
         super().__init__(state, message)
-        if files is None:
-            files = []
         self.files = files
-
-    def add_files_info(self, files: list[dict]) -> None:
-        """
-        Add a file to the status.
-
-        Parameters
-        ----------
-        files : list[dict]
-            Files to add.
-
-        Returns
-        -------
-        None
-        """
-        path_list = self.get_file_paths()
-        for f in files:
-            if f.get("path") not in path_list:
-                self.files.append(f)
-
-    def get_file_paths(self) -> list[str]:
-        """
-        Get the paths of the files in the status.
-
-        Returns
-        -------
-        list[str]
-            Paths of the files in the status.
-        """
-        return [f.get("path") for f in self.files]

digitalhub/entities/_base/material/utils.py

@@ -0,0 +1,106 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from digitalhub.utils.file_utils import eval_zip_type
+from digitalhub.utils.s3_utils import get_s3_bucket
+from digitalhub.utils.uri_utils import S3Schemes, has_local_scheme
+
+
+def eval_local_source(source: str | list[str]) -> None:
+    """
+    Evaluate if source is local.
+
+    Parameters
+    ----------
+    source : str | list[str]
+        Source(s).
+
+    Returns
+    -------
+    None
+    """
+    if isinstance(source, list):
+        if not source:
+            raise ValueError("Empty list of sources.")
+        source_is_local = all(has_local_scheme(s) for s in source)
+        for s in source:
+            if Path(s).is_dir():
+                raise ValueError(f"Invalid source path: {s}. List of paths must be list of files, not directories.")
+    else:
+        source_is_local = has_local_scheme(source)
+
+    if not source_is_local:
+        raise ValueError("Invalid source path. Source must be a local path.")
+
+
+def eval_zip_sources(source: str | list[str]) -> str:
+    """
+    Evaluate zip sources.
+
+    Parameters
+    ----------
+    source : str | list[str]
+        Source(s).
+
+    Returns
+    -------
+    str
+        S3Schemes.
+    """
+    if isinstance(source, list):
+        if len(source) > 1:
+            return S3Schemes.S3.value
+        path = source[0]
+    else:
+        if Path(source).is_dir():
+            return S3Schemes.S3.value
+        path = source
+
+    if not eval_zip_type(path):
+        return S3Schemes.S3.value
+    return S3Schemes.ZIP_S3.value
+
+
+def build_log_path_from_source(
+    project: str,
+    entity_type: str,
+    name: str,
+    uuid: str,
+    source: str | list[str],
+) -> str:
+    """
+    Build log path.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    name : str
+        Object name.
+    uuid : str
+        Object UUID.
+    source : str | list[str]
+        Source(s).
+
+    Returns
+    -------
+    str
+        Log path.
+    """
+    scheme = eval_zip_sources(source)
+    path = f"{scheme}://{get_s3_bucket()}/{project}/{entity_type}/{name}/{uuid}"
+
+    if isinstance(source, list) and len(source) >= 1:
+        if len(source) > 1:
+            path += "/"
+        else:
+            path += f"/{Path(source[0]).name}"
+    elif Path(source).is_dir():
+        path += "/"
+    elif Path(source).is_file():
+        path += f"/{Path(source).name}"
+
+    return path