digitalhub 0.8.0__py3-none-any.whl → 0.8.0b1__py3-none-any.whl

digitalhub/entities/_base/crud.py

@@ -2,118 +2,215 @@ 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.context.builder import get_context
+from digitalhub.entities._base.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.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
+from digitalhub.entities.utils import parse_entity_key
 
 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
+    from digitalhub.client.objects.base import Client
 
 
-def _check_context(project: str) -> None:
+def create_entity_api_base(
+    client: Client,
+    entity_type: str,
+    entity_dict: dict,
+    **kwargs,
+) -> dict:
     """
-    Check if the given project is in the context.
-    Otherwise try to get the project from remote.
+    Create object in backend.
 
     Parameters
     ----------
-    project : str
-        Project name.
+    client : Client
+        Client instance.
+    entity_type : str
+        Entity type.
+    entity_dict : dict
+        Object instance.
+    **kwargs : dict
+        Parameters to pass to the API call.
 
     Returns
     -------
-    None
+    dict
+        Object instance.
     """
-    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.")
+    api = api_base_create(entity_type)
+    return client.create_object(api, entity_dict, **kwargs)
 
 
-def _check_project_from_identifier(identifier: str, project: str | None = None) -> None:
+def read_entity_api_base(
+    client: Client,
+    entity_type: str,
+    entity_name: str,
+    **kwargs,
+) -> dict:
     """
-    Check if the given project is in the context.
-    Otherwise try to get the project from remote.
+    Read object from backend.
 
     Parameters
     ----------
-    identifier : str
-        Entity key (store://...) or entity name.
-    project : str
-        Project name.
+    client : Client
+        Client instance.
+    entity_type : str
+        Entity type.
+    entity_name : str
+        Entity name.
+    **kwargs : dict
+        Parameters to pass to the API call.
 
     Returns
     -------
-    None
+    dict
+        Object instance.
     """
-    if not identifier.startswith("store://"):
-        if project is None:
-            raise EntityError("Specify project if you do not specify entity key.")
+    api = api_base_read(entity_type, entity_name)
+    return client.read_object(api, **kwargs)
 
-    else:
-        project, _, _, _, _ = parse_entity_key(identifier)
 
-    _check_context(project)
+def update_entity_api_base(
+    client: Client,
+    entity_type: str,
+    entity_name: str,
+    entity_dict: dict,
+    **kwargs,
+) -> dict:
+    """
+    Update object. Note that object spec are immutable.
+
+    Parameters
+    ----------
+    client : Client
+        Client instance.
+    entity_type : str
+        Entity type.
+    entity_name : str
+        Entity name.
+    entity_dict : dict
+        Object instance.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    dict
+        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.
+
+    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,
+    **kwargs,
+) -> list[dict]:
+    """
+    List objects from backend.
 
+    Parameters
+    ----------
+    entity_type : str
+        Entity type.
+    **kwargs : dict
+        Parameters to pass to the API call.
 
-def new_context_entity(**kwargs) -> ContextEntity:
+    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 a new object.
+    Create object in backend.
 
     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.
+    entity_type : str
+        Entity type.
+    entity_dict : dict
+        Object instance.
+    **kwargs : dict
+        Parameters to pass to the API call.
 
     Returns
     -------
-    ContextEntity
+    dict
         Object instance.
     """
-    _check_context(kwargs["project"])
-    obj = build_entity_from_params(**kwargs)
-    obj.save()
-    return obj
+    api = api_ctx_create(project, entity_type)
+    return get_context(project).create_object(api, entity_dict, **kwargs)
 
 
-def get_versioned_entity(
+def read_entity_api_ctx(
     identifier: str,
     entity_type: str | None = None,
     project: str | None = None,
     entity_id: str | None = None,
     **kwargs,
-) -> VersionedEntity:
+) -> dict:
     """
     Get object from backend.
 
@@ -132,105 +229,112 @@ def get_versioned_entity(
 
     Returns
     -------
-    VersionedEntity
+    dict
         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)
 
+    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)
 
-def get_unversioned_entity(
+    api = api_ctx_read(project, entity_type, entity_id)
+    return get_context(project).read_object(api, **kwargs)
+
+
+def read_entity_api_ctx_versions(
     identifier: str,
     entity_type: str | None = None,
     project: str | None = None,
     **kwargs,
-) -> UnversionedEntity:
+) -> list[dict]:
     """
-    Get object from backend.
+    Get all versions object from backend.
 
     Parameters
     ----------
-    entity_type : str
-        Entity type.
     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
     -------
-    UnversionedEntity
-        Object instance.
+    list[dict]
+        Object instances.
     """
-    _check_project_from_identifier(identifier, project)
+    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)
 
-    obj = read_entity_api_ctx(
-        identifier,
-        entity_type=entity_type,
-        project=project,
-        **kwargs,
-    )
-    return build_entity_from_dict(obj)
+    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 get_material_entity(
-    identifier: str,
-    entity_type: str | None = None,
-    project: str | None = None,
-    entity_id: str | None = None,
+
+def update_entity_api_ctx(
+    project: str,
+    entity_type: str,
+    entity_id: str,
+    entity_dict: dict,
     **kwargs,
-) -> MaterialEntity:
+) -> dict:
     """
-    Get object from backend.
+    Update object. Note that object spec are immutable.
 
     Parameters
     ----------
-    identifier : str
-        Entity key (store://...) or entity name.
-    entity_type : str
-        Entity type.
     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
     -------
-    MaterialEntity
-        Object instance.
+    dict
+        Response from backend.
     """
-    obj: MaterialEntity = get_versioned_entity(
-        identifier,
-        entity_type=entity_type,
-        project=project,
-        entity_id=entity_id,
-        **kwargs,
-    )
-    obj._get_files_info()
-    return obj
+    api = api_ctx_update(project, entity_type, entity_id=entity_id)
+    return get_context(project).update_object(api, entity_dict, **kwargs)
 
 
-def get_context_entity_versions(
+def delete_entity_api_ctx(
     identifier: str,
-    entity_type: str | None = None,
+    entity_type: str,
     project: str | None = None,
+    entity_id: str | None = None,
     **kwargs,
-) -> list[ContextEntity]:
+) -> dict:
     """
-    Get object versions from backend.
+    Delete object from backend.
 
     Parameters
     ----------
@@ -240,67 +344,81 @@ def get_context_entity_versions(
         Entity type.
     project : str
         Project name.
+    entity_id : str
+        Entity ID.
     **kwargs : dict
         Parameters to pass to the API call.
 
     Returns
     -------
-    list[ContextEntity]
-        List of object instances.
+    dict
+        Response from backend.
     """
-    _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]
+    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)
 
-def get_material_entity_versions(
-    identifier: str,
-    entity_type: str | None = None,
-    project: str | None = None,
+    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[MaterialEntity]:
+) -> list[dict]:
     """
-    Get object versions from backend.
+    List objects from backend.
 
     Parameters
     ----------
-    identifier : str
-        Entity key (store://...) or entity name.
-    entity_type : str
-        Entity type.
     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.
+    list[dict]
+        List of objects.
     """
-    _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
+    api = api_ctx_list(project, entity_type)
+    return get_context(project).list_objects(api, **kwargs)
 
 
-def list_context_entities(project: str, entity_type: str, **kwargs) -> list[ContextEntity]:
+def set_data_api(
+    project: str,
+    entity_type: str,
+    data: dict,
+    **kwargs,
+) -> None:
     """
-    List all latest version objects from backend.
+    Set data in backend.
 
     Parameters
     ----------
@@ -308,30 +426,26 @@ def list_context_entities(project: str, entity_type: str, **kwargs) -> list[Cont
         Project name.
     entity_type : str
         Entity type.
+    data : dict
+        Data dictionary.
     **kwargs : dict
         Parameters to pass to the API call.
 
     Returns
     -------
-    list[ContextEntity]
-        List of object instances.
+    None
     """
-    _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]
+    api = api_ctx_data(project, entity_type)
+    get_context(project).update_object(api, data, **kwargs)
 
 
-def list_material_entities(
+def get_data_api(
     project: str,
     entity_type: str,
     **kwargs,
-) -> list[MaterialEntity]:
+) -> dict:
     """
-    List all latest version objects from backend.
+    Read data from backend.
 
     Parameters
     ----------
@@ -344,125 +458,153 @@ def list_material_entities(
 
     Returns
     -------
-    list[MaterialEntity]
-        List of object instances.
+    dict
+        Response from backend.
     """
-    _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
+    api = api_ctx_data(project, entity_type)
+    return get_context(project).read_object(api, **kwargs)
 
 
-def import_context_entity(file: str) -> ContextEntity:
+def logs_api(
+    project: str,
+    entity_type: str,
+    entity_id: str,
+    **kwargs,
+) -> dict:
     """
-    Get object from file.
+    Read logs from backend.
 
     Parameters
     ----------
-    file : str
-        Path to YAML file.
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+    **kwargs : dict
+        Parameters to pass to the API call.
 
     Returns
     -------
-    ContextEntity
-        Object instance.
+    dict
+        Response from backend.
     """
-    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
+    api = api_ctx_logs(project, entity_type, entity_id)
+    return get_context(project).read_object(api, **kwargs)
 
 
-def import_executable_entity(file: str) -> ExecutableEntity:
+def stop_api(
+    project: str,
+    entity_type: str,
+    entity_id: str,
+    **kwargs,
+) -> None:
     """
-    Get object from file.
+    Stop object in backend.
 
     Parameters
     ----------
-    file : str
-        Path to YAML file.
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+    **kwargs : dict
+        Parameters to pass to the API call.
 
     Returns
     -------
-    ExecutableEntity
-        Object instance.
+    None
     """
-    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 = []
+    api = api_ctx_stop(project, entity_type, entity_id)
+    get_context(project).create_object(api, obj={}, **kwargs)
 
-    _check_context(exec_dict["project"])
 
-    obj: ExecutableEntity = build_entity_from_dict(exec_dict)
+def resume_api(
+    project: str,
+    entity_type: str,
+    entity_id: str,
+    **kwargs,
+) -> None:
+    """
+    Resume object in backend.
 
-    obj.import_tasks(tsk_dicts)
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+    **kwargs : dict
+        Parameters to pass to the API call.
 
-    try:
-        obj.save()
-    except EntityAlreadyExistsError:
-        pass
-    return obj
+    Returns
+    -------
+    None
+    """
+    api = api_ctx_resume(project, entity_type, entity_id)
+    get_context(project).create_object(api, obj={}, **kwargs)
 
 
-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,
+def files_info_get_api(
+    project: str,
+    entity_type: str,
+    entity_id: str,
     **kwargs,
-) -> dict:
+) -> list[dict]:
     """
-    Delete object from backend.
+    Get files info from backend.
 
     Parameters
     ----------
-    identifier : str
-        Entity key (store://...) or entity name.
+    project : str
+        Project 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.
-    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.
+    entity_list : list[dict]
+        Entity list.
     **kwargs : dict
         Parameters to pass to the API call.
 
     Returns
     -------
-    dict
-        Response from backend.
+    None
     """
-    _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,
-    )
+    api = api_ctx_files(project, entity_type, entity_id)
+    get_context(project).update_object(api, entity_list, **kwargs)