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

zrb/task/remote_cmd_task.py

@@ -20,16 +20,16 @@ from zrb.task_env.env_file import EnvFile
 from zrb.task_group.group import Group
 from zrb.task_input.any_input import AnyInput
 
-CURRENT_DIR = os.path.dirname(__file__)
-SHELL_SCRIPT_DIR = os.path.join(CURRENT_DIR, "..", "shell-scripts")
-with open(os.path.join(SHELL_SCRIPT_DIR, "ssh-util.sh")) as file:
-    SSH_UTIL_SCRIPT = file.read()
+_CURRENT_DIR = os.path.dirname(__file__)
+_SHELL_SCRIPT_DIR = os.path.join(_CURRENT_DIR, "..", "shell-scripts")
+with open(os.path.join(_SHELL_SCRIPT_DIR, "ssh-util.sh")) as file:
+    _SSH_UTIL_SCRIPT = file.read()
 
 ensure_ssh_is_installed = CmdTask(
     name="ensure-ssh-is-installed",
     cmd_path=[
-        os.path.join(SHELL_SCRIPT_DIR, "_common-util.sh"),
-        os.path.join(SHELL_SCRIPT_DIR, "ensure-ssh-is-installed.sh"),
+        os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+        os.path.join(_SHELL_SCRIPT_DIR, "ensure-ssh-is-installed.sh"),
     ],
     preexec_fn=None,
 )
@@ -53,6 +53,7 @@ class RemoteCmdTask(BaseRemoteCmdTask):
         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,
@@ -71,7 +72,7 @@ class RemoteCmdTask(BaseRemoteCmdTask):
     ):
         pre_cmd = "\n".join(
             [
-                SSH_UTIL_SCRIPT,
+                _SSH_UTIL_SCRIPT,
                 "_SCRIPT=\"$(cat <<'ENDSCRIPT'",
             ]
         )
@@ -94,6 +95,7 @@ class RemoteCmdTask(BaseRemoteCmdTask):
             post_cmd=post_cmd,
             cwd=cwd,
             upstreams=[ensure_ssh_is_installed] + upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,

zrb/task/resource_maker.py

@@ -5,6 +5,7 @@ from zrb.helper.typing import (
     Callable,
     Iterable,
     JinjaTemplate,
+    List,
     Mapping,
     Optional,
     TypeVar,
@@ -39,6 +40,36 @@ ReplacementMutator = Callable[[AnyTask, Replacement], Replacement]
 TResourceMaker = TypeVar("TResourceMaker", bound="ResourceMaker")
 
 
+def get_default_resource_skip_parsing() -> List[str]:
+    return [
+        "*.mp3",
+        "*.pdf",
+        "*.exe",
+        "*.dll",
+        "*.bin",
+        "*.iso",
+        "*.png",
+        "*.jpg",
+        "*.gif",
+        "*.ico",
+        "*.pyc",
+        "*.gz",
+        "*.whl",
+        "*.db",
+    ]
+
+
+def get_default_resource_excludes() -> List[str]:
+    return [
+        "*/.git",
+        "*/__pycache__",
+        "*/node_modules",
+        "*/.venv",
+        "*/poetry.lock",
+        "*/.env",
+    ]
+
+
 @typechecked
 class ResourceMaker(BaseTask):
     def __init__(
@@ -48,7 +79,7 @@ class ResourceMaker(BaseTask):
         destination_path: JinjaTemplate,
         replacements: Replacement = {},
         replacement_mutator: Optional[ReplacementMutator] = None,
-        excludes: Iterable[str] = [],
+        excludes: Iterable[str] = get_default_resource_excludes(),
         group: Optional[Group] = None,
         inputs: Iterable[AnyInput] = [],
         envs: Iterable[Env] = [],
@@ -57,6 +88,7 @@ class ResourceMaker(BaseTask):
         color: Optional[str] = None,
         description: str = "",
         upstreams: Iterable[AnyTask] = [],
+        fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
         on_waiting: Optional[OnWaiting] = None,
         on_skipped: Optional[OnSkipped] = None,
@@ -65,7 +97,7 @@ class ResourceMaker(BaseTask):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         should_execute: Union[bool, JinjaTemplate, Callable[..., bool]] = True,
-        skip_parsing: Optional[Iterable[str]] = None,
+        skip_parsing: Iterable[str] = get_default_resource_skip_parsing(),
     ):
         BaseTask.__init__(
             self,
@@ -78,6 +110,7 @@ class ResourceMaker(BaseTask):
             color=color,
             description=description,
             upstreams=upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,
@@ -96,28 +129,11 @@ class ResourceMaker(BaseTask):
         self._excludes = excludes
         self._replacements = replacements
         self._replacement_mutator = replacement_mutator
-        self._set_skip_parsing(skip_parsing)
+        self._skip_parsing = skip_parsing
 
     def copy(self) -> TResourceMaker:
         return super().copy()
 
-    def _set_skip_parsing(self, skip_parsing: Optional[Iterable[str]]):
-        if skip_parsing is not None:
-            self._skip_parsing: Iterable[str] = skip_parsing
-            return
-        self._skip_parsing: Iterable[str] = [
-            "*.mp3",
-            "*.pdf",
-            "*.exe",
-            "*.dll",
-            "*.bin",
-            "*.iso",
-            "*.png",
-            "*.jpg",
-            "*.gif",
-            "*.ico",
-        ]
-
     def to_function(
         self,
         env_prefix: str = "",
@@ -168,11 +184,14 @@ class ResourceMaker(BaseTask):
     ) -> Mapping[str, str]:
         transformations: Mapping[str, Callable[[str], str]] = {
             "Pascal": to_pascal_case,
-            "kebab": to_kebab_case,
             "camel": to_camel_case,
+            "kebab": to_kebab_case,
+            "KEBAB": _to_upper(to_kebab_case),
             "snake": to_snake_case,
+            "SNAKE": _to_upper(to_snake_case),
             "human readable": to_human_readable,
             "Human readable": to_capitalized_human_readable,
+            "HUMAN READABLE": _to_upper(to_capitalized_human_readable),
         }
         keys = list(rendered_replacements.keys())
         for key in keys:
@@ -183,4 +202,13 @@ class ResourceMaker(BaseTask):
                     continue
                 transformed_value = transform(value)
                 rendered_replacements[prefixed_key] = transformed_value
+            if key != key.upper():
+                rendered_replacements[key.upper()] = value.upper()
         return rendered_replacements
+
+
+def _to_upper(fn: Callable[[str], str]) -> Callable[[str], str]:
+    def upperized_fn(text: str) -> str:
+        return fn(text).upper()
+
+    return upperized_fn

zrb/task/rsync_task.py

@@ -20,17 +20,17 @@ from zrb.task_env.env_file import EnvFile
 from zrb.task_group.group import Group
 from zrb.task_input.any_input import AnyInput
 
-CURRENT_DIR = os.path.dirname(__file__)
-SHELL_SCRIPT_DIR = os.path.join(CURRENT_DIR, "..", "shell-scripts")
-with open(os.path.join(SHELL_SCRIPT_DIR, "rsync-util.sh")) as file:
-    RSYNC_UTIL_SCRIPT = file.read()
+_CURRENT_DIR = os.path.dirname(__file__)
+_SHELL_SCRIPT_DIR = os.path.join(_CURRENT_DIR, "..", "shell-scripts")
+with open(os.path.join(_SHELL_SCRIPT_DIR, "rsync-util.sh")) as file:
+    _RSYNC_UTIL_SCRIPT = file.read()
 
 ensure_rsync_is_installed = CmdTask(
     name="ensure-ssh-is-installed",
     cmd_path=[
-        os.path.join(SHELL_SCRIPT_DIR, "_common-util.sh"),
-        os.path.join(SHELL_SCRIPT_DIR, "ensure-ssh-is-installed.sh"),
-        os.path.join(SHELL_SCRIPT_DIR, "ensure-rsync-is-installed.sh"),
+        os.path.join(_SHELL_SCRIPT_DIR, "_common-util.sh"),
+        os.path.join(_SHELL_SCRIPT_DIR, "ensure-ssh-is-installed.sh"),
+        os.path.join(_SHELL_SCRIPT_DIR, "ensure-rsync-is-installed.sh"),
     ],
     preexec_fn=None,
 )
@@ -56,6 +56,7 @@ class RsyncTask(BaseRemoteCmdTask):
         executable: Optional[str] = None,
         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,
@@ -87,10 +88,11 @@ class RsyncTask(BaseRemoteCmdTask):
             color=color,
             description=description,
             executable=executable,
-            pre_cmd=RSYNC_UTIL_SCRIPT,
+            pre_cmd=_RSYNC_UTIL_SCRIPT,
             cmd=cmd,
             cwd=cwd,
             upstreams=[ensure_rsync_is_installed] + upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,

zrb/task/time_watcher.py

@@ -51,6 +51,7 @@ class TimeWatcher(Checker):
         color: Optional[str] = None,
         description: str = "",
         upstreams: Iterable[AnyTask] = [],
+        fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
         on_waiting: Optional[OnWaiting] = None,
         on_skipped: Optional[OnSkipped] = None,
@@ -74,6 +75,7 @@ class TimeWatcher(Checker):
             color=color,
             description=description,
             upstreams=upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,

zrb/task/wiki_task.py

@@ -0,0 +1,127 @@
+import os
+
+from zrb.action.runner import Runner
+from zrb.helper.task import show_lines
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, Callable, Iterable, List, Mapping, Optional, Union
+from zrb.helper.util import to_human_readable
+from zrb.task.any_task import AnyTask
+from zrb.task.any_task_event_handler import (
+    OnFailed,
+    OnReady,
+    OnRetry,
+    OnSkipped,
+    OnStarted,
+    OnTriggered,
+    OnWaiting,
+)
+from zrb.task.task import Task
+from zrb.task_env.env import Env
+from zrb.task_env.env_file import EnvFile
+from zrb.task_group.group import Group
+from zrb.task_input.any_input import AnyInput
+
+
+@typechecked
+def create_wiki_tasks(
+    directory: str,
+    group: Optional[Group] = None,
+    inputs: Iterable[AnyInput] = [],
+    envs: Iterable[Env] = [],
+    env_files: Iterable[EnvFile] = [],
+    icon: Optional[str] = None,
+    color: Optional[str] = None,
+    upstreams: Iterable[AnyTask] = [],
+    fallbacks: Iterable[AnyTask] = [],
+    on_triggered: Optional[OnTriggered] = None,
+    on_waiting: Optional[OnWaiting] = None,
+    on_skipped: Optional[OnSkipped] = None,
+    on_started: Optional[OnStarted] = None,
+    on_ready: Optional[OnReady] = None,
+    on_retry: Optional[OnRetry] = None,
+    on_failed: Optional[OnFailed] = None,
+    should_execute: Union[bool, str, Callable[..., bool]] = True,
+    runner: Optional[Runner] = None,
+):
+    abs_directory = os.path.abspath(directory)
+    directory_structure = _get_directory_structure(abs_directory)
+    tasks: List[AnyTask] = []
+    for file_name in directory_structure["files"]:
+        if not file_name.endswith(".md"):
+            continue
+        task_name = file_name[:-3]
+        task_description = f"Article about {to_human_readable(task_name)}"
+        task = Task(
+            name=task_name,
+            group=group,
+            description=task_description,
+            inputs=inputs,
+            envs=envs,
+            env_files=env_files,
+            icon=icon,
+            color=color,
+            upstreams=upstreams,
+            fallbacks=fallbacks,
+            on_triggered=on_triggered,
+            on_waiting=on_waiting,
+            on_skipped=on_skipped,
+            on_started=on_started,
+            on_ready=on_ready,
+            on_retry=on_retry,
+            on_failed=on_failed,
+            should_execute=should_execute,
+            run=_create_function(directory=directory, file_name=file_name),
+        )
+        if runner is not None:
+            runner.register(task)
+        tasks.append(task)
+    for dir_name in directory_structure["dirs"]:
+        sub_group_description = f"Articles related to {to_human_readable(dir_name)}"
+        sub_group = Group(
+            name=dir_name,
+            parent=group,
+            description=sub_group_description,
+        )
+        sub_tasks = create_wiki_tasks(
+            directory=os.path.join(abs_directory, dir_name),
+            group=sub_group,
+            inputs=inputs,
+            envs=envs,
+            env_files=env_files,
+            icon=icon,
+            color=color,
+            upstreams=upstreams,
+            fallbacks=fallbacks,
+            on_triggered=on_triggered,
+            on_waiting=on_waiting,
+            on_skipped=on_skipped,
+            on_started=on_started,
+            on_ready=on_ready,
+            on_retry=on_retry,
+            on_failed=on_failed,
+            should_execute=should_execute,
+            runner=runner,
+        )
+        tasks = tasks + sub_tasks
+    return tasks
+
+
+def _create_function(directory: str, file_name: str) -> Callable[..., Any]:
+    def fn(*args: Any, **kwargs: Any):
+        with open(os.path.join(directory, file_name)) as f:
+            content = f.read()
+            lines = content.split("\n")
+            show_lines(kwargs["_task"], *lines)
+
+    return fn
+
+
+def _get_directory_structure(path) -> Mapping[str, List[str]]:
+    contents = {"files": [], "dirs": []}
+    for item in os.listdir(path):
+        full_path = os.path.join(path, item)
+        if os.path.isdir(full_path):
+            contents["dirs"].append(item)
+        elif os.path.isfile(full_path):
+            contents["files"].append(item)
+    return contents

zrb/task_env/constant.py

@@ -1 +1 @@
-RESERVED_ENV_NAMES = ("_ZRB_EXECUTION_ID",)
+RESERVED_ENV_NAMES = ("_ZRB_EXECUTION_ID", "_ZRB_EXECUTION_ID")

zrb/task_env/env.py

@@ -132,3 +132,15 @@ class Env:
         os_name = "None" if self.__os_name is None else double_quote(self.__os_name)
         default = double_quote(self.__default)
         return f"<{cls_name} {name} os_name={os_name} default={default}>"
+
+
+class PrivateEnv(Env):
+    def __init__(
+        self,
+        name: str,
+        default: JinjaTemplate = "",
+        should_render: bool = True,
+    ):
+        return super().__init__(
+            name=name, os_name="", default=default, should_render=should_render
+        )