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

digitalhub/entities/task/_base/models.py

@@ -0,0 +1,208 @@
+from __future__ import annotations
+
+from pydantic import BaseModel, Field
+from typing_extensions import Literal
+
+
+class Volume(BaseModel):
+    """
+    Volume model.
+    """
+
+    volume_type: Literal["persistent_volume_claim", "empty_dir"]
+    """Volume type."""
+
+    name: str
+    """Volume name."""
+
+    mount_path: str
+    """Volume mount path inside the container."""
+
+    spec: dict[str, str]
+    """Volume spec."""
+
+
+class NodeSelector(BaseModel):
+    """
+    NodeSelector model.
+    """
+
+    key: str
+    """Node selector key."""
+
+    value: str
+    """Node selector value."""
+
+
+class ResourceItem(BaseModel):
+    """
+    Resource item model.
+    """
+
+    requests: str = Field(default=None, regex=r"[\d]+|^([0-9])+([a-zA-Z])+$")
+    """Resource requests."""
+
+    limits: str = Field(default=None, regex=r"[\d]+|^([0-9])+([a-zA-Z])+$")
+    """Resource limits."""
+
+
+class Resource(BaseModel):
+    """
+    Resource model.
+    """
+
+    cpu: ResourceItem = None
+    """CPU resource model."""
+
+    mem: ResourceItem = None
+    """Memory resource model."""
+
+    gpu: ResourceItem = None
+    """GPU resource model."""
+
+
+class Env(BaseModel):
+    """
+    Env variable model.
+    """
+
+    name: str
+    """Env variable name."""
+
+    value: str
+    """Env variable value."""
+
+
+class Toleration(BaseModel):
+    """
+    Toleration model.
+    """
+
+    key: str = None
+    """Toleration key."""
+
+    operator: str = None
+    """Toleration operator."""
+
+    value: str = None
+    """Toleration value."""
+
+    effect: str = None
+    """Toleration effect."""
+
+    toleration_seconds: int = None
+    """Toleration seconds."""
+
+
+class V1NodeSelectorRequirement(BaseModel):
+    key: str
+    operator: str
+    values: list[str] = None
+
+
+class V1NodeSelectorTerm(BaseModel):
+    match_expressions: list[V1NodeSelectorRequirement] = None
+    match_fields: list[V1NodeSelectorRequirement] = None
+
+
+class V1NodeSelector(BaseModel):
+    node_selector_terms: list[V1NodeSelectorTerm]
+
+
+class V1PreferredSchedulingTerm(BaseModel):
+    preference: V1NodeSelector
+    weight: int
+
+
+class V1LabelSelectorRequirement(BaseModel):
+    key: str
+    operator: str
+    values: list[str] = None
+
+
+class V1LabelSelector(BaseModel):
+    match_expressions: list[V1LabelSelectorRequirement] = None
+    match_labels: dict[str, str] = None
+
+
+class V1PodAffinityTerm(BaseModel):
+    label_selector: V1LabelSelector = None
+    match_label_keys: list[str] = None
+    mismatch_label_keys: list[str] = None
+    namespace_selector: V1LabelSelector = None
+    namespaces: list[str] = None
+    topology_key: str
+
+
+class V1WeightedPodAffinityTerm(BaseModel):
+    pod_affinity_term: V1PodAffinityTerm
+    weight: int
+
+
+class V1NodeAffinity(BaseModel):
+    preferred_during_scheduling_ignored_during_execution: list[V1PreferredSchedulingTerm] = None
+    required_during_scheduling_ignored_during_execution: V1NodeSelector = None
+
+
+class V1PodAffinity(BaseModel):
+    preferred_during_scheduling_ignored_during_execution: list[V1WeightedPodAffinityTerm] = None
+    required_during_scheduling_ignored_during_execution: list[V1PodAffinityTerm] = None
+
+
+class V1PodAntiAffinity(BaseModel):
+    preferred_during_scheduling_ignored_during_execution: list[V1WeightedPodAffinityTerm] = None
+    required_during_scheduling_ignored_during_execution: list[V1PodAffinityTerm] = None
+
+
+class Affinity(BaseModel):
+    """
+    Affinity model.
+    """
+
+    node_affinity: V1NodeAffinity = None
+    """Node affinity."""
+
+    pod_affinity: V1PodAffinity = None
+    """Pod affinity."""
+
+    pod_anti_affinity: V1PodAntiAffinity = None
+    """Pod anti affinity."""
+
+
+class K8s(BaseModel):
+    """
+    Kubernetes resource model.
+    """
+
+    node_selector: list[NodeSelector] = None
+    """Node selector."""
+
+    volumes: list[Volume] = None
+    """List of volumes."""
+
+    resources: Resource = None
+    """Resources restrictions."""
+
+    affinity: Affinity = None
+    """Affinity."""
+
+    tolerations: list[Toleration] = None
+    """Tolerations."""
+
+    envs: list[Env] = None
+    """Env variables."""
+
+    secrets: list[str] = None
+    """List of secret names."""
+
+    profile: str = None
+    """Profile template."""
+
+
+class CorePort(BaseModel):
+    """
+    Port mapper model.
+    """
+
+    port: int
+    target_port: int

digitalhub/entities/task/_base/spec.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.entity.spec import Spec, SpecValidator
+from digitalhub.entities.task._base.models import K8s
+
+
+class TaskSpec(Spec):
+    """TaskSpec specifications."""
+
+    def __init__(self, function: str) -> None:
+        self.function = function
+
+
+class TaskSpecK8s(TaskSpec):
+    """TaskSpecK8s specifications."""
+
+    def __init__(
+        self,
+        function: str,
+        node_selector: dict | None = None,
+        volumes: list | None = None,
+        resources: dict | None = None,
+        affinity: dict | None = None,
+        tolerations: list | None = None,
+        envs: list | None = None,
+        secrets: list | None = None,
+        profile: str | None = None,
+        **kwargs,
+    ) -> None:
+        super().__init__(function)
+        self.node_selector = node_selector
+        self.volumes = volumes
+        self.resources = resources
+        self.affinity = affinity
+        self.tolerations = tolerations
+        self.envs = envs
+        self.secrets = secrets
+        self.profile = profile
+
+
+class TaskValidator(SpecValidator):
+    """
+    TaskValidator validator.
+    """
+
+    function: str
+    """Function string."""
+
+
+class TaskValidatorK8s(TaskValidator, K8s):
+    """
+    TaskValidatorK8s validator.
+    """

digitalhub/entities/task/_base/status.py

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

digitalhub/entities/task/crud.py

@@ -0,0 +1,228 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.crud import (
+    delete_entity,
+    get_unversioned_entity,
+    import_context_entity,
+    list_context_entities,
+    new_context_entity,
+)
+from digitalhub.entities.utils.entity_types import EntityTypes
+from digitalhub.utils.exceptions import EntityError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.task._base.entity import Task
+
+
+ENTITY_TYPE = EntityTypes.TASK.value
+
+
+def new_task(
+    project: str,
+    kind: str,
+    uuid: str | None = None,
+    labels: list[str] | None = None,
+    function: str | None = None,
+    **kwargs,
+) -> Task:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    kind : str
+        Kind the object.
+    uuid : str
+        ID of the object.
+    labels : list[str]
+        List of labels.
+    function : str
+        Name of the executable associated with the task.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Task
+        Object instance.
+
+    Examples
+    --------
+    >>> obj = new_task(project="my-project",
+    >>>                kind="python+job",
+    >>>                function="function-string")
+    """
+    return new_context_entity(
+        project=project,
+        kind=kind,
+        uuid=uuid,
+        labels=labels,
+        function=function,
+        **kwargs,
+    )
+
+
+def get_task(
+    identifier: str,
+    project: str | None = None,
+    **kwargs,
+) -> Task:
+    """
+    Get object from backend.
+
+    Parameters
+    ----------
+    identifier : str
+        Entity key (store://...) or entity ID.
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    Task
+        Object instance.
+
+    Examples
+    --------
+    Using entity key:
+    >>> obj = get_task("store://my-task-key")
+
+    Using entity ID:
+    >>> obj = get_task("my-task-id"
+    >>>               project="my-project")
+    """
+    return get_unversioned_entity(
+        identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        **kwargs,
+    )
+
+
+def list_tasks(project: str, **kwargs) -> list[Task]:
+    """
+    List all latest version objects from backend.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    **kwargs : dict
+        Parameters to pass to the API call.
+
+    Returns
+    -------
+    list[Task]
+        List of object instances.
+
+    Examples
+    --------
+    >>> objs = list_tasks(project="my-project")
+    """
+    return list_context_entities(
+        project=project,
+        entity_type=ENTITY_TYPE,
+        **kwargs,
+    )
+
+
+def import_task(file: str) -> Task:
+    """
+    Get object from file.
+
+    Parameters
+    ----------
+    file : str
+        Path to YAML file.
+
+    Returns
+    -------
+    Task
+        Object instance.
+
+    Example
+    -------
+    >>> obj = import_task("my-task.yaml")
+    """
+    return import_context_entity(file)
+
+
+def update_task(entity: Task) -> Task:
+    """
+    Update object. Note that object spec are immutable.
+
+    Parameters
+    ----------
+    entity : Task
+        Object to update.
+
+    Returns
+    -------
+    Task
+        Entity updated.
+
+    Examples
+    --------
+    >>> obj = update_task(obj)
+    """
+    return entity.save(update=True)
+
+
+def delete_task(
+    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_task("store://my-task-key")
+
+    Otherwise:
+    >>> obj = delete_task("task-name",
+    >>>                  project="my-project",
+    >>>                  delete_all_versions=True)
+    """
+    if not identifier.startswith("store://"):
+        raise EntityError("Task has no name. Use key instead.")
+    return delete_entity(
+        identifier=identifier,
+        entity_type=ENTITY_TYPE,
+        project=project,
+        entity_id=entity_id,
+        delete_all_versions=delete_all_versions,
+        cascade=cascade,
+        **kwargs,
+    )