zrb 0.23.4__py3-none-any.whl → 0.26.0__py3-none-any.whl

zrb/helper/cli.py

@@ -4,9 +4,10 @@ from functools import lru_cache
 
 import click
 
-from zrb.config.config import init_scripts, should_load_builtin, version
+from zrb.config.config import INIT_MODULES, INIT_SCRIPTS, SHOULD_LOAD_BUILTIN, VERSION
 from zrb.helper.accessories.color import colored
 from zrb.helper.loader.load_module import load_module
+from zrb.helper.loader.load_script import load_script
 from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.runner import runner
@@ -18,7 +19,7 @@ HELP = f"""
    zzzzz rr rr  bb
      zz  rrr  r bbbbbb
     zz   rr     bb   bb
-   zzzzz rr     bbbbbb   {version}
+   zzzzz rr     bbbbbb   {VERSION}
    _ _ . .  . _ .  _ . . .
 
 Super framework for your super app.
@@ -40,20 +41,33 @@ def create_cli() -> click.Group:
     logger.info(colored("Prepare CLI", attrs=["dark"]))
     zrb_cli_group = MultilineHelpClickGroup(name="zrb", help=HELP)
     # Load default tasks
-    if should_load_builtin:
+    if SHOULD_LOAD_BUILTIN:
         logger.info(colored("Load builtins", attrs=["dark"]))
         from zrb import builtin
 
         assert builtin
+    # load from ZRB_INIT_MODULES
+    for init_module in INIT_MODULES:
+        try:
+            load_module(init_module)
+        except Exception:
+            logger.error(
+                colored(
+                    f"Failed to load module {init_module}",
+                    color="red",
+                    attrs=["bold"],
+                )
+            )
+            traceback.print_exc()
     # Load zrb_init.py
     project_dir = os.getenv("ZRB_PROJECT_DIR", os.getcwd())
     project_script = os.path.join(project_dir, "zrb_init.py")
-    load_module(script_path=project_script, sys_path_index=0)
+    load_script(script_path=project_script, sys_path_index=0)
     # load from ZRB_INIT_SCRIPTS environment
-    for index, init_script in enumerate(init_scripts):
+    for index, init_script in enumerate(INIT_SCRIPTS):
         logger.info(colored(f"Load module from {init_script}", attrs=["dark"]))
         try:
-            load_module(script_path=init_script, sys_path_index=index + 1)
+            load_script(script_path=init_script, sys_path_index=index + 1)
         except Exception:
             logger.error(
                 colored(

zrb/helper/codemod/add_import_module.py

@@ -1,9 +1,10 @@
+from typing import Optional, Union
+
 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"]))
 
@@ -83,7 +84,7 @@ def _get_new_import(
 
 
 @typechecked
-def _split_module_path(module_path) -> Tuple[str, str]:
+def _split_module_path(module_path) -> tuple[str, str]:
     prefix = ""
     suffix = ""
     is_prefix = True

zrb/helper/codemod/add_property_to_class.py

@@ -1,9 +1,10 @@
+from typing import Optional
+
 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"])

zrb/helper/default_env.py

@@ -1,10 +1,11 @@
 import os
+from collections.abc import Mapping
 from functools import lru_cache
+from typing import Optional
 
 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, Optional
 
 logger.debug(colored("Loading zrb.helper.default_env", attrs=["dark"]))
 _PROJECT_DIR_MAP: Mapping[str, str] = {}

zrb/helper/docker_compose/fetch_external_env.py

@@ -1,7 +1,9 @@
+from collections.abc import Mapping
+from typing import Any
+
 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"])
@@ -19,7 +21,7 @@ def fetch_compose_file_env_map(data: Any) -> Mapping[str, str]:
         environments = data["services"][service]["environment"]
         if isinstance(environments, list):
             for environment in environments:
-                parts: List[str] = environment.split("=")
+                parts: list[str] = environment.split("=")
                 if len(parts) > 0:
                     env_str = str(parts[1])
                     env_dict = parse_compose_file_env_string(env_str)

zrb/helper/docker_compose/file.py

@@ -1,9 +1,11 @@
+from collections.abc import Mapping
+from typing import Any
+
 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"]))
 

zrb/helper/env_map/fetch.py

@@ -1,8 +1,9 @@
+from collections.abc import Mapping
+
 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
 from zrb.task.any_task import AnyTask
 from zrb.task_env.env import Env
 from zrb.task_group.group import Group
@@ -39,7 +40,7 @@ def fetch_env_map_from_task(env_map: Mapping[str, str], task: AnyTask):
 
 @typechecked
 def _add_envs_to_env_map(
-    env_map: Mapping[str, str], envs: List[Env]
+    env_map: Mapping[str, str], envs: list[Env]
 ) -> Mapping[str, str]:
     for env in envs:
         if env.get_os_name() == "":

zrb/helper/file/copy_tree.py

@@ -1,13 +1,14 @@
 import fnmatch
 import os
 import shutil
+from collections.abc import Iterable, Mapping
+from typing import Optional
 
 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"]))
 

zrb/helper/file/match.py

@@ -1,16 +1,16 @@
 import fnmatch
 import glob
+from collections.abc import Iterable
 
 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]:
+def get_file_names(glob_path: str, glob_ignored_paths: Iterable[str]) -> list[str]:
     matches = []
     for file in glob.glob(glob_path, recursive=True):
         should_ignore = any(

zrb/helper/git/detect_changes.py

@@ -1,9 +1,9 @@
 import subprocess
+from collections.abc import Mapping
 
 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"]))
 

zrb/helper/loader/load_module.py

@@ -1,8 +1,6 @@
-import importlib.util
-import os
-import re
-import sys
+import importlib
 from functools import lru_cache
+from typing import Any
 
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
@@ -10,48 +8,11 @@ from zrb.helper.typecheck import typechecked
 
 logger.debug(colored("Loading zrb.helper.loader.load_module", attrs=["dark"]))
 
-pattern = re.compile("[^a-zA-Z0-9]")
-
 
 @lru_cache
 @typechecked
-def load_module(script_path: str, sys_path_index: int = 0):
-    if not os.path.isfile(script_path):
-        return
-    script_dir_path = os.path.dirname(script_path)
-    _append_dir_to_sys_path(script_dir_path, sys_path_index)
-    _append_dir_to_python_path(script_dir_path)
-    _exec_script_as_module(script_path)
-
-
-def _exec_script_as_module(script_path: str):
-    module_name = pattern.sub("", script_path)
-    logger.info(colored(f"Get module spec: {script_path}", attrs=["dark"]))
-    spec = importlib.util.spec_from_file_location(module_name, script_path)
-    logger.info(colored(f"Create module: {script_path}", attrs=["dark"]))
-    module = importlib.util.module_from_spec(spec)
-    logger.info(colored(f"Exec module: {script_path}", attrs=["dark"]))
-    spec.loader.exec_module(module)
-    logger.info(colored(f"Module executed: {script_path}", attrs=["dark"]))
-
-
-def _append_dir_to_sys_path(dir_path: str, index: int):
-    if dir_path in sys.path:
-        return
-    sys.path.insert(index, dir_path)
-    logger.info(colored(f"Set sys.path to {sys.path}", attrs=["dark"]))
-
-
-def _append_dir_to_python_path(dir_path: str):
-    new_python_path = _get_new_python_path(dir_path)
-    logger.info(colored(f"Set PYTHONPATH to {new_python_path}", attrs=["dark"]))
-    os.environ["PYTHONPATH"] = new_python_path
-
-
-def _get_new_python_path(dir_path: str) -> str:
-    current_python_path = os.getenv("PYTHONPATH")
-    if current_python_path is None or current_python_path == "":
-        return dir_path
-    if dir_path in current_python_path.split(":"):
-        return current_python_path
-    return ":".join([current_python_path, dir_path])
+def load_module(module_name: str) -> Any:
+    logger.info(colored(f"Importing module: {module_name}", attrs=["dark"]))
+    module = importlib.import_module(module_name)
+    logger.info(colored(f"Module imported: {module_name}", attrs=["dark"]))
+    return module

zrb/helper/loader/load_script.py

@@ -0,0 +1,57 @@
+import importlib.util
+import os
+import re
+import sys
+from functools import lru_cache
+
+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_script", attrs=["dark"]))
+
+pattern = re.compile("[^a-zA-Z0-9]")
+
+
+@lru_cache
+@typechecked
+def load_script(script_path: str, sys_path_index: int = 0):
+    if not os.path.isfile(script_path):
+        return
+    script_dir_path = os.path.dirname(script_path)
+    _append_dir_to_sys_path(script_dir_path, sys_path_index)
+    _append_dir_to_python_path(script_dir_path)
+    _exec_script_as_module(script_path)
+
+
+def _exec_script_as_module(script_path: str):
+    module_name = pattern.sub("", script_path)
+    logger.info(colored(f"Get module spec: {script_path}", attrs=["dark"]))
+    spec = importlib.util.spec_from_file_location(module_name, script_path)
+    logger.info(colored(f"Create module: {script_path}", attrs=["dark"]))
+    module = importlib.util.module_from_spec(spec)
+    logger.info(colored(f"Exec module: {script_path}", attrs=["dark"]))
+    spec.loader.exec_module(module)
+    logger.info(colored(f"Module executed: {script_path}", attrs=["dark"]))
+
+
+def _append_dir_to_sys_path(dir_path: str, index: int):
+    if dir_path in sys.path:
+        return
+    sys.path.insert(index, dir_path)
+    logger.info(colored(f"Set sys.path to {sys.path}", attrs=["dark"]))
+
+
+def _append_dir_to_python_path(dir_path: str):
+    new_python_path = _get_new_python_path(dir_path)
+    logger.info(colored(f"Set PYTHONPATH to {new_python_path}", attrs=["dark"]))
+    os.environ["PYTHONPATH"] = new_python_path
+
+
+def _get_new_python_path(dir_path: str) -> str:
+    current_python_path = os.getenv("PYTHONPATH")
+    if current_python_path is None or current_python_path == "":
+        return dir_path
+    if dir_path in current_python_path.split(":"):
+        return current_python_path
+    return ":".join([current_python_path, dir_path])

zrb/helper/log.py

@@ -1,15 +1,15 @@
 import logging
 
-from zrb.config.config import logging_level
+from zrb.config.config import LOGGING_LEVEL
 from zrb.helper.accessories.untyped_color import untyped_colored as colored
 
 # create logger
 logger = logging.getLogger("zrb")
-logger.setLevel(logging_level)
+logger.setLevel(LOGGING_LEVEL)
 
 # create console handler and set level to debug
 ch = logging.StreamHandler()
-ch.setLevel(logging_level)
+ch.setLevel(LOGGING_LEVEL)
 
 # create formatter
 formatter = logging.Formatter(

zrb/helper/map/conversion.py

@@ -1,7 +1,9 @@
+from collections.abc import Mapping
+from typing import Any
+
 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.map.conversion", attrs=["dark"]))
 

zrb/helper/string/jinja.py

@@ -1,7 +1,8 @@
+from typing import Any
+
 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
 
 logger.debug(colored("Loading zrb.helper.string.jinja", attrs=["dark"]))
 

zrb/helper/string/parse_replacement.py

@@ -1,9 +1,9 @@
 import re
+from collections.abc import Mapping
 
 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.string.parse_replacment", attrs=["dark"]))
 

zrb/helper/typecheck.py

@@ -1,6 +1,6 @@
 from typing import TypeVar
 
-from zrb.config.config import enable_type_checking
+from zrb.config.config import ENABLE_TYPE_CHECKING
 from zrb.helper.accessories.untyped_color import untyped_colored as colored
 from zrb.helper.log import logger
 
@@ -9,7 +9,7 @@ T = TypeVar("T")
 
 
 def typechecked(anything: T) -> T:
-    if enable_type_checking:
+    if ENABLE_TYPE_CHECKING:
         from beartype import beartype
 
         return beartype(anything)

zrb/helper/typing.py

@@ -1,35 +1,13 @@
-from zrb.config.config import enable_type_checking
+from collections.abc import Callable, Iterable, Mapping
+from typing import Any, Optional, Type, TypeVar, Union
+
 from zrb.helper.accessories.untyped_color import untyped_colored as colored
 from zrb.helper.log import logger
 
 logger.debug(colored("Loading zrb.helper.typing", attrs=["dark"]))
 
-if enable_type_checking:
-    from beartype.typing import (
-        Any,
-        Callable,
-        Iterable,
-        List,
-        Mapping,
-        Optional,
-        Tuple,
-        Type,
-        TypeVar,
-        Union,
-    )
-else:
-    from typing import (
-        Any,
-        Callable,
-        Iterable,
-        List,
-        Mapping,
-        Optional,
-        Tuple,
-        Type,
-        TypeVar,
-        Union,
-    )
+Tuple = tuple
+List = list
 
 JinjaTemplate = str
 

zrb/helper/util.py

@@ -1,4 +1,6 @@
 import re
+from functools import lru_cache
+from typing import Any, Optional
 
 import jinja2
 
@@ -6,7 +8,6 @@ from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
 from zrb.helper.string.conversion import to_boolean as conversion_to_boolean
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import Any, Optional
 
 logger.debug(colored("Loading zrb.helper.util", attrs=["dark"]))
 
@@ -18,6 +19,7 @@ def _is_undefined(value: Any) -> bool:
     return value is None or isinstance(value, jinja2.Undefined)
 
 
+@lru_cache
 @typechecked
 def coalesce(value: Any, *alternatives: Any) -> Any:
     if not _is_undefined(value):
@@ -28,6 +30,7 @@ def coalesce(value: Any, *alternatives: Any) -> Any:
     return None
 
 
+@lru_cache
 @typechecked
 def coalesce_str(value: Any, *alternatives: Any) -> Any:
     if not _is_undefined(value) and value != "":
@@ -38,6 +41,7 @@ def coalesce_str(value: Any, *alternatives: Any) -> Any:
     return ""
 
 
+@lru_cache
 @typechecked
 def to_camel_case(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ""
@@ -47,6 +51,7 @@ def to_camel_case(text: Optional[str]) -> str:
     return pascal[0].lower() + pascal[1:]
 
 
+@lru_cache
 @typechecked
 def to_pascal_case(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ""
@@ -56,6 +61,7 @@ def to_pascal_case(text: Optional[str]) -> str:
     )
 
 
+@lru_cache
 @typechecked
 def to_kebab_case(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ""
@@ -63,6 +69,7 @@ def to_kebab_case(text: Optional[str]) -> str:
     return "-".join([x.lower() for x in _to_space_separated(text).split(" ")])
 
 
+@lru_cache
 @typechecked
 def to_snake_case(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ""
@@ -70,12 +77,14 @@ def to_snake_case(text: Optional[str]) -> str:
     return "_".join([x.lower() for x in _to_space_separated(text).split(" ")])
 
 
+@lru_cache
 @typechecked
 def _to_alphanum(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ""
     return NON_ALPHA_NUM.sub(" ", text)
 
 
+@lru_cache
 @typechecked
 def to_human_readable(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ""
@@ -87,11 +96,13 @@ def to_human_readable(text: Optional[str]) -> str:
     )
 
 
+@lru_cache
 @typechecked
 def to_capitalized_human_readable(text: Optional[str]) -> str:
     return to_human_readable(text).capitalize()
 
 
+@lru_cache
 @typechecked
 def _to_space_separated(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ""
@@ -122,6 +133,7 @@ def _to_space_separated(text: Optional[str]) -> str:
     return " ".join(new_parts).strip(" ")
 
 
+@lru_cache
 @typechecked
 def to_boolean(text: str) -> bool:
     return conversion_to_boolean(text)

zrb/runner.py

@@ -1,7 +1,7 @@
 from zrb.action.runner import Runner
-from zrb.config.config import env_prefix
+from zrb.config.config import ENV_PREFIX
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
 
 logger.debug(colored("Loading zrb.runner", attrs=["dark"]))
-runner = Runner(env_prefix=env_prefix)
+runner = Runner(env_prefix=ENV_PREFIX)

zrb/task/any_task.py

@@ -1,18 +1,10 @@
 from abc import ABC, abstractmethod
+from collections.abc import Callable, Iterable, Mapping
+from typing import Any, Optional, TypeVar, Union
 
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
-from zrb.helper.typing import (
-    Any,
-    Callable,
-    Iterable,
-    JinjaTemplate,
-    List,
-    Mapping,
-    Optional,
-    TypeVar,
-    Union,
-)
+from zrb.helper.typing import JinjaTemplate
 from zrb.task_env.env import Env
 from zrb.task_env.env_file import EnvFile
 from zrb.task_input.any_input import AnyInput
@@ -824,7 +816,7 @@ class AnyTask(ABC):
         pass
 
     @abstractmethod
-    def _get_env_files(self) -> List[EnvFile]:
+    def _get_env_files(self) -> list[EnvFile]:
         """
         Retrieves the list of environment variable files associated with the task.
 
@@ -832,7 +824,7 @@ class AnyTask(ABC):
         uses to load environment variables, primarily for setup and configuration purposes.
 
         Returns:
-            List[EnvFile]: A list of `EnvFile` instances associated with the task.
+            list[EnvFile]: A list of `EnvFile` instances associated with the task.
         """
         pass
 
@@ -850,7 +842,7 @@ class AnyTask(ABC):
         pass
 
     @abstractmethod
-    def _get_envs(self) -> List[Env]:
+    def _get_envs(self) -> list[Env]:
         """
         Retrieves the list of environment variables set for the task.
 
@@ -858,7 +850,7 @@ class AnyTask(ABC):
         configured for the task, essential for understanding and debugging the task's environment setup.
 
         Returns:
-            List[Env]: A list of `Env` instances representing the environment variables of the task.
+            list[Env]: A list of `Env` instances representing the environment variables of the task.
         """
         pass
 
@@ -880,7 +872,7 @@ class AnyTask(ABC):
         pass
 
     @abstractmethod
-    def _get_inputs(self) -> List[AnyInput]:
+    def _get_inputs(self) -> list[AnyInput]:
         """
         Retrieves the list of inputs associated with the task.
 
@@ -889,7 +881,7 @@ class AnyTask(ABC):
         for introspection and debugging purposes.
 
         Returns:
-            List[AnyInput]: A list of `AnyInput` instances representing the inputs for the task.
+            list[AnyInput]: A list of `AnyInput` instances representing the inputs for the task.
         """
         pass
 

zrb/task/any_task_event_handler.py

@@ -1,6 +1,8 @@
+from collections.abc import Callable
+from typing import Any
+
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
-from zrb.helper.typing import Any, Callable
 from zrb.task.any_task import AnyTask
 
 logger.debug(colored("Loading zrb.task.any_task_event_handler", attrs=["dark"]))

zrb/task/base_remote_cmd_task.py

@@ -1,19 +1,12 @@
 import os
 import pathlib
+from collections.abc import Callable, Iterable, Mapping
+from typing import Any, Optional, TypeVar, Union
 
 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,
-    Callable,
-    Iterable,
-    JinjaTemplate,
-    Mapping,
-    Optional,
-    TypeVar,
-    Union,
-)
+from zrb.helper.typing import JinjaTemplate
 from zrb.helper.util import to_snake_case
 from zrb.task.any_task import AnyTask
 from zrb.task.any_task_event_handler import (