zrb 0.24.0__py3-none-any.whl → 0.26.2__py3-none-any.whl

zrb/action/runner.py

@@ -1,11 +1,13 @@
 import sys
+from collections.abc import Callable, Mapping
+from typing import Any, Union
 
 import click
 
 from zrb.helper.accessories.color import colored
+from zrb.helper.asyncio_task import stop_asyncio_sync
 from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import Any, Callable, List, Mapping, Union
 from zrb.task.any_task import AnyTask
 from zrb.task_group.group import Group as TaskGroup
 
@@ -24,11 +26,11 @@ class Runner:
     def __init__(self, env_prefix: str = ""):
         logger.info(colored("Create runner", attrs=["dark"]))
         self.__env_prefix = env_prefix
-        self.__tasks: List[AnyTask] = []
+        self.__tasks: list[AnyTask] = []
         self.__registered_groups: Mapping[str, click.Group] = {}
-        self.__top_levels: List[CliSubcommand] = []
-        self.__subcommands: Mapping[str, List[click.Group]] = {}
-        self.__registered_task_cli_name: List[str] = []
+        self.__top_levels: list[CliSubcommand] = []
+        self.__subcommands: Mapping[str, list[click.Group]] = {}
+        self.__registered_task_cli_name: list[str] = []
         logger.info(colored("Runner created", attrs=["dark"]))
 
     def register(self, *tasks: AnyTask):
@@ -119,6 +121,7 @@ class Runner:
             try:
                 function(*args, **kwargs)
             except Exception:
+                stop_asyncio_sync()
                 sys.exit(1)
             finally:
                 task.clear_xcom()

zrb/advertisement.py

@@ -1,13 +1,12 @@
 from zrb.helper.accessories.color import colored
 from zrb.helper.advertisement import Advertisement
 from zrb.helper.log import logger
-from zrb.helper.typing import List
 
 logger.debug(colored("Loading zrb.advertisement", attrs=["dark"]))
 
 # flake8: noqa E501
 
-advertisements: List[Advertisement] = [
+advertisements: list[Advertisement] = [
     Advertisement(
         content="\n".join(
             [

zrb/builtin/__init__.py

@@ -24,6 +24,7 @@ from zrb.builtin.eval import evaluate
 from zrb.builtin.explain import explain_group, explain_tasks
 from zrb.builtin.git import clear_git_branch, get_git_file_changes, git_group
 from zrb.builtin.md5 import hash_text_md5, md5_group, sum_file_md5
+from zrb.builtin.monorepo import add_to_monorepo, pull_from_monorepo, push_to_monorepo
 from zrb.builtin.process import (
     get_process_pid_by_name,
     get_process_pid_by_port,
@@ -113,6 +114,9 @@ assert add_project_tasks
 assert add_cmd_task
 assert add_docker_compose_task
 assert add_python_task
+assert add_to_monorepo
+assert pull_from_monorepo
+assert push_to_monorepo
 assert ubuntu_group
 assert ubuntu_install_group
 assert update_ubuntu

zrb/builtin/base64/decode.py

@@ -1,8 +1,8 @@
 import base64
+from typing import Any
 
 from zrb.builtin.base64._group import base64_group
 from zrb.builtin.base64._input import text_input
-from zrb.helper.typing import Any
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 

zrb/builtin/base64/encode.py

@@ -1,8 +1,8 @@
 import base64
+from typing import Any
 
 from zrb.builtin.base64._group import base64_group
 from zrb.builtin.base64._input import text_input
-from zrb.helper.typing import Any
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 

zrb/builtin/devtool/install/_helper.py

@@ -1,8 +1,9 @@
 import os
+from collections.abc import Callable
+from typing import Any
 
 from zrb.helper.file.text import read_text_file_async, write_text_file_async
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import Any, Callable
 from zrb.task.task import Task
 
 

zrb/builtin/docker/prune.py

@@ -1,15 +1,23 @@
 from zrb.builtin.docker._group import docker_group
 from zrb.runner import runner
 from zrb.task.cmd_task import CmdTask
+from zrb.task_input.bool_input import BoolInput
 
 prune_docker = CmdTask(
     name="prune",
     group=docker_group,
     description="Prune unused images and volumes",
+    inputs=[
+        BoolInput(
+            name="all", shortcut="a", prompt="Remove all unused images", default=False
+        ),
+        BoolInput(
+            name="volume", shortcut="v", prompt="Prune anonymous volume", default=False
+        ),
+    ],
     cmd=[
-        "docker system prune -af",
-        "docker image prune -af",
-        "docker system prune -af --volumes",
+        "docker system prune -f {% if input.all %}-a{% endif %} {% if input.volume %}--volumes{% endif %}",  # noqa
+        "docker image prune -f {% if input.all %}-a{% endif %}",
         "docker system df",
     ],
 )

zrb/builtin/env/get.py

@@ -1,6 +1,7 @@
+from typing import Any
+
 from zrb.builtin.env._group import env_group
 from zrb.helper.accessories.color import colored
-from zrb.helper.typing import Any, List
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task.task import Task
@@ -15,7 +16,7 @@ async def get_env(*args: Any, **kwargs: Any):
     names = list(env_map.keys())
     names.sort()
     colored_equal = colored("=", color="grey", attrs=["dark"])
-    env_lines: List[str] = []
+    env_lines: list[str] = []
     for name in names:
         value = env_map[name]
         colored_name = colored(name, color="green", attrs=["bold"])

zrb/builtin/eval.py

@@ -1,4 +1,5 @@
-from zrb.helper.typing import Any
+from typing import Any
+
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task_input.str_input import StrInput

zrb/builtin/git/get_file_changes.py

@@ -1,8 +1,9 @@
+from typing import Any
+
 from zrb.builtin.git._group import git_group
 from zrb.helper.accessories.color import colored
 from zrb.helper.git.detect_changes import get_modified_file_states
 from zrb.helper.task import show_lines
-from zrb.helper.typing import Any
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task_input.bool_input import BoolInput

zrb/builtin/md5/hash.py

@@ -1,7 +1,7 @@
 import hashlib
+from typing import Any
 
 from zrb.builtin.md5._group import md5_group
-from zrb.helper.typing import Any
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task_input.str_input import StrInput

zrb/builtin/md5/sum.py

@@ -1,9 +1,9 @@
 import hashlib
+from typing import Any
 
 import aiofiles
 
 from zrb.builtin.md5._group import md5_group
-from zrb.helper.typing import Any
 from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task_input.str_input import StrInput

zrb/builtin/monorepo/__init__.py

@@ -0,0 +1,7 @@
+from zrb.builtin.monorepo.add import add_to_monorepo
+from zrb.builtin.monorepo.pull import pull_from_monorepo
+from zrb.builtin.monorepo.push import push_to_monorepo
+
+assert add_to_monorepo
+assert pull_from_monorepo
+assert push_to_monorepo

zrb/builtin/monorepo/_common.sh

@@ -0,0 +1,15 @@
+log_info() {
+    echo -e "🤖 \e[0;33m${1}\e[0;0m"
+}
+
+log_error() {
+    echo -e "\e[1;31m${1}\e[0;0m" >&2
+}
+
+log_conflict_error() {
+    log_error "Action blocked by unresolved conflicts."
+    log_error "You need to resolve the conflict(s) and commit the changes."
+    log_error "Unresolved conflict(s) detected:"
+    log_error "$1"
+}
+

zrb/builtin/monorepo/_config.py

@@ -0,0 +1,11 @@
+import json
+import os
+from collections.abc import Mapping
+
+PROJECT_DIR = os.getenv("ZRB_PROJECT_DIR", ".")
+MONOREPO_CONFIG_FILE = os.path.join(PROJECT_DIR, "monorepo.zrb.json")
+MONOREPO_CONFIG: Mapping[str, Mapping[str, str]] = {}
+
+if os.path.isfile(MONOREPO_CONFIG_FILE):
+    with open(MONOREPO_CONFIG_FILE, "r") as file:
+        MONOREPO_CONFIG = json.load(file)

zrb/builtin/monorepo/_group.py

@@ -0,0 +1,3 @@
+from zrb.task_group.group import Group
+
+monorepo_group = Group(name="monorepo", description="Monorepo management")

zrb/builtin/monorepo/_helper.py

@@ -0,0 +1,140 @@
+import os
+
+from zrb.builtin.monorepo._config import PROJECT_DIR
+from zrb.task.cmd_task import CmdTask
+from zrb.task_env.env import Env
+from zrb.task_input.any_input import AnyInput
+from zrb.task_input.str_input import StrInput
+
+_CURRENT_DIR = os.path.dirname(__file__)
+
+
+def create_pull_monorepo_task(
+    task_name: str = "pull-monorepo",
+) -> CmdTask:
+    return CmdTask(
+        name=task_name,
+        envs=[
+            Env("TIME", os_name="", default="{{datetime.datetime.now()}}"),
+        ],
+        cmd_path=[
+            os.path.join(_CURRENT_DIR, "_common.sh"),
+            os.path.join(_CURRENT_DIR, "pull-monorepo.sh"),
+        ],
+        cwd=PROJECT_DIR,
+        should_show_cmd=False,
+        should_show_working_directory=False,
+        should_print_cmd_result=False,
+        retry=0,
+    )
+
+
+def create_push_monorepo_task(
+    task_name: str = "push-monorepo", default_commit_message: str = "Save changes"
+) -> CmdTask:
+    return CmdTask(
+        name=task_name,
+        inputs=[_create_commit_message_input(default_commit_message)],
+        envs=[
+            Env("MESSAGE", os_name="", default="{{input.message}}"),
+        ],
+        cmd_path=[
+            os.path.join(_CURRENT_DIR, "_common.sh"),
+            os.path.join(_CURRENT_DIR, "push-monorepo.sh"),
+        ],
+        cwd=PROJECT_DIR,
+        should_show_cmd=False,
+        should_show_working_directory=False,
+        should_print_cmd_result=False,
+        retry=0,
+    )
+
+
+def create_add_subrepo_task(
+    origin: str,
+    folder: str,
+    branch: str,
+    task_name: str = "add",
+) -> CmdTask:
+    return CmdTask(
+        name=task_name,
+        envs=[
+            Env("ORIGIN", os_name="", default=origin),
+            Env("FOLDER", os_name="", default=folder),
+            Env("BRANCH", os_name="", default=branch),
+            Env("TIME", os_name="", default="{{datetime.datetime.now()}}"),
+        ],
+        cmd_path=[
+            os.path.join(_CURRENT_DIR, "_common.sh"),
+            os.path.join(_CURRENT_DIR, "add-subrepo.sh"),
+        ],
+        cwd=PROJECT_DIR,
+        should_show_cmd=False,
+        should_show_working_directory=False,
+        should_print_cmd_result=False,
+        retry=0,
+    )
+
+
+def create_pull_subrepo_task(
+    origin: str,
+    folder: str,
+    branch: str,
+    task_name: str = "pull",
+) -> CmdTask:
+    return CmdTask(
+        name=task_name,
+        envs=[
+            Env("ORIGIN", os_name="", default=origin),
+            Env("FOLDER", os_name="", default=folder),
+            Env("BRANCH", os_name="", default=branch),
+            Env("TIME", os_name="", default="{{datetime.datetime.now()}}"),
+        ],
+        cmd_path=[
+            os.path.join(_CURRENT_DIR, "_common.sh"),
+            os.path.join(_CURRENT_DIR, "pull-subrepo.sh"),
+        ],
+        cwd=PROJECT_DIR,
+        should_show_cmd=False,
+        should_show_working_directory=False,
+        should_print_cmd_result=False,
+        retry=0,
+    )
+
+
+def create_push_subrepo_task(
+    origin: str,
+    folder: str,
+    branch: str,
+    task_name: str = "push",
+    default_commit_message: str = "Commit",
+) -> CmdTask:
+    return CmdTask(
+        name=task_name,
+        inputs=[_create_commit_message_input(default_commit_message)],
+        envs=[
+            Env("ORIGIN", os_name="", default=origin),
+            Env("FOLDER", os_name="", default=folder),
+            Env("BRANCH", os_name="", default=branch),
+            Env("TIME", os_name="", default="{{datetime.datetime.now()}}"),
+            Env("MESSAGE", os_name="", default="{{input.message}}"),
+        ],
+        cmd_path=[
+            os.path.join(_CURRENT_DIR, "_common.sh"),
+            os.path.join(_CURRENT_DIR, "push-subrepo.sh"),
+        ],
+        cwd=PROJECT_DIR,
+        should_show_cmd=False,
+        should_show_working_directory=False,
+        should_print_cmd_result=False,
+        retry=0,
+    )
+
+
+def _create_commit_message_input(default: str) -> AnyInput:
+    return StrInput(
+        name="message",
+        shortcut="m",
+        prompt="Commit Message",
+        default=default,
+    )

zrb/builtin/monorepo/_task.py

@@ -0,0 +1,126 @@
+from zrb.builtin.monorepo._config import MONOREPO_CONFIG
+from zrb.builtin.monorepo._group import monorepo_group
+from zrb.builtin.monorepo._helper import (
+    create_add_subrepo_task,
+    create_pull_monorepo_task,
+    create_pull_subrepo_task,
+    create_push_monorepo_task,
+    create_push_subrepo_task,
+)
+from zrb.helper.util import to_kebab_case
+from zrb.runner import runner
+from zrb.task.flow_task import FlowTask
+from zrb.task_group.group import Group
+
+_pull_monorepo = create_pull_monorepo_task()
+
+PULL_SUBREPO_UPSTREAM = _pull_monorepo
+PUSH_SUBREPO_UPSTREAM = _pull_monorepo
+for name, config in MONOREPO_CONFIG.items():
+    kebab_name = to_kebab_case(name)
+    group = Group(
+        name=kebab_name, parent=monorepo_group, description=f"Subrepo {name} management"
+    )
+    origin = config.get("origin", "")
+    folder = config.get("folder", "")
+    branch = config.get("branch", "main")
+
+    pull_subrepo = FlowTask(
+        name="pull",
+        group=group,
+        upstreams=[_pull_monorepo],
+        steps=[
+            create_add_subrepo_task(
+                origin=origin,
+                folder=folder,
+                branch=branch,
+                task_name=f"add-{kebab_name}-subrepo",
+            ),
+            create_pull_subrepo_task(
+                origin=origin,
+                folder=folder,
+                branch=branch,
+                task_name=f"pull-{kebab_name}-subrepo",
+            ),
+        ],
+    )
+    runner.register(pull_subrepo)
+
+    linked_pull_subrepo = FlowTask(
+        name=f"pull-{kebab_name}",
+        upstreams=[PULL_SUBREPO_UPSTREAM],
+        steps=[
+            create_add_subrepo_task(
+                origin=origin,
+                folder=folder,
+                branch=branch,
+                task_name=f"add-{kebab_name}-subrepo",
+            ),
+            create_pull_subrepo_task(
+                origin=origin,
+                folder=folder,
+                branch=branch,
+                task_name=f"pull-{kebab_name}-subrepo",
+            ),
+        ],
+    )
+    PULL_SUBREPO_UPSTREAM = linked_pull_subrepo
+
+    push_subrepo = FlowTask(
+        name="push",
+        group=group,
+        upstreams=[_pull_monorepo],
+        steps=[
+            create_add_subrepo_task(
+                origin=origin,
+                folder=folder,
+                branch=branch,
+                task_name=f"add-{kebab_name}-subrepo",
+            ),
+            create_pull_subrepo_task(
+                origin=origin,
+                folder=folder,
+                branch=branch,
+                task_name=f"pull-{kebab_name}-subrepo",
+            ),
+            create_push_subrepo_task(
+                origin=origin,
+                folder=folder,
+                branch=branch,
+                task_name=f"push-{kebab_name}-subrepo",
+            ),
+            create_push_monorepo_task(task_name="push-monorepo"),
+        ],
+    )
+    runner.register(push_subrepo)
+
+    linked_push_subrepo = FlowTask(
+        name=f"push-{kebab_name}",
+        upstreams=[PUSH_SUBREPO_UPSTREAM],
+        steps=[
+            create_add_subrepo_task(
+                origin=origin,
+                folder=folder,
+                branch=branch,
+                task_name=f"add-{kebab_name}-subrepo",
+            ),
+            create_pull_subrepo_task(
+                origin=origin,
+                folder=folder,
+                branch=branch,
+                task_name=f"pull-{kebab_name}-subrepo",
+            ),
+            create_push_subrepo_task(
+                origin=origin,
+                folder=folder,
+                branch=branch,
+                task_name=f"push-{kebab_name}-subrepo",
+            ),
+        ],
+    )
+    PUSH_SUBREPO_UPSTREAM = linked_push_subrepo
+
+
+_push_monorepo = create_push_monorepo_task(task_name="push-monorepo")
+PUSH_SUBREPO_UPSTREAM >> _push_monorepo
+PUSH_SUBREPO_UPSTREAM = _push_monorepo

zrb/builtin/monorepo/add-subrepo.sh

@@ -0,0 +1,22 @@
+set -e
+
+if [ -d "${FOLDER}" ]
+then
+    exit 0
+fi
+
+CONFLICT="$(git diff --name-only --diff-filter=U)"
+if [ -n "${CONFLICT}" ]
+then
+    log_conflict_error "${CONFLICT}"
+    exit 1
+fi
+
+log_info "Adding subtree: ${FOLDER}"
+git subtree add --prefix "${FOLDER}" "${ORIGIN}" "${BRANCH}"
+git add . -A
+if [ -n "$(git status --porcelain)" ]
+then
+    log_info "Commit changes"
+    git commit -m "Adding subtree: ${FOLDER} at ${TIME}"
+fi

zrb/builtin/monorepo/add.py

@@ -0,0 +1,48 @@
+import json
+import os
+from collections.abc import Mapping
+
+from zrb.builtin.monorepo._config import (
+    MONOREPO_CONFIG,
+    MONOREPO_CONFIG_FILE,
+    PROJECT_DIR,
+)
+from zrb.builtin.monorepo._group import monorepo_group
+from zrb.runner import runner
+from zrb.task.any_task import AnyTask
+from zrb.task.decorator import python_task
+from zrb.task_input.str_input import StrInput
+
+
+@python_task(
+    name="add",
+    group=monorepo_group,
+    inputs=[
+        StrInput(name="alias", shortcut="a", prompt="Repo Alias", prompt_required=True),
+        StrInput(name="folder", shortcut="d", prompt="Directory", prompt_required=True),
+        StrInput(name="origin", shortcut="o", prompt="Repo URL", prompt_required=True),
+        StrInput(
+            name="branch",
+            shortcut="b",
+            prompt="Repo Branch",
+            prompt_required=True,
+            default="main",
+        ),
+    ],
+    description="Add repo to monorepo",
+    runner=runner,
+)
+def add_to_monorepo(*args, **kwargs):
+    task: AnyTask = kwargs.get("_task")
+    input_map: Mapping[str, str] = task.get_input_map()
+    abs_folder = os.path.join(PROJECT_DIR, input_map.get("folder", ""))
+    if os.path.isdir(abs_folder):
+        raise ValueError(f"Directory exists: {abs_folder}")
+    config = dict(MONOREPO_CONFIG)
+    config[input_map.get("alias", "")] = {
+        "folder": input_map.get("folder", ""),
+        "branch": input_map.get("branch", ""),
+        "origin": input_map.get("origin", ""),
+    }
+    with open(MONOREPO_CONFIG_FILE, "w") as file:
+        json.dump(config, file, indent=2)

zrb/builtin/monorepo/pull-monorepo.sh

@@ -0,0 +1,18 @@
+set -e
+
+CONFLICT="$(git diff --name-only --diff-filter=U)"
+if [ -n "${CONFLICT}" ]
+then
+    log_conflict_error "${CONFLICT}"
+    exit 1
+fi
+
+git add . -A
+if [ -n "$(git status --porcelain)" ]
+then
+    log_info "Commit changes"
+    git commit -m "Before pulling from monorepo at ${TIME}"
+fi
+
+log_info "Pulling from main repository"
+git pull origin "$(git branch --show-current)"

zrb/builtin/monorepo/pull-subrepo.sh

@@ -0,0 +1,18 @@
+set -e
+
+CONFLICT="$(git diff --name-only --diff-filter=U)"
+if [ -n "${CONFLICT}" ]
+then
+    log_conflict_error "${CONFLICT}"
+    exit 1
+fi
+
+log_info "Pulling from subtree"
+git subtree pull --prefix "${FOLDER}" "${ORIGIN}" "${BRANCH}"
+
+CONFLICT="$(git diff --name-only --diff-filter=U)"
+if [ -n "${CONFLICT}" ]
+then
+    log_conflict_error "${CONFLICT}"
+    exit 1
+fi

zrb/builtin/monorepo/pull.py

@@ -0,0 +1,24 @@
+from datetime import datetime
+
+from zrb.builtin.monorepo._group import monorepo_group
+from zrb.builtin.monorepo._task import PULL_SUBREPO_UPSTREAM
+from zrb.runner import runner
+from zrb.task.task import Task
+from zrb.task_input.str_input import StrInput
+
+pull_from_monorepo = Task(
+    name="pull",
+    group=monorepo_group,
+    description="Pulling from subrepos",
+    inputs=[
+        StrInput(
+            name="message",
+            shortcut="m",
+            prompt="Commit Messsage",
+            default=lambda m: f"Synchronize subrepos at {datetime.now()}",
+        )
+    ],
+    retry=0,
+)
+PULL_SUBREPO_UPSTREAM >> pull_from_monorepo
+runner.register(pull_from_monorepo)

zrb/builtin/monorepo/push-monorepo.sh

@@ -0,0 +1,18 @@
+set -e
+
+CONFLICT="$(git diff --name-only --diff-filter=U)"
+if [ -n "${CONFLICT}" ]
+then
+    log_conflict_error "${CONFLICT}"
+    exit 1
+fi
+
+git add . -A
+if [ -n "$(git status --porcelain)" ]
+then
+    log_info "Commit changes"
+    git commit -m "${MESSAGE}"
+fi
+
+log_info "Pushing to main repository"
+git push origin "$(git branch --show-current)"

zrb/builtin/monorepo/push-subrepo.sh

@@ -0,0 +1,18 @@
+set -e
+
+CONFLICT="$(git diff --name-only --diff-filter=U)"
+if [ -n "${CONFLICT}" ]
+then
+    log_conflict_error "${CONFLICT}"
+    exit 1
+fi
+
+git add . -A
+if [ -n "$(git status --porcelain)" ]
+then
+    log_info "Commit changes"
+    git commit -m "${MESSAGE}"
+fi
+
+log_info "Pushing to subtree"
+git subtree push --prefix "${FOLDER}" "${ORIGIN}" "${BRANCH}"