zrb 0.0.85__py3-none-any.whl → 0.0.87__py3-none-any.whl

zrb/helper/codemod/append_code_to_function.py

@@ -1,6 +1,8 @@
+from typeguard import typechecked
 import libcst as cst
 
 
+@typechecked
 class AppendCodeTransformer(cst.CSTTransformer):
     def __init__(self, function_name: str, new_code: str):
         self.function_name = function_name
@@ -20,6 +22,7 @@ class AppendCodeTransformer(cst.CSTTransformer):
         return updated_node
 
 
+@typechecked
 def append_code_to_function(
     code: str, function_name: str, new_code: str
 ) -> str:

zrb/helper/codemod/format_code.py

@@ -1,5 +1,7 @@
+from typeguard import typechecked
 import autopep8
 
 
+@typechecked
 def format_code(code: str) -> str:
     return autopep8.fix_code(code)

zrb/helper/default_env.py

@@ -1,3 +1,4 @@
+from typeguard import typechecked
 from typing import Optional
 from .accessories.color import colored
 from .log import logger
@@ -34,6 +35,7 @@ def inject_default_env():
         os.environ['ZRB_PROJECT_NAME'] = zrb_project_name
 
 
+@typechecked
 def _get_project_dir(project_dir: str) -> Optional[str]:
     project_script = os.path.join(project_dir, 'zrb_init.py')
     if os.path.isfile(project_script):

zrb/helper/docker_compose/fetch_external_env.py

@@ -1,6 +1,8 @@
+from typeguard import typechecked
 from typing import Any, List, Mapping
 
 
+@typechecked
 def fetch_compose_file_env_map(data: Any) -> Mapping[str, str]:
     global_env_dict = {}
     if 'services' not in data:
@@ -24,6 +26,7 @@ def fetch_compose_file_env_map(data: Any) -> Mapping[str, str]:
     return global_env_dict
 
 
+@typechecked
 def parse_compose_file_env_string(env_str: str) -> Mapping[str, str]:
     env_dict = {}
     stack = []

zrb/helper/docker_compose/file.py

@@ -1,7 +1,9 @@
+from typeguard import typechecked
 from typing import Any, Mapping
 from ruamel.yaml import YAML, CommentedMap
 
 
+@typechecked
 def read_compose_file(file_name: str) -> Any:
     yaml = YAML()
     with open(file_name, 'r') as f:
@@ -9,12 +11,14 @@ def read_compose_file(file_name: str) -> Any:
     return data
 
 
+@typechecked
 def write_compose_file(file_name: str, data: Any):
     yaml = YAML()
     with open(file_name, 'w') as f:
         yaml.dump(data, f)
 
 
+@typechecked
 def add_services(file_name: str, new_services: Mapping[str, str]):
     data = read_compose_file(file_name)
     data = CommentedMap(data)

zrb/helper/env_map/fetch.py

@@ -1,3 +1,4 @@
+from typeguard import typechecked
 from typing import List, Mapping
 from ...task_group.group import Group
 from ...task.any_task import AnyTask
@@ -5,6 +6,7 @@ from ...task_env.env import Env
 from ..string.jinja import is_probably_jinja
 
 
+@typechecked
 def fetch_env_map_from_group(
     env_map: Mapping[str, str], group: Group
 ) -> Mapping[str, str]:
@@ -18,6 +20,7 @@ def fetch_env_map_from_group(
     return env_map
 
 
+@typechecked
 def fetch_env_map_from_task(
     env_map: Mapping[str, str], task: AnyTask
 ):
@@ -34,6 +37,7 @@ def fetch_env_map_from_task(
     return env_map
 
 
+@typechecked
 def add_envs_to_env_map(
     env_map: Mapping[str, str], envs: List[Env]
 ) -> Mapping[str, str]:
@@ -46,6 +50,7 @@ def add_envs_to_env_map(
     return env_map
 
 
+@typechecked
 def cascade_env_map(
     env_map: Mapping[str, str],
     other_env_map: Mapping[str, str]
@@ -57,12 +62,14 @@ def cascade_env_map(
     return env_map
 
 
+@typechecked
 def get_env_name(env: Env) -> str:
     if env.os_name is None:
         return env.name
     return env.os_name
 
 
+@typechecked
 def get_env_default(env: Env) -> str:
     if is_probably_jinja(env.default):
         return ''

zrb/helper/file/text.py

@@ -1,17 +1,23 @@
+from typeguard import typechecked
 import aiofiles
+import os
 
 
+@typechecked
 async def read_text_file_async(file_name: str) -> str:
     async with aiofiles.open(file_name, mode='r') as file:
         content = await file.read()
     return content
 
 
+@typechecked
 async def write_text_file_async(file_name: str, content: str):
+    os.makedirs(os.path.dirname(file_name), exist_ok=True)
     async with aiofiles.open(file_name, mode='w') as file:
         await file.write(content)
 
 
+@typechecked
 async def append_text_file_async(file_name: str, additional_content: str):
     content = await read_text_file_async(file_name)
     if content != '':

zrb/helper/git/detect_changes.py

@@ -1,12 +1,16 @@
+from typeguard import typechecked
 from typing import Mapping
 import subprocess
 
+
+@typechecked
 class ModificationState():
     def __init__(self):
         self.plus: bool = False
         self.minus: bool = False
 
 
+@typechecked
 def get_modified_files(commit: str) -> Mapping[str, ModificationState]:
     exit_status, output = subprocess.getstatusoutput(f'git show {commit}')
     if exit_status != 0:

zrb/helper/loader/load_module.py

@@ -1,3 +1,4 @@
+from typeguard import typechecked
 from ..log import logger
 from ..accessories.color import colored
 
@@ -8,6 +9,7 @@ import re
 pattern = re.compile('[^a-zA-Z0-9]')
 
 
+@typechecked
 def load_module(script_path: str):
     if not os.path.isfile(script_path):
         return

zrb/helper/map/conversion.py

@@ -1,6 +1,8 @@
+from typeguard import typechecked
 from typing import Any, Mapping
 
 
+@typechecked
 def to_str(
     str_map: Mapping[str, Any],
     item_separator: str = '\n',

zrb/helper/string/conversion.py

@@ -1,3 +1,4 @@
+from typeguard import typechecked
 import keyword
 import logging
 import re
@@ -16,10 +17,12 @@ LOGGING_LEVEL_MAP = {
 }
 
 
+@typechecked
 def to_cmd_name(name: str) -> str:
     return NON_WORD.sub('-', name).strip('-').lower()
 
 
+@typechecked
 def to_variable_name(string: str) -> str:
     # Replace any non-word characters with underscore
     string = NON_WORD.sub('_', string).strip()
@@ -32,6 +35,7 @@ def to_variable_name(string: str) -> str:
     return string
 
 
+@typechecked
 def to_boolean(string: str) -> bool:
     if string.lower() in ['true', '1', 'yes', 'y', 'active']:
         return True
@@ -40,6 +44,7 @@ def to_boolean(string: str) -> bool:
     raise Exception(f'Cannot infer boolean value from "{string}"')
 
 
+@typechecked
 def to_logging_level(logging_level_str: str) -> int:
     lower_logging_level_str = logging_level_str.lower()
     if lower_logging_level_str in LOGGING_LEVEL_MAP:

zrb/helper/string/double_quote.py

@@ -1,2 +1,6 @@
-def double_quote(s):
-    return '"' + s.replace('"', '\\"') + '"'
+from typeguard import typechecked
+
+
+@typechecked
+def double_quote(text: str) -> str:
+    return '"' + text.replace('"', '\\"') + '"'

zrb/helper/string/jinja.py

@@ -1,6 +1,8 @@
+from typeguard import typechecked
 from typing import Any
 
 
+@typechecked
 def is_probably_jinja(value: Any) -> bool:
     if not isinstance(value, str):
         return False

zrb/helper/string/parse_replacement.py

@@ -1,6 +1,8 @@
+from typeguard import typechecked
 from typing import Mapping
 
 
+@typechecked
 def parse_replacement(text: str, replacement: Mapping[str, str]):
     new_text = text
     for old, new in replacement.items():

zrb/helper/util.py

@@ -1,3 +1,4 @@
+from typeguard import typechecked
 from typing import Any, Optional
 from .string.conversion import to_boolean as conversion_to_boolean
 import re
@@ -6,10 +7,12 @@ import jinja2
 NON_ALPHA_NUM = re.compile(r'[^a-zA-Z0-9]+')
 
 
+@typechecked
 def _is_undefined(value: Any) -> bool:
     return value is None or isinstance(value, jinja2.Undefined)
 
 
+@typechecked
 def coalesce(value: Any, *alternatives: Any) -> Any:
     if not _is_undefined(value):
         return value
@@ -19,6 +22,7 @@ def coalesce(value: Any, *alternatives: Any) -> Any:
     return None
 
 
+@typechecked
 def coalesce_str(value: Any, *alternatives: Any) -> Any:
     if not _is_undefined(value) and value != '':
         return str(value)
@@ -28,6 +32,7 @@ def coalesce_str(value: Any, *alternatives: Any) -> Any:
     return ''
 
 
+@typechecked
 def to_camel_case(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ''
     pascal = to_pascal_case(text)
@@ -36,6 +41,7 @@ def to_camel_case(text: Optional[str]) -> str:
     return pascal[0].lower() + pascal[1:]
 
 
+@typechecked
 def to_pascal_case(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ''
     text = _to_alphanum(text)
@@ -44,6 +50,7 @@ def to_pascal_case(text: Optional[str]) -> str:
     ])
 
 
+@typechecked
 def to_kebab_case(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ''
     text = _to_alphanum(text)
@@ -52,6 +59,7 @@ def to_kebab_case(text: Optional[str]) -> str:
     ])
 
 
+@typechecked
 def to_snake_case(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ''
     text = _to_alphanum(text)
@@ -60,11 +68,13 @@ def to_snake_case(text: Optional[str]) -> str:
     ])
 
 
+@typechecked
 def _to_alphanum(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ''
     return NON_ALPHA_NUM.sub(' ', text)
 
 
+@typechecked
 def to_human_readable(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ''
     return ' '.join([
@@ -73,10 +83,12 @@ def to_human_readable(text: Optional[str]) -> str:
     ])
 
 
+@typechecked
 def to_capitalized_human_readable(text: Optional[str]) -> str:
     return to_human_readable(text).capitalize()
 
 
+@typechecked
 def _to_space_separated(text: Optional[str]) -> str:
     text = str(text) if not _is_undefined(text) else ''
     text = text.replace('-', ' ').replace('_', ' ')
@@ -102,5 +114,6 @@ def _to_space_separated(text: Optional[str]) -> str:
     return ' '.join(new_parts).strip(' ')
 
 
+@typechecked
 def to_boolean(text: str) -> bool:
     return conversion_to_boolean(text)

zrb/task/any_task.py

@@ -4,7 +4,7 @@ from typing import (
 from abc import ABC, abstractmethod
 from ..task_env.env_file import EnvFile
 from ..task_env.env import Env
-from ..task_input.base_input import BaseInput
+from ..task_input.any_input import AnyInput
 
 TAnyTask = TypeVar('TAnyTask', bound='AnyTask')
 
@@ -69,7 +69,7 @@ class AnyTask(ABC):
         pass
 
     @abstractmethod
-    def get_all_inputs(self) -> Iterable[BaseInput]:
+    def get_all_inputs(self) -> Iterable[AnyInput]:
         pass
 
     @abstractmethod

zrb/task/base_task.py

@@ -8,8 +8,8 @@ from ..advertisement import advertisements
 from ..task_group.group import Group
 from ..task_env.env import Env
 from ..task_env.env_file import EnvFile
-from ..task_input.base_input import BaseInput
-from ..task_input._constant import RESERVED_INPUT_NAMES
+from ..task_input.any_input import AnyInput
+from ..task_input.constant import RESERVED_INPUT_NAMES
 from ..helper.accessories.color import colored
 from ..helper.advertisement import get_advertisement
 from ..helper.string.double_quote import double_quote
@@ -40,7 +40,7 @@ class BaseTask(
         name: str,
         group: Optional[Group] = None,
         description: str = '',
-        inputs: List[BaseInput] = [],
+        inputs: List[AnyInput] = [],
         envs: Iterable[Env] = [],
         env_files: Iterable[EnvFile] = [],
         icon: Optional[str] = None,
@@ -81,7 +81,7 @@ class BaseTask(
         )
         # init private properties
         self._is_keyval_set = False  # Flag
-        self._all_inputs: Optional[List[BaseInput]] = None
+        self._all_inputs: Optional[List[AnyInput]] = None
         self._is_check_triggered: bool = False
         self._is_ready: bool = False
         self._is_execution_triggered: bool = False
@@ -90,29 +90,29 @@ class BaseTask(
         self._kwargs: Mapping[str, Any] = {}
         self._allow_add_upstream: bool = True
 
-    def get_all_inputs(self) -> Iterable[BaseInput]:
+    def get_all_inputs(self) -> Iterable[AnyInput]:
         ''''
         Getting all inputs of this task and all its upstream, non-duplicated.
         '''
         if self._all_inputs is not None:
             return self._all_inputs
         self._allow_add_upstream = False
-        self._all_inputs: List[BaseInput] = []
+        self._all_inputs: List[AnyInput] = []
         existing_input_names: Mapping[str, bool] = {}
         # Add task inputs
         for task_input in self._inputs:
-            if task_input.name in existing_input_names:
+            if task_input.get_name() in existing_input_names:
                 continue
             self._all_inputs.append(task_input)
-            existing_input_names[task_input.name] = True
+            existing_input_names[task_input.get_name()] = True
         # Add upstream inputs
         for upstream in self._upstreams:
             upstream_inputs = upstream.get_all_inputs()
             for upstream_input in upstream_inputs:
-                if upstream_input.name in existing_input_names:
+                if upstream_input.get_name() in existing_input_names:
                     continue
                 self._all_inputs.append(upstream_input)
-                existing_input_names[upstream_input.name] = True
+                existing_input_names[upstream_input.get_name()] = True
         return self._all_inputs
 
     def to_function(
@@ -193,9 +193,9 @@ class BaseTask(
         self._is_keyval_set = True
         self.log_info('Set input map')
         for task_input in self.get_all_inputs():
-            input_name = self._get_normalized_input_key(task_input.name)
+            input_name = self._get_normalized_input_key(task_input.get_name())
             input_value = self.render_any(
-                kwargs.get(input_name, task_input.default)
+                kwargs.get(input_name, task_input.get_default())
             )
             self._set_input_map(input_name, input_value)
         self.log_debug(
@@ -271,7 +271,7 @@ class BaseTask(
     def _print_result(self, result: Any):
         '''
         Print result to stdout so that it can be processed further.
-        e.g.: echo $(zrb show principle solid) > solid-principle.txt
+        e.g.: echo $(zrb explain solid) > solid-principle.txt
 
         You need to override this method
         if you want to show the result differently.
@@ -298,7 +298,7 @@ class BaseTask(
     def _show_run_command(self):
         params: List[str] = [double_quote(arg) for arg in self._args]
         for task_input in self.get_all_inputs():
-            key = task_input.name
+            key = task_input.get_name()
             kwarg_key = self._get_normalized_input_key(key)
             quoted_value = double_quote(str(self._kwargs[kwarg_key]))
             params.append(f'--{key} {quoted_value}')
@@ -420,10 +420,10 @@ class BaseTask(
     async def _set_keyval(self, kwargs: Mapping[str, Any], env_prefix: str):
         # if input is not in input_map, add default values
         for task_input in self.get_all_inputs():
-            key = self._get_normalized_input_key(task_input.name)
+            key = self._get_normalized_input_key(task_input.get_name())
             if key in kwargs:
                 continue
-            kwargs[key] = task_input.default
+            kwargs[key] = task_input.get_default()
         # set current task local keyval
         await self._set_local_keyval(kwargs=kwargs, env_prefix=env_prefix)
         # get new_kwargs for upstream and checkers

zrb/task/base_task_composite.py

@@ -8,7 +8,7 @@ from ..helper.log import logger
 from ..helper.accessories.color import colored, get_random_color
 from ..helper.accessories.icon import get_random_icon
 from ..helper.util import coalesce_str
-from ..task_input.base_input import BaseInput
+from ..task_input.any_input import AnyInput
 from ..task_group.group import Group
 from ..task_env.env import Env
 from ..task_env.env_file import EnvFile
@@ -30,7 +30,7 @@ class CommonTaskModel():
         name: str,
         group: Optional[Group] = None,
         description: str = '',
-        inputs: List[BaseInput] = [],
+        inputs: List[AnyInput] = [],
         envs: Iterable[Env] = [],
         env_files: Iterable[EnvFile] = [],
         icon: Optional[str] = None,
@@ -288,7 +288,7 @@ class TaskModelWithPrinterAndTracker(
         name: str,
         group: Optional[Group] = None,
         description: str = '',
-        inputs: List[BaseInput] = [],
+        inputs: List[AnyInput] = [],
         envs: Iterable[Env] = [],
         env_files: Iterable[EnvFile] = [],
         icon: Optional[str] = None,
@@ -361,16 +361,19 @@ class TaskModelWithPrinterAndTracker(
         )
         logger.critical(colored_message, exc_info=True)
 
-    def print_out(self, msg: Any):
+    def print_out(self, message: Any, trim_message: bool = True):
         prefix = self._get_colored_print_prefix()
-        print(f'🤖 ➜  {prefix} • {msg}'.rstrip(), file=sys.stderr)
+        message_str = f'{message}'.rstrip() if trim_message else f'{message}'
+        print(f'🤖 ➜  {prefix} • {message_str}', file=sys.stderr)
 
-    def print_err(self, msg: Any):
+    def print_err(self, message: Any, trim_message: bool = True):
         prefix = self._get_colored_print_prefix()
-        print(f'🤖 ⚠  {prefix} • {msg}'.rstrip(), file=sys.stderr)
+        message_str = f'{message}'.rstrip() if trim_message else f'{message}'
+        print(f'🤖 ⚠  {prefix} • {message_str}', file=sys.stderr)
 
-    def print_out_dark(self, msg: Any):
-        self.print_out(colored(msg, attrs=['dark']))
+    def print_out_dark(self, message: Any, trim_message: bool = True):
+        message_str = f'{message}'
+        self.print_out(colored(message_str, attrs=['dark']), trim_message)
 
     def _play_bell(self):
         print('\a', end='', file=sys.stderr)

zrb/task/cmd_task.py

@@ -5,7 +5,7 @@ from .base_task import BaseTask
 from ..task_env.env import Env
 from ..task_env.env_file import EnvFile
 from ..task_group.group import Group
-from ..task_input.base_input import BaseInput
+from ..task_input.any_input import AnyInput
 from ..config.config import default_shell
 
 import asyncio
@@ -14,6 +14,8 @@ import os
 import pathlib
 import signal
 
+CmdVal = Union[str, Iterable[str], Callable[..., Union[Iterable[str], str]]]
+
 
 class CmdResult():
     def __init__(self, output: str, error: str):
@@ -57,15 +59,15 @@ class CmdTask(BaseTask):
         self,
         name: str,
         group: Optional[Group] = None,
-        inputs: Iterable[BaseInput] = [],
+        inputs: Iterable[AnyInput] = [],
         envs: Iterable[Env] = [],
         env_files: Iterable[EnvFile] = [],
         icon: Optional[str] = None,
         color: Optional[str] = None,
         description: str = '',
         executable: Optional[str] = None,
-        cmd: Union[str, Iterable[str], Callable[..., str]] = '',
-        cmd_path: str = '',
+        cmd: CmdVal = '',
+        cmd_path: CmdVal = '',
         cwd: Optional[Union[str, pathlib.Path]] = None,
         upstreams: Iterable[AnyTask] = [],
         checkers: Iterable[AnyTask] = [],
@@ -217,16 +219,25 @@ class CmdTask(BaseTask):
         return self._create_cmd_str(self._cmd_path, self._cmd, *args, **kwargs)
 
     def _create_cmd_str(
-        self,
-        cmd_path: str,
-        cmd: Union[str, Iterable[str], Callable[..., str]],
-        *args: Any,
-        **kwargs: Any
+        self, cmd_path: CmdVal, cmd: CmdVal, *args: Any, **kwargs: Any
     ) -> str:
-        if cmd_path != '':
-            return self.render_file(cmd_path)
+        if not isinstance(cmd_path, str) or cmd_path != '':
+            if callable(cmd_path):
+                return self._render_cmd_path_str(cmd_path(*args, **kwargs))
+            return self._render_cmd_path_str(cmd_path)
         if callable(cmd):
-            return cmd(*args, **kwargs)
+            return self._render_cmd_str(cmd(*args, **kwargs))
+        return self._render_cmd_str(cmd)
+
+    def _render_cmd_path_str(self, cmd_path: Union[str, Iterable[str]]) -> str:
+        if isinstance(cmd_path, str):
+            return self.render_file(cmd_path)
+        return '\n'.join([
+            self.render_file(cmd_path_str)
+            for cmd_path_str in cmd_path
+        ])
+
+    def _render_cmd_str(self, cmd: Union[str, Iterable[str]]) -> str:
         if isinstance(cmd, str):
             return self.render_str(cmd)
         return self.render_str('\n'.join(list(cmd)))

zrb/task/decorator.py

@@ -3,7 +3,7 @@ from typing import (
 )
 from typeguard import typechecked
 from ..task.any_task import AnyTask
-from ..task_input.base_input import BaseInput
+from ..task_input.any_input import AnyInput
 from ..task_env.env import Env
 from ..task_env.env_file import EnvFile
 from ..task_group.group import Group
@@ -15,7 +15,7 @@ from .task import Task
 def python_task(
     name: str,
     group: Optional[Group] = None,
-    inputs: Iterable[BaseInput] = [],
+    inputs: Iterable[AnyInput] = [],
     envs: Iterable[Env] = [],
     env_files: Iterable[EnvFile] = [],
     icon: Optional[str] = None,

zrb/task/docker_compose_task.py

@@ -1,11 +1,11 @@
 from typing import Any, Callable, Iterable, List, Mapping, Optional, Union
 from typeguard import typechecked
-from .cmd_task import CmdTask, CmdResult
+from .cmd_task import CmdTask, CmdResult, CmdVal
 from .any_task import AnyTask
 from ..task_env.env import Env
 from ..task_env.env_file import EnvFile
 from ..task_group.group import Group
-from ..task_input.base_input import BaseInput
+from ..task_input.any_input import AnyInput
 from ..helper.accessories.name import get_random_name
 from ..helper.string.conversion import to_cmd_name
 from ..helper.string.double_quote import double_quote
@@ -37,7 +37,7 @@ class DockerComposeTask(CmdTask):
         self,
         name: str,
         group: Optional[Group] = None,
-        inputs: Iterable[BaseInput] = [],
+        inputs: Iterable[AnyInput] = [],
         envs: Iterable[Env] = [],
         env_files: Iterable[EnvFile] = [],
         icon: Optional[str] = None,
@@ -51,8 +51,8 @@ class DockerComposeTask(CmdTask):
         compose_flags: Iterable[str] = [],
         compose_args: Iterable[str] = [],
         compose_env_prefix: str = '',
-        setup_cmd: Union[str, Iterable[str], Callable[..., str]] = '',
-        setup_cmd_path: str = '',
+        setup_cmd: CmdVal = '',
+        setup_cmd_path: CmdVal = '',
         cwd: Optional[Union[str, pathlib.Path]] = None,
         upstreams: Iterable[AnyTask] = [],
         checkers: Iterable[AnyTask] = [],