digitalhub 0.8.0b3__tar.gz → 0.8.0b5__tar.gz

{digitalhub-0.8.0b3 → digitalhub-0.8.0b5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: digitalhub
-Version: 0.8.0b3
+Version: 0.8.0b5
 Summary: Python SDK for Digitalhub
 Author-email: Fondazione Bruno Kessler <dslab@fbk.eu>, Matteo Martini <mmartini@fbk.eu>
 License:                               Apache License

{digitalhub-0.8.0b3 → digitalhub-0.8.0b5}/digitalhub/__init__.py

@@ -73,9 +73,10 @@ except ImportError:
     ...
 
 from digitalhub.client.dhcore.utils import refresh_token, set_dhcore_env
-from digitalhub.registry.utils import register_entities, register_runtimes_entities
-from digitalhub.stores.builder import set_store
 
 # Register entities into registry
+from digitalhub.factory.utils import register_entities, register_runtimes_entities
+from digitalhub.stores.builder import set_store
+
 register_entities()
 register_runtimes_entities()

{digitalhub-0.8.0b3 → digitalhub-0.8.0b5}/digitalhub/client/dhcore/client.py

@@ -579,11 +579,16 @@ class ClientDHCore(Client):
         dict
             Response object.
         """
+        # Get refersh token from .core file to avoid concurrency
+        # in a shared workspace
+        self._load_env()
+        refresh_token = os.getenv("DHCORE_REFRESH_TOKEN")
+
         # Send request to get new access token
         payload = {
             "grant_type": "refresh_token",
             "client_id": self._client_id,
-            "refresh_token": self._refresh_token,
+            "refresh_token": refresh_token,
         }
         headers = {"Content-Type": "application/x-www-form-urlencoded"}
         r = request("POST", url, data=payload, headers=headers, timeout=60)

{digitalhub-0.8.0b3 → digitalhub-0.8.0b5}/digitalhub/context/builder.py

@@ -5,7 +5,7 @@ import typing
 from digitalhub.context.context import Context
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.project.project.entity import Project
+    from digitalhub.entities.project._base.entity import Project
 
 
 class ContextBuilder:

{digitalhub-0.8.0b3 → digitalhub-0.8.0b5}/digitalhub/context/context.py

@@ -4,7 +4,7 @@ import typing
 from pathlib import Path
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.project.project.entity import Project
+    from digitalhub.entities.project._base.entity import Project
 
 
 class Context:

{digitalhub-0.8.0b3 → digitalhub-0.8.0b5}/digitalhub/entities/_base/entity/entity.py

@@ -4,6 +4,7 @@ import typing
 from abc import ABCMeta, abstractmethod
 
 from digitalhub.entities._base._base.entity import Base
+from digitalhub.factory.factory import factory
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -68,7 +69,7 @@ class Entity(Base, metaclass=ABCMeta):
         -------
         None
         """
-        new_obj = self.from_dict(obj)
+        new_obj = factory.build_entity_from_dict(self.kind, obj)
         self.metadata = new_obj.metadata
         self.spec = new_obj.spec
         self.status = new_obj.status
@@ -93,33 +94,6 @@ class Entity(Base, metaclass=ABCMeta):
         """
         return {k: v for k, v in super().to_dict().items() if k in self._obj_attr}
 
-    @classmethod
-    def from_dict(cls, obj: dict, validate: bool = True) -> Entity:
-        """
-        Create a new object from dictionary.
-
-        Parameters
-        ----------
-        obj : dict
-            Dictionary to create object from.
-        validate : bool
-            Flag to indicate if arguments validation against a pydantic schema must be ignored.
-
-        Returns
-        -------
-        Self
-            Self instance.
-        """
-        parsed_dict = cls._parse_dict(obj, validate=validate)
-        return cls(**parsed_dict)
-
-    @staticmethod
-    @abstractmethod
-    def _parse_dict(obj: dict, validate: bool = True) -> dict:
-        """
-        Abstract method to parse dictionary.
-        """
-
     def __repr__(self) -> str:
         """
         Return string representation of the entity object.

digitalhub-0.8.0b5/digitalhub/entities/_base/unversioned/builder.py

@@ -0,0 +1,66 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._builders.entity import EntityBuilder
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.unversioned.entity import UnversionedEntity
+
+
+class UnversionedBuilder(EntityBuilder):
+    """
+    Unversioned builder.
+    """
+
+    def from_dict(self, obj: dict, validate: bool = True) -> UnversionedEntity:
+        """
+        Create a new object from dictionary.
+
+        Parameters
+        ----------
+        obj : dict
+            Dictionary to create object from.
+        validate : bool
+            Flag to indicate if arguments must be validated.
+
+        Returns
+        -------
+        UnversionedEntity
+            Object instance.
+        """
+        parsed_dict = self._parse_dict(obj, validate=validate)
+        return self.build_entity(**parsed_dict)
+
+    def _parse_dict(self, obj: dict, validate: bool = True) -> dict:
+        """
+        Get dictionary and parse it to a valid entity dictionary.
+
+        Parameters
+        ----------
+        entity : str
+            Entity type.
+        obj : dict
+            Dictionary to parse.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the attributes of the entity instance.
+        """
+        project = obj.get("project")
+        kind = obj.get("kind")
+        uuid = self.build_uuid(obj.get("id"))
+        metadata = self.build_metadata(**obj.get("metadata", {}))
+        spec = self.build_spec(validate=validate, **obj.get("spec", {}))
+        status = self.build_status(**obj.get("status", {}))
+        user = obj.get("user")
+        return {
+            "project": project,
+            "uuid": uuid,
+            "kind": kind,
+            "metadata": metadata,
+            "spec": spec,
+            "status": status,
+            "user": user,
+        }

{digitalhub-0.8.0b3 → digitalhub-0.8.0b5}/digitalhub/entities/_base/unversioned/entity.py

@@ -3,10 +3,6 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
-from digitalhub.entities._builders.metadata import build_metadata
-from digitalhub.entities._builders.spec import build_spec
-from digitalhub.entities._builders.status import build_status
-from digitalhub.entities._builders.uuid import build_uuid
 from digitalhub.utils.io_utils import write_yaml
 
 if typing.TYPE_CHECKING:
@@ -51,37 +47,3 @@ class UnversionedEntity(ContextEntity):
         pth = self._context().root / filename
         write_yaml(pth, obj)
         return str(pth)
-
-    @staticmethod
-    def _parse_dict(obj: dict, validate: bool = True) -> dict:
-        """
-        Get dictionary and parse it to a valid entity dictionary.
-
-        Parameters
-        ----------
-        entity : str
-            Entity type.
-        obj : dict
-            Dictionary to parse.
-
-        Returns
-        -------
-        dict
-            A dictionary containing the attributes of the entity instance.
-        """
-        project = obj.get("project")
-        kind = obj.get("kind")
-        uuid = build_uuid(obj.get("id"))
-        metadata = build_metadata(kind, **obj.get("metadata", {}))
-        spec = build_spec(kind, validate=validate, **obj.get("spec", {}))
-        status = build_status(kind, **obj.get("status", {}))
-        user = obj.get("user")
-        return {
-            "project": project,
-            "uuid": uuid,
-            "kind": kind,
-            "metadata": metadata,
-            "spec": spec,
-            "status": status,
-            "user": user,
-        }

digitalhub-0.8.0b5/digitalhub/entities/_base/versioned/builder.py

@@ -0,0 +1,68 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._builders.entity import EntityBuilder
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.versioned.entity import VersionedEntity
+
+
+class VersionedBuilder(EntityBuilder):
+    """
+    Versioned builder.
+    """
+
+    def from_dict(self, obj: dict, validate: bool = True) -> VersionedEntity:
+        """
+        Create a new object from dictionary.
+
+        Parameters
+        ----------
+        obj : dict
+            Dictionary to create object from.
+        validate : bool
+            Flag to indicate if arguments must be validated.
+
+        Returns
+        -------
+        VersionedEntity
+            Object instance.
+        """
+        parsed_dict = self._parse_dict(obj, validate=validate)
+        return self.build_entity(**parsed_dict)
+
+    def _parse_dict(self, obj: dict, validate: bool = True) -> dict:
+        """
+        Get dictionary and parse it to a valid entity dictionary.
+
+        Parameters
+        ----------
+        entity : str
+            Entity type.
+        obj : dict
+            Dictionary to parse.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the attributes of the entity instance.
+        """
+        project = obj.get("project")
+        kind = obj.get("kind")
+        name = self.build_name(obj.get("name"))
+        uuid = self.build_uuid(obj.get("id"))
+        metadata = self.build_metadata(**obj.get("metadata", {}))
+        spec = self.build_spec(validate=validate, **obj.get("spec", {}))
+        status = self.build_status(**obj.get("status", {}))
+        user = obj.get("user")
+        return {
+            "project": project,
+            "name": name,
+            "uuid": uuid,
+            "kind": kind,
+            "metadata": metadata,
+            "spec": spec,
+            "status": status,
+            "user": user,
+        }

{digitalhub-0.8.0b3 → digitalhub-0.8.0b5}/digitalhub/entities/_base/versioned/entity.py

@@ -3,11 +3,6 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
-from digitalhub.entities._builders.metadata import build_metadata
-from digitalhub.entities._builders.name import build_name
-from digitalhub.entities._builders.spec import build_spec
-from digitalhub.entities._builders.status import build_status
-from digitalhub.entities._builders.uuid import build_uuid
 from digitalhub.utils.io_utils import write_yaml
 
 if typing.TYPE_CHECKING:
@@ -56,39 +51,3 @@ class VersionedEntity(ContextEntity):
         pth = self._context().root / filename
         write_yaml(pth, obj)
         return str(pth)
-
-    @staticmethod
-    def _parse_dict(obj: dict, validate: bool = True) -> dict:
-        """
-        Get dictionary and parse it to a valid entity dictionary.
-
-        Parameters
-        ----------
-        entity : str
-            Entity type.
-        obj : dict
-            Dictionary to parse.
-
-        Returns
-        -------
-        dict
-            A dictionary containing the attributes of the entity instance.
-        """
-        project = obj.get("project")
-        kind = obj.get("kind")
-        name = build_name(obj.get("name"))
-        uuid = build_uuid(obj.get("id"))
-        metadata = build_metadata(kind, **obj.get("metadata", {}))
-        spec = build_spec(kind, validate=validate, **obj.get("spec", {}))
-        status = build_status(kind, **obj.get("status", {}))
-        user = obj.get("user")
-        return {
-            "project": project,
-            "name": name,
-            "uuid": uuid,
-            "kind": kind,
-            "metadata": metadata,
-            "spec": spec,
-            "status": status,
-            "user": user,
-        }

{digitalhub-0.8.0b3 → digitalhub-0.8.0b5}/digitalhub/entities/_builders/entity.py

@@ -1,13 +1,14 @@
 from __future__ import annotations
 
 import typing
-from abc import ABCMeta, abstractmethod
+from abc import abstractmethod
 
 from digitalhub.entities._builders.metadata import build_metadata
 from digitalhub.entities._builders.name import build_name
 from digitalhub.entities._builders.spec import build_spec
 from digitalhub.entities._builders.status import build_status
 from digitalhub.entities._builders.uuid import build_uuid
+from digitalhub.utils.exceptions import BuilderError
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.entity import Entity
@@ -16,26 +17,32 @@ if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.status import Status
 
 
-class EntityBuilder(metaclass=ABCMeta):
+class EntityBuilder:
     """
     Builder class for building entities.
     """
 
     # Class variables
+    ENTITY_TYPE: str = None
     ENTITY_CLASS: Entity = None
     ENTITY_SPEC_CLASS: Spec = None
     ENTITY_SPEC_VALIDATOR: SpecValidator = None
     ENTITY_STATUS_CLASS: Status = None
+    ENTITY_KIND: str = None
 
     def __init__(self) -> None:
+        if self.ENTITY_TYPE is None:
+            raise BuilderError("ENTITY_TYPE must be set")
         if self.ENTITY_CLASS is None:
-            raise ValueError("ENTITY_CLASS must be set")
+            raise BuilderError("ENTITY_CLASS must be set")
         if self.ENTITY_SPEC_CLASS is None:
-            raise ValueError("ENTITY_SPEC_CLASS must be set")
+            raise BuilderError("ENTITY_SPEC_CLASS must be set")
         if self.ENTITY_SPEC_VALIDATOR is None:
-            raise ValueError("ENTITY_SPEC_VALIDATOR must be set")
+            raise BuilderError("ENTITY_SPEC_VALIDATOR must be set")
         if self.ENTITY_STATUS_CLASS is None:
-            raise ValueError("ENTITY_STATUS_CLASS must be set")
+            raise BuilderError("ENTITY_STATUS_CLASS must be set")
+        if self.ENTITY_KIND is None:
+            raise BuilderError("ENTITY_KIND must be set")
 
     def build_name(self, name: str) -> str:
         """
@@ -69,14 +76,12 @@ class EntityBuilder(metaclass=ABCMeta):
         """
         return build_uuid(uuid)
 
-    def build_metadata(self, kind: str, **kwargs) -> Metadata:
+    def build_metadata(self, **kwargs) -> Metadata:
         """
         Build entity metadata object.
 
         Parameters
         ----------
-        kind : str
-            Registry entry kind.
         **kwargs : dict
             Keyword arguments for the constructor.
 
@@ -85,16 +90,14 @@ class EntityBuilder(metaclass=ABCMeta):
         Metadata
             Metadata object.
         """
-        return build_metadata(kind, **kwargs)
+        return build_metadata(**kwargs)
 
-    def build_spec(self, kind: str, **kwargs) -> Spec:
+    def build_spec(self, validate: bool = True, **kwargs) -> Spec:
         """
         Build entity spec object.
 
         Parameters
         ----------
-        kind : str
-            Registry entry kind.
         **kwargs : dict
             Keyword arguments for the constructor.
 
@@ -103,16 +106,14 @@ class EntityBuilder(metaclass=ABCMeta):
         Spec
             Spec object.
         """
-        return build_spec(kind, **kwargs)
+        return build_spec(self.ENTITY_SPEC_CLASS, self.ENTITY_SPEC_VALIDATOR, validate=validate, **kwargs)
 
-    def build_status(self, kind: str, **kwargs) -> Status:
+    def build_status(self, **kwargs) -> Status:
         """
         Build entity status object.
 
         Parameters
         ----------
-        kind : str
-            Registry entry kind.
         **kwargs : dict
             Keyword arguments for the constructor.
 
@@ -121,28 +122,32 @@ class EntityBuilder(metaclass=ABCMeta):
         Status
             Status object.
         """
-        return build_status(kind, **kwargs)
+        return build_status(self.ENTITY_STATUS_CLASS, **kwargs)
 
-    @abstractmethod
-    def build(self, _validate: bool = True, **kwargs) -> Entity:
+    def build_entity(self, **kwargs) -> Entity:
         """
         Build entity object.
-        """
-
-    def from_dict(self, obj: dict, validate: bool = True) -> Entity:
-        """
-        Build entity from dictionary.
 
         Parameters
         ----------
-        obj : dict
-            Dictionary to build the entity from.
-        validate : bool
-            Whether to validate the entity.
+        **kwargs : dict
+            Keyword arguments for the constructor.
 
         Returns
         -------
-        ArtifactArtifact
-            Entity built from the dictionary.
+        Entity
+            Entity object.
+        """
+        return self.ENTITY_CLASS(**kwargs)
+
+    @abstractmethod
+    def build(self, *args, **kwargs) -> Entity:
+        """
+        Build entity object.
+        """
+
+    @abstractmethod
+    def from_dict(self, obj: dict, validate: bool = True) -> Entity:
+        """
+        Build entity object from dictionary.
         """
-        return self.build(**obj, _validate=validate)

{digitalhub-0.8.0b3 → digitalhub-0.8.0b5}/digitalhub/entities/_builders/metadata.py

@@ -4,20 +4,13 @@ from digitalhub.entities._base.entity.metadata import Metadata
 from digitalhub.utils.generic_utils import get_timestamp
 
 
-def build_metadata(kind: str, **kwargs) -> Metadata:
+def build_metadata(**kwargs) -> Metadata:
     """
-    Build entity metadata object. The builder takes as input
-    the kind of metadata's object to build and the keyword
-    arguments to pass to the metadata's constructor.
-    The specific Metadata class is searched in the global
-    registry, where lies info about where to find the class.
-    The arguments are parsed, eventually adding default values,
-    and then passed to the constructor.
+    Build entity metadata object. This method is used to build entity
+    metadata.
 
     Parameters
     ----------
-    kind : str
-        Registry entry kind.
     **kwargs : dict
         Keyword arguments for the constructor.
 

digitalhub-0.8.0b5/digitalhub/entities/_builders/spec.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+import typing
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.spec import Spec, SpecValidator
+
+
+def build_spec(spec_cls: Spec, spec_validator: SpecValidator, validate: bool = True, **kwargs) -> Spec:
+    """
+    Build entity spec object. This method is used to build entity
+    specifications and is used to validate the parameters passed
+    to the constructor.
+
+    Parameters
+    ----------
+    spec_cls : Spec
+        Spec class.
+    spec_validator : SpecValidator
+        Spec validator class.
+    validate : bool
+        Flag to determine if validate kwargs.
+    **kwargs : dict
+        Keyword arguments for the constructor.
+
+    Returns
+    -------
+    Spec
+        Spec object.
+    """
+    if validate:
+        kwargs = spec_validator(**kwargs).dict(by_alias=True, exclude_none=True)
+    return spec_cls(**kwargs)

digitalhub-0.8.0b5/digitalhub/entities/_builders/status.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities.utils.state import State
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.status import Status
+
+
+def build_status(status_cls: Status, **kwargs) -> Status:
+    """
+    Build entity status object. This method is used to build entity
+    status.
+
+    Parameters
+    ----------
+    status_cls : Status
+        Entity status class.
+    **kwargs : dict
+        Keyword arguments.
+
+    Returns
+    -------
+    Status
+        Entity status object.
+    """
+    kwargs = parse_arguments(**kwargs)
+    return status_cls(**kwargs)
+
+
+def parse_arguments(**kwargs) -> dict:
+    """
+    Parse keyword arguments and add default values if necessary.
+
+    Parameters
+    ----------
+    **kwargs : dict
+        Keyword arguments.
+
+    Returns
+    -------
+    dict
+        Keyword arguments with default values.
+    """
+    state = kwargs.get("state")
+    if state is None:
+        kwargs["state"] = State.CREATED.value
+    else:
+        if kwargs["state"] not in State.__members__:
+            raise ValueError(f"Invalid state: {state}")
+    return kwargs

{digitalhub-0.8.0b3 → digitalhub-0.8.0b5}/digitalhub/entities/_builders/uuid.py

@@ -2,15 +2,7 @@ from __future__ import annotations
 
 from uuid import uuid4
 
-from pydantic import UUID4, BaseModel
-
-
-class UUIDValidator(BaseModel):
-    """
-    Validate UUID format.
-    """
-
-    uuid: UUID4
+from digitalhub.utils.generic_utils import slugify_string
 
 
 def build_uuid(uuid: str | None = None) -> str:
@@ -20,7 +12,7 @@ def build_uuid(uuid: str | None = None) -> str:
     Parameters
     ----------
     uuid : str
-        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+        ID of the object.
 
     Returns
     -------
@@ -28,6 +20,7 @@ def build_uuid(uuid: str | None = None) -> str:
         Validated UUID4.
     """
     if uuid is not None:
-        UUIDValidator(uuid=uuid)
+        if slugify_string(uuid) != uuid:
+            raise ValueError(f"Invalid ID: {uuid}. Must pass slugified ID.")
         return uuid
     return str(uuid4())