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

zrb/__init__.py

@@ -32,6 +32,7 @@ from zrb.task.resource_maker import (
     get_default_resource_skip_parsing,
 )
 from zrb.task.rsync_task import RsyncTask
+from zrb.task.server import Controller, Server
 from zrb.task.task import Task
 from zrb.task.time_watcher import TimeWatcher
 from zrb.task.wiki_task import create_wiki_tasks
@@ -74,6 +75,8 @@ assert HTTPChecker
 assert PortChecker
 assert PathChecker
 assert PathWatcher
+assert Controller
+assert Server
 assert TimeWatcher
 assert ResourceMaker
 assert FlowTask

zrb/__main__.py

@@ -1,10 +1,7 @@
-from zrb.helper.accessories.color import colored
 from zrb.helper.cli import create_cli
 from zrb.helper.default_env import inject_default_env
-from zrb.helper.log import logger
 
 inject_default_env()
-logger.info(colored("Create CLI instance", attrs=["dark"]))
 cli = create_cli()
 
 if __name__ == "__main__":

zrb/action/runner.py

@@ -9,6 +9,8 @@ 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
 
+logger.debug(colored("Loading zrb.action.runner", attrs=["dark"]))
+
 CliSubcommand = Union[click.Group, click.Command]
 
 
@@ -88,7 +90,7 @@ class Runner:
         task_inputs = task._get_combined_inputs()
         task_cli_name = task.get_cli_name()
         task_description = task.get_description()
-        callback = self.__wrap_task_function(task)
+        callback = self.__get_wrapped_task_function(task)
         command = click.Command(
             callback=callback, name=task_cli_name, help=task_description
         )
@@ -106,12 +108,14 @@ class Runner:
             command.params.append(click.Option(param_decl, **options))
         return command
 
-    def __wrap_task_function(self, task: AnyTask) -> Callable[..., Any]:
+    def __get_wrapped_task_function(self, task: AnyTask) -> Callable[..., Any]:
         def wrapped_function(*args: Any, **kwargs: Any) -> Any:
             function = task.to_function(env_prefix=self.__env_prefix, raise_error=True)
             try:
                 function(*args, **kwargs)
             except Exception:
                 sys.exit(1)
+            finally:
+                task.clear_xcom()
 
         return wrapped_function

zrb/advertisement.py

@@ -1,6 +1,10 @@
+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] = [

zrb/builtin/devtool/install/_input.py

@@ -1,11 +1,9 @@
-from zrb.config.config import get_current_shell
+from zrb.config.config import default_shell
 from zrb.task_input.str_input import StrInput
 
-current_shell = get_current_shell()
-
 terminal_config_file_input = StrInput(
     name="config-file",
     shortcut="c",
     prompt="Config file",
-    default="~/.zshrc" if current_shell == "zsh" else "~/.bashrc",
+    default="~/.zshrc" if default_shell == "zsh" else "~/.bashrc",
 )

zrb/builtin/devtool/install/helix/resource/config.toml

@@ -3,6 +3,7 @@ theme = "gruvbox_transparent"
 [editor]
 line-number = "relative"
 mouse = true
+bufferline = "always"
 
 [editor.cursor-shape]
 insert = "bar"
@@ -16,4 +17,4 @@ enable = true
 hidden = false
 git-ignore = false
 git-global = false
-git-exclude = false
+git-exclude = false

zrb/builtin/process/pid/get_by_name.py

@@ -16,7 +16,7 @@ get_process_pid_by_name = CmdTask(
             prompt="Process name to be checked",
         )
     ],
-    cmd="pgrep {{ input.name }}",
+    cmd='pgrep "{{ input.name }}" || exit 0',
     checking_interval=3,
 )
 runner.register(get_process_pid_by_name)

zrb/builtin/project/create/template/project.sh

@@ -56,6 +56,7 @@ reload() {
     fi
 
     log_info 'Install'
+    poetry lock --no-update
     poetry install
 
     if [ "$IS_TERMUX" = "1" ]

zrb/builtin/schedule.py

@@ -1,10 +1,10 @@
 from zrb.builtin._helper.reccuring_action import create_recurring_action
 from zrb.runner import runner
-from zrb.task.recurring_task import RecurringTask
+from zrb.task.server import Controller, Server
 from zrb.task.time_watcher import TimeWatcher
 from zrb.task_input.str_input import StrInput
 
-schedule = RecurringTask(
+schedule = Server(
     name="schedule",
     icon="📅",
     color="yellow",
@@ -17,15 +17,21 @@ schedule = RecurringTask(
             description="Schedule cron pattern to show the message",
         ),
     ],
-    triggers=[
-        TimeWatcher(
-            name="watch-time", color="cyan", icon="⏰", schedule="{{input.schedule}}"
+    controllers=[
+        Controller(
+            name="periodic",
+            trigger=TimeWatcher(
+                name="watch-time",
+                color="cyan",
+                icon="⏰",
+                schedule="{{input.schedule}}",
+            ),
+            action=create_recurring_action(
+                notif_title="Schedule",
+                trigger_caption="Schedule",
+                trigger_xcom_key="watch-time.scheduled-time",
+            ),
         )
     ],
-    task=create_recurring_action(
-        notif_title="Schedule",
-        trigger_caption="Schedule",
-        trigger_xcom_key="watch-time.scheduled-time",
-    ),
 )
 runner.register(schedule)

zrb/builtin/watch_changes.py

@@ -1,10 +1,10 @@
 from zrb.builtin._helper.reccuring_action import create_recurring_action
 from zrb.runner import runner
 from zrb.task.path_watcher import PathWatcher
-from zrb.task.recurring_task import RecurringTask
+from zrb.task.server import Controller, Server
 from zrb.task_input.str_input import StrInput
 
-watch_changes = RecurringTask(
+watch_changes = Server(
     name="watch-changes",
     icon="🕵️",
     color="yellow",
@@ -23,19 +23,22 @@ watch_changes = RecurringTask(
             description="Ignored file pattern",
         ),
     ],
-    triggers=[
-        PathWatcher(
-            name="watch-path",
-            color="cyan",
-            icon="👀",
-            path="{{input.pattern}}",
-            ignored_path="{{input.ignored_pattern}}",
+    controllers=[
+        Controller(
+            name="watch",
+            trigger=PathWatcher(
+                name="watch-path",
+                color="cyan",
+                icon="👀",
+                path="{{input.pattern}}",
+                ignored_path="{{input.ignored_pattern}}",
+            ),
+            action=create_recurring_action(
+                notif_title="Watch",
+                trigger_caption="File changes",
+                trigger_xcom_key="watch-path.file",
+            ),
         )
     ],
-    task=create_recurring_action(
-        notif_title="Watch",
-        trigger_caption="File changes",
-        trigger_xcom_key="watch-path.file",
-    ),
 )
 runner.register(watch_changes)

zrb/config/config.py

@@ -1,17 +1,17 @@
 import importlib.metadata as metadata
 import os
 
-from zrb.helper.string.conversion import to_boolean, to_logging_level
-from zrb.helper.typecheck import typechecked
+from zrb.helper.string.untyped_conversion import (
+    untyped_to_boolean,
+    untyped_to_logging_level,
+)
 
 
-@typechecked
-def get_version() -> str:
+def _get_version() -> str:
     return metadata.version("zrb")
 
 
-@typechecked
-def get_current_shell() -> str:
+def _get_current_shell() -> str:
     current_shell = os.getenv("SHELL", "")
     if current_shell.endswith("zsh"):
         return "zsh"
@@ -24,17 +24,24 @@ def _get_valid_container_backend(container_backend: str) -> str:
     return "docker"
 
 
-tmp_dir = os.getenv("ZRB_TMP_DIR", "/tmp")
-default_shell = os.getenv("ZRB_SHELL", get_current_shell())
+def _get_default_tmp_dir() -> str:
+    if os.path.isdir("/tmp"):
+        return "/tmp"
+    return os.path.expanduser(os.path.join("~", ".tmp"))
+
+
+tmp_dir = os.getenv("ZRB_TMP_DIR", _get_default_tmp_dir())
+default_shell = os.getenv("ZRB_SHELL", _get_current_shell())
 init_script_str = os.getenv("ZRB_INIT_SCRIPTS", "")
 init_scripts = init_script_str.split(":") if init_script_str != "" else []
-logging_level = to_logging_level(os.getenv("ZRB_LOGGING_LEVEL", "WARNING"))
-should_load_builtin = to_boolean(os.getenv("ZRB_SHOULD_LOAD_BUILTIN", "1"))
+logging_level = untyped_to_logging_level(os.getenv("ZRB_LOGGING_LEVEL", "WARNING"))
+should_load_builtin = untyped_to_boolean(os.getenv("ZRB_SHOULD_LOAD_BUILTIN", "1"))
 env_prefix = os.getenv("ZRB_ENV", "")
-show_advertisement = to_boolean(os.getenv("ZRB_SHOW_ADVERTISEMENT", "1"))
-show_prompt = to_boolean(os.getenv("ZRB_SHOW_PROMPT", "1"))
-show_time = to_boolean(os.getenv("ZRB_SHOW_TIME", "1"))
-version = get_version()
+show_advertisement = untyped_to_boolean(os.getenv("ZRB_SHOW_ADVERTISEMENT", "1"))
+show_prompt = untyped_to_boolean(os.getenv("ZRB_SHOW_PROMPT", "1"))
+show_time = untyped_to_boolean(os.getenv("ZRB_SHOW_TIME", "1"))
+version = _get_version()
 container_backend = _get_valid_container_backend(
     os.getenv("ZRB_CONTAINER_BACKEND", "docker")
 )
+enable_type_checking = untyped_to_boolean(os.getenv("ZRB_ENABLE_TYPE_CHECKING", "1"))

zrb/helper/accessories/color.py

@@ -1,11 +1,14 @@
 import random
 
 from termcolor import COLORS
-from termcolor import colored as term_colored
 
+from zrb.helper.accessories.untyped_color import untyped_colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Iterable, Optional
 
+logger.debug(untyped_colored("Loading zrb.helper.accessories.color", attrs=["dark"]))
+
 
 @typechecked
 def get_random_color() -> str:
@@ -37,4 +40,4 @@ def colored(
     on_color: Optional[str] = None,
     attrs: Optional[Iterable[str]] = None,
 ) -> str:
-    return term_colored(text, color, on_color, attrs)
+    return untyped_colored(text, color, on_color, attrs)

zrb/helper/accessories/icon.py

@@ -1,7 +1,11 @@
 import random
 
+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.accessories.icon", attrs=["dark"]))
+
 
 @typechecked
 def get_random_icon() -> str:

zrb/helper/accessories/name.py

@@ -1,8 +1,12 @@
 import random
 import string
 
+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.accessories.name", attrs=["dark"]))
+
 
 @typechecked
 def get_random_name(

zrb/helper/accessories/untyped_color.py

@@ -0,0 +1,10 @@
+from termcolor import colored as term_colored
+
+
+def untyped_colored(
+    text,
+    color=None,
+    on_color=None,
+    attrs=None,
+) -> str:
+    return term_colored(text, color, on_color, attrs)

zrb/helper/advertisement.py

@@ -4,9 +4,12 @@ import re
 import sys
 
 from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Iterable, Optional
 
+logger.debug(colored("Loading zrb.helper.advertisement", attrs=["dark"]))
+
 
 @typechecked
 class Advertisement:

zrb/helper/callable.py

@@ -1,6 +1,11 @@
 import inspect
 from typing import Any, Callable
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
+
+logger.debug(colored("Loading zrb.helper.callable", attrs=["dark"]))
+
 
 async def run_async(fn: Callable, *args: Any, **kwargs: Any) -> Any:
     if inspect.iscoroutinefunction(fn):

zrb/helper/cli.py

@@ -11,6 +11,8 @@ from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.runner import runner
 
+logger.debug(colored("Loading zrb.helper.cli", attrs=["dark"]))
+
 HELP = f"""
                 bb
    zzzzz rr rr  bb

zrb/helper/codemod/add_argument_to_function.py

@@ -1,7 +1,13 @@
 import libcst as cst
 
+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.codemod.add_argument_to_function", attrs=["dark"])
+)
+
 
 @typechecked
 class AddArgumentTransformer(cst.CSTTransformer):

zrb/helper/codemod/add_argument_to_function_call.py

@@ -1,7 +1,13 @@
 import libcst as cst
 
+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.codemod.add_argument_to_function_call", attrs=["dark"])
+)
+
 
 @typechecked
 class AddArgumentTransformer(cst.CSTTransformer):

zrb/helper/codemod/add_assert_resource.py

@@ -1,7 +1,11 @@
 import libcst as cst
 
+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.codemod.add_assert_resource", attrs=["dark"]))
+
 
 @typechecked
 def add_assert_resource(code: str, resource: str) -> str:

zrb/helper/codemod/add_function_call.py

@@ -1,7 +1,11 @@
 import libcst as cst
 
+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.codemod.add_function_call", attrs=["dark"]))
+
 
 @typechecked
 def add_function_call(code: str, function_name: str, parameters: list) -> str:

zrb/helper/codemod/add_import_module.py

@@ -1,8 +1,12 @@
 import libcst as cst
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Optional, Tuple, Union
 
+logger.debug(colored("Loading zrb.helper.codemod.add_import_module", attrs=["dark"]))
+
 
 @typechecked
 def add_import_module(

zrb/helper/codemod/add_key_value_to_dict.py

@@ -1,7 +1,13 @@
 import libcst as cst
 
+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.codemod.add_key_value_to_dict", attrs=["dark"])
+)
+
 
 @typechecked
 class AddKeyValuePairTransformer(cst.CSTTransformer):

zrb/helper/codemod/add_property_to_class.py

@@ -1,8 +1,14 @@
 import libcst as cst
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Optional
 
+logger.debug(
+    colored("Loading zrb.helper.codemod.add_property_to_class", attrs=["dark"])
+)
+
 
 @typechecked
 class AddPropertyTransformer(cst.CSTTransformer):

zrb/helper/codemod/add_upstream_to_task.py

@@ -1,7 +1,11 @@
 import libcst as cst
 
+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.codemod.add_upstream_to_task", attrs=["dark"]))
+
 
 @typechecked
 class TaskTransformer(cst.CSTTransformer):

zrb/helper/codemod/append_code_to_function.py

@@ -1,7 +1,13 @@
 import libcst as cst
 
+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.codemod.append_code_to_function", attrs=["dark"])
+)
+
 
 @typechecked
 class AppendCodeTransformer(cst.CSTTransformer):

zrb/helper/codemod/format_code.py

@@ -1,7 +1,11 @@
 import autopep8
 
+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.codemod.format_code", attrs=["dark"]))
+
 
 @typechecked
 def format_code(code: str) -> str:

zrb/helper/default_env.py

@@ -6,9 +6,11 @@ from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Mapping, Optional
 
+logger.debug(colored("Loading zrb.helper.default_env", attrs=["dark"]))
 _PROJECT_DIR_MAP: Mapping[str, str] = {}
 
 
+@lru_cache
 def inject_default_env():
     # Inject PYTHONUNBUFFERED
     if "PYTHONUNBUFFERED" not in os.environ:

zrb/helper/docker_compose/fetch_external_env.py

@@ -1,6 +1,12 @@
+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, List, Mapping
 
+logger.debug(
+    colored("Loading zrb.helper.docker_compose.fetch_external_env", attrs=["dark"])
+)
+
 
 @typechecked
 def fetch_compose_file_env_map(data: Any) -> Mapping[str, str]:

zrb/helper/docker_compose/file.py

@@ -1,8 +1,12 @@
 from ruamel.yaml import YAML, CommentedMap
 
+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, Mapping
 
+logger.debug(colored("Loading zrb.helper.docker_compose.file", attrs=["dark"]))
+
 
 @typechecked
 def read_compose_file(file_name: str) -> Any:

zrb/helper/docstring.py

@@ -1,6 +1,11 @@
 import inspect
 import re
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
+
+logger.debug(colored("Loading zrb.helper.docstring", attrs=["dark"]))
+
 
 def get_markdown_from_docstring(cls) -> str:
     """

zrb/helper/env_map/fetch.py

@@ -1,3 +1,5 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.string.jinja import is_probably_jinja
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import List, Mapping
@@ -5,6 +7,8 @@ from zrb.task.any_task import AnyTask
 from zrb.task_env.env import Env
 from zrb.task_group.group import Group
 
+logger.debug(colored("Loading zrb.helper.env_map.fetch", attrs=["dark"]))
+
 
 @typechecked
 def fetch_env_map_from_group(

zrb/helper/file/copy_tree.py

@@ -2,12 +2,15 @@ import fnmatch
 import os
 import shutil
 
+from zrb.helper.accessories.color import colored
 from zrb.helper.file.text import read_text_file_async, write_text_file_async
 from zrb.helper.log import logger
 from zrb.helper.string.parse_replacement import parse_replacement
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Iterable, Mapping, Optional
 
+logger.debug(colored("Loading zrb.helper.file.copy_tree", attrs=["dark"]))
+
 
 @typechecked
 async def copy_tree(

zrb/helper/file/match.py

@@ -1,9 +1,13 @@
 import fnmatch
 import glob
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Iterable, List
 
+logger.debug(colored("Loading zrb.helper.file.match", attrs=["dark"]))
+
 
 @typechecked
 def get_file_names(glob_path: str, glob_ignored_paths: Iterable[str]) -> List[str]:

zrb/helper/file/text.py

@@ -2,8 +2,12 @@ import os
 
 import aiofiles
 
+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.file.text", attrs=["dark"]))
+
 
 @typechecked
 async def read_text_file_async(file_name: str) -> str:

zrb/helper/git/detect_changes.py

@@ -1,8 +1,12 @@
 import subprocess
 
+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.git.detect_changes", attrs=["dark"]))
+
 
 @typechecked
 class ModificationState:

zrb/helper/loader/load_module.py

@@ -8,6 +8,8 @@ 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.loader.load_module", attrs=["dark"]))
+
 pattern = re.compile("[^a-zA-Z0-9]")
 
 

zrb/helper/log.py

@@ -1,7 +1,7 @@
 import logging
 
 from zrb.config.config import logging_level
-from zrb.helper.accessories.color import colored
+from zrb.helper.accessories.untyped_color import untyped_colored as colored
 
 # create logger
 logger = logging.getLogger("zrb")