zrb 0.9.2__py3-none-any.whl → 0.15.0__py3-none-any.whl

zrb/config/config.py

@@ -7,13 +7,7 @@ from zrb.helper.typecheck import typechecked
 
 @typechecked
 def get_version() -> str:
-    try:
-        return metadata.version("zrb")
-    except metadata.PackageNotFoundError:
-        import flit
-
-        meta = flit.read_module_metadata("zrb")
-        return str(meta["module"]["version"])
+    return metadata.version("zrb")
 
 
 @typechecked
@@ -24,6 +18,13 @@ def get_current_shell() -> str:
     return "bash"
 
 
+def _get_valid_container_backend(container_backend: str) -> str:
+    if container_backend.lower().strip() == "podman":
+        return "podman"
+    return "docker"
+
+
+tmp_dir = os.getenv("ZRB_TMP_DIR", "/tmp")
 default_shell = os.getenv("ZRB_SHELL", get_current_shell())
 init_script_str = os.getenv("ZRB_INIT_SCRIPTS", "")
 init_scripts = init_script_str.split(":") if init_script_str != "" else []
@@ -34,3 +35,6 @@ show_advertisement = to_boolean(os.getenv("ZRB_SHOW_ADVERTISEMENT", "1"))
 show_prompt = to_boolean(os.getenv("ZRB_SHOW_PROMPT", "1"))
 show_time = to_boolean(os.getenv("ZRB_SHOW_TIME", "1"))
 version = get_version()
+container_backend = _get_valid_container_backend(
+    os.getenv("ZRB_CONTAINER_BACKEND", "docker")
+)

zrb/helper/accessories/name.py

@@ -9,124 +9,68 @@ def get_random_name(
     separator: str = "-", add_random_digit: bool = True, digit_count: int = 4
 ) -> str:
     prefixes = [
-        "albedo",
-        "argent",
-        "argentum",
-        "aurora",
-        "aurum",
-        "azure",
-        "basilisk",
-        "cerulean",
-        "chimeric",
-        "citrin",
-        "coral",
-        "crimson",
-        "diamond",
-        "draco",
-        "dragon",
-        "emerald",
-        "ethereal",
-        "ferrum",
-        "flammeus",
-        "garnet",
-        "glacial",
-        "glimmering",
-        "glistening",
-        "golden",
-        "helios",
-        "igneous",
-        "imperial",
-        "jade",
-        "luminous",
-        "luna",
-        "lunar",
-        "mystic",
-        "nephrite",
-        "nocturnal",
-        "obsidian",
-        "opal",
-        "pearl",
-        "platinum",
-        "prismatic",
-        "ruby",
-        "sapphire",
-        "serpentine",
-        "silver",
-        "sol",
-        "solar",
-        "spiritual",
-        "stellar",
-        "tempest",
-        "topaz",
-        "turquoise",
-        "verde",
-        "vermillion",
-        "vitreous",
-        "zephyr",
-        "zircon",
+        "bold",
+        "calm",
+        "dark",
+        "deep",
+        "fast",
+        "firm",
+        "glad",
+        "grey",
+        "hard",
+        "high",
+        "kind",
+        "late",
+        "lean",
+        "long",
+        "loud",
+        "mild",
+        "neat",
+        "pure",
+        "rare",
+        "rich",
+        "safe",
+        "slow",
+        "soft",
+        "tall",
+        "thin",
+        "trim",
+        "vast",
+        "warm",
+        "weak",
+        "wild",
     ]
     suffixes = [
-        "aether",
-        "albedo",
-        "alchemy",
-        "arcana",
-        "aureum",
-        "aetheris",
-        "anima",
-        "astralis",
-        "caelestis",
-        "chrysopoeia",
-        "cosmicum",
-        "crystallum",
-        "deum",
-        "divinitas",
-        "draconis",
-        "elementorum",
-        "elixir",
-        "essentia",
-        "eternis",
-        "ethereus",
-        "fatum",
-        "flamma",
-        "fulgur",
-        "hermetica",
-        "ignis",
-        "illuminationis",
-        "imperium",
-        "incantatum",
-        "infinitum",
-        "lapis",
-        "lux",
-        "magicae",
-        "magnum",
-        "materia",
-        "metallum",
-        "mysticum",
-        "natura",
-        "occultum",
-        "omnipotentis",
-        "opulentia",
-        "philosophia",
-        "philosophorum",
-        "praeparatum",
-        "praestantissimum",
-        "prima",
-        "primordium",
-        "quintessentia",
-        "regeneratio",
-        "ritualis",
-        "sanctum",
-        "spiritus",
-        "tenebris",
-        "terra",
-        "tinctura",
-        "transmutationis",
-        "universalis",
-        "vapores",
-        "venenum",
-        "veritas",
-        "vitae",
-        "volatus",
+        "arch",
+        "area",
+        "atom",
+        "base",
+        "beam",
+        "bell",
+        "bolt",
+        "bone",
+        "bulk",
+        "bush",
+        "cell",
+        "chip",
+        "clay",
+        "coal",
+        "coil",
+        "cone",
+        "cube",
+        "disk",
+        "dust",
+        "face",
+        "film",
+        "foam",
+        "frog",
+        "fuel",
+        "gate",
+        "gear",
+        "hall",
+        "hand",
+        "horn",
+        "leaf",
     ]
     prefix = random.choice(prefixes)
     suffix = random.choice(suffixes)

zrb/helper/cli.py

@@ -46,12 +46,12 @@ def create_cli() -> click.Group:
     # Load zrb_init.py
     project_dir = os.getenv("ZRB_PROJECT_DIR", os.getcwd())
     project_script = os.path.join(project_dir, "zrb_init.py")
-    load_module(script_path=project_script)
+    load_module(script_path=project_script, sys_path_index=0)
     # load from ZRB_INIT_SCRIPTS environment
-    for init_script in init_scripts:
+    for index, init_script in enumerate(init_scripts):
         logger.info(colored(f"Load module from {init_script}", attrs=["dark"]))
         try:
-            load_module(script_path=init_script)
+            load_module(script_path=init_script, sys_path_index=index + 1)
         except Exception:
             logger.error(
                 colored(

zrb/helper/codemod/add_property_to_class.py

@@ -65,7 +65,7 @@ def add_property_to_class(
 ) -> str:
     module = cst.parse_module(code)
     property_name_node = cst.Name(value=property_name)
-    property_type_node = cst.Annotation(cst.Name(value=property_type))
+    property_type_node = _get_property_type_node(property_type)
     property_value_node = _get_property_value_node(property_value)
     transformed_module = module.visit(
         AddPropertyTransformer(
@@ -78,6 +78,23 @@ def add_property_to_class(
     return transformed_module.code
 
 
+def _get_property_type_node(property_type: str) -> cst.Annotation:
+    if property_type.startswith("Optional[") and property_type.endswith("]"):
+        inner_type = property_type[len("Optional[") : -1]
+        return cst.Annotation(
+            annotation=cst.Subscript(
+                value=cst.Name("Optional"),
+                slice=[
+                    cst.SubscriptElement(
+                        slice=cst.Index(value=cst.Name(value=inner_type))
+                    )
+                ],
+            )
+        )
+    else:
+        return cst.Annotation(cst.Name(value=property_type))
+
+
 def _get_property_value_node(
     property_value: Optional[str],
 ) -> Optional[cst.BaseExpression]:

zrb/helper/loader/load_module.py

@@ -13,11 +13,11 @@ pattern = re.compile("[^a-zA-Z0-9]")
 
 @lru_cache
 @typechecked
-def load_module(script_path: str, add_to_system: bool = False):
+def load_module(script_path: str, sys_path_index: int = 0):
     if not os.path.isfile(script_path):
         return
     script_dir_path = os.path.dirname(script_path)
-    _append_dir_to_sys_path(script_dir_path)
+    _append_dir_to_sys_path(script_dir_path, sys_path_index)
     _append_dir_to_python_path(script_dir_path)
     _exec_script_as_module(script_path)
 
@@ -33,8 +33,10 @@ def _exec_script_as_module(script_path: str):
     logger.info(colored(f"Module executed: {script_path}", attrs=["dark"]))
 
 
-def _append_dir_to_sys_path(dir_path: str):
-    sys.path.append(dir_path)
+def _append_dir_to_sys_path(dir_path: str, index: int):
+    if dir_path in sys.path:
+        return
+    sys.path.insert(index, dir_path)
     logger.info(colored(f"Set sys.path to {sys.path}", attrs=["dark"]))
 
 
@@ -48,4 +50,6 @@ def _get_new_python_path(dir_path: str) -> str:
     current_python_path = os.getenv("PYTHONPATH")
     if current_python_path is None or current_python_path == "":
         return dir_path
+    if dir_path in current_python_path.split(":"):
+        return current_python_path
     return ":".join([current_python_path, dir_path])

zrb/helper/python_task.py

@@ -1,8 +1,22 @@
+import sys
+
+from zrb.helper.accessories.color import colored
+from zrb.helper.task import show_lines as task_show_lines
 from zrb.helper.typecheck import typechecked
 from zrb.task.task import Task
 
+_DEPRECATION_WARNING = """
+DEPRECATED: zrb.helper.python_task
+Use zrb.helper.task instead
+
+```python
+from zrb.helper.task import show_lines
+```
+"""
+
+print(colored(_DEPRECATION_WARNING, color="red", attrs=["bold"]), file=sys.stderr)
+
 
 @typechecked
 def show_lines(task: Task, *lines: str):
-    separator = "\n    "
-    task.print_out("\n" + separator + separator.join(lines) + "\n", trim_message=False)
+    task_show_lines(task, *lines)

zrb/helper/task.py

@@ -0,0 +1,8 @@
+from zrb.helper.typecheck import typechecked
+from zrb.task.task import Task
+
+
+@typechecked
+def show_lines(task: Task, *lines: str):
+    separator = "\n    "
+    task.print_out("\n" + separator + separator.join(lines) + "\n", trim_message=False)

zrb/shell-scripts/ensure-podman-is-installed.sh

@@ -0,0 +1,55 @@
+set -e
+if command_exists podman
+then
+    log_info "Podman is already installed."
+else
+    log_info "Installing Podman..."
+    if [ "$OS_TYPE" = "Darwin" ]
+    then
+        if command_exists brew
+        then
+            brew install --cask podman
+            log_info "Please start Podman before proceeding."
+        else
+            log_info "Homebrew not found. Please install Homebrew and try again."
+            exit 1
+        fi
+    elif [ "$OS_TYPE" = "Linux" ]
+    then
+        if command_exists apt
+        then
+            try_sudo apt update
+            try_sudo apt install -y podman
+        elif command_exists yum
+        then
+            try_sudo yum install -y podman
+        elif command_exists dnf
+        then
+            try_sudo dnf install -y podman
+        elif command_exists pacman
+        then
+            try_sudo pacman -Syu --noconfirm podman
+        else
+            log_info "No known package manager found. Please install Podman manually."
+            exit 1
+        fi
+    else
+        log_info "Unsupported OS type. Please install Podman manually."
+        exit 1
+    fi
+fi
+
+if ! command_exists podman-compose
+then
+    log_info "Installing Podman Compose plugin..."
+    pip install podman-compose
+fi
+
+# Check Podman Compose plugin installation
+if command_exists podman && command_exists podman-compose
+then
+    log_info "Podman Compose plugin is already installed."
+else
+    log_info "Podman Compose plugin is not installed or podman is not running. Please check your installation."
+    exit 1
+fi

zrb/task/any_task.py

@@ -103,7 +103,7 @@ class AnyTask(ABC):
         pass
 
     @abstractmethod
-    def set_xcom(self, key: str, value: Any) -> str:
+    def set_xcom(self, key: str, value: Any):
         """
         Set xcom for cross task communication.
 
@@ -125,7 +125,7 @@ class AnyTask(ABC):
         pass
 
     @abstractmethod
-    def set_task_xcom(self, key: str, value: Any) -> str:
+    def set_task_xcom(self, key: str, value: Any):
         """
         Set task xcom for cross task communication.
 
@@ -151,7 +151,7 @@ class AnyTask(ABC):
         """
         Get xcom value for cross task communication.
 
-        Argss:
+        Args:
             key (str): Xcom key
 
         Returns:
@@ -165,6 +165,13 @@ class AnyTask(ABC):
         """
         pass
 
+    @abstractmethod
+    def clear_xcom(self):
+        """
+        Clear cross task communication.
+        """
+        pass
+
     @abstractmethod
     def on_triggered(self):
         """
@@ -296,6 +303,7 @@ class AnyTask(ABC):
         raise_error: bool = True,
         is_async: bool = False,
         show_done_info: bool = True,
+        should_clear_xcom: bool = False,
     ) -> Callable[..., Any]:
         """
         Converts the current task into a callable function.
@@ -309,6 +317,7 @@ class AnyTask(ABC):
             raise_error (bool): Whether to raise an error if the task execution fails.
             is_async (bool): Whether the resulting function should be asynchronous.
             show_done_info (bool): Whether to show information upon task completion.
+            should_clear_xcom (bool): Whether should clear xcom or not.
 
         Returns:
             Callable[..., Any]: A callable representation of the task.
@@ -384,6 +393,44 @@ class AnyTask(ABC):
         """
         pass
 
+    @abstractmethod
+    def insert_fallback(self, *fallbacks: TAnyTask):
+        """
+        Inserts one or more `AnyTask` instances at the beginning of the current task's fallback list.
+
+        This method is used to define dependencies for the current task. Tasks in the fallback list are executed when the task is failed.
+        Adding a task to the beginning of the list means it will be
+        executed earlier than those already in the list.
+
+        Args:
+            fallbacks (TAnyTask): One or more task instances to be added to the fallback list.
+
+        Examples:
+            >>> from zrb import Task
+            >>> task = Task(name='task')
+            >>> fallback_task = Task(name='fallback-task')
+            >>> task.insert_fallback(fallback_task)
+        """
+        pass
+
+    @abstractmethod
+    def add_fallback(self, *fallbacks: TAnyTask):
+        """
+        Adds one or more `AnyTask` instances to the end of the current task's fallback list.
+
+        This method appends tasks to the fallback list, indicating that these tasks should be executed when the task is failed.
+
+        Args:
+            fallbacks (TAnyTask): One or more task instances to be added to the fallback list.
+
+        Examples:
+            >>> from zrb import Task
+            >>> task = Task(name='task')
+            >>> fallback_task = Task(name='fallback-task')
+            >>> task.add_fallback(fallback_task)
+        """
+        pass
+
     @abstractmethod
     def add_upstream(self, *upstreams: TAnyTask):
         """
@@ -519,6 +566,20 @@ class AnyTask(ABC):
         """
         pass
 
+    @abstractmethod
+    def _lock_upstreams(self):
+        """
+        Lock upstreams so that it cannot be altered anymore
+        """
+        pass
+
+    @abstractmethod
+    def _lock_fallbacks(self):
+        """
+        Lock fallbacks so that it cannot be altered anymore
+        """
+        pass
+
     @abstractmethod
     def _set_execution_id(self, execution_id: str):
         """
@@ -885,6 +946,37 @@ class AnyTask(ABC):
         """
         pass
 
+    @abstractmethod
+    def inject_fallbacks(self):
+        """
+        Injects fallback tasks into the current task.
+
+        This method is used for programmatically adding fallback to the task.
+        fallback tasks are those that must be completed when the task is failed.
+        Override this method in subclasses to specify such dependencies.
+
+        Examples:
+            >>> from zrb import Task
+            >>> class MyTask(Task):
+            >>>     def inject_fallbacks(self):
+            >>>         self.add_fallback(another_task)
+        """
+        pass
+
+    @abstractmethod
+    def _get_fallbacks(self) -> Iterable[TAnyTask]:
+        """
+        Retrieves the fallback tasks of the current task.
+
+        An internal method to get the list of fallback tasks that have been set for the
+        task, either statically or through `inject_fallbacks`. This is essential for task
+        fallback scenario.
+
+        Returns:
+            Iterable[TAnyTask]: An iterable of fallback tasks.
+        """
+        pass
+
     @abstractmethod
     def _get_combined_inputs(self) -> Iterable[AnyInput]:
         """

zrb/task/base_remote_cmd_task.py

@@ -78,6 +78,7 @@ class SingleBaseRemoteCmdTask(CmdTask):
         post_cmd_path: CmdVal = "",
         cwd: Optional[Union[str, pathlib.Path]] = None,
         upstreams: Iterable[AnyTask] = [],
+        fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
         on_waiting: Optional[OnWaiting] = None,
         on_skipped: Optional[OnSkipped] = None,
@@ -94,6 +95,9 @@ class SingleBaseRemoteCmdTask(CmdTask):
         preexec_fn: Optional[Callable[[], Any]] = os.setsid,
         should_execute: Union[bool, str, Callable[..., bool]] = True,
         return_upstream_result: bool = False,
+        should_print_cmd_result: bool = True,
+        should_show_cmd: bool = True,
+        should_show_working_directory: bool = True,
     ):
         CmdTask.__init__(
             self,
@@ -110,6 +114,7 @@ class SingleBaseRemoteCmdTask(CmdTask):
             cmd_path=cmd_path,
             cwd=cwd,
             upstreams=upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,
@@ -126,6 +131,9 @@ class SingleBaseRemoteCmdTask(CmdTask):
             preexec_fn=preexec_fn,
             should_execute=should_execute,
             return_upstream_result=return_upstream_result,
+            should_print_cmd_result=should_print_cmd_result,
+            should_show_cmd=should_show_cmd,
+            should_show_working_directory=should_show_working_directory,
         )
         self._pre_cmd = pre_cmd
         self._pre_cmd_path = pre_cmd_path
@@ -231,6 +239,9 @@ class BaseRemoteCmdTask(BaseTask):
         preexec_fn: Optional[Callable[[], Any]] = os.setsid,
         should_execute: Union[bool, str, Callable[..., bool]] = True,
         return_upstream_result: bool = False,
+        should_print_cmd_result: bool = True,
+        should_show_cmd: bool = True,
+        should_show_working_directory: bool = True,
     ):
         sub_tasks = [
             SingleBaseRemoteCmdTask(
@@ -265,6 +276,9 @@ class BaseRemoteCmdTask(BaseTask):
                 preexec_fn=preexec_fn,
                 should_execute=should_execute,
                 return_upstream_result=return_upstream_result,
+                should_print_cmd_result=should_print_cmd_result,
+                should_show_cmd=should_show_cmd,
+                should_show_working_directory=should_show_working_directory,
             )
             for remote_config in list(remote_configs)
         ]