digitalhub 0.7.0b2__py3-none-any.whl → 0.8.0__py3-none-any.whl

digitalhub/entities/_base/context/entity.py

@@ -0,0 +1,118 @@
+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.utils.generic_utils import get_timestamp
+
+if typing.TYPE_CHECKING:
+    from digitalhub.context.context import Context
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.status import Status
+
+
+class ContextEntity(Entity):
+    def __init__(
+        self,
+        project: str,
+        kind: str,
+        metadata: Metadata,
+        spec: Spec,
+        status: Status,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(kind, metadata, spec, status, user)
+        self.project = project
+        self._obj_attr.extend(["project"])
+
+    ##############################
+    #  Save / Refresh / Export
+    ##############################
+
+    def save(self, update: bool = False) -> ContextEntity:
+        """
+        Save or update the entity into the backend.
+
+        Parameters
+        ----------
+        update : bool
+            Flag to indicate update.
+
+        Returns
+        -------
+        ContextEntity
+            Entity saved.
+        """
+        obj = self.to_dict()
+        if not update:
+            return self._save(obj)
+        return self._update(obj)
+
+    def _save(self, obj: dict) -> 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)
+        self._update_attributes(new_obj)
+        return self
+
+    def _update(self, obj: dict) -> 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._update_attributes(new_obj)
+        return self
+
+    def refresh(self) -> ContextEntity:
+        """
+        Refresh object from backend.
+
+        Returns
+        -------
+        ContextEntity
+            Entity refreshed.
+        """
+        new_obj = read_entity_api_ctx(self.key)
+        self._update_attributes(new_obj)
+        return self
+
+    ##############################
+    #  Context
+    ##############################
+
+    def _context(self) -> Context:
+        """
+        Get context.
+
+        Returns
+        -------
+        Context
+            Context object.
+        """
+        return get_context(self.project)

digitalhub/entities/_base/crud.py

@@ -0,0 +1,468 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.client.api import build_client, get_client
+from digitalhub.context.api import check_context
+from digitalhub.entities._base.api_utils import (
+    delete_entity_api_ctx,
+    list_entity_api_ctx,
+    read_entity_api_base,
+    read_entity_api_ctx,
+    read_entity_api_ctx_versions,
+)
+from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.entities.utils.utils import parse_entity_key
+from digitalhub.factory.api import build_entity_from_dict, build_entity_from_params
+from digitalhub.utils.exceptions import ContextError, 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._base.material.entity import MaterialEntity
+    from digitalhub.entities._base.unversioned.entity import UnversionedEntity
+    from digitalhub.entities._base.versioned.entity import VersionedEntity
+
+
+def _check_context(project: str) -> None:
+    """
+    Check if the given project is in the context.
+    Otherwise try to get the project from remote.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+
+    Returns
+    -------
+    None
+    """
+    try:
+        check_context(project)
+    except ContextError:
+        try:
+            build_client()
+            client = get_client()
+            obj = read_entity_api_base(client, EntityTypes.PROJECT.value, project)
+            build_entity_from_dict(obj)
+        except EntityNotExistsError:
+            raise ContextError(f"Project '{project}' not found.")
+
+
+def _check_project_from_identifier(identifier: str, project: str | None = None) -> None:
+    """
+    Check if the given project is in the context.
+    Otherwise try to get the project from remote.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+
+    Returns
+    -------
+    None
+    """
+    if not identifier.startswith("store://"):
+        if project is None:
+            raise EntityError("Specify project if you do not specify entity key.")
+
+    else:
+        project, _, _, _, _ = parse_entity_key(identifier)
+
+    _check_context(project)
+
+
+def new_context_entity(**kwargs) -> ContextEntity:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    kind : str
+        Kind the object.
+    uuid : str
+        ID of the object.
+    description : str
+        Description of the object (human readable).
+    labels : list[str]
+        List of labels.
+    embedded : bool
+        Flag to determine if object spec must be embedded in project spec.
+
+    Returns
+    -------
+    ContextEntity
+        Object instance.
+    """
+    _check_context(kwargs["project"])
+    obj = build_entity_from_params(**kwargs)
+    obj.save()
+    return obj
+
+
+def get_versioned_entity(
+    identifier: str,
+    entity_type: str | None = None,
+    project: str | None = None,
+    entity_id: str | None = None,
+    **kwargs,
+) -> VersionedEntity:
+    """
+    Get object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    entity_type : str
+        Entity type.
+    project : str
+        Project name.
+    entity_id : str
+        Entity ID.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    VersionedEntity
+        Object instance.
+    """
+    _check_project_from_identifier(identifier, project)
+    obj = read_entity_api_ctx(
+        identifier,
+        entity_type=entity_type,
+        project=project,
+        entity_id=entity_id,
+        **kwargs,
+    )
+    return build_entity_from_dict(obj)
+
+
+def get_unversioned_entity(
+    identifier: str,
+    entity_type: str | None = None,
+    project: str | None = None,
+    **kwargs,
+) -> UnversionedEntity:
+    """
+    Get object from backend.
+
+    Parameters
+    ----------
+    entity_type : str
+        Entity type.
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    entity_id : str
+        Entity ID.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    UnversionedEntity
+        Object instance.
+    """
+    _check_project_from_identifier(identifier, project)
+
+    obj = read_entity_api_ctx(
+        identifier,
+        entity_type=entity_type,
+        project=project,
+        **kwargs,
+    )
+    return build_entity_from_dict(obj)
+
+
+def get_material_entity(
+    identifier: str,
+    entity_type: str | None = None,
+    project: str | None = None,
+    entity_id: str | None = None,
+    **kwargs,
+) -> MaterialEntity:
+    """
+    Get object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    entity_type : str
+        Entity type.
+    project : str
+        Project name.
+    entity_id : str
+        Entity ID.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    MaterialEntity
+        Object instance.
+    """
+    obj: MaterialEntity = get_versioned_entity(
+        identifier,
+        entity_type=entity_type,
+        project=project,
+        entity_id=entity_id,
+        **kwargs,
+    )
+    obj._get_files_info()
+    return obj
+
+
+def get_context_entity_versions(
+    identifier: str,
+    entity_type: str | None = None,
+    project: str | None = None,
+    **kwargs,
+) -> list[ContextEntity]:
+    """
+    Get object versions from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    entity_type : str
+        Entity type.
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[ContextEntity]
+        List of object instances.
+    """
+    _check_project_from_identifier(identifier, project)
+    obj = read_entity_api_ctx_versions(
+        identifier,
+        entity_type=entity_type,
+        project=project,
+        **kwargs,
+    )
+    return [build_entity_from_dict(o) for o in obj]
+
+
+def get_material_entity_versions(
+    identifier: str,
+    entity_type: str | None = None,
+    project: str | None = None,
+    **kwargs,
+) -> list[MaterialEntity]:
+    """
+    Get object versions from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    entity_type : str
+        Entity type.
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[MaterialEntity]
+        List of object instances.
+    """
+    _check_project_from_identifier(identifier, project)
+    objs = read_entity_api_ctx_versions(
+        identifier,
+        entity_type=entity_type,
+        project=project,
+        **kwargs,
+    )
+    objects = []
+    for o in objs:
+        entity: MaterialEntity = build_entity_from_dict(o)
+        entity._get_files_info()
+        objects.append(entity)
+    return objects
+
+
+def list_context_entities(project: str, entity_type: str, **kwargs) -> list[ContextEntity]:
+    """
+    List all latest version objects from backend.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[ContextEntity]
+        List of object instances.
+    """
+    _check_context(project)
+    objs = list_entity_api_ctx(
+        project=project,
+        entity_type=entity_type,
+        **kwargs,
+    )
+    return [build_entity_from_dict(obj) for obj in objs]
+
+
+def list_material_entities(
+    project: str,
+    entity_type: str,
+    **kwargs,
+) -> list[MaterialEntity]:
+    """
+    List all latest version objects from backend.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[MaterialEntity]
+        List of object instances.
+    """
+    _check_context(project)
+    objs = list_entity_api_ctx(
+        project=project,
+        entity_type=entity_type,
+        **kwargs,
+    )
+    objects = []
+    for o in objs:
+        entity: MaterialEntity = build_entity_from_dict(o)
+        entity._get_files_info()
+        objects.append(entity)
+    return objects
+
+
+def import_context_entity(file: str) -> ContextEntity:
+    """
+    Get object from file.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    ContextEntity
+        Object instance.
+    """
+    dict_obj: dict = read_yaml(file)
+
+    _check_context(dict_obj["project"])
+
+    obj = build_entity_from_dict(dict_obj)
+    try:
+        obj.save()
+    except EntityAlreadyExistsError:
+        pass
+    return obj
+
+
+def import_executable_entity(file: str) -> ExecutableEntity:
+    """
+    Get object from file.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    ExecutableEntity
+        Object instance.
+    """
+    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 = []
+
+    _check_context(exec_dict["project"])
+
+    obj: ExecutableEntity = build_entity_from_dict(exec_dict)
+
+    obj.import_tasks(tsk_dicts)
+
+    try:
+        obj.save()
+    except EntityAlreadyExistsError:
+        pass
+    return obj
+
+
+def delete_entity(
+    identifier: str,
+    entity_type: str | None = None,
+    project: str | None = None,
+    entity_id: str | None = None,
+    delete_all_versions: bool = False,
+    cascade: bool = True,
+    **kwargs,
+) -> dict:
+    """
+    Delete object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    entity_type : str
+        Entity type.
+    project : str
+        Project name.
+    entity_id : str
+        Entity ID.
+    delete_all_versions : bool
+        Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
+    cascade : bool
+        Cascade delete.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    dict
+        Response from backend.
+    """
+    _check_project_from_identifier(identifier, project)
+    return delete_entity_api_ctx(
+        identifier=identifier,
+        entity_type=entity_type,
+        project=project,
+        entity_id=entity_id,
+        delete_all_versions=delete_all_versions,
+        cascade=cascade,
+        **kwargs,
+    )

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

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.entity.metadata import Metadata
+from digitalhub.utils.generic_utils import get_timestamp
+
+
+def build_metadata(**kwargs) -> Metadata:
+    """
+    Build entity metadata object. This method is used to build entity
+    metadata.
+
+    Parameters
+    ----------
+    **kwargs : dict
+        Keyword arguments for the constructor.
+
+    Returns
+    -------
+    Metadata
+        Metadata object.
+    """
+    kwargs = parse_arguments(**kwargs)
+    return Metadata(**kwargs)
+
+
+def parse_arguments(**kwargs) -> dict:
+    """
+    Parse keyword arguments and add default values if necessary.
+
+    Parameters
+    ----------
+    **kwargs : dict
+        Keyword arguments.
+
+    Returns
+    -------
+    dict
+        A dictionary containing the entity metadata attributes.
+    """
+    if "created" not in kwargs or kwargs["created"] is None:
+        kwargs["created"] = get_timestamp()
+    if "updated" not in kwargs or kwargs["updated"] is None:
+        kwargs["updated"] = kwargs["created"]
+    return kwargs

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

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from pydantic import BaseModel, Field
+
+NAME_REGEX = r"^[a-zA-Z0-9._+-]+$"
+
+
+class NameValidator(BaseModel):
+    """
+    Validate name format.
+    """
+
+    name: str = Field(min_length=1, max_length=256, regex=NAME_REGEX)
+
+
+def build_name(name: str) -> str:
+    """
+    Build name.
+
+    Parameters
+    ----------
+    name : str
+        The name.
+
+    Returns
+    -------
+    str
+        The name.
+    """
+    NameValidator(name=name)
+    return name

digitalhub/entities/_base/entity/_constructors/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)