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

digitalhub/client/local/api_builder.py

@@ -0,0 +1,100 @@
+from __future__ import annotations
+
+from digitalhub.client._base.api_builder import ClientApiBuilder
+from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
+from digitalhub.utils.exceptions import BackendError
+
+API_BASE = "/api/v1"
+API_CONTEXT = f"{API_BASE}/-"
+
+
+class ClientLocalApiBuilder(ClientApiBuilder):
+    """
+    This class is used to build the API for the Local client.
+    """
+
+    def build_api(self, category: str, operation: str, **kwargs) -> str:
+        """
+        Build the API for the client.
+
+        Parameters
+        ----------
+        category : str
+            API category.
+        operation : str
+            API operation.
+        **kwargs : dict
+            Additional parameters.
+
+        Returns
+        -------
+        str
+            API formatted.
+        """
+        if category == ApiCategories.BASE.value:
+            return self.build_api_base(operation, **kwargs)
+        return self.build_api_context(operation, **kwargs)
+
+    def build_api_base(self, operation: str, **kwargs) -> str:
+        """
+        Build the base API for the client.
+
+        Parameters
+        ----------
+        operation : str
+            API operation.
+        **kwargs : dict
+            Additional parameters.
+
+        Returns
+        -------
+        str
+            API formatted.
+        """
+        entity_type = kwargs["entity_type"] + "s"
+        if operation in (
+            BackendOperations.CREATE.value,
+            BackendOperations.LIST.value,
+        ):
+            return f"{API_BASE}/{entity_type}"
+        elif operation in (
+            BackendOperations.READ.value,
+            BackendOperations.UPDATE.value,
+            BackendOperations.DELETE.value,
+        ):
+            return f"{API_BASE}/{entity_type}/{kwargs['entity_name']}"
+        elif operation == BackendOperations.SHARE.value:
+            raise BackendError("Share API not implemented for Local.")
+        raise BackendError(f"Invalid operation '{operation}' for entity type '{entity_type}' in Local.")
+
+    def build_api_context(self, operation: str, **kwargs) -> str:
+        """
+        Build the context API for the client.
+        """
+        entity_type = kwargs["entity_type"] + "s"
+        project = kwargs["project"]
+        if operation in (
+            BackendOperations.CREATE.value,
+            BackendOperations.LIST.value,
+        ):
+            return f"{API_CONTEXT}/{project}/{entity_type}"
+        elif operation in (
+            BackendOperations.READ.value,
+            BackendOperations.UPDATE.value,
+            BackendOperations.DELETE.value,
+        ):
+            return f"{API_CONTEXT}/{project}/{entity_type}/{kwargs['entity_id']}"
+        elif operation == BackendOperations.LOGS.value:
+            raise BackendError("Logs run API not implemented for Local.")
+        elif operation == BackendOperations.STOP.value:
+            raise BackendError("Stop run API not implemented for Local.")
+        elif operation == BackendOperations.RESUME.value:
+            raise BackendError("Resume run API not implemented for Local.")
+        elif operation == BackendOperations.DATA.value:
+            raise BackendError("Secret API (read/set value) not implemented for Local.")
+        elif operation == BackendOperations.FILES.value:
+            raise BackendError("Files API not implemented for Local.")
+        elif operation == BackendOperations.SEARCH.value:
+            raise BackendError("Search API not implemented for Local.")
+
+        raise BackendError(f"Invalid operation '{operation}' for entity type '{entity_type}' in Local.")

digitalhub/client/local/client.py

@@ -4,6 +4,7 @@ from copy import deepcopy
 from datetime import datetime, timezone
 
 from digitalhub.client._base.client import Client
+from digitalhub.client.local.api_builder import ClientLocalApiBuilder
 from digitalhub.utils.exceptions import BackendError
 
 
@@ -22,6 +23,7 @@ class ClientLocal(Client):
 
     def __init__(self) -> None:
         super().__init__()
+        self._api_builder = ClientLocalApiBuilder()
         self._db: dict[str, dict[str, dict]] = {}
 
     ##############################
@@ -349,6 +351,24 @@ class ClientLocal(Client):
         except IndexError:
             raise IndexError("No objects found")
 
+    def search_objects(self, api: str, **kwargs) -> dict:
+        """
+        Search objects from Local.
+
+        Parameters
+        ----------
+        api : str
+            Search API.
+        **kwargs : dict
+            Keyword arguments to pass to the request.
+
+        Returns
+        -------
+        dict
+            Response objects.
+        """
+        raise NotImplementedError("Local client does not support search_objects.")
+
     ##############################
     # Helpers
     ##############################

digitalhub/context/api.py

@@ -3,45 +3,26 @@ from __future__ import annotations
 import typing
 
 from digitalhub.context.builder import context_builder
-from digitalhub.utils.exceptions import ContextError
 
 if typing.TYPE_CHECKING:
     from digitalhub.context.context import Context
     from digitalhub.entities.project._base.entity import Project
 
 
-def check_context(project: str) -> None:
-    """
-    Check if the given project is in the context.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-
-    Returns
-    -------
-    bool
-        True if the project is in the context, False otherwise.
-    """
-    if project not in context_builder._instances:
-        raise ContextError
-
-
-def set_context(project: Project) -> None:
+def build_context(project: Project, overwrite: bool = False) -> None:
     """
     Wrapper for ContextBuilder.build().
 
     Parameters
     ----------
     project : Project
-        The project object used to set the current context.
+        The project object used to build the context.
 
     Returns
     -------
     None
     """
-    context_builder.build(project)
+    context_builder.build(project, overwrite)
 
 
 def get_context(project: str) -> Context:
@@ -61,22 +42,6 @@ def get_context(project: str) -> Context:
     return context_builder.get(project)
 
 
-def set_context_object(context: Context) -> None:
-    """
-    Wrapper for ContextBuilder.set().
-
-    Parameters
-    ----------
-    context : Context
-        The context to set.
-
-    Returns
-    -------
-    None
-    """
-    context_builder.set(context)
-
-
 def delete_context(project: str) -> None:
     """
     Wrapper for ContextBuilder.remove().

digitalhub/context/builder.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.context.context import Context
+from digitalhub.utils.exceptions import ContextError
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.project._base.entity import Project
@@ -19,7 +20,7 @@ class ContextBuilder:
     def __init__(self) -> None:
         self._instances: dict[str, Context] = {}
 
-    def build(self, project_object: Project) -> None:
+    def build(self, project_object: Project, overwrite: bool = False) -> None:
         """
         Add a project as context.
 
@@ -27,12 +28,15 @@ class ContextBuilder:
         ----------
         project_object : Project
             The project to add.
+        overwrite : bool
+            If True, the project will be overwritten if it already exists.
 
         Returns
         -------
         None
         """
-        self._instances[project_object.name] = Context(project_object)
+        if (project_object.name not in self._instances) or overwrite:
+            self._instances[project_object.name] = Context(project_object)
 
     def get(self, project: str) -> Context:
         """
@@ -53,12 +57,10 @@ class ContextBuilder:
         ValueError
             If the project is not in the context.
         """
-        ctx = self._instances.get(project)
-        if ctx is None:
-            raise ValueError(
-                f"Context '{project}' not found. Please get or create a project named '{project}' to access its objects."
-            )
-        return ctx
+        try:
+            return self._instances[project]
+        except KeyError:
+            raise ContextError(f"Context '{project}' not found. Get or create a project named '{project}'.")
 
     def remove(self, project: str) -> None:
         """
@@ -75,20 +77,5 @@ class ContextBuilder:
         """
         self._instances.pop(project, None)
 
-    def set(self, context: Context) -> None:
-        """
-        Set the context.
-
-        Parameters
-        ----------
-        context : Context
-            The context to set.
-
-        Returns
-        -------
-        None
-        """
-        self._instances[context.name] = context
-
 
 context_builder = ContextBuilder()

digitalhub/context/context.py

@@ -13,8 +13,6 @@ class Context:
     some information about the project, such as the project name,
     a client instance (local or non-local), the local context
     project path and information about client locality.
-    It exposes CRUD operations for the entities and act as a layer
-    between the project object and its client.
     """
 
     def __init__(self, project: Project) -> None:
@@ -22,115 +20,45 @@ class Context:
         self.client = project._client
         self.local = project._client.is_local()
         self.root = Path(project.spec.context)
+        self.root.mkdir(parents=True, exist_ok=True)
 
-    def create_object(self, api: str, obj: dict, **kwargs) -> dict:
-        """
-        Create an object.
-
-        Parameters
-        ----------
-        api : str
-            Create API.
-        obj : dict
-            Object to create.
-        **kwargs : dict
-            Keyword arguments passed to the request.
-
-        Returns
-        -------
-        dict
-            Response object.
-        """
-        return self.client.create_object(api, obj, **kwargs)
-
-    def read_object(self, api: str, **kwargs) -> dict:
-        """
-        Read an object.
-
-        Parameters
-        ----------
-        api : str
-            Read API.
-        **kwargs : dict
-            Keyword arguments passed to the request.
-
-        Returns
-        -------
-        dict
-            Response object.
-        """
-        return self.client.read_object(api, **kwargs)
-
-    def update_object(self, api: str, obj: dict, **kwargs) -> dict:
-        """
-        Update an object.
-
-        Parameters
-        ----------
-        api : str
-            Update API.
-        obj : dict
-            Object to update.
-        **kwargs : dict
-            Keyword arguments passed to the request.
-
-        Returns
-        -------
-        dict
-            Response object.
-        """
-        return self.client.update_object(api, obj, **kwargs)
+        self.is_running: bool = False
+        self._run_ctx: str = None
 
-    def delete_object(self, api: str, **kwargs) -> dict:
+    def set_run(self, run_ctx: str) -> None:
         """
-        Delete an object.
+        Set run identifier.
 
         Parameters
         ----------
-        api : str
-            Delete API.
-        **kwargs : dict
-            Keyword arguments passed to the request.
+        run_ctx : str
+            Run key.
 
         Returns
         -------
-        dict
-            Response object.
+        None
         """
-        return self.client.delete_object(api, **kwargs)
+        self.is_running = True
+        self._run_ctx = run_ctx
 
-    def list_objects(self, api: str, **kwargs) -> dict:
+    def unset_run(self) -> None:
         """
-        List objects.
-
-        Parameters
-        ----------
-        api : str
-            The api to list the objects with.
-        **kwargs : dict
-            Keyword arguments passed to the request.
+        Unset run identifier.
 
         Returns
         -------
-        dict
-            The list of objects.
+        None
         """
-        return self.client.list_objects(api, **kwargs)
+        self.is_running = False
+        self._run_ctx = None
 
-    def list_first_object(self, api: str, **kwargs) -> dict:
+    def get_run_ctx(self) -> str:
         """
-        List first objects.
-
-        Parameters
-        ----------
-        api : str
-            The api to list the objects with.
-        **kwargs : dict
-            Keyword arguments passed to the request.
+        Get run identifier.
 
         Returns
         -------
-        dict
-            The list of objects.
+        str
+            Run key.
         """
-        return self.client.list_first_object(api, **kwargs)
+        return self._run_ctx

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,39 @@ 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, source: str, dest: str) -> None:
+        """
+        Add relationship to entity metadata.
+
+        Parameters
+        ----------
+        relation : str
+            The type of relationship.
+        source : str
+            The source entity.
+        dest : str
+            The target entity..
+
+        Returns
+        -------
+        None
+        """
+        if self.metadata.relationships is None:
+            self.metadata.relationships = []
+        obj = {"type": relation, "source": source, "dest": dest}
+        self.metadata.relationships.append(obj)
+
     def to_dict(self) -> dict:
         """
         Override default to_dict method to add the possibility to exclude