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

zrb/task/docker_compose_task.py

@@ -1,6 +1,7 @@
 import os
 import pathlib
 
+from zrb.config.config import container_backend
 from zrb.helper.accessories.name import get_random_name
 from zrb.helper.docker_compose.fetch_external_env import fetch_compose_file_env_map
 from zrb.helper.docker_compose.file import read_compose_file, write_compose_file
@@ -36,27 +37,30 @@ 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")
-TDockerComposeTask = TypeVar("TDockerComposeTask", bound="DockerComposeTask")
 
-ensure_docker_is_installed = CmdTask(
-    name="ensure-docker-is-installed",
-    cmd_path=[
-        os.path.join(SHELL_SCRIPT_DIR, "_common-util.sh"),
-        os.path.join(SHELL_SCRIPT_DIR, "ensure-docker-is-installed.sh"),
-    ],
-    preexec_fn=None,
-)
+def _get_ensure_zrb_network_task(backend: str):
+    CURRENT_DIR = os.path.dirname(__file__)
+    SHELL_SCRIPT_DIR = os.path.join(CURRENT_DIR, "..", "shell-scripts")
+    ensure_container_backend = CmdTask(
+        name="ensure-container_backend",
+        cmd_path=[
+            os.path.join(SHELL_SCRIPT_DIR, "_common-util.sh"),
+            os.path.join(SHELL_SCRIPT_DIR, f"ensure-{backend}-is-installed.sh"),
+        ],
+        preexec_fn=None,
+    )
+    return CmdTask(
+        name="ensure-zrb-network",
+        cmd=[
+            f"{backend} network inspect zrb >/dev/null 2>&1 || \\",
+            f"{backend} network create -d bridge zrb",
+        ],
+        upstreams=[ensure_container_backend],
+    )
 
-ensure_zrb_network_exists = CmdTask(
-    name="ensure-zrb-network-exists",
-    cmd=[
-        "docker network inspect zrb >/dev/null 2>&1 || \\",
-        "docker network create -d bridge zrb",
-    ],
-    upstreams=[ensure_docker_is_installed],
-)
+
+TDockerComposeTask = TypeVar("TDockerComposeTask", bound="DockerComposeTask")
+ensure_zrb_network_task = _get_ensure_zrb_network_task(container_backend)
 
 
 @typechecked
@@ -96,6 +100,7 @@ class DockerComposeTask(CmdTask):
         setup_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,
@@ -126,7 +131,8 @@ class DockerComposeTask(CmdTask):
             description=description,
             executable=executable,
             cwd=cwd,
-            upstreams=[ensure_zrb_network_exists] + upstreams,
+            upstreams=[ensure_zrb_network_task] + upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,
@@ -350,7 +356,7 @@ class DockerComposeTask(CmdTask):
         cmd_str = "\n".join(
             [
                 setup_cmd_str,
-                f"docker compose {options} {self._compose_cmd} {flags} {args}",
+                f"{container_backend} compose {options} {self._compose_cmd} {flags} {args}",  # noqa
             ]
         )
         self.log_info(f"Command: {cmd_str}")

zrb/task/flow_task.py

@@ -32,6 +32,7 @@ class FlowTask(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,
@@ -72,6 +73,7 @@ class FlowTask(BaseTask):
             color=color,
             description=description,
             upstreams=final_upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,

zrb/task/http_checker.py

@@ -75,6 +75,7 @@ class HTTPChecker(Checker):
         url: str = "/",
         is_https: Union[bool, str] = False,
         upstreams: Iterable[AnyTask] = [],
+        fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
         on_waiting: Optional[OnWaiting] = None,
         on_skipped: Optional[OnSkipped] = None,
@@ -98,6 +99,7 @@ class HTTPChecker(Checker):
             color=color,
             description=description,
             upstreams=upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,

zrb/task/notifier.py

@@ -46,6 +46,7 @@ class Notifier(BaseTask):
         show_toast: bool = True,
         show_stdout: bool = True,
         upstreams: Iterable[AnyTask] = [],
+        fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
         on_waiting: Optional[OnWaiting] = None,
         on_skipped: Optional[OnSkipped] = None,
@@ -69,6 +70,7 @@ class Notifier(BaseTask):
             color=color,
             description=description,
             upstreams=upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,

zrb/task/path_checker.py

@@ -42,6 +42,7 @@ class PathChecker(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,
@@ -67,6 +68,7 @@ class PathChecker(Checker):
             color=color,
             description=description,
             upstreams=upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,

zrb/task/path_watcher.py

@@ -56,6 +56,7 @@ class PathWatcher(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,
@@ -83,6 +84,7 @@ class PathWatcher(Checker):
             color=color,
             description=description,
             upstreams=upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,

zrb/task/port_checker.py

@@ -54,6 +54,7 @@ class PortChecker(Checker):
         port: Union[int, JinjaTemplate] = 80,
         timeout: Union[int, JinjaTemplate] = 5,
         upstreams: Iterable[AnyTask] = [],
+        fallbacks: Iterable[AnyTask] = [],
         on_triggered: Optional[OnTriggered] = None,
         on_waiting: Optional[OnWaiting] = None,
         on_skipped: Optional[OnSkipped] = None,
@@ -77,6 +78,7 @@ class PortChecker(Checker):
             color=color,
             description=description,
             upstreams=upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,

zrb/task/recurring_task.py

@@ -63,6 +63,7 @@ class RecurringTask(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,
@@ -92,6 +93,7 @@ class RecurringTask(BaseTask):
             color=color,
             description=description,
             upstreams=upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,

zrb/task/remote_cmd_task.py

@@ -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,
@@ -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

@@ -57,6 +57,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,
@@ -78,6 +79,7 @@ class ResourceMaker(BaseTask):
             color=color,
             description=description,
             upstreams=upstreams,
+            fallbacks=fallbacks,
             on_triggered=on_triggered,
             on_waiting=on_waiting,
             on_skipped=on_skipped,

zrb/task/rsync_task.py

@@ -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,
@@ -91,6 +92,7 @@ class RsyncTask(BaseRemoteCmdTask):
             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,119 @@
+import os
+
+from zrb.action.runner import Runner
+from zrb.helper.python_task import show_lines
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, Callable, Iterable, List, Mapping, Optional, Union
+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 = Task(
+            name=task_name,
+            group=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,
+            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 = Group(name=dir_name, parent=group)
+        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-0.9.2.dist-info → zrb-0.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.9.2
+Version: 0.10.0
 Summary: A Framework to Enhance Your Workflow
 Home-page: https://github.com/state-alchemists/zrb
 License: AGPL-3.0-or-later