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

digitalhub/entities/trigger/crud.py

@@ -0,0 +1,303 @@
+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,
+    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 kwargs is None:
+        kwargs = {}
+    if template is None:
+        template = {}
+    template["task"] = task
+    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/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,22 @@
+from __future__ import annotations
+
+from digitalhub.entities.trigger._base.spec import TriggerSpec, TriggerValidator
+
+
+class TriggerSpecScheduler(TriggerSpec):
+    """
+    TriggerSpecScheduler specifications.
+    """
+
+    def __init__(self, task: str, function: str, template: dict, schedule: str) -> None:
+        super().__init__(task, function, template)
+        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)

digitalhub/factory/factory.py

@@ -8,7 +8,7 @@ if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.builder import EntityBuilder
     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.spec import Spec, SpecValidator
     from digitalhub.entities._base.entity.status import Status
     from digitalhub.entities._base.runtime_entity.builder import RuntimeEntityBuilder
     from digitalhub.runtimes._base import Runtime
@@ -17,7 +17,26 @@ if typing.TYPE_CHECKING:
 
 class Factory:
     """
-    Factory class for building entities and runtimes.
+    Factory for creating and managing entity and runtime builders.
+
+    This class implements the Factory pattern to manage the creation of
+    entities and runtimes through their respective builders. It maintains
+    separate registries for entity and runtime builders.
+
+    Many function arguments are called kind_to_build_from to avoid overwriting
+    kind in kwargs.
+
+    Attributes
+    ----------
+    _entity_builders : dict[str, EntityBuilder | RuntimeEntityBuilder]
+        Registry of entity builders indexed by kind.
+    _runtime_builders : dict[str, RuntimeBuilder]
+        Registry of runtime builders indexed by kind.
+
+    Notes
+    -----
+    All builder methods may raise BuilderError if the requested kind
+    is not found in the registry.
     """
 
     def __init__(self):
@@ -26,18 +45,19 @@ class Factory:
 
     def add_entity_builder(self, name: str, builder: EntityBuilder | RuntimeEntityBuilder) -> None:
         """
-        Add a builder to the factory.
+        Register an entity builder.
 
         Parameters
         ----------
         name : str
-            Builder name.
-        builder : EntityBuilder
-            Builder object.
-
-        Returns
-        -------
-        None
+            The unique identifier for the builder.
+        builder : EntityBuilder | RuntimeEntityBuilder
+            The builder instance to register.
+
+        Raises
+        ------
+        BuilderError
+            If a builder with the same name already exists.
         """
         if name in self._entity_builders:
             raise BuilderError(f"Builder {name} already exists.")
@@ -45,31 +65,30 @@ class Factory:
 
     def add_runtime_builder(self, name: str, builder: RuntimeBuilder) -> None:
         """
-        Add a builder to the factory.
+        Register a runtime builder.
 
         Parameters
         ----------
         name : str
-            Builder name.
+            The unique identifier for the builder.
         builder : RuntimeBuilder
-            Builder object.
+            The builder instance to register.
 
-        Returns
-        -------
-        None
+        Raises
+        ------
+        BuilderError
+            If a builder with the same name already exists.
         """
         if name in self._runtime_builders:
             raise BuilderError(f"Builder {name} already exists.")
         self._runtime_builders[name] = builder()
 
-    def build_entity_from_params(self, kind_to_build_from: str, **kwargs) -> Entity:
+    def build_entity_from_params(self, **kwargs) -> Entity:
         """
         Build an entity from parameters.
 
         Parameters
         ----------
-        kind_to_build_from : str
-            Entity type.
         **kwargs
             Entity parameters.
 
@@ -78,17 +97,20 @@ class Factory:
         Entity
             Entity object.
         """
-        return self._entity_builders[kind_to_build_from].build(**kwargs)
-
-    def build_entity_from_dict(self, kind_to_build_from: str, obj: dict) -> Entity:
+        try:
+            kind = kwargs["kind"]
+        except KeyError:
+            raise BuilderError("Missing 'kind' parameter.")
+        self._raise_if_entity_builder_not_found(kind)
+        return self._entity_builders[kind].build(**kwargs)
+
+    def build_entity_from_dict(self, obj: dict) -> Entity:
         """
         Build an entity from a dictionary.
 
         Parameters
         ----------
-        kind_to_build_from : str
-            Entity type.
-        dict_data : dict
+        obj : dict
             Dictionary with entity data.
 
         Returns
@@ -96,7 +118,12 @@ class Factory:
         Entity
             Entity object.
         """
-        return self._entity_builders[kind_to_build_from].from_dict(obj)
+        try:
+            kind = obj["kind"]
+        except KeyError:
+            raise BuilderError("Missing 'kind' parameter.")
+        self._raise_if_entity_builder_not_found(kind)
+        return self._entity_builders[kind].from_dict(obj)
 
     def build_spec(self, kind_to_build_from: str, **kwargs) -> Spec:
         """
@@ -112,6 +139,7 @@ class Factory:
         Spec
             Spec object.
         """
+        self._raise_if_entity_builder_not_found(kind_to_build_from)
         return self._entity_builders[kind_to_build_from].build_spec(**kwargs)
 
     def build_metadata(self, kind_to_build_from: str, **kwargs) -> Metadata:
@@ -128,6 +156,7 @@ class Factory:
         Metadata
             Metadata object.
         """
+        self._raise_if_entity_builder_not_found(kind_to_build_from)
         return self._entity_builders[kind_to_build_from].build_metadata(**kwargs)
 
     def build_status(self, kind_to_build_from: str, **kwargs) -> Status:
@@ -144,6 +173,7 @@ class Factory:
         Status
             Status object.
         """
+        self._raise_if_entity_builder_not_found(kind_to_build_from)
         return self._entity_builders[kind_to_build_from].build_status(**kwargs)
 
     def build_runtime(self, kind_to_build_from: str, project: str) -> Runtime:
@@ -162,6 +192,7 @@ class Factory:
         Runtime
             Runtime object.
         """
+        self._raise_if_runtime_builder_not_found(kind_to_build_from)
         return self._runtime_builders[kind_to_build_from].build(project=project)
 
     def get_entity_type_from_kind(self, kind: str) -> str:
@@ -178,6 +209,7 @@ class Factory:
         str
             Entity type.
         """
+        self._raise_if_entity_builder_not_found(kind)
         return self._entity_builders[kind].get_entity_type()
 
     def get_executable_kind(self, kind: str) -> str:
@@ -194,6 +226,7 @@ class Factory:
         str
             Executable kind.
         """
+        self._raise_if_entity_builder_not_found(kind)
         return self._entity_builders[kind].get_executable_kind()
 
     def get_action_from_task_kind(self, kind: str, task_kind: str) -> str:
@@ -212,6 +245,7 @@ class Factory:
         str
             Action.
         """
+        self._raise_if_entity_builder_not_found(kind)
         return self._entity_builders[kind].get_action_from_task_kind(task_kind)
 
     def get_task_kind_from_action(self, kind: str, action: str) -> list[str]:
@@ -230,6 +264,7 @@ class Factory:
         list[str]
             Task kinds.
         """
+        self._raise_if_entity_builder_not_found(kind)
         return self._entity_builders[kind].get_task_kind_from_action(action)
 
     def get_run_kind(self, kind: str) -> str:
@@ -246,6 +281,7 @@ class Factory:
         str
             Run kind.
         """
+        self._raise_if_entity_builder_not_found(kind)
         return self._entity_builders[kind].get_run_kind()
 
     def get_all_kinds(self, kind: str) -> list[str]:
@@ -264,5 +300,56 @@ class Factory:
         """
         return self._entity_builders[kind].get_all_kinds()
 
+    def get_spec_validator(self, kind: str) -> SpecValidator:
+        """
+        Get spec validators.
+
+        Parameters
+        ----------
+        kind : str
+            Kind.
+
+        Returns
+        -------
+        SpecValidator
+            Spec validator.
+        """
+        self._raise_if_entity_builder_not_found(kind)
+        return self._entity_builders[kind].get_spec_validator()
+
+    def _raise_if_entity_builder_not_found(self, kind: str) -> None:
+        """
+        Verify entity builder existence.
+
+        Parameters
+        ----------
+        kind : str
+            The entity kind to verify.
+
+        Raises
+        ------
+        BuilderError
+            If no builder exists for the specified kind.
+        """
+        if kind not in self._entity_builders:
+            raise BuilderError(f"Entity builder for kind '{kind}' not found.")
+
+    def _raise_if_runtime_builder_not_found(self, kind: str) -> None:
+        """
+        Verify runtime builder existence.
+
+        Parameters
+        ----------
+        kind : str
+            The runtime kind to verify.
+
+        Raises
+        ------
+        BuilderError
+            If no builder exists for the specified kind.
+        """
+        if kind not in self._runtime_builders:
+            raise BuilderError(f"Runtime builder for kind '{kind}' not found.")
+
 
 factory = Factory()