zrb 0.9.3__py3-none-any.whl → 0.15.1__py3-none-any.whl

zrb/helper/string/conversion.py

@@ -1,54 +1,31 @@
-import keyword
-import logging
-import re
-
-from zrb.helper.string.constant import FALSE_STRS, TRUE_STRS
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
+from zrb.helper.string.untyped_conversion import (
+    untyped_to_boolean,
+    untyped_to_cli_name,
+    untyped_to_logging_level,
+    untyped_to_variable_name,
+)
 from zrb.helper.typecheck import typechecked
 
-NON_WORD = re.compile(r"[\W]+")
-LEADING_NUM = re.compile(r"^\d+")
-LOGGING_LEVEL_MAP = {
-    "critical": logging.CRITICAL,
-    "fatal": logging.FATAL,
-    "error": logging.ERROR,
-    "warning": logging.WARNING,
-    "warn": logging.WARN,
-    "info": logging.INFO,
-    "debug": logging.DEBUG,
-    "notset": logging.NOTSET,
-}
+logger.debug(colored("Loading zrb.helper.string.conversion", attrs=["dark"]))
 
 
 @typechecked
 def to_cli_name(name: str) -> str:
-    return NON_WORD.sub("-", name).strip("-").lower()
+    return untyped_to_cli_name((name))
 
 
 @typechecked
 def to_variable_name(string: str) -> str:
-    # Replace any non-word characters with underscore
-    string = NON_WORD.sub("_", string).strip()
-    # Remove leading digits
-    string = LEADING_NUM.sub("", string)
-    # Convert to lowercase
-    string = string.lower()
-    if keyword.iskeyword(string):
-        return string + "_"
-    return string
+    return untyped_to_variable_name(string)
 
 
 @typechecked
 def to_boolean(string: str) -> bool:
-    if string.lower() in TRUE_STRS:
-        return True
-    if string.lower() in FALSE_STRS:
-        return False
-    raise Exception(f'Cannot infer boolean value from "{string}"')
+    return untyped_to_boolean(string)
 
 
 @typechecked
 def to_logging_level(logging_level_str: str) -> int:
-    lower_logging_level_str = logging_level_str.lower()
-    if lower_logging_level_str in LOGGING_LEVEL_MAP:
-        return LOGGING_LEVEL_MAP[lower_logging_level_str]
-    return logging.WARNING
+    return untyped_to_logging_level(logging_level_str)

zrb/helper/string/jinja.py

@@ -1,6 +1,10 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Any
 
+logger.debug(colored("Loading zrb.helper.string.jinja", attrs=["dark"]))
+
 
 @typechecked
 def is_probably_jinja(value: Any) -> bool:

zrb/helper/string/modification.py

@@ -1,5 +1,9 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 
+logger.debug(colored("Loading zrb.helper.string.modification", attrs=["dark"]))
+
 
 @typechecked
 def double_quote(text: str) -> str:

zrb/helper/string/parse_replacement.py

@@ -1,6 +1,10 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Mapping
 
+logger.debug(colored("Loading zrb.helper.string.parse_replacment", attrs=["dark"]))
+
 
 @typechecked
 def parse_replacement(text: str, replacement: Mapping[str, str]):

zrb/helper/string/untyped_conversion.py

@@ -0,0 +1,49 @@
+import keyword
+import logging
+import re
+
+from zrb.helper.string.constant import FALSE_STRS, TRUE_STRS
+
+NON_WORD = re.compile(r"[\W]+")
+LEADING_NUM = re.compile(r"^\d+")
+LOGGING_LEVEL_MAP = {
+    "critical": logging.CRITICAL,
+    "fatal": logging.FATAL,
+    "error": logging.ERROR,
+    "warning": logging.WARNING,
+    "warn": logging.WARN,
+    "info": logging.INFO,
+    "debug": logging.DEBUG,
+    "notset": logging.NOTSET,
+}
+
+
+def untyped_to_cli_name(name: str) -> str:
+    return NON_WORD.sub("-", name).strip("-").lower()
+
+
+def untyped_to_variable_name(string: str) -> str:
+    # Replace any non-word characters with underscore
+    string = NON_WORD.sub("_", string).strip()
+    # Remove leading digits
+    string = LEADING_NUM.sub("", string)
+    # Convert to lowercase
+    string = string.lower()
+    if keyword.iskeyword(string):
+        return string + "_"
+    return string
+
+
+def untyped_to_boolean(string: str) -> bool:
+    if string.lower() in TRUE_STRS:
+        return True
+    if string.lower() in FALSE_STRS:
+        return False
+    raise Exception(f'Cannot infer boolean value from "{string}"')
+
+
+def untyped_to_logging_level(logging_level_str: str) -> int:
+    lower_logging_level_str = logging_level_str.lower()
+    if lower_logging_level_str in LOGGING_LEVEL_MAP:
+        return LOGGING_LEVEL_MAP[lower_logging_level_str]
+    return logging.WARNING

zrb/helper/task.py

@@ -0,0 +1,12 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
+from zrb.helper.typecheck import typechecked
+from zrb.task.task import Task
+
+logger.debug(colored("Loading zrb.helper.task", attrs=["dark"]))
+
+
+@typechecked
+def show_lines(task: Task, *lines: str):
+    separator = "\n    "
+    task.print_out("\n" + separator + separator.join(lines) + "\n", trim_message=False)

zrb/helper/typecheck.py

@@ -1,17 +1,16 @@
-import os
 from typing import TypeVar
 
-from beartype import beartype
-
-from zrb.helper.string.constant import FALSE_STRS
-
-enable_type_checking_str = os.getenv("ZRB_ENABLE_TYPE_CHECKING", "1").lower()
-enable_type_checking = enable_type_checking_str not in FALSE_STRS
+from zrb.config.config import enable_type_checking
+from zrb.helper.accessories.untyped_color import untyped_colored as colored
+from zrb.helper.log import logger
 
+logger.debug(colored("Loading zrb.helper.typecheck", attrs=["dark"]))
 T = TypeVar("T")
 
 
 def typechecked(anything: T) -> T:
     if enable_type_checking:
+        from beartype import beartype
+
         return beartype(anything)
     return anything

zrb/helper/typing.py

@@ -1,15 +1,35 @@
-from beartype.typing import (
-    Any,
-    Callable,
-    Iterable,
-    List,
-    Mapping,
-    Optional,
-    Tuple,
-    Type,
-    TypeVar,
-    Union,
-)
+from zrb.config.config import enable_type_checking
+from zrb.helper.accessories.untyped_color import untyped_colored as colored
+from zrb.helper.log import logger
+
+logger.debug(colored("Loading zrb.helper.typing", attrs=["dark"]))
+
+if enable_type_checking:
+    from beartype.typing import (
+        Any,
+        Callable,
+        Iterable,
+        List,
+        Mapping,
+        Optional,
+        Tuple,
+        Type,
+        TypeVar,
+        Union,
+    )
+else:
+    from typing import (
+        Any,
+        Callable,
+        Iterable,
+        List,
+        Mapping,
+        Optional,
+        Tuple,
+        Type,
+        TypeVar,
+        Union,
+    )
 
 JinjaTemplate = str
 

zrb/helper/util.py

@@ -2,10 +2,14 @@ import re
 
 import jinja2
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.string.conversion import to_boolean as conversion_to_boolean
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Any, Optional
 
+logger.debug(colored("Loading zrb.helper.util", attrs=["dark"]))
+
 NON_ALPHA_NUM = re.compile(r"[^a-zA-Z0-9]+")
 
 

zrb/runner.py

@@ -1,4 +1,7 @@
 from zrb.action.runner import Runner
 from zrb.config.config import env_prefix
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 
+logger.debug(colored("Loading zrb.runner", attrs=["dark"]))
 runner = Runner(env_prefix=env_prefix)

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

@@ -1,5 +1,7 @@
 from abc import ABC, abstractmethod
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typing import (
     Any,
     Callable,
@@ -15,6 +17,8 @@ from zrb.task_env.env import Env
 from zrb.task_env.env_file import EnvFile
 from zrb.task_input.any_input import AnyInput
 
+logger.debug(colored("Loading zrb.task.any_task", attrs=["dark"]))
+
 # flake8: noqa E501
 TAnyTask = TypeVar("TAnyTask", bound="AnyTask")
 
@@ -103,7 +107,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 +129,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 +155,7 @@ class AnyTask(ABC):
         """
         Get xcom value for cross task communication.
 
-        Argss:
+        Args:
             key (str): Xcom key
 
         Returns:
@@ -165,6 +169,13 @@ class AnyTask(ABC):
         """
         pass
 
+    @abstractmethod
+    def clear_xcom(self):
+        """
+        Clear cross task communication.
+        """
+        pass
+
     @abstractmethod
     def on_triggered(self):
         """
@@ -296,6 +307,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 +321,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 +397,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 +570,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 +950,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/any_task_event_handler.py

@@ -1,6 +1,10 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typing import Any, Callable
 from zrb.task.any_task import AnyTask
 
+logger.debug(colored("Loading zrb.task.any_task_event_handler", attrs=["dark"]))
+
 _TaskEventHandler = Callable[[AnyTask], Any]
 OnTriggered = _TaskEventHandler
 OnWaiting = _TaskEventHandler

zrb/task/base_remote_cmd_task.py

@@ -2,6 +2,8 @@ import copy
 import os
 import pathlib
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import (
     Any,
@@ -31,6 +33,8 @@ from zrb.task_env.env_file import EnvFile
 from zrb.task_group.group import Group
 from zrb.task_input.any_input import AnyInput
 
+logger.debug(colored("Loading zrb.task.base_remote_cmd_task", attrs=["dark"]))
+
 TSingleBaseRemoteCmdTask = TypeVar(
     "TSingleBaseRemoteCmdTask", bound="SingleBaseRemoteCmdTask"
 )
@@ -78,6 +82,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 +99,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 +118,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 +135,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 +243,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 +280,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)
         ]