zrb 1.0.0a8__tar.gz → 1.0.0a9__tar.gz

{zrb-1.0.0a8 → zrb-1.0.0a9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 1.0.0a8
+Version: 1.0.0a9
 Summary: Your Automation Powerhouse
 Home-page: https://github.com/state-alchemists/zrb
 License: AGPL-3.0-or-later
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: rag
 Requires-Dist: autopep8 (>=2.0.4,<3.0.0)
 Requires-Dist: beautifulsoup4 (>=4.12.3,<5.0.0)

{zrb-1.0.0a8 → zrb-1.0.0a9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zrb"
-version = "1.0.0a8"
+version = "1.0.0a9"
 description = "Your Automation Powerhouse"
 authors = ["Go Frendi Gunawan <gofrendiasgard@gmail.com>"]
 license = "AGPL-3.0-or-later"

{zrb-1.0.0a8 → zrb-1.0.0a9}/src/zrb/builtin/__init__.py

@@ -12,10 +12,14 @@ from zrb.builtin.md5 import hash_md5, sum_md5
 from zrb.builtin.project.add.fastapp import add_fastapp_to_project
 from zrb.builtin.project.create.create import create_project
 from zrb.builtin.python import format_python_code
+from zrb.builtin.setup.dev.asdf import setup_asdf
+from zrb.builtin.setup.dev.tmux import setup_tmux
+from zrb.builtin.setup.system.latex.ubuntu import setup_latex_on_ubuntu
+from zrb.builtin.setup.system.ubuntu import setup_ubuntu
 from zrb.builtin.shell.autocomplete.bash import make_bash_autocomplete
 from zrb.builtin.shell.autocomplete.subcmd import get_shell_subcommands
 from zrb.builtin.shell.autocomplete.zsh import make_zsh_autocomplete
-from zrb.builtin.todo import todo_add, todo_complete, todo_edit, todo_list, todo_log
+from zrb.builtin.todo import add_todo, complete_todo, edit_todo, list_todo, log_todo
 
 assert create_project
 assert add_fastapp_to_project
@@ -36,8 +40,12 @@ assert git_push
 assert git_add_subtree
 assert git_pull_subtree
 assert git_push_subtree
-assert todo_list
-assert todo_add
-assert todo_edit
-assert todo_complete
-assert todo_log
+assert list_todo
+assert add_todo
+assert edit_todo
+assert complete_todo
+assert log_todo
+assert setup_ubuntu
+assert setup_latex_on_ubuntu
+assert setup_asdf
+assert setup_tmux

{zrb-1.0.0a8 → zrb-1.0.0a9}/src/zrb/builtin/group.py

@@ -33,11 +33,16 @@ add_fastapp_to_project_group = add_to_project_group.add_group(
     Group(name="fastapp", description="🚀 Add Fastapp resources")
 )
 
-setup_group = cli.add_group(Group(name="setup", description="🛠️ Setup"))
+setup_group = cli.add_group(Group(name="setup", description="🔧 Setup"))
 setup_system_group = setup_group.add_group(
-    Group(name="system", description="🛠️ Setup system")
+    Group(name="system", description="🔧 Setup system")
+)
+setup_latex_group = setup_system_group.add_group(
+    Group(name="latex", description="✍️ Setup LaTeX")
+)
+setup_dev_group = setup_group.add_group(
+    Group(name="dev", description="💻 Setup developer tools")
 )
-setup_dev_group = setup_group.add_group(Group(name="dev", description="🧑‍💻 Setup dev"))
 setup_service_group = setup_group.add_group(
     Group(name="services", description="🌐 Setup services")
 )

zrb-1.0.0a9/src/zrb/builtin/setup/common_input.py

@@ -0,0 +1,35 @@
+from zrb.input.bool_input import BoolInput
+from zrb.input.option_input import OptionInput
+
+package_manager_input = OptionInput(
+    name="package-manager",
+    description="Your package manager",
+    prompt="Your package manager",
+    options=["apt", "dnf", "pacman", "zypper", "pkg", "brew", "spack"],
+    default_str="apt",
+)
+
+use_sudo_input = BoolInput(
+    name="use-sudo",
+    description="Use sudo or not",
+    prompt="Need sudo",
+    default_str="yes",
+)
+
+setup_bash_input = BoolInput(
+    name="setup-bash",
+    description="Setup bash",
+    prompt="Setup bash",
+    default_str="yes",
+)
+
+setup_zsh_input = BoolInput(
+    name="setup-zsh", description="Setup zsh", prompt="Setup zsh", default_str="yes"
+)
+
+setup_powershell_input = BoolInput(
+    name="setup-powershell",
+    description="Setup powershell",
+    prompt="Setup powershell",
+    default_str="no",
+)

zrb-1.0.0a9/src/zrb/builtin/setup/dev/asdf.py

@@ -0,0 +1,86 @@
+import os
+
+from zrb.builtin.group import setup_dev_group
+from zrb.builtin.setup.common_input import (
+    package_manager_input,
+    setup_bash_input,
+    setup_powershell_input,
+    setup_zsh_input,
+    use_sudo_input,
+)
+from zrb.builtin.setup.dev.asdf_helper import (
+    check_inexist_asdf_dir,
+    get_install_prerequisites_cmd,
+    setup_asdf_ps_config,
+    setup_asdf_sh_config,
+)
+from zrb.context.any_context import AnyContext
+from zrb.task.cmd_task import CmdTask
+from zrb.task.make_task import make_task
+
+install_asdf_prerequisites = CmdTask(
+    name="install-asdf-prerequisites",
+    input=[package_manager_input, use_sudo_input],
+    cmd=get_install_prerequisites_cmd,
+)
+
+
+download_asdf = CmdTask(
+    name="download-asdf",
+    cmd="git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.14.1",
+    execute_condition=check_inexist_asdf_dir,
+)
+install_asdf_prerequisites >> download_asdf
+
+
+@make_task(
+    name="setup-asdf-on-bash",
+    input=setup_bash_input,
+    execute_condition='{ctx.input["setup-bash"]}',
+    upstream=download_asdf,
+)
+def setup_asdf_on_bash(ctx: AnyContext):
+    ctx.print("Configure asdf for bash")
+    setup_asdf_sh_config(os.path.expanduser(os.path.join("~", ".bashrc")))
+
+
+@make_task(
+    name="setup-asdf-on-zsh",
+    input=setup_zsh_input,
+    execute_condition='{ctx.input["setup-zsh"]}',
+    upstream=download_asdf,
+)
+def setup_asdf_on_zsh(ctx: AnyContext):
+    ctx.print("Configure asdf for zsh")
+    setup_asdf_sh_config(os.path.expanduser(os.path.join("~", ".zshrc")))
+
+
+@make_task(
+    name="setup-asdf-on-powershell",
+    input=setup_powershell_input,
+    execute_condition='{ctx.input["setup-powershell"]}',
+    upstream=download_asdf,
+)
+def setup_asdf_on_powershell(ctx: AnyContext):
+    ctx.print("Configure asdf for powershell")
+    setup_asdf_ps_config(
+        os.path.expanduser(os.path.join("~", ".config", "powershell", "profile.ps1"))
+    )
+
+
+@make_task(
+    name="setup-asdf",
+    description="🧰 Setup `asdf`.",
+    group=setup_dev_group,
+    alias="asdf",
+)
+def setup_asdf(ctx: AnyContext):
+    ctx.print("Setup complete, restart your terminal to continue")
+    ctx.print("Some useful commands:")
+    ctx.print("- asdf plugin add python")
+    ctx.print("- asdf list all python")
+    ctx.print("- asdf install python 3.12.0")
+    ctx.print("- asdf global python 3.12.0")
+
+
+setup_asdf << [setup_asdf_on_bash, setup_asdf_on_zsh, setup_asdf_on_powershell]

zrb-1.0.0a9/src/zrb/builtin/setup/dev/asdf_helper.py

@@ -0,0 +1,44 @@
+import os
+
+from zrb.context.any_context import AnyContext
+
+
+def get_install_prerequisites_cmd(ctx: AnyContext) -> str:
+    package_manager: str = ctx.input["package-manager"]
+    if package_manager in ["brew", "spack"]:
+        cmd = f"{package_manager} install coreutils curl git"
+    elif package_manager == "pacman":
+        cmd = f"{package_manager} -S curl git"
+    else:
+        cmd = f"{package_manager} install curl git"
+    use_sudo: bool = ctx.input["use-sudo"]
+    if use_sudo:
+        return f"sudo {cmd}"
+    return cmd
+
+
+def check_inexist_asdf_dir(_: AnyContext):
+    asdf_dir = os.path.expanduser(os.path.join("~", ".asdf"))
+    return not os.path.isdir(asdf_dir)
+
+
+def setup_asdf_sh_config(file_path: str):
+    _setup_asdf_config(file_path, '. "$HOME/.asdf/asdf.sh"')
+
+
+def setup_asdf_ps_config(file_path: str):
+    _setup_asdf_config(file_path, '. "$HOME/.asdf/asdf.ps1"')
+
+
+def _setup_asdf_config(file_path: str, asdf_config: str):
+    dir_path = os.path.dirname(file_path)
+    os.makedirs(dir_path, exist_ok=True)
+    if not os.path.isfile(file_path):
+        with open(file_path, "w") as f:
+            f.write("")
+    with open(file_path, "r") as f:
+        content = f.read()
+    if asdf_config in content:
+        return
+    with open(file_path, "a") as f:
+        f.write(f"\n{asdf_config}\n")

zrb-1.0.0a9/src/zrb/builtin/setup/dev/tmux.py

@@ -0,0 +1,50 @@
+import os
+
+from zrb.builtin.group import setup_dev_group
+from zrb.builtin.setup.common_input import package_manager_input, use_sudo_input
+from zrb.builtin.setup.dev.tmux_helper import get_install_tmux_cmd
+from zrb.context.any_context import AnyContext
+from zrb.input.str_input import StrInput
+from zrb.task.cmd_task import CmdTask
+from zrb.task.make_task import make_task
+
+install_tmux = CmdTask(
+    name="install-tmux",
+    input=[package_manager_input, use_sudo_input],
+    cmd=get_install_tmux_cmd,
+)
+
+
+@make_task(
+    name="setup-tmux",
+    input=StrInput(
+        name="tmux-config",
+        description="Tmux config file",
+        prompt="Tmux config file",
+        default_str="~/.tmux.conf",
+    ),
+    description="🖥️ Setup `tmux`.",
+    group=setup_dev_group,
+    alias="tmux",
+)
+def setup_tmux(ctx: AnyContext):
+    with open(os.path.join(os.path.dirname(__file__), "tmux_config.sh"), "r") as f:
+        tmux_config_template = f.read()
+    tmux_config_file = os.path.expanduser(ctx.input["tmux-config"])
+    tmux_config_dir = os.path.dirname(tmux_config_file)
+    # Make sure config file exists
+    os.makedirs(tmux_config_dir, exist_ok=True)
+    if not os.path.isfile(tmux_config_file):
+        with open(tmux_config_file, "w") as f:
+            f.write("")
+    with open(tmux_config_file, "r") as f:
+        # config file already contain the config
+        if tmux_config_template in f.read():
+            return
+    # Write config
+    with open(tmux_config_file, "a") as f:
+        f.write(f"\n{tmux_config_template}\n")
+    ctx.print("Setup complete, restart your terminal to continue")
+
+
+install_tmux >> setup_tmux

zrb-1.0.0a9/src/zrb/builtin/setup/dev/tmux_helper.py

@@ -0,0 +1,13 @@
+from zrb.context.any_context import AnyContext
+
+
+def get_install_tmux_cmd(ctx: AnyContext) -> str:
+    package_manager: str = ctx.input["package-manager"]
+    if package_manager == "pacman":
+        cmd = f"{package_manager} -S tmux"
+    else:
+        cmd = f"{package_manager} install tmux"
+    use_sudo: bool = ctx.input["use-sudo"]
+    if use_sudo:
+        return f"sudo {cmd}"
+    return cmd

zrb-1.0.0a9/src/zrb/builtin/setup/system/latex/ubuntu.py

@@ -0,0 +1,18 @@
+from zrb.builtin.group import setup_latex_group
+from zrb.builtin.setup.system.ubuntu import setup_ubuntu
+from zrb.task.cmd_task import CmdTask
+
+setup_latex_on_ubuntu = setup_latex_group.add_task(
+    CmdTask(
+        name="setup-latex-on-ubuntu",
+        description="🐧 Setup LaTeX on Ubuntu",
+        cmd=[
+            "sudo apt install -y \\",
+            "texlive-full texlive-latex-base texlive-fonts-recommended \\",
+            "texlive-fonts-extra texlive-latex-extra",
+        ],
+        render_cmd=False,
+    ),
+    alias="ubuntu",
+)
+setup_ubuntu >> setup_latex_on_ubuntu

zrb-1.0.0a9/src/zrb/builtin/setup/system/ubuntu.py

@@ -0,0 +1,28 @@
+from zrb.builtin.group import setup_system_group
+from zrb.task.cmd_task import CmdTask
+
+update_ubuntu = CmdTask(name="update-ubuntu", cmd="sudo apt update", render_cmd=False)
+
+upgrade_todo = CmdTask(
+    name="upgrade-ubuntu", cmd="sudo apt upgrade -y", render_cmd=False
+)
+update_ubuntu >> upgrade_todo
+
+setup_ubuntu = setup_system_group.add_task(
+    CmdTask(
+        name="setup-ubuntu",
+        description="🐧 Setup ubuntu",
+        cmd=[
+            "sudo apt install -y \\",
+            "build-essential python3-distutils libssl-dev zlib1g-dev \\"
+            "libbz2-dev libreadline-dev libsqlite3-dev libpq-dev python3-dev \\",
+            "llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev \\",
+            "liblzma-dev python3-openssl libblas-dev liblapack-dev rustc \\",
+            "golang gfortran fd-find ripgrep wget curl git ncat zip unzip \\",
+            "cmake make tree tmux zsh neovim xdotool xsel",
+        ],
+        render_cmd=False,
+    ),
+    alias="ubuntu",
+)
+upgrade_todo >> setup_ubuntu

{zrb-1.0.0a8 → zrb-1.0.0a9}/src/zrb/builtin/todo.py

@@ -51,7 +51,7 @@ from zrb.util.todo import (
     group=todo_group,
     alias="add",
 )
-def todo_add(ctx: AnyContext):
+def add_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
     todo_list: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
@@ -81,7 +81,7 @@ def todo_add(ctx: AnyContext):
 
 
 @make_task(name="todo-list", description="📋 List todo", group=todo_group, alias="list")
-def todo_list(ctx: AnyContext):
+def list_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
     todo_tasks: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
@@ -96,7 +96,7 @@ def todo_list(ctx: AnyContext):
     group=todo_group,
     alias="complete",
 )
-def todo_complete(ctx: AnyContext):
+def complete_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
     todo_list: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
@@ -142,7 +142,7 @@ def todo_complete(ctx: AnyContext):
     group=todo_group,
     alias="log",
 )
-def todo_log(ctx: AnyContext):
+def log_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
     todo_list: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
@@ -196,7 +196,7 @@ def _get_default_start() -> str:
     group=todo_group,
     alias="edit",
 )
-def todo_edit(ctx: AnyContext):
+def edit_todo(ctx: AnyContext):
     todo_list = [
         cascade_todo_task(line_to_todo_task(line))
         for line in ctx.input.text.split("\n")

{zrb-1.0.0a8 → zrb-1.0.0a9}/src/zrb/config.py

@@ -49,6 +49,9 @@ LOGGING_LEVEL = _get_log_level(os.getenv("ZRB_LOGGING_LEVEL", "WARNING"))
 LOAD_BUILTIN = to_boolean(os.getenv("ZRB_LOAD_BUILTIN", "1"))
 ENV_PREFIX = os.getenv("ZRB_ENV", "")
 SHOW_PROMPT = to_boolean(os.getenv("ZRB_SHOW_PROMPT", "1"))
+WARN_UNRECOMMENDED_COMMAND = to_boolean(
+    os.getenv("ZRB_WARN_UNRECOMMENDED_COMMAND", "1")
+)
 SESSION_LOG_DIR = os.getenv(
     "ZRB_SESSION_LOG_DIR", os.path.expanduser(os.path.join("~", ".zrb-session"))
 )

{zrb-1.0.0a8 → zrb-1.0.0a9}/src/zrb/task/cmd_task.py

@@ -5,13 +5,14 @@ import sys
 from zrb.attr.type import BoolAttr, IntAttr, StrAttr
 from zrb.cmd.cmd_result import CmdResult
 from zrb.cmd.cmd_val import AnyCmdVal, CmdVal, SingleCmdVal
-from zrb.config import DEFAULT_SHELL
+from zrb.config import DEFAULT_SHELL, WARN_UNRECOMMENDED_COMMAND
 from zrb.context.any_context import AnyContext
 from zrb.env.any_env import AnyEnv
 from zrb.input.any_input import AnyInput
 from zrb.task.any_task import AnyTask
 from zrb.task.base_task import BaseTask
 from zrb.util.attr import get_int_attr, get_str_attr
+from zrb.util.cmd.command import check_unrecommended_commands
 from zrb.util.cmd.remote import get_remote_cmd_script
 
 
@@ -32,6 +33,7 @@ class CmdTask(BaseTask):
         remote_host: StrAttr | None = None,
         render_remote_host: bool = True,
         remote_port: IntAttr | None = None,
+        render_remote_port: bool = True,
         remote_user: StrAttr | None = None,
         render_remote_user: bool = True,
         remote_password: StrAttr | None = None,
@@ -42,6 +44,7 @@ class CmdTask(BaseTask):
         render_cmd: bool = True,
         cwd: str | None = None,
         render_cwd: bool = True,
+        warn_unrecommended_command: bool | None = None,
         max_output_line: int = 1000,
         max_error_line: int = 1000,
         execute_condition: BoolAttr = True,
@@ -83,6 +86,7 @@ class CmdTask(BaseTask):
         self._remote_host = remote_host
         self._render_remote_host = render_remote_host
         self._remote_port = remote_port
+        self._render_remote_port = render_remote_port
         self._remote_user = remote_user
         self._render_remote_user = render_remote_user
         self._remote_password = remote_password
@@ -95,6 +99,7 @@ class CmdTask(BaseTask):
         self._render_cwd = render_cwd
         self._max_output_line = max_output_line
         self._max_error_line = max_error_line
+        self._should_warn_unrecommended_command = warn_unrecommended_command
 
     async def _exec_action(self, ctx: AnyContext) -> CmdResult:
         """Turn _cmd attribute into subprocess.Popen and execute it as task's action.
@@ -105,7 +110,6 @@ class CmdTask(BaseTask):
         Returns:
             Any: The result of the action execution.
         """
-        ctx.log_info("Running script")
         cmd_script = self._get_cmd_script(ctx)
         ctx.log_debug(f"Script: {self.__get_multiline_repr(cmd_script)}")
         shell = self._get_shell(ctx)
@@ -116,7 +120,10 @@ class CmdTask(BaseTask):
         env_map = self.__get_env_map(ctx)
         ctx.log_debug(f"Environment map: {env_map}")
         cmd_process = None
+        if self._get_should_warn_unrecommended_commands():
+            self._check_unrecommended_commands(ctx, shell, cmd_script)
         try:
+            ctx.log_info("Running script")
             cmd_process = await asyncio.create_subprocess_exec(
                 shell,
                 shell_flag,
@@ -150,6 +157,21 @@ class CmdTask(BaseTask):
             if cmd_process is not None and cmd_process.returncode is None:
                 cmd_process.terminate()
 
+    def _get_should_warn_unrecommended_commands(self):
+        if self._should_warn_unrecommended_command is None:
+            return WARN_UNRECOMMENDED_COMMAND
+        return self._should_warn_unrecommended_command
+
+    def _check_unrecommended_commands(
+        self, ctx: AnyContext, shell: str, cmd_script: str
+    ):
+        if shell.endswith("bash") or shell.endswith("zsh"):
+            unrecommended_commands = check_unrecommended_commands(cmd_script)
+            if unrecommended_commands:
+                ctx.log_warning("The script contains unrecommended commands")
+            for command, reason in unrecommended_commands.items():
+                ctx.log_warning(f"- {command}: {reason}")
+
     def __get_env_map(self, ctx: AnyContext) -> dict[str, str]:
         envs = {key: val for key, val in ctx.env.items()}
         envs["_ZRB_SSH_PASSWORD"] = self._get_remote_password(ctx)
@@ -195,7 +217,9 @@ class CmdTask(BaseTask):
         )
 
     def _get_remote_port(self, ctx: AnyContext) -> int:
-        return get_int_attr(ctx, self._remote_port, 22, auto_render=True)
+        return get_int_attr(
+            ctx, self._remote_port, 22, auto_render=self._render_remote_port
+        )
 
     def _get_remote_user(self, ctx: AnyContext) -> str:
         return get_str_attr(

{zrb-1.0.0a8 → zrb-1.0.0a9}/src/zrb/task/llm_task.py

@@ -108,8 +108,13 @@ class LLMTask(BaseTask):
         )
 
     async def _exec_action(self, ctx: AnyContext) -> Any:
-        from litellm import acompletion
+        from litellm import acompletion, supports_function_calling
 
+        model = self._get_model(ctx)
+        try:
+            allow_function_call = supports_function_calling(model=model)
+        except Exception:
+            allow_function_call = False
         model_kwargs = self._get_model_kwargs(ctx)
         ctx.log_debug("MODEL KWARGS", model_kwargs)
         system_prompt = self._get_system_prompt(ctx)
@@ -121,27 +126,28 @@ class LLMTask(BaseTask):
         messages = history + [user_message]
         available_tools = self._get_tools(ctx)
         available_tools["scratchpad"] = scratchpad
-        tool_schema = [
-            callable_to_tool_schema(tool, name)
-            for name, tool in available_tools.items()
-        ]
-        for additional_tool in self._additional_tools:
-            fn = additional_tool.fn
-            tool_name = additional_tool.name or fn.__name__
-            tool_description = additional_tool.description
-            available_tools[tool_name] = additional_tool.fn
-            tool_schema.append(
-                callable_to_tool_schema(
-                    fn, name=tool_name, description=tool_description
+        if allow_function_call:
+            tool_schema = [
+                callable_to_tool_schema(tool, name)
+                for name, tool in available_tools.items()
+            ]
+            for additional_tool in self._additional_tools:
+                fn = additional_tool.fn
+                tool_name = additional_tool.name or fn.__name__
+                tool_description = additional_tool.description
+                available_tools[tool_name] = additional_tool.fn
+                tool_schema.append(
+                    callable_to_tool_schema(
+                        fn, name=tool_name, description=tool_description
+                    )
                 )
-            )
-        ctx.log_debug("TOOL SCHEMA", tool_schema)
+            model_kwargs["tools"] = tool_schema
+            ctx.log_debug("TOOL SCHEMA", tool_schema)
         history_file = self._get_history_file(ctx)
         while True:
             response = await acompletion(
-                model=self._get_model(ctx),
+                model=model,
                 messages=[{"role": "system", "content": system_prompt}] + messages,
-                tools=tool_schema,
                 **model_kwargs,
             )
             response_message = response.choices[0].message
@@ -189,7 +195,7 @@ class LLMTask(BaseTask):
     def _get_model_kwargs(self, ctx: AnyContext) -> dict[str, Callable]:
         if callable(self._model_kwargs):
             return self._model_kwargs(ctx)
-        return self._model_kwargs
+        return {**self._model_kwargs}
 
     def _get_tools(self, ctx: AnyContext) -> dict[str, Callable]:
         if callable(self._tools):

{zrb-1.0.0a8 → zrb-1.0.0a9}/src/zrb/task/rsync_task.py

@@ -24,13 +24,13 @@ class RsyncTask(CmdTask):
         remote_host: StrAttr | None = None,
         auto_render_remote_host: bool = True,
         remote_port: IntAttr | None = None,
-        auto_render_remote_port: bool = True,
+        render_remote_port: bool = True,
         remote_user: StrAttr | None = None,
-        auto_render_remote_user: bool = True,
+        render_remote_user: bool = True,
         remote_password: StrAttr | None = None,
-        auto_render_remote_password: bool = True,
+        render_remote_password: bool = True,
         remote_ssh_key: StrAttr | None = None,
-        auto_render_remote_ssh_key: bool = True,
+        render_remote_ssh_key: bool = True,
         remote_source_path: StrAttr | None = None,
         render_remote_source_path: bool = True,
         remote_destination_path: StrAttr | None = None,
@@ -63,13 +63,13 @@ class RsyncTask(CmdTask):
             remote_host=remote_host,
             render_remote_host=auto_render_remote_host,
             remote_port=remote_port,
-            auto_render_remote_port=auto_render_remote_port,
+            auto_render_remote_port=render_remote_port,
             remote_user=remote_user,
-            render_remote_user=auto_render_remote_user,
+            render_remote_user=render_remote_user,
             remote_password=remote_password,
-            render_remote_password=auto_render_remote_password,
+            render_remote_password=render_remote_password,
             remote_ssh_key=remote_ssh_key,
-            render_remote_ssh_key=auto_render_remote_ssh_key,
+            render_remote_ssh_key=render_remote_ssh_key,
             cwd=cwd,
             render_cwd=auto_render_cwd,
             max_output_line=max_output_line,

zrb-1.0.0a9/src/zrb/util/cmd/command.py

@@ -0,0 +1,33 @@
+import re
+
+
+def check_unrecommended_commands(cmd_script: str) -> dict[str, str]:
+    banned_commands = {
+        "<(": "Process substitution isn't POSIX compliant and causes trouble",
+        "column": "Command isn't included in Ubuntu packages and is not POSIX compliant",
+        "echo": "echo isn't consistent across OS; use printf instead",
+        "eval": "Avoid eval as it can accidentally execute arbitrary strings",
+        "realpath": "Not available by default on OSX",
+        "source": "Not POSIX compliant; use '.' instead",
+        " test": "Use '[' instead for consistency",
+        "which": "Command in not POSIX compliant, use command -v",
+    }
+    banned_commands_regex = {
+        r"grep.* -y": "grep -y does not work on Alpine; use grep -i",
+        r"grep.* -P": "grep -P is not valid on OSX",
+        r"grep[^|]+--\w{2,}": "grep long commands do not work on Alpine",
+        r'readlink.+-.*f.+["$]': "readlink -f behaves differently on OSX",
+        r"sort.*-V": "sort -V is not supported everywhere",
+        r"sort.*--sort-versions": "sort --sort-version is not supported everywhere",
+        r"\bls ": "Avoid using ls; use shell globs or find instead",
+    }
+    violations = {}
+    # Check banned commands
+    for cmd, reason in banned_commands.items():
+        if cmd in cmd_script:
+            violations[cmd] = reason
+    # Check banned regex patterns
+    for pattern, reason in banned_commands_regex.items():
+        if re.search(pattern, cmd_script):
+            violations[pattern] = reason
+    return violations