digitalhub 0.8.0b7__py3-none-any.whl → 0.8.0b11__py3-none-any.whl

digitalhub/entities/_base/crud.py

@@ -2,215 +2,138 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.context.builder import get_context
-from digitalhub.entities.utils.api import (
-    api_base_create,
-    api_base_delete,
-    api_base_list,
-    api_base_read,
-    api_base_update,
-    api_ctx_create,
-    api_ctx_data,
-    api_ctx_delete,
-    api_ctx_files,
-    api_ctx_list,
-    api_ctx_logs,
-    api_ctx_read,
-    api_ctx_resume,
-    api_ctx_stop,
-    api_ctx_update,
+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_ctx,
+    read_entity_api_ctx_versions,
 )
-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 EntityAlreadyExistsError, EntityError
+from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
-    from digitalhub.client._base.client import Client
+    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 create_entity_api_base(
-    client: Client,
-    entity_type: str,
-    entity_dict: dict,
-    **kwargs,
-) -> dict:
+def new_context_entity(**kwargs) -> ContextEntity:
     """
-    Create object in backend.
+    Create a new object.
 
     Parameters
     ----------
-    client : Client
-        Client instance.
-    entity_type : str
-        Entity type.
-    entity_dict : dict
-        Object instance.
-    **kwargs : dict
-        Parameters to pass to the API call.
-
-    Returns
-    -------
-    dict
-        Object instance.
-    """
-    api = api_base_create(entity_type)
-    return client.create_object(api, entity_dict, **kwargs)
-
-
-def read_entity_api_base(
-    client: Client,
-    entity_type: str,
-    entity_name: str,
-    **kwargs,
-) -> dict:
-    """
-    Read object from backend.
-
-    Parameters
-    ----------
-    client : Client
-        Client instance.
-    entity_type : str
-        Entity type.
-    entity_name : str
-        Entity name.
-    **kwargs : dict
-        Parameters to pass to the API call.
+    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
     -------
-    dict
+    ContextEntity
         Object instance.
     """
-    api = api_base_read(entity_type, entity_name)
-    return client.read_object(api, **kwargs)
+    check_context(kwargs["project"])
+    obj = build_entity_from_params(**kwargs)
+    obj.save()
+    return obj
 
 
-def update_entity_api_base(
-    client: Client,
-    entity_type: str,
-    entity_name: str,
-    entity_dict: dict,
+def get_versioned_entity(
+    identifier: str,
+    entity_type: str | None = None,
+    project: str | None = None,
+    entity_id: str | None = None,
     **kwargs,
-) -> dict:
+) -> VersionedEntity:
     """
-    Update object. Note that object spec are immutable.
+    Get object from backend.
 
     Parameters
     ----------
-    client : Client
-        Client instance.
+    identifier : str
+        Entity key (store://...) or entity name.
     entity_type : str
         Entity type.
-    entity_name : str
-        Entity name.
-    entity_dict : dict
-        Object instance.
+    project : str
+        Project name.
+    entity_id : str
+        Entity ID.
     **kwargs : dict
         Parameters to pass to the API call.
 
     Returns
     -------
-    dict
+    VersionedEntity
         Object instance.
     """
-    api = api_base_update(entity_type, entity_name)
-    return client.update_object(api, entity_dict, **kwargs)
-
-
-def delete_entity_api_base(
-    client: Client,
-    entity_type: str,
-    entity_name: str,
-    **kwargs,
-) -> dict:
-    """
-    Delete object from backend.
+    obj = read_entity_api_ctx(
+        identifier,
+        entity_type=entity_type,
+        project=project,
+        entity_id=entity_id,
+        **kwargs,
+    )
+    return build_entity_from_dict(obj)
 
-    Parameters
-    ----------
-    client : Client
-        Client instance.
-    entity_type : str
-        Entity type.
-    entity_name : str
-        Entity name.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
-    Returns
-    -------
-    dict
-        Object instance.
-    """
-    if "params" not in kwargs:
-        kwargs["params"] = {}
-    if "cascade" in kwargs["params"]:
-        kwargs["params"]["cascade"] = str(kwargs["cascade"]).lower()
-    if "cascade" in kwargs:
-        kwargs["params"]["cascade"] = str(kwargs.pop("cascade")).lower()
-    api = api_base_delete(entity_type, entity_name)
-    return client.delete_object(api, **kwargs)
-
-
-def list_entity_api_base(
-    client: Client,
-    entity_type: str,
+def get_unversioned_entity(
+    identifier: str,
+    entity_type: str | None = None,
+    project: str | None = None,
     **kwargs,
-) -> list[dict]:
+) -> UnversionedEntity:
     """
-    List objects from backend.
+    Get object from backend.
 
     Parameters
     ----------
     entity_type : str
         Entity type.
-    **kwargs : dict
-        Parameters to pass to the API call.
-
-    Returns
-    -------
-    list[dict]
-        List of objects.
-    """
-    api = api_base_list(entity_type)
-    return client.list_objects(api, **kwargs)
-
-
-def create_entity_api_ctx(
-    project: str,
-    entity_type: str,
-    entity_dict: dict,
-    **kwargs,
-) -> dict:
-    """
-    Create object in backend.
-
-    Parameters
-    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
     project : str
         Project name.
-    entity_type : str
-        Entity type.
-    entity_dict : dict
-        Object instance.
+    entity_id : str
+        Entity ID.
     **kwargs : dict
         Parameters to pass to the API call.
 
     Returns
     -------
-    dict
+    UnversionedEntity
         Object instance.
     """
-    api = api_ctx_create(project, entity_type)
-    return get_context(project).create_object(api, entity_dict, **kwargs)
+    if not identifier.startswith("store://") and project is None:
+        raise EntityError("Specify entity key or entity ID combined with project")
+    obj = read_entity_api_ctx(
+        identifier,
+        entity_type=entity_type,
+        project=project,
+        **kwargs,
+    )
+    return build_entity_from_dict(obj)
 
 
-def read_entity_api_ctx(
+def get_material_entity(
     identifier: str,
     entity_type: str | None = None,
     project: str | None = None,
     entity_id: str | None = None,
     **kwargs,
-) -> dict:
+) -> MaterialEntity:
     """
     Get object from backend.
 
@@ -229,38 +152,28 @@ def read_entity_api_ctx(
 
     Returns
     -------
-    dict
+    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
 
-    if identifier.startswith("store://"):
-        project, entity_type, _, _, entity_id = parse_entity_key(identifier)
-        api = api_ctx_read(project, entity_type, entity_id)
-        return get_context(project).read_object(api, **kwargs)
-
-    if project is None or entity_type is None:
-        raise ValueError("Project and entity type must be specified.")
-
-    if "params" not in kwargs:
-        kwargs["params"] = {}
 
-    if entity_id is None:
-        kwargs["params"]["name"] = identifier
-        api = api_ctx_list(project, entity_type)
-        return get_context(project).list_first_object(api, **kwargs)
-
-    api = api_ctx_read(project, entity_type, entity_id)
-    return get_context(project).read_object(api, **kwargs)
-
-
-def read_entity_api_ctx_versions(
+def get_context_entity_versions(
     identifier: str,
     entity_type: str | None = None,
     project: str | None = None,
     **kwargs,
-) -> list[dict]:
+) -> list[ContextEntity]:
     """
-    Get all versions object from backend.
+    Get object versions from backend.
 
     Parameters
     ----------
@@ -275,66 +188,26 @@ def read_entity_api_ctx_versions(
 
     Returns
     -------
-    list[dict]
-        Object instances.
-    """
-    if not identifier.startswith("store://"):
-        if project is None or entity_type is None:
-            raise ValueError("Project and entity type must be specified.")
-        entity_name = identifier
-    else:
-        project, entity_type, _, entity_name, _ = parse_entity_key(identifier)
-
-    if "params" not in kwargs:
-        kwargs["params"] = {}
-    kwargs["params"]["name"] = entity_name
-    kwargs["params"]["versions"] = "all"
-
-    api = api_ctx_list(project, entity_type)
-    return get_context(project).list_objects(api, **kwargs)
-
-
-def update_entity_api_ctx(
-    project: str,
-    entity_type: str,
-    entity_id: str,
-    entity_dict: dict,
-    **kwargs,
-) -> dict:
+    list[ContextEntity]
+        List of object instances.
     """
-    Update object. Note that object spec are immutable.
+    obj = read_entity_api_ctx_versions(
+        identifier,
+        entity_type=entity_type,
+        project=project,
+        **kwargs,
+    )
+    return [build_entity_from_dict(o) for o in obj]
 
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-    entity_dict : dict
-        Entity dictionary.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
-    Returns
-    -------
-    dict
-        Response from backend.
-    """
-    api = api_ctx_update(project, entity_type, entity_id=entity_id)
-    return get_context(project).update_object(api, entity_dict, **kwargs)
-
-
-def delete_entity_api_ctx(
+def get_material_entity_versions(
     identifier: str,
-    entity_type: str,
+    entity_type: str | None = None,
     project: str | None = None,
-    entity_id: str | None = None,
     **kwargs,
-) -> dict:
+) -> list[MaterialEntity]:
     """
-    Delete object from backend.
+    Get object versions from backend.
 
     Parameters
     ----------
@@ -344,54 +217,31 @@ def delete_entity_api_ctx(
         Entity type.
     project : str
         Project name.
-    entity_id : str
-        Entity ID.
     **kwargs : dict
         Parameters to pass to the API call.
 
     Returns
     -------
-    dict
-        Response from backend.
+    list[MaterialEntity]
+        List of object instances.
     """
-    if "params" not in kwargs:
-        kwargs["params"] = {}
-    if "cascade" in kwargs["params"]:
-        kwargs["params"]["cascade"] = str(kwargs["cascade"]).lower()
-    if "cascade" in kwargs:
-        kwargs["params"]["cascade"] = str(kwargs.pop("cascade")).lower()
-
-    delete_all_versions: bool = kwargs.pop("delete_all_versions", False)
+    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
 
-    if identifier.startswith("store://"):
-        project, _, _, _, entity_id = parse_entity_key(identifier)
-        api = api_ctx_delete(project, entity_type, entity_id)
-        return get_context(project).delete_object(api, **kwargs)
 
-    if project is None:
-        raise ValueError("Project must be provided.")
-
-    if entity_id is not None:
-        api = api_ctx_delete(project, entity_type, entity_id)
-    else:
-        kwargs["params"]["name"] = identifier
-        api = api_ctx_list(project, entity_type)
-        if delete_all_versions:
-            return get_context(project).delete_object(api, **kwargs)
-        obj = get_context(project).list_first_object(api, **kwargs)
-        entity_id = obj["id"]
-
-    api = api_ctx_delete(project, entity_type, entity_id)
-    return get_context(project).delete_object(api, **kwargs)
-
-
-def list_entity_api_ctx(
-    project: str,
-    entity_type: str,
-    **kwargs,
-) -> list[dict]:
+def list_context_entities(project: str, entity_type: str, **kwargs) -> list[ContextEntity]:
     """
-    List objects from backend.
+    List all latest version objects from backend.
 
     Parameters
     ----------
@@ -404,21 +254,24 @@ def list_entity_api_ctx(
 
     Returns
     -------
-    list[dict]
-        List of objects.
+    list[ContextEntity]
+        List of object instances.
     """
-    api = api_ctx_list(project, entity_type)
-    return get_context(project).list_objects(api, **kwargs)
+    objs = list_entity_api_ctx(
+        project=project,
+        entity_type=entity_type,
+        **kwargs,
+    )
+    return [build_entity_from_dict(obj) for obj in objs]
 
 
-def set_data_api(
+def list_material_entities(
     project: str,
     entity_type: str,
-    data: dict,
     **kwargs,
-) -> None:
+) -> list[MaterialEntity]:
     """
-    Set data in backend.
+    List all latest version objects from backend.
 
     Parameters
     ----------
@@ -426,185 +279,128 @@ def set_data_api(
         Project name.
     entity_type : str
         Entity type.
-    data : dict
-        Data dictionary.
     **kwargs : dict
         Parameters to pass to the API call.
 
     Returns
     -------
-    None
+    list[MaterialEntity]
+        List of object instances.
     """
-    api = api_ctx_data(project, entity_type)
-    get_context(project).update_object(api, data, **kwargs)
+    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 get_data_api(
-    project: str,
-    entity_type: str,
-    **kwargs,
-) -> dict:
+def import_context_entity(file: str) -> ContextEntity:
     """
-    Read data from backend.
+    Get object from file.
 
     Parameters
     ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    **kwargs : dict
-        Parameters to pass to the API call.
+    file : str
+        Path to YAML file.
 
     Returns
     -------
-    dict
-        Response from backend.
-    """
-    api = api_ctx_data(project, entity_type)
-    return get_context(project).read_object(api, **kwargs)
-
-
-def logs_api(
-    project: str,
-    entity_type: str,
-    entity_id: str,
-    **kwargs,
-) -> dict:
+    ContextEntity
+        Object instance.
     """
-    Read logs from backend.
+    dict_obj: dict = read_yaml(file)
 
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-    **kwargs : dict
-        Parameters to pass to the API call.
+    check_context(dict_obj["project"])
 
-    Returns
-    -------
-    dict
-        Response from backend.
-    """
-    api = api_ctx_logs(project, entity_type, entity_id)
-    return get_context(project).read_object(api, **kwargs)
+    obj = build_entity_from_dict(dict_obj)
+    try:
+        obj.save()
+    except EntityAlreadyExistsError:
+        pass
+    return obj
 
 
-def stop_api(
-    project: str,
-    entity_type: str,
-    entity_id: str,
-    **kwargs,
-) -> None:
+def import_executable_entity(file: str) -> ExecutableEntity:
     """
-    Stop object in backend.
+    Get object from file.
 
     Parameters
     ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-    **kwargs : dict
-        Parameters to pass to the API call.
+    file : str
+        Path to YAML file.
 
     Returns
     -------
-    None
+    ExecutableEntity
+        Object instance.
     """
-    api = api_ctx_stop(project, entity_type, entity_id)
-    get_context(project).create_object(api, obj={}, **kwargs)
+    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"])
 
-def resume_api(
-    project: str,
-    entity_type: str,
-    entity_id: str,
-    **kwargs,
-) -> None:
-    """
-    Resume object in backend.
+    obj: ExecutableEntity = build_entity_from_dict(exec_dict)
 
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-    **kwargs : dict
-        Parameters to pass to the API call.
+    obj.import_tasks(tsk_dicts)
 
-    Returns
-    -------
-    None
-    """
-    api = api_ctx_resume(project, entity_type, entity_id)
-    get_context(project).create_object(api, obj={}, **kwargs)
+    try:
+        obj.save()
+    except EntityAlreadyExistsError:
+        pass
+    return obj
 
 
-def files_info_get_api(
-    project: str,
-    entity_type: str,
-    entity_id: str,
+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,
-) -> list[dict]:
+) -> dict:
     """
-    Get files info from backend.
+    Delete object from backend.
 
     Parameters
     ----------
-    project : str
-        Project name.
+    identifier : str
+        Entity key (store://...) or entity name.
     entity_type : str
         Entity type.
-    entity_id : str
-        Entity ID.
-    **kwargs : dict
-        Parameters to pass to the API call.
-
-    Returns
-    -------
-    list[dict]
-        Response from backend.
-    """
-    api = api_ctx_files(project, entity_type, entity_id)
-    return get_context(project).read_object(api, **kwargs)
-
-
-def files_info_put_api(
-    project: str,
-    entity_type: str,
-    entity_id: str,
-    entity_list: list[dict],
-    **kwargs,
-) -> None:
-    """
-    Get files info from backend.
-
-    Parameters
-    ----------
     project : str
         Project name.
-    entity_type : str
-        Entity type.
     entity_id : str
         Entity ID.
-    entity_list : list[dict]
-        Entity list.
+    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
     -------
-    None
+    dict
+        Response from backend.
     """
-    api = api_ctx_files(project, entity_type, entity_id)
-    get_context(project).update_object(api, entity_list, **kwargs)
+    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,
+    )