digitalhub 0.10.2__py3-none-any.whl → 0.11.0__py3-none-any.whl

digitalhub/entities/trigger/_base/status.py

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

digitalhub/entities/trigger/crud.py

@@ -0,0 +1,309 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._commons.enums import EntityTypes
+from digitalhub.entities._processors.context import context_processor
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.trigger._base.entity import Trigger
+
+
+ENTITY_TYPE = EntityTypes.TRIGGER.value
+
+
+def new_trigger(
+    project: str,
+    name: str,
+    kind: str,
+    task: str,
+    function: str | None = None,
+    workflow: str | None = None,
+    uuid: str | None = None,
+    description: str | None = None,
+    labels: list[str] | None = None,
+    embedded: bool = False,
+    template: dict | None = None,
+    **kwargs,
+) -> Trigger:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    name : str
+        Object 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.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Trigger
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = new_trigger(project="my-project",
+    >>>                   kind="trigger",
+    >>>                   name="my-trigger",)
+    """
+    if workflow is None and function is None:
+        raise ValueError("Workflow or function must be provided")
+    if kwargs is None:
+        kwargs = {}
+    if template is None:
+        template = {}
+    template["task"] = task
+    if workflow is not None:
+        template["workflow"] = workflow
+    if function is not None:
+        template["function"] = function
+    kwargs["template"] = template
+    return context_processor.create_context_entity(
+        project=project,
+        name=name,
+        kind=kind,
+        uuid=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+        **kwargs,
+    )
+
+
+def get_trigger(
+    identifier: str,
+    project: str | None = None,
+    entity_id: str | None = None,
+    **kwargs,
+) -> Trigger:
+    """
+    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
+    -------
+    Trigger
+        Object instance.
+
+    Examples
+    --------
+    Using entity key:
+    >>> obj = get_trigger("store://my-trigger-key")
+
+    Using entity name:
+    >>> obj = get_trigger("my-trigger-name"
+    >>>                  project="my-project",
+    >>>                  entity_id="my-trigger-id")
+    """
+    return context_processor.read_context_entity(
+        identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        **kwargs,
+    )
+
+
+def get_trigger_versions(
+    identifier: str,
+    project: str | None = None,
+    **kwargs,
+) -> list[Trigger]:
+    """
+    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[Trigger]
+        List of object instances.
+
+    Examples
+    --------
+    Using entity key:
+    >>> objs = get_trigger_versions("store://my-trigger-key")
+
+    Using entity name:
+    >>> objs = get_trigger_versions("my-trigger-name",
+    >>>                            project="my-project")
+    """
+    return context_processor.read_context_entity_versions(
+        identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        **kwargs,
+    )
+
+
+def list_triggers(project: str, **kwargs) -> list[Trigger]:
+    """
+    List all latest version objects from backend.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[Trigger]
+        List of object instances.
+
+    Examples
+    --------
+    >>> objs = list_triggers(project="my-project")
+    """
+    return context_processor.list_context_entities(
+        project=project,
+        entity_type=ENTITY_TYPE,
+        **kwargs,
+    )
+
+
+def import_trigger(file: str) -> Trigger:
+    """
+    Import object from a YAML file and create a new object into the backend.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    Trigger
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = import_trigger("my-trigger.yaml")
+    """
+    return context_processor.import_context_entity(file)
+
+
+def load_trigger(file: str) -> Trigger:
+    """
+    Load object from a YAML file and update an existing object into the backend.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    Trigger
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = load_trigger("my-trigger.yaml")
+    """
+    return context_processor.load_context_entity(file)
+
+
+def update_trigger(entity: Trigger) -> Trigger:
+    """
+    Update object. Note that object spec are immutable.
+
+    Parameters
+    ----------
+    entity : Trigger
+        Object to update.
+
+    Returns
+    -------
+    Trigger
+        Entity updated.
+
+    Examples
+    --------
+    >>> obj = update_trigger(obj)
+    """
+    return context_processor.update_context_entity(
+        project=entity.project,
+        entity_type=entity.ENTITY_TYPE,
+        entity_id=entity.id,
+        entity_dict=entity.to_dict(),
+    )
+
+
+def delete_trigger(
+    identifier: str,
+    project: str | None = None,
+    entity_id: str | None = None,
+    delete_all_versions: bool = False,
+    **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.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    dict
+        Response from backend.
+
+    Examples
+    --------
+    If delete_all_versions is False:
+    >>> obj = delete_trigger("store://my-trigger-key")
+
+    Otherwise:
+    >>> obj = delete_trigger("my-trigger-name"
+    >>>                     project="my-project",
+    >>>                     delete_all_versions=True)
+    """
+    return context_processor.delete_context_entity(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        delete_all_versions=delete_all_versions,
+        **kwargs,
+    )

digitalhub/entities/trigger/lifecycle/builder.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from digitalhub.entities._commons.enums import EntityKinds
+from digitalhub.entities.trigger._base.builder import TriggerBuilder
+from digitalhub.entities.trigger.lifecycle.entity import TriggerLifecycle
+from digitalhub.entities.trigger.lifecycle.spec import TriggerSpecLifecycle, TriggerValidatorLifecycle
+from digitalhub.entities.trigger.lifecycle.status import TriggerStatusLifecycle
+
+
+class TriggerLifecycleBuilder(TriggerBuilder):
+    """
+    TriggerLifecycle builder.
+    """
+
+    ENTITY_CLASS = TriggerLifecycle
+    ENTITY_SPEC_CLASS = TriggerSpecLifecycle
+    ENTITY_SPEC_VALIDATOR = TriggerValidatorLifecycle
+    ENTITY_STATUS_CLASS = TriggerStatusLifecycle
+    ENTITY_KIND = EntityKinds.TRIGGER_LIFECYCLE.value

digitalhub/entities/trigger/lifecycle/entity.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities.trigger._base.entity import Trigger
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.trigger.lifecycle.spec import TriggerSpecLifecycle
+    from digitalhub.entities.trigger.lifecycle.status import TriggerStatusLifecycle
+
+
+class TriggerLifecycle(Trigger):
+    """
+    TriggerLifecycle class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: TriggerSpecLifecycle,
+        status: TriggerStatusLifecycle,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: TriggerSpecLifecycle
+        self.status: TriggerStatusLifecycle

digitalhub/entities/trigger/lifecycle/spec.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from pydantic import Field
+
+from digitalhub.entities.trigger._base.spec import TriggerSpec, TriggerValidator
+
+regexp = r"store://([^/]+)/(.+)"
+
+
+class TriggerSpecLifecycle(TriggerSpec):
+    """
+    TriggerSpecLifecycle specifications.
+    """
+
+    def __init__(
+        self,
+        task: str,
+        template: dict,
+        function: str | None = None,
+        workflow: str | None = None,
+        key: str | None = None,
+        states: list[str] | None = None,
+    ) -> None:
+        super().__init__(task, template, function, workflow)
+        self.key = key
+        self.states = states
+
+
+class TriggerValidatorLifecycle(TriggerValidator):
+    """
+    TriggerValidatorLifecycle validator.
+    """
+
+    key: str = Field(pattern=regexp)
+    """Entity key."""
+
+    states: list[str] = None
+    """List of entity states."""

digitalhub/entities/trigger/lifecycle/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities.trigger._base.status import TriggerStatus
+
+
+class TriggerStatusLifecycle(TriggerStatus):
+    """
+    TriggerStatusLifecycle status.
+    """

digitalhub/entities/trigger/scheduler/builder.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from digitalhub.entities._commons.enums import EntityKinds
+from digitalhub.entities.trigger._base.builder import TriggerBuilder
+from digitalhub.entities.trigger.scheduler.entity import TriggerScheduler
+from digitalhub.entities.trigger.scheduler.spec import TriggerSpecScheduler, TriggerValidatorScheduler
+from digitalhub.entities.trigger.scheduler.status import TriggerStatusScheduler
+
+
+class TriggerSchedulerBuilder(TriggerBuilder):
+    """
+    TriggerScheduler builder.
+    """
+
+    ENTITY_CLASS = TriggerScheduler
+    ENTITY_SPEC_CLASS = TriggerSpecScheduler
+    ENTITY_SPEC_VALIDATOR = TriggerValidatorScheduler
+    ENTITY_STATUS_CLASS = TriggerStatusScheduler
+    ENTITY_KIND = EntityKinds.TRIGGER_SCHEDULER.value

digitalhub/entities/trigger/scheduler/entity.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities.trigger._base.entity import Trigger
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities.trigger.scheduler.spec import TriggerSpecScheduler
+    from digitalhub.entities.trigger.scheduler.status import TriggerStatusScheduler
+
+
+class TriggerScheduler(Trigger):
+    """
+    TriggerScheduler class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: TriggerSpecScheduler,
+        status: TriggerStatusScheduler,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: TriggerSpecScheduler
+        self.status: TriggerStatusScheduler

digitalhub/entities/trigger/scheduler/spec.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from digitalhub.entities.trigger._base.spec import TriggerSpec, TriggerValidator
+
+
+class TriggerSpecScheduler(TriggerSpec):
+    """
+    TriggerSpecScheduler specifications.
+    """
+
+    def __init__(
+        self,
+        task: str,
+        template: dict,
+        function: str | None = None,
+        workflow: str | None = None,
+        schedule: str | None = None,
+    ) -> None:
+        super().__init__(task, template, function, workflow)
+        self.schedule = schedule
+
+
+class TriggerValidatorScheduler(TriggerValidator):
+    """
+    TriggerValidatorScheduler validator.
+    """
+
+    schedule: str
+    """Quartz cron expression."""

digitalhub/entities/trigger/scheduler/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities.trigger._base.status import TriggerStatus
+
+
+class TriggerStatusScheduler(TriggerStatus):
+    """
+    TriggerStatusScheduler status.
+    """

digitalhub/entities/workflow/_base/entity.py

@@ -4,7 +4,7 @@ import typing
 
 from digitalhub.entities._base.executable.entity import ExecutableEntity
 from digitalhub.entities._commons.enums import EntityTypes, Relationship
-from digitalhub.factory.api import get_run_kind, get_task_kind_from_action
+from digitalhub.factory.factory import factory
 from digitalhub.utils.exceptions import BackendError
 
 if typing.TYPE_CHECKING:
@@ -68,8 +68,8 @@ class Workflow(ExecutableEntity):
             Run instance.
         """
         # Get task and run kind
-        task_kind = get_task_kind_from_action(self.kind, action)
-        run_kind = get_run_kind(self.kind)
+        task_kind = factory.get_task_kind_from_action(self.kind, action)
+        run_kind = factory.get_run_kind(self.kind)
 
         # Create or update new task
         task = self._get_or_create_task(task_kind)