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

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/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 (

zrb/task/base_task/base_task.py

@@ -2,9 +2,11 @@ import asyncio
 import copy
 import os
 import shutil
+from collections.abc import Callable, Iterable, Mapping
+from typing import Any, Optional, Union
 
 from zrb.advertisement import advertisements
-from zrb.config.config import show_advertisement, tmp_dir
+from zrb.config.config import SHOW_ADVERTISEMENT, TMP_DIR
 from zrb.helper.accessories.name import get_random_name
 from zrb.helper.advertisement import get_advertisement
 from zrb.helper.callable import run_async
@@ -12,7 +14,6 @@ from zrb.helper.map.conversion import to_str as map_to_str
 from zrb.helper.string.conversion import to_variable_name
 from zrb.helper.string.modification import double_quote
 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,
@@ -41,14 +42,14 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
     Every Task definition should be extended from this class.
     """
 
-    __running_tasks: List[AnyTask] = []
+    __running_tasks: list[AnyTask] = []
 
     def __init__(
         self,
         name: str,
         group: Optional[Group] = None,
         description: str = "",
-        inputs: List[AnyInput] = [],
+        inputs: list[AnyInput] = [],
         envs: Iterable[Env] = [],
         env_files: Iterable[EnvFile] = [],
         icon: Optional[str] = None,
@@ -119,7 +120,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
             operand.add_upstream(self)
             return operand
         if isinstance(operand, AnyParallel):
-            other_tasks: List[AnyTask] = operand.get_tasks()
+            other_tasks: list[AnyTask] = operand.get_tasks()
             for other_task in other_tasks:
                 other_task.add_upstream(self)
             return operand
@@ -127,7 +128,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
     def __get_xcom_dir(self, execution_id: Optional[str] = None) -> str:
         if execution_id is None:
             execution_id = self.get_execution_id()
-        return os.path.join(tmp_dir, f"xcom.{execution_id}")
+        return os.path.join(TMP_DIR, f"xcom.{execution_id}")
 
     def __ensure_xcom_dir_exists(self, execution_id: Optional[str] = None):
         xcom_dir = self.__get_xcom_dir(execution_id=execution_id)
@@ -303,7 +304,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
             await asyncio.sleep(self._checking_interval)
         self._end_timer()
         if show_done_info:
-            if show_advertisement:
+            if SHOW_ADVERTISEMENT:
                 selected_advertisement = get_advertisement(advertisements)
                 selected_advertisement.show()
             self._show_done_info()
@@ -415,7 +416,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
         # wait all upstream checkers to complete
         await asyncio.gather(*coroutines)
 
-    async def __trigger_failure(self, tasks: List[AnyTask]):
+    async def __trigger_failure(self, tasks: list[AnyTask]):
         coroutines = [
             task.on_failed(is_last_attempt=True, exception=Exception("canceled"))
             for task in tasks
@@ -423,7 +424,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
         await asyncio.gather(*coroutines)
 
     async def __trigger_fallbacks(
-        self, tasks: List[AnyTask], kwargs: Mapping[str, Any]
+        self, tasks: list[AnyTask], kwargs: Mapping[str, Any]
     ):
         coroutines: Iterable[asyncio.Task] = []
         for fallback in self.__get_all_fallbacks(tasks):
@@ -431,8 +432,8 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
             coroutines.append(asyncio.create_task(fallback._run_all(**kwargs)))
         await asyncio.gather(*coroutines)
 
-    def __get_all_fallbacks(self, tasks: List[AnyTask]) -> List[AnyTask]:
-        all_fallbacks: List[AnyTask] = []
+    def __get_all_fallbacks(self, tasks: list[AnyTask]) -> list[AnyTask]:
+        all_fallbacks: list[AnyTask] = []
         for task in tasks:
             task._lock_fallbacks()
             for fallback in task._get_fallbacks():

zrb/task/base_task/component/base_task_model.py

@@ -2,24 +2,17 @@ import datetime
 import logging
 import os
 import sys
+from collections.abc import Callable, Iterable, Mapping
 from functools import lru_cache
+from typing import Any, Optional, Union
 
-from zrb.config.config import env_prefix, logging_level, show_time
+from zrb.config.config import ENV_PREFIX, LOGGING_LEVEL, SHOW_TIME
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
 from zrb.helper.string.conversion import to_variable_name
 from zrb.helper.string.modification import double_quote
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import (
-    Any,
-    Callable,
-    Iterable,
-    JinjaTemplate,
-    List,
-    Mapping,
-    Optional,
-    Union,
-)
+from zrb.helper.typing import JinjaTemplate
 from zrb.task.any_task import AnyTask
 from zrb.task.any_task_event_handler import (
     OnFailed,
@@ -48,7 +41,7 @@ class BaseTaskModel(CommonTaskModel, PidModel, TimeTracker):
         name: str,
         group: Optional[Group] = None,
         description: str = "",
-        inputs: List[AnyInput] = [],
+        inputs: list[AnyInput] = [],
         envs: Iterable[Env] = [],
         env_files: Iterable[EnvFile] = [],
         icon: Optional[str] = None,
@@ -102,7 +95,7 @@ class BaseTaskModel(CommonTaskModel, PidModel, TimeTracker):
         )
         PidModel.__init__(self)
         TimeTracker.__init__(self)
-        self.__args: List[Any] = []
+        self.__args: list[Any] = []
         self.__kwargs: Mapping[str, Any] = {}
 
     def _set_args(self, args: Iterable[Any]):
@@ -118,35 +111,35 @@ class BaseTaskModel(CommonTaskModel, PidModel, TimeTracker):
         self.__kwargs = kwargs
 
     def log_debug(self, message: Any):
-        if logging_level > logging.DEBUG:
+        if LOGGING_LEVEL > logging.DEBUG:
             return
         prefix = self.__get_log_prefix()
         colored_message = colored(f"{prefix} • {message}", attrs=["dark"])
         logger.debug(colored_message)
 
     def log_warn(self, message: Any):
-        if logging_level > logging.WARNING:
+        if LOGGING_LEVEL > logging.WARNING:
             return
         prefix = self.__get_log_prefix()
         colored_message = colored(f"{prefix} • {message}", attrs=["dark"])
         logger.warning(colored_message)
 
     def log_info(self, message: Any):
-        if logging_level > logging.INFO:
+        if LOGGING_LEVEL > logging.INFO:
             return
         prefix = self.__get_log_prefix()
         colored_message = colored(f"{prefix} • {message}", attrs=["dark"])
         logger.info(colored_message)
 
     def log_error(self, message: Any):
-        if logging_level > logging.ERROR:
+        if LOGGING_LEVEL > logging.ERROR:
             return
         prefix = self.__get_log_prefix()
         colored_message = colored(f"{prefix} • {message}", color="red", attrs=["bold"])
         logger.error(colored_message, exc_info=True)
 
     def log_critical(self, message: Any):
-        if logging_level > logging.CRITICAL:
+        if LOGGING_LEVEL > logging.CRITICAL:
             return
         prefix = self.__get_log_prefix()
         colored_message = colored(f"{prefix} • {message}", color="red", attrs=["bold"])
@@ -192,16 +185,16 @@ class BaseTaskModel(CommonTaskModel, PidModel, TimeTracker):
         self._play_bell()
 
     def _show_env_prefix(self):
-        if env_prefix == "":
+        if ENV_PREFIX == "":
             return
-        colored_env_prefix = colored(env_prefix, color="yellow")
+        colored_env_prefix = colored(ENV_PREFIX, color="yellow")
         colored_label = colored("Your current environment: ", attrs=["dark"])
         print(colored(f"{colored_label}{colored_env_prefix}"), file=sys.stderr)
 
     def _show_run_command(self):
         if not self.__has_cli_interface:
             return
-        params: List[str] = [double_quote(arg) for arg in self.__args]
+        params: list[str] = [double_quote(arg) for arg in self.__args]
         for task_input in self._get_combined_inputs():
             if task_input.is_hidden():
                 continue
@@ -225,7 +218,7 @@ class BaseTaskModel(CommonTaskModel, PidModel, TimeTracker):
         return colored(text, color=self.get_color())
 
     def __get_print_prefix(self) -> str:
-        common_prefix = self.__get_common_prefix(show_time=show_time)
+        common_prefix = self.__get_common_prefix(show_time=SHOW_TIME)
         icon = self.get_icon()
         length = LOG_NAME_LENGTH - len(icon)
         rjust_cli_name = self.__get_rjust_full_cli_name(length)