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

digitalhub/entities/workflow/_base/entity.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.executable.entity import ExecutableEntity
+from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.factory.api import get_run_kind, get_task_kind_from_action
+from digitalhub.utils.exceptions import BackendError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.run._base.entity import Run
+    from digitalhub.entities.workflow._base.spec import WorkflowSpec
+    from digitalhub.entities.workflow._base.status import WorkflowStatus
+
+
+class Workflow(ExecutableEntity):
+    """
+    A class representing a workflow.
+    """
+
+    ENTITY_TYPE = EntityTypes.WORKFLOW.value
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: WorkflowSpec,
+        status: WorkflowStatus,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: WorkflowSpec
+        self.status: WorkflowStatus
+
+    ##############################
+    #  Workflow Methods
+    ##############################
+
+    def run(self, action: str | None = None, **kwargs) -> Run:
+        """
+        Run workflow.
+
+        Parameters
+        ----------
+        action : str
+            Action to execute.
+        **kwargs : dict
+            Keyword arguments passed to Run builder.
+
+        Returns
+        -------
+        Run
+            Run instance.
+        """
+        if action is None:
+            action = "pipeline"
+
+        # Get task and run kind
+        task_kind = get_task_kind_from_action(self.kind, action)
+        run_kind = get_run_kind(self.kind)
+
+        # Create or update new task
+        task = self._get_or_create_task(task_kind)
+
+        # Raise error if execution is not done by DHCore backend
+        if self._context().local:
+            raise BackendError("Cannot run workflow with local backend.")
+
+        return task.run(run_kind, local_execution=False, **kwargs)

digitalhub/entities/workflow/_base/spec.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.entity.spec import Spec, SpecValidator
+
+
+class WorkflowSpec(Spec):
+    """
+    WorkflowSpec specifications.
+    """
+
+
+class WorkflowValidator(SpecValidator):
+    """
+    WorkflowValidator validator.
+    """

digitalhub/entities/workflow/_base/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.entity.status import Status
+
+
+class WorkflowStatus(Status):
+    """
+    WorkflowStatus status.
+    """

digitalhub/entities/workflow/crud.py

@@ -0,0 +1,278 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.crud import (
+    delete_entity,
+    get_context_entity_versions,
+    get_versioned_entity,
+    import_executable_entity,
+    list_context_entities,
+    new_context_entity,
+)
+from digitalhub.entities.utils.entity_types import EntityTypes
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.workflow._base.entity import Workflow
+
+
+ENTITY_TYPE = EntityTypes.WORKFLOW.value
+
+
+def new_workflow(
+    project: str,
+    name: str,
+    kind: str,
+    uuid: str | None = None,
+    description: str | None = None,
+    labels: list[str] | None = None,
+    embedded: bool = False,
+    **kwargs,
+) -> Workflow:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    name : str
+        Object name.
+    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.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Workflow
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = new_function(project="my-project",
+    >>>                    name="my-workflow",
+    >>>                    kind="kfp",
+    >>>                    code_src="pipeline.py",
+    >>>                    handler="pipeline-handler")
+    """
+    return new_context_entity(
+        project=project,
+        name=name,
+        kind=kind,
+        uuid=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+        **kwargs,
+    )
+
+
+def get_workflow(
+    identifier: str,
+    project: str | None = None,
+    entity_id: str | None = None,
+    **kwargs,
+) -> Workflow:
+    """
+    Get object from backend.
+
+    Parameters
+    ----------
+    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
+    -------
+    Workflow
+        Object instance.
+
+    Examples
+    --------
+    Using entity key:
+    >>> obj = get_workflow("store://my-workflow-key")
+
+    Using entity name:
+    >>> obj = get_workflow("my-workflow-name"
+    >>>                    project="my-project",
+    >>>                    entity_id="my-workflow-id")
+    """
+    return get_versioned_entity(
+        identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        **kwargs,
+    )
+
+
+def get_workflow_versions(
+    identifier: str,
+    project: str | None = None,
+    **kwargs,
+) -> list[Workflow]:
+    """
+    Get object versions from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity name.
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[Workflow]
+        List of object instances.
+
+    Examples
+    --------
+    Using entity key:
+    >>> obj = get_workflow_versions("store://my-workflow-key")
+
+    Using entity name:
+    >>> obj = get_workflow_versions("my-workflow-name"
+    >>>                             project="my-project")
+    """
+    return get_context_entity_versions(
+        identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        **kwargs,
+    )
+
+
+def list_workflows(project: str, **kwargs) -> list[Workflow]:
+    """
+    List all latest version objects from backend.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[Workflow]
+        List of object instances.
+
+    Examples
+    --------
+    >>> objs = list_workflows(project="my-project")
+    """
+    return list_context_entities(
+        project=project,
+        entity_type=ENTITY_TYPE,
+        **kwargs,
+    )
+
+
+def import_workflow(file: str) -> Workflow:
+    """
+    Import object from a YAML file.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    Workflow
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = import_workflow("my-workflow.yaml")
+    """
+    return import_executable_entity(file)
+
+
+def update_workflow(entity: Workflow) -> Workflow:
+    """
+    Update object. Note that object spec are immutable.
+
+    Parameters
+    ----------
+    entity : Workflow
+        Object to update.
+
+    Returns
+    -------
+    Workflow
+        Entity updated.
+
+    Examples
+    --------
+    >>> obj = update_workflow(obj)
+    """
+    return entity.save(update=True)
+
+
+def delete_workflow(
+    identifier: str,
+    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.
+    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.
+
+    Examples
+    --------
+    If delete_all_versions is False:
+    >>> obj = delete_workflow("store://my-workflow-key")
+
+    Otherwise:
+    >>> obj = delete_workflow("workflow-name",
+    >>>                       project="my-project",
+    >>>                       delete_all_versions=True)
+    """
+    return delete_entity(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        delete_all_versions=delete_all_versions,
+        cascade=cascade,
+        **kwargs,
+    )

digitalhub/factory/api.py

@@ -0,0 +1,277 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.factory.factory import factory
+from digitalhub.utils.exceptions import BuilderError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.entity import Entity
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.status import Status
+    from digitalhub.runtimes._base import Runtime
+
+
+def build_entity_from_params(**kwargs) -> Entity:
+    """
+    Build an entity.
+
+    Parameters
+    ----------
+    **kwargs
+        Entity parameters.
+
+    Returns
+    -------
+    Entity
+        Entity object.
+    """
+    try:
+        kind = kwargs["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    _raise_if_entity_builder_not_found(kind)
+    return factory.build_entity_from_params(kind, **kwargs)
+
+
+def build_entity_from_dict(obj: dict) -> Entity:
+    """
+    Build an entity from a dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary with entity data.
+
+    Returns
+    -------
+    Entity
+        Entity object.
+    """
+    try:
+        kind = obj["kind"]
+    except KeyError:
+        raise BuilderError("Missing 'kind' parameter.")
+    _raise_if_entity_builder_not_found(kind)
+    return factory.build_entity_from_dict(kind, obj)
+
+
+def build_spec(kind_to_build_from: str, **kwargs) -> Spec:
+    """
+    Build an entity spec.
+
+    Parameters
+    ----------
+    kind_to_build_from : str
+        Entity type.
+
+    Returns
+    -------
+    Spec
+        Spec object.
+    """
+    _raise_if_entity_builder_not_found(kind_to_build_from)
+    return factory.build_spec(kind_to_build_from, **kwargs)
+
+
+def build_metadata(kind_to_build_from: str, **kwargs) -> Metadata:
+    """
+    Build an entity metadata.
+
+    Parameters
+    ----------
+    kind_to_build_from : str
+        Entity type.
+
+    Returns
+    -------
+    Metadata
+        Metadata object.
+    """
+    _raise_if_entity_builder_not_found(kind_to_build_from)
+    return factory.build_metadata(kind_to_build_from, **kwargs)
+
+
+def build_status(kind_to_build_from: str, **kwargs) -> Status:
+    """
+    Build an entity status.
+
+    Parameters
+    ----------
+    kind_to_build_from : str
+        Entity type.
+
+    Returns
+    -------
+    Status
+        Status object.
+    """
+    _raise_if_entity_builder_not_found(kind_to_build_from)
+    return factory.build_status(kind_to_build_from, **kwargs)
+
+
+def build_runtime(kind_to_build_from: str, project: str) -> Runtime:
+    """
+    Build a runtime.
+
+    Parameters
+    ----------
+    kind_to_build_from : str
+        Runtime type.
+    project : str
+        Project name.
+
+    Returns
+    -------
+    Runtime
+        Runtime object.
+    """
+    _raise_if_runtime_builder_not_found(kind_to_build_from)
+    return factory.build_runtime(kind_to_build_from, project)
+
+
+def get_entity_type_from_kind(kind: str) -> str:
+    """
+    Get entity type from builder.
+
+    Parameters
+    ----------
+    kind : str
+        Entity type.
+
+    Returns
+    -------
+    str
+        Entity type.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_entity_type_from_kind(kind)
+
+
+def get_all_kinds(kind: str) -> list[str]:
+    """
+    Get all kinds.
+
+    Parameters
+    ----------
+    kind : str
+        Kind.
+
+    Returns
+    -------
+    list[str]
+        All entities runtime kinds.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_all_kinds(kind)
+
+
+def get_executable_kind(kind: str) -> str:
+    """
+    Get executable kind.
+
+    Parameters
+    ----------
+    kind : str
+        Kind.
+
+    Returns
+    -------
+    str
+        Executable kind.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_executable_kind(kind)
+
+
+def get_task_kind_from_action(kind: str, action: str) -> str:
+    """
+    Get task kinds from action.
+
+    Parameters
+    ----------
+    kind : str
+        Kind.
+    action : str
+        Action.
+
+    Returns
+    -------
+    str
+        Task kind.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_task_kind_from_action(kind, action)
+
+
+def get_action_from_task_kind(kind: str, task_kind: str) -> str:
+    """
+    Get action from task.
+
+    Parameters
+    ----------
+    kind : str
+        Kind.
+    task_kind : str
+        Task kind.
+
+    Returns
+    -------
+    str
+        Action.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_action_from_task_kind(kind, task_kind)
+
+
+def get_run_kind(kind: str) -> str:
+    """
+    Get run kind.
+
+    Parameters
+    ----------
+    kind : str
+        Kind.
+
+    Returns
+    -------
+    str
+        Run kind.
+    """
+    _raise_if_entity_builder_not_found(kind)
+    return factory.get_run_kind(kind)
+
+
+def _raise_if_entity_builder_not_found(kind: str) -> None:
+    """
+    Raise error if entity builder not found.
+
+    Parameters
+    ----------
+    kind : str
+        Entity type.
+
+    Returns
+    -------
+    None
+    """
+    if kind not in factory._entity_builders:
+        raise BuilderError(f"Builder for kind '{kind}' not found.")
+
+
+def _raise_if_runtime_builder_not_found(kind: str) -> None:
+    """
+    Raise error if runtime builder not found.
+
+    Parameters
+    ----------
+    kind : str
+        Runtime type.
+
+    Returns
+    -------
+    None
+    """
+    if kind not in factory._runtime_builders:
+        raise BuilderError(f"Builder for kind '{kind}' not found.")