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

digitalhub/entities/utils/api.py

@@ -1,346 +0,0 @@
-from __future__ import annotations
-
-API_BASE = "/api/v1"
-API_CONTEXT = f"{API_BASE}/-"
-
-
-##############################
-# Context APIs
-##############################
-
-
-def api_ctx_create(
-    project: str,
-    entity_type: str,
-) -> str:
-    """
-    Create context API.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        The name of the entity_type.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_CONTEXT}/{project}/{entity_type}"
-
-
-def api_ctx_read(project: str, entity_type: str, entity_id: str) -> str:
-    """
-    Read context API.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}"
-
-
-def api_ctx_update(
-    project: str,
-    entity_type: str,
-    entity_id: str,
-) -> str:
-    """
-    Update context API.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}"
-
-
-def api_ctx_delete(project: str, entity_type: str, entity_id: str) -> str:
-    """
-    Delete context API.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}"
-
-
-def api_ctx_list(project: str, entity_type: str) -> str:
-    """
-    List context API.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_CONTEXT}/{project}/{entity_type}"
-
-
-def api_ctx_data(project: str, entity_type: str) -> str:
-    """
-    Data context API.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_CONTEXT}/{project}/{entity_type}/data"
-
-
-def api_ctx_logs(project: str, entity_type: str, entity_id: str) -> str:
-    """
-    Logs context API.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}/logs"
-
-
-def api_ctx_stop(project: str, entity_type: str, entity_id: str) -> str:
-    """
-    Stop context API.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}/stop"
-
-
-def api_ctx_resume(project: str, entity_type: str, entity_id: str) -> str:
-    """
-    Resume context API.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}/resume"
-
-
-def api_ctx_files(project: str, entity_type: str, entity_id: str) -> str:
-    """
-    Files context API.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}/files/info"
-
-
-##############################
-# Base APIs
-##############################
-
-
-def api_base_list(entity_type: str) -> str:
-    """
-    List base API.
-
-    Parameters
-    ----------
-    entity_type : str
-        Entity type.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_BASE}/{entity_type}"
-
-
-def api_base_create(entity_type: str) -> str:
-    """
-    Create base API.
-
-    Parameters
-    ----------
-    entity_type : str
-        Entity type.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_BASE}/{entity_type}"
-
-
-def api_base_read(entity_type: str, entity_id: str) -> str:
-    """
-    Read base API.
-
-    Parameters
-    ----------
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_BASE}/{entity_type}/{entity_id}"
-
-
-def api_base_update(entity_type: str, entity_id: str) -> str:
-    """
-    Update base API.
-
-    Parameters
-    ----------
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_BASE}/{entity_type}/{entity_id}"
-
-
-def api_base_delete(entity_type: str, entity_id: str) -> str:
-    """
-    Delete base API.
-
-    Parameters
-    ----------
-    entity_type : str
-        Entity type.
-    entity_id : str
-        Entity ID.
-
-    Returns
-    -------
-    str
-        The API string formatted.
-    """
-    if not entity_type.endswith("s"):
-        entity_type += "s"
-    return f"{API_BASE}/{entity_type}/{entity_id}"

digitalhub/entities/utils/entity_types.py

@@ -1,19 +0,0 @@
-from __future__ import annotations
-
-from enum import Enum
-
-
-class EntityTypes(Enum):
-    """
-    Entity types.
-    """
-
-    PROJECT = "project"
-    ARTIFACT = "artifact"
-    DATAITEM = "dataitem"
-    MODEL = "model"
-    SECRET = "secret"
-    FUNCTION = "function"
-    WORKFLOW = "workflow"
-    TASK = "task"
-    RUN = "run"

digitalhub/entities/utils/state.py

@@ -1,31 +0,0 @@
-from __future__ import annotations
-
-from enum import Enum
-
-
-class State(Enum):
-    """
-    State enumeration.
-    """
-
-    BUILT = "BUILT"
-    CANCELLED = "CANCELLED"
-    COMPLETED = "COMPLETED"
-    CREATED = "CREATED"
-    CREATING = "CREATING"
-    DELETED = "DELETED"
-    DELETING = "DELETING"
-    ERROR = "ERROR"
-    FSM_ERROR = "FSM_ERROR"
-    IDLE = "IDLE"
-    NONE = "NONE"
-    ONLINE = "ONLINE"
-    PENDING = "PENDING"
-    READY = "READY"
-    RESUME = "RESUME"
-    RUN_ERROR = "RUN_ERROR"
-    RUNNING = "RUNNING"
-    STOP = "STOP"
-    STOPPED = "STOPPED"
-    SUCCESS = "SUCCESS"
-    UNKNOWN = "UNKNOWN"

digitalhub/entities/utils/utils.py

@@ -1,202 +0,0 @@
-from __future__ import annotations
-
-from pathlib import Path
-
-from digitalhub.entities.utils.entity_types import EntityTypes
-from digitalhub.utils.file_utils import get_file_mime_type
-from digitalhub.utils.s3_utils import get_s3_bucket
-from digitalhub.utils.uri_utils import check_local_path
-
-
-def parse_entity_key(key: str) -> tuple[str]:
-    """
-    Parse the entity key. Returns project, entity type, kind, name and uuid.
-
-    Parameters
-    ----------
-    key : str
-        The entity key.
-
-    Returns
-    -------
-    tuple[str]
-        Project, entity type, kind, name and uuid.
-    """
-    try:
-        # Remove "store://" from the key
-        key = key.replace("store://", "")
-
-        # Split the key into parts
-        parts = key.split("/")
-
-        # The project is the first part
-        project = parts[0]
-
-        # The entity type is the second part
-        entity_type = parts[1]
-
-        # The kind is the third part
-        kind = parts[2]
-
-        # Tasks and runs have no name and uuid
-        if entity_type in (EntityTypes.TASK.value, EntityTypes.RUN.value):
-            name = None
-            uuid = parts[3]
-
-        # The name and uuid are separated by a colon in the last part
-        else:
-            name, uuid = parts[3].split(":")
-
-        return project, entity_type, kind, name, uuid
-    except Exception as e:
-        raise ValueError("Invalid key format.") from e
-
-
-def eval_local_source(source: str | list[str]) -> None:
-    """
-    Evaluate if source is local.
-
-    Parameters
-    ----------
-    source : str | list[str]
-        Source(s).
-
-    Returns
-    -------
-    None
-    """
-    if isinstance(source, list):
-        if not source:
-            raise ValueError("Empty list of sources.")
-        source_is_local = all(check_local_path(s) for s in source)
-        for s in source:
-            if Path(s).is_dir():
-                raise ValueError(f"Invalid source path: {s}. List of paths must be list of files, not directories.")
-    else:
-        source_is_local = check_local_path(source)
-
-    if not source_is_local:
-        raise ValueError("Invalid source path. Source must be a local path.")
-
-
-def eval_zip_type(source: str | list[str]) -> bool:
-    """
-    Evaluate zip type.
-
-    Parameters
-    ----------
-    source : str | list[str]
-        Source(s).
-
-    Returns
-    -------
-    bool
-        True if path is zip.
-    """
-    if isinstance(source, list):
-        if len(source) > 1:
-            return False
-        else:
-            path = source[0]
-    else:
-        if Path(source).is_dir():
-            return False
-        path = source
-
-    extension = path.endswith(".zip")
-    mime_zip = get_file_mime_type(path) == "application/zip"
-    return extension or mime_zip
-
-
-def build_log_path_from_filename(
-    project: str,
-    entity_type: str,
-    name: str,
-    uuid: str,
-    filename: str,
-) -> str:
-    """
-    Build log path.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    name : str
-        Object name.
-    uuid : str
-        Object UUID.
-    filename : str
-        Filename.
-
-    Returns
-    -------
-    str
-        Log path.
-    """
-    return f"s3://{get_s3_bucket()}/{project}/{entity_type}/{name}/{uuid}/{filename}"
-
-
-def build_log_path_from_source(
-    project: str,
-    entity_type: str,
-    name: str,
-    uuid: str,
-    source: str | list[str],
-) -> str:
-    """
-    Build log path.
-
-    Parameters
-    ----------
-    project : str
-        Project name.
-    entity_type : str
-        Entity type.
-    name : str
-        Object name.
-    uuid : str
-        Object UUID.
-    source : str | list[str]
-        Source(s).
-
-    Returns
-    -------
-    str
-        Log path.
-    """
-    is_zip = eval_zip_type(source)
-    scheme = "zip+s3" if is_zip else "s3"
-    path = f"{scheme}://{get_s3_bucket()}/{project}/{entity_type}/{name}/{uuid}"
-
-    if isinstance(source, list) and len(source) >= 1:
-        if len(source) > 1:
-            path += "/"
-        else:
-            path += f"/{Path(source[0]).name}"
-    elif Path(source).is_dir():
-        path += "/"
-    elif Path(source).is_file():
-        path += f"/{Path(source).name}"
-
-    return path
-
-
-def get_entity_type_from_key(key: str) -> str:
-    """
-    Get entity type.
-
-    Parameters
-    ----------
-    key : str
-        The key of the entity.
-
-    Returns
-    -------
-    str
-        The entity type.
-    """
-    _, entity_type, _, _, _ = parse_entity_key(key)
-    return entity_type