digitalhub 0.13.3__py3-none-any.whl → 0.14.0__py3-none-any.whl

digitalhub/entities/_base/runtime_entity/builder.py

@@ -4,6 +4,7 @@
 
 from __future__ import annotations
 
+from digitalhub.entities._commons.utils import KindAction
 from digitalhub.utils.exceptions import EntityError
 
 
@@ -13,16 +14,40 @@ class RuntimeEntityBuilder:
     """
 
     EXECUTABLE_KIND: str = None
-    TASKS_KINDS: dict = None
-    RUN_KIND: str = None
+    TASKS_KINDS: list[KindAction] = None
+    RUN_KINDS: list[KindAction] = None
 
     def __init__(self) -> None:
-        if self.EXECUTABLE_KIND is None:
-            raise EntityError("EXECUTABLE_KIND must be set")
-        if self.TASKS_KINDS is None:
-            raise EntityError("TASKS_KINDS must be set")
-        if self.RUN_KIND is None:
-            raise EntityError("RUN_KIND must be set")
+        self._validate()
+
+    def _validate(self) -> None:
+        """
+        Validate the entity.
+        """
+        for attr_name in ["EXECUTABLE_KIND", "TASKS_KINDS", "RUN_KINDS"]:
+            value = getattr(self, attr_name)
+            if value is None:
+                raise EntityError(f"{attr_name} must be set")
+
+        for attr_name in ["TASKS_KINDS", "RUN_KINDS"]:
+            self._instance_validation(getattr(self, attr_name))
+
+    def _instance_validation(self, attribute: list[KindAction]) -> None:
+        """
+        Validate if the attribute is a list of KindAction.
+
+        Parameters
+        ----------
+        attribute : list[KindAction]
+            Attribute to validate.
+        """
+        if not isinstance(attribute, list):
+            raise EntityError(f"{attribute} must be a list")
+        for i in attribute:
+            if not isinstance(i, KindAction):
+                raise EntityError(f"{attribute} must be a list of KindAction")
+            if i.kind is None:
+                raise EntityError(f"{attribute} must be a list of KindAction with kind set")
 
     def get_action_from_task_kind(self, task_kind: str) -> str:
         """
@@ -39,8 +64,8 @@ class RuntimeEntityBuilder:
             Action.
         """
         for task in self.TASKS_KINDS:
-            if task["kind"] == task_kind:
-                return task["action"]
+            if task.kind == task_kind:
+                return task.action
         msg = f"Task kind {task_kind} not allowed."
         raise EntityError(msg)
 
@@ -59,21 +84,30 @@ class RuntimeEntityBuilder:
             Task kinds.
         """
         for task in self.TASKS_KINDS:
-            if task["action"] == action:
-                return task["kind"]
+            if task.action == action:
+                return task.kind
         msg = f"Action {action} not allowed."
         raise EntityError(msg)
 
-    def get_run_kind(self) -> str:
+    def get_run_kind_from_action(self, action: str) -> str:
         """
-        Get run kind.
+        Get run kind from action.
+
+        Parameters
+        ----------
+        action : str
+            Action.
 
         Returns
         -------
         str
             Run kind.
         """
-        return self.RUN_KIND
+        for run in self.RUN_KINDS:
+            if run.action == action:
+                return run.kind
+        msg = f"Action {action} not allowed."
+        raise EntityError(msg)
 
     def get_executable_kind(self) -> str:
         """
@@ -95,8 +129,9 @@ class RuntimeEntityBuilder:
         list[str]
             All kinds.
         """
-        task_kinds = [i["kind"] for i in self.TASKS_KINDS]
-        return [self.EXECUTABLE_KIND, self.RUN_KIND, *task_kinds]
+        task_kinds = [i.kind for i in self.TASKS_KINDS]
+        run_kinds = [i.kind for i in self.RUN_KINDS]
+        return [self.EXECUTABLE_KIND, *run_kinds, *task_kinds]
 
     def get_all_actions(self) -> list[str]:
         """
@@ -107,4 +142,4 @@ class RuntimeEntityBuilder:
         list[str]
             All actions.
         """
-        return [i["action"] for i in self.TASKS_KINDS]
+        return [i.action for i in self.TASKS_KINDS]

digitalhub/entities/_base/unversioned/entity.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata

digitalhub/entities/_base/versioned/entity.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.context.entity import ContextEntity
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata

digitalhub/entities/_commons/enums.py

@@ -32,6 +32,7 @@ class Relationship(Enum):
     PRODUCEDBY = "produced_by"
     CONSUMES = "consumes"
     RUN_OF = "run_of"
+    STEP_OF = "step_of"
 
 
 class State(Enum):
@@ -63,37 +64,6 @@ class State(Enum):
     UPLOADING = "UPLOADING"
 
 
-class ApiCategories(Enum):
-    """
-    Entity categories.
-    """
-
-    BASE = "base"
-    CONTEXT = "context"
-
-
-class BackendOperations(Enum):
-    """
-    Backend operations.
-    """
-
-    CREATE = "create"
-    READ = "read"
-    READ_ALL_VERSIONS = "read_all_versions"
-    UPDATE = "update"
-    DELETE = "delete"
-    LIST = "list"
-    LIST_FIRST = "list_first"
-    STOP = "stop"
-    RESUME = "resume"
-    DATA = "data"
-    FILES = "files"
-    LOGS = "logs"
-    SEARCH = "search"
-    SHARE = "share"
-    METRICS = "metrics"
-
-
 class EntityKinds(Enum):
     """
     Entity kinds.

digitalhub/entities/_commons/utils.py

@@ -4,8 +4,53 @@
 
 from __future__ import annotations
 
+import re
+from collections import namedtuple
+
 from digitalhub.entities._commons.enums import EntityTypes
 
+KindAction = namedtuple("KindAction", ["kind", "action"])
+
+
+KEY_PATTERN_WITH_ID = "store://([^/]+)/([^/]+)/([^/]+)/([^:]+):(.+)"
+KEY_PATTERN_NO_ID = "store://([^/]+)/([^/]+)/([^/]+)/([^:]+)"
+
+
+def is_valid_key(key: str) -> bool:
+    """
+    Check if an entity key is valid.
+
+    Parameters
+    ----------
+    key : str
+        The entity key to validate.
+
+    Returns
+    -------
+    bool
+        True if the key is valid, False otherwise.
+    """
+    return bool(re.fullmatch(KEY_PATTERN_WITH_ID, key) or re.fullmatch(KEY_PATTERN_NO_ID, key))
+
+
+def sanitize_unversioned_key(key: str) -> str:
+    """
+    Sanitize an unversioned entity key (from name:id to id).
+
+    Parameters
+    ----------
+    key : str
+        The unversioned entity key.
+
+    Returns
+    -------
+    str
+        The sanitized entity key with version.
+    """
+    splt = key.split("/")[2:]
+    ent_id = splt[-1].split(":")[0]
+    return "store://" + "/".join(splt[:-1] + [ent_id])
+
 
 def parse_entity_key(key: str) -> tuple[str, str, str, str | None, str]:
     """
@@ -32,34 +77,34 @@ def parse_entity_key(key: str) -> tuple[str, str, str, str | None, str]:
     ValueError
         If the key format is invalid or cannot be parsed.
     """
-    try:
-        # Remove "store://" from the key
-        key = key.replace("store://", "")
+    if not is_valid_key(key):
+        raise ValueError("Invalid entity key format.")
 
-        # Split the key into parts
-        parts = key.split("/")
+    # Remove "store://" from the key
+    key = key.replace("store://", "")
 
-        # The project is the first part
-        project = parts[0]
+    # Split the key into parts
+    parts = key.split("/")
 
-        # The entity type is the second part
-        entity_type = parts[1]
+    # The project is the first part
+    project = parts[0]
 
-        # The kind is the third part
-        kind = parts[2]
+    # The entity type is the second part
+    entity_type = parts[1]
 
-        # Tasks and runs have no name and uuid
-        if entity_type in (EntityTypes.TASK.value, EntityTypes.RUN.value):
-            name = None
-            uuid = parts[3]
+    # The kind is the third part
+    kind = parts[2]
 
-        # The name and uuid are separated by a colon in the last part
-        else:
-            name, uuid = parts[3].split(":")
+    # Tasks and runs have no name and uuid
+    if entity_type in (EntityTypes.TASK.value, EntityTypes.RUN.value):
+        name = None
+        uuid = parts[3]
 
-        return project, entity_type, kind, name, uuid
-    except Exception as e:
-        raise ValueError("Invalid key format.") from e
+    # 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
 
 
 def get_entity_type_from_key(key: str) -> str:
@@ -112,3 +157,20 @@ def get_project_from_key(key: str) -> str:
     """
     project, _, _, _, _ = parse_entity_key(key)
     return project
+
+
+def map_actions(kind_action_list: list[tuple[str, str]]) -> list[KindAction]:
+    """
+    Build task actions as KindAction namedtuples.
+
+    Parameters
+    ----------
+    kind_action_list : list[tuple[str, str]]
+        List of kind-action couples.
+
+    Returns
+    -------
+    list[KindAction]
+        Returns the task actions as KindAction namedtuples.
+    """
+    return [KindAction(kind, action) for (kind, action) in kind_action_list]

digitalhub/entities/_constructors/_resources.py

@@ -0,0 +1,151 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+ANIMALS = [
+    "ant",
+    "bear",
+    "bee",
+    "bison",
+    "cat",
+    "cheetah",
+    "cougar",
+    "crane",
+    "deer",
+    "dolphin",
+    "duck",
+    "eagle",
+    "falcon",
+    "finch",
+    "fox",
+    "frog",
+    "gecko",
+    "hawk",
+    "heron",
+    "horse",
+    "jaguar",
+    "koala",
+    "leopard",
+    "lion",
+    "llama",
+    "lynx",
+    "mole",
+    "moose",
+    "otter",
+    "owl",
+    "panda",
+    "penguin",
+    "rabbit",
+    "robin",
+    "seal",
+    "shark",
+    "sparrow",
+    "tiger",
+    "tortoise",
+    "wolf",
+]
+
+ADJECTIVES = [
+    "able",
+    "agile",
+    "alert",
+    "alpha",
+    "amber",
+    "apex",
+    "arctic",
+    "atomic",
+    "balanced",
+    "basic",
+    "bold",
+    "bright",
+    "brisk",
+    "calm",
+    "clever",
+    "clear",
+    "cloudy",
+    "crisp",
+    "curious",
+    "cyber",
+    "daring",
+    "deep",
+    "delta",
+    "digital",
+    "dynamic",
+    "early",
+    "easy",
+    "electric",
+    "epic",
+    "fast",
+    "firm",
+    "fluent",
+    "focused",
+    "fresh",
+    "friendly",
+    "full",
+    "future",
+    "gentle",
+    "global",
+    "golden",
+    "grand",
+    "great",
+    "green",
+    "happy",
+    "high",
+    "honest",
+    "hyper",
+    "ideal",
+    "infinite",
+    "inner",
+    "instant",
+    "keen",
+    "kind",
+    "known",
+    "large",
+    "light",
+    "linear",
+    "logical",
+    "lucky",
+    "lunar",
+    "magic",
+    "major",
+    "mega",
+    "mild",
+    "modern",
+    "neat",
+    "noble",
+    "open",
+    "outer",
+    "peak",
+    "perfect",
+    "plain",
+    "prime",
+    "pure",
+    "quick",
+    "quiet",
+    "rapid",
+    "rare",
+    "ready",
+    "real",
+    "red",
+    "right",
+    "safe",
+    "sharp",
+    "silent",
+    "simple",
+    "smart",
+    "solid",
+    "solar",
+    "speedy",
+    "stable",
+    "steady",
+    "stellar",
+    "strong",
+    "swift",
+    "true",
+    "ultra",
+    "vast",
+    "vital",
+    "wise",
+]

digitalhub/entities/{_base/entity/_constructors → _constructors}/name.py

@@ -4,8 +4,12 @@
 
 from __future__ import annotations
 
+import random
+
 from pydantic import BaseModel, Field
 
+from digitalhub.entities._constructors._resources import ADJECTIVES, ANIMALS
+
 NAME_REGEX = r"^[a-zA-Z0-9._+-]+$"
 
 
@@ -33,3 +37,17 @@ def build_name(name: str) -> str:
     """
     NameValidator(name=name)
     return name
+
+
+def random_name() -> str:
+    """
+    Generate a random name.
+
+    Returns
+    -------
+    str
+        The random name.
+    """
+    adjective = random.choice(ADJECTIVES)
+    animal = random.choice(ANIMALS)
+    return f"{adjective}-{animal}"

digitalhub/entities/_processors/base/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: © 2025 DSLab - Fondazione Bruno Kessler
+#
+# SPDX-License-Identifier: Apache-2.0