zrb 0.18.1__py3-none-any.whl → 0.19.0__py3-none-any.whl

zrb/__init__.py

@@ -45,6 +45,7 @@ from zrb.task_input.bool_input import BoolInput
 from zrb.task_input.choice_input import ChoiceInput
 from zrb.task_input.float_input import FloatInput
 from zrb.task_input.int_input import IntInput
+from zrb.task_input.multiline_input import MultilineInput
 from zrb.task_input.password_input import PasswordInput
 from zrb.task_input.str_input import StrInput
 from zrb.task_input.task_input import Input
@@ -93,6 +94,7 @@ assert BoolInput
 assert ChoiceInput
 assert FloatInput
 assert IntInput
+assert MultilineInput
 assert PasswordInput
 assert StrInput
 assert Env

zrb/builtin/project/add/fastapp/crud/nodejs/codemod/package-lock.json

@@ -60,10 +60,13 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "20.6.0",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.6.0.tgz",
-      "integrity": "sha512-najjVq5KN2vsH2U/xyh2opaSEz6cZMR2SetLIlxlj08nOcmPOemJmUK2o4kUzfLqfrWE0PIrNeE16XhYDd3nqg==",
-      "dev": true
+      "version": "20.14.2",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.2.tgz",
+      "integrity": "sha512-xyu6WAMVwv6AKFLB+e/7ySZVr/0zLCzOa7rSpq6jNwpqOrUbcACDWC+53d4n2QHOnDou0fbIsg8wZu/sxrnI4Q==",
+      "dev": true,
+      "dependencies": {
+        "undici-types": "~5.26.4"
+      }
     },
     "node_modules/balanced-match": {
       "version": "1.0.2",
@@ -79,11 +82,11 @@
       }
     },
     "node_modules/braces": {
-      "version": "3.0.2",
-      "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
-      "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
+      "version": "3.0.3",
+      "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
+      "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==",
       "dependencies": {
-        "fill-range": "^7.0.1"
+        "fill-range": "^7.1.1"
       },
       "engines": {
         "node": ">=8"
@@ -95,9 +98,9 @@
       "integrity": "sha512-q4dMFMlXtKR3XNBHyMHt/3pwYNA69EDk00lloMOaaUMKPUXBw6lpXtbu3MMVG6/uOihGnRDOlkyqsONEUj60+w=="
     },
     "node_modules/fast-glob": {
-      "version": "3.3.1",
-      "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.1.tgz",
-      "integrity": "sha512-kNFPyjhh5cKjrUltxs+wFx+ZkbRaxxmZ+X0ZU31SOsxCEtP9VPgtq2teZw1DebupL5GmDaNQ6yKMMVcM41iqDg==",
+      "version": "3.3.2",
+      "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz",
+      "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==",
       "dependencies": {
         "@nodelib/fs.stat": "^2.0.2",
         "@nodelib/fs.walk": "^1.2.3",
@@ -110,17 +113,17 @@
       }
     },
     "node_modules/fastq": {
-      "version": "1.15.0",
-      "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.15.0.tgz",
-      "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==",
+      "version": "1.17.1",
+      "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz",
+      "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==",
       "dependencies": {
         "reusify": "^1.0.4"
       }
     },
     "node_modules/fill-range": {
-      "version": "7.0.1",
-      "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
-      "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
+      "version": "7.1.1",
+      "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
+      "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==",
       "dependencies": {
         "to-regex-range": "^5.0.1"
       },
@@ -175,11 +178,11 @@
       }
     },
     "node_modules/micromatch": {
-      "version": "4.0.5",
-      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz",
-      "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==",
+      "version": "4.0.7",
+      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz",
+      "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==",
       "dependencies": {
-        "braces": "^3.0.2",
+        "braces": "^3.0.3",
         "picomatch": "^2.3.1"
       },
       "engines": {
@@ -301,9 +304,9 @@
       }
     },
     "node_modules/typescript": {
-      "version": "5.2.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz",
-      "integrity": "sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==",
+      "version": "5.4.5",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz",
+      "integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==",
       "dev": true,
       "bin": {
         "tsc": "bin/tsc",
@@ -312,6 +315,12 @@
       "engines": {
         "node": ">=14.17"
       }
+    },
+    "node_modules/undici-types": {
+      "version": "5.26.5",
+      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
+      "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==",
+      "dev": true
     }
   }
 }

zrb/config/config.py

@@ -32,6 +32,7 @@ def _get_default_tmp_dir() -> str:
 
 tmp_dir = os.getenv("ZRB_TMP_DIR", _get_default_tmp_dir())
 default_shell = os.getenv("ZRB_SHELL", _get_current_shell())
+default_editor = os.getenv("ZRB_EDITOR", "nano")
 init_script_str = os.getenv("ZRB_INIT_SCRIPTS", "")
 init_scripts = init_script_str.split(":") if init_script_str != "" else []
 logging_level = untyped_to_logging_level(os.getenv("ZRB_LOGGING_LEVEL", "WARNING"))

zrb/helper/multilline.py

@@ -0,0 +1,11 @@
+import click
+
+from zrb.helper.typecheck import typechecked
+
+
+@typechecked
+def edit(editor: str, mark_comment: str, text: str) -> str:
+    result = click.edit(text="\n".join([mark_comment, text]), editor=editor)
+    if result is None:
+        result = text
+    return "\n".join(result.split(mark_comment)).strip()

zrb/task_input/base_input.py

@@ -2,7 +2,7 @@ from zrb.config.config import show_prompt
 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, Optional, Union
+from zrb.helper.typing import Any, Callable, List, Mapping, Optional, Union
 from zrb.task_input.any_input import AnyInput
 from zrb.task_input.constant import RESERVED_INPUT_NAMES
 
@@ -10,6 +10,9 @@ logger.debug(colored("Loading zrb.task_input.base_input", attrs=["dark"]))
 
 # flake8: noqa E501
 
+InputCallback = Callable[[Mapping[str, Any], Any], Any]
+InputDefault = Callable[[Mapping[str, Any]], Any]
+
 
 @typechecked
 class BaseInput(AnyInput):
@@ -22,8 +25,9 @@ class BaseInput(AnyInput):
         name (str): The name of the input, used as a unique identifier.
         shortcut (Optional[str]): An optional single-character shortcut for the input.
         default (Optional[Any]): The default value of the input.
+        callback (Optional[Any]): The default value of the input.
         description (Optional[str]): A brief description of what the input is for.
-        show_default (Union[bool, JinjaTemplate, None]): Determines whether the default value should be displayed.
+        show_default (Union[bool, JinjaTemplate, None]): Determines the default value to be shown.
         prompt (Union[bool, str]): The prompt text to be displayed when asking for the input.
         confirmation_prompt (Union[bool, str]): A prompt for confirmation if required.
         prompt_required (bool): Indicates whether a prompt is required.
@@ -50,11 +54,15 @@ class BaseInput(AnyInput):
         >>> )
     """
 
+    __input_value_map: Mapping[str, Any] = {}
+    __default: Mapping[str, Any] = {}
+
     def __init__(
         self,
         name: str,
         shortcut: Optional[str] = None,
-        default: Optional[Any] = None,
+        default: Optional[Union[Any, InputDefault]] = None,
+        callback: Optional[InputCallback] = None,
         description: Optional[str] = None,
         show_default: Union[bool, str, None] = None,
         prompt: Union[bool, str] = True,
@@ -79,6 +87,7 @@ class BaseInput(AnyInput):
         self._shortcut = shortcut
         self._prompt = prompt
         self._default = default
+        self._callback = callback
         self._help = description if description is not None else name
         self._type = type
         self._show_default = show_default
@@ -110,7 +119,6 @@ class BaseInput(AnyInput):
 
     def get_options(self) -> Mapping[str, Any]:
         options: Mapping[str, Any] = {
-            "default": self._default,
             "help": self._help,
             "type": self._type,
             "show_default": self._show_default,
@@ -126,11 +134,33 @@ class BaseInput(AnyInput):
             "show_choices": self._show_choices,
             "show_envvar": self._show_envvar,
             "nargs": self._nargs,
+            "callback": self._wrapped_callback,
+            "default": self._wrapped_default,
         }
         if show_prompt:
             options["prompt"] = self._prompt
         return options
 
+    def _wrapped_callback(self, ctx, param, value) -> Any:
+        if self.get_name() not in self.__input_value_map:
+            if callable(self._callback):
+                result = self._callback(self.__input_value_map, value)
+                self.__input_value_map[self.get_name()] = result
+                return result
+            self.__input_value_map[self.get_name()] = value
+            return value
+        return self.__input_value_map[self.get_name()]
+
+    def _wrapped_default(self) -> Any:
+        if self.get_name() not in self.__default:
+            if callable(self._default):
+                default = self._default(self.__input_value_map)
+                self.__default[self.get_name()] = default
+                return default
+            self.__default[self.get_name()] = self._default
+            return self._default
+        return self.__default[self.get_name()]
+
     def should_render(self) -> bool:
         return self.__should_render
 

zrb/task_input/bool_input.py

@@ -2,7 +2,7 @@ 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, Optional, Union
-from zrb.task_input.base_input import BaseInput
+from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
 
 logger.debug(colored("Loading zrb.task_input.bool_input", attrs=["dark"]))
 
@@ -20,9 +20,10 @@ class BoolInput(BaseInput):
     Args:
         name (str): The name of the input.
         shortcut (Optional[str]): A shortcut string for the input.
-        default (Optional[Any]): The default value for the input. Should be a boolean if set.
-        description (Optional[str]): A brief description of the input.
-        show_default (Union[bool, str, None]): Option to display the default value. Can be a boolean or string representation.
+        default (Optional[Any]): The default value of the input.
+        callback (Optional[Any]): The default value of the input.
+        description (Optional[str]): A brief description of what the input is for.
+        show_default (Union[bool, JinjaTemplate, None]): Determines the default value to be shown.
         prompt (Union[bool, str]): A boolean or string to prompt the user for input. If `True`, uses the default prompt.
         confirmation_prompt (Union[bool, str]): If set to `True`, the user is asked to confirm the input.
         prompt_required (bool): If `True`, the prompt for input is mandatory.
@@ -48,7 +49,8 @@ class BoolInput(BaseInput):
         self,
         name: str,
         shortcut: Optional[str] = None,
-        default: Optional[Any] = None,
+        default: Optional[Union[Any, InputDefault]] = None,
+        callback: Optional[InputCallback] = None,
         description: Optional[str] = None,
         show_default: Union[bool, str, None] = None,
         prompt: Union[bool, str] = True,
@@ -71,6 +73,7 @@ class BoolInput(BaseInput):
             name=name,
             shortcut=shortcut,
             default=default,
+            callback=callback,
             description=description,
             show_default=show_default,
             prompt=prompt,

zrb/task_input/choice_input.py

@@ -4,7 +4,7 @@ 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, Iterable, Optional, Union
-from zrb.task_input.base_input import BaseInput
+from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
 
 logger.debug(colored("Loading zrb.task_input.choice_input", attrs=["dark"]))
 
@@ -25,8 +25,9 @@ class ChoiceInput(BaseInput):
         shortcut (Optional[str]): An optional shortcut string for the input.
         choices (Iterable[Any]): An iterable of choices from which the user can select.
         default (Optional[Any]): The default value for the input. Should be one of the choices if set.
-        description (Optional[str]): A brief description of the input.
-        show_default (Union[bool, str, None]): Option to display the default value. Can be a boolean or string representation.
+        callback (Optional[Any]): The default value of the input.
+        description (Optional[str]): A brief description of what the input is for.
+        show_default (Union[bool, JinjaTemplate, None]): Determines the default value to be shown.
         prompt (Union[bool, str]): A boolean or string to prompt the user for input. If `True`, uses the default prompt.
         confirmation_prompt (Union[bool, str]): If set to `True`, the user is asked to confirm the input.
         prompt_required (bool): If `True`, the prompt for input is mandatory.
@@ -53,7 +54,8 @@ class ChoiceInput(BaseInput):
         name: str,
         shortcut: Optional[str] = None,
         choices: Iterable[Any] = [],
-        default: Optional[Any] = None,
+        default: Optional[Union[Any, InputDefault]] = None,
+        callback: Optional[InputCallback] = None,
         description: Optional[str] = None,
         show_default: Union[bool, str, None] = None,
         prompt: Union[bool, str] = True,
@@ -76,6 +78,7 @@ class ChoiceInput(BaseInput):
             name=name,
             shortcut=shortcut,
             default=default,
+            callback=callback,
             description=description,
             show_default=show_default,
             prompt=prompt,

zrb/task_input/float_input.py

@@ -2,7 +2,7 @@ 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, Optional, Union
-from zrb.task_input.base_input import BaseInput
+from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
 
 logger.debug(colored("Loading zrb.task_input.float_input", attrs=["dark"]))
 
@@ -21,8 +21,9 @@ class FloatInput(BaseInput):
         name (str): The name of the input.
         shortcut (Optional[str]): An optional shortcut string for the input.
         default (Optional[Any]): The default value for the input, expected to be a float if set.
-        description (Optional[str]): A brief description of the input's purpose.
-        show_default (Union[bool, str, None]): Option to display the default value. Can be a boolean or string.
+        callback (Optional[Any]): The default value of the input.
+        description (Optional[str]): A brief description of what the input is for.
+        show_default (Union[bool, JinjaTemplate, None]): Determines the default value to be shown.
         prompt (Union[bool, str]): A boolean or string to prompt the user for input. If `True`, uses the default prompt.
         confirmation_prompt (Union[bool, str]): If `True`, the user is asked to confirm the input.
         prompt_required (bool): If `True`, the prompt for input is mandatory.
@@ -48,7 +49,8 @@ class FloatInput(BaseInput):
         self,
         name: str,
         shortcut: Optional[str] = None,
-        default: Optional[Any] = None,
+        default: Optional[Union[Any, InputDefault]] = None,
+        callback: Optional[InputCallback] = None,
         description: Optional[str] = None,
         show_default: Union[bool, str, None] = None,
         prompt: Union[bool, str] = True,
@@ -71,6 +73,7 @@ class FloatInput(BaseInput):
             name=name,
             shortcut=shortcut,
             default=default,
+            callback=callback,
             description=description,
             show_default=show_default,
             prompt=prompt,

zrb/task_input/int_input.py

@@ -2,7 +2,7 @@ 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, Optional, Union
-from zrb.task_input.base_input import BaseInput
+from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
 
 logger.debug(colored("Loading zrb.task_input.int_input", attrs=["dark"]))
 
@@ -22,8 +22,9 @@ class IntInput(BaseInput):
         name (str): The name of the input, serving as an identifier.
         shortcut (Optional[str]): An optional shortcut for easier reference to the input.
         default (Optional[Any]): The default value for the input, should be an integer if provided.
-        description (Optional[str]): A brief description of what the input represents or its intended use.
-        show_default (Union[bool, str, None]): Option to show the default value in prompts or documentation.
+        callback (Optional[Any]): The default value of the input.
+        description (Optional[str]): A brief description of what the input is for.
+        show_default (Union[bool, JinjaTemplate, None]): Determines the default value to be shown.
         prompt (Union[bool, str]): A boolean or string to determine the prompt for user input. If `True`, uses a default prompt.
         confirmation_prompt (Union[bool, str]): If `True`, the user will be asked to confirm their input.
         prompt_required (bool): If `True`, makes the input prompt mandatory.
@@ -49,7 +50,8 @@ class IntInput(BaseInput):
         self,
         name: str,
         shortcut: Optional[str] = None,
-        default: Optional[Any] = None,
+        default: Optional[Union[Any, InputDefault]] = None,
+        callback: Optional[InputCallback] = None,
         description: Optional[str] = None,
         show_default: Union[bool, str, None] = None,
         prompt: Union[bool, str] = True,
@@ -72,6 +74,7 @@ class IntInput(BaseInput):
             name=name,
             shortcut=shortcut,
             default=default,
+            callback=callback,
             description=description,
             show_default=show_default,
             prompt=prompt,

zrb/task_input/multiline_input.py

@@ -0,0 +1,113 @@
+from zrb.config.config import default_editor
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
+from zrb.helper.multilline import edit
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, Mapping, Optional, Union
+from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
+
+logger.debug(colored("Loading zrb.task_input.multiline_input", attrs=["dark"]))
+
+# flake8: noqa E501
+
+
+@typechecked
+class MultilineInput(BaseInput):
+    """
+    A specialized input class for handling string-based inputs in various tasks.
+
+    `StrInput` extends `BaseInput` to manage string-type inputs, supporting features like
+    default values, prompts, flags, and other customization options. This class is useful
+    for tasks requiring textual input, such as names, descriptions, or any other string parameters.
+
+    Args:
+        name (str): The name of the input, used as an identifier.
+        shortcut (Optional[str]): An optional shortcut string for the input.
+        default (Optional[Any]): The default value for the input, expected to be a string if set.
+        callback (Optional[Any]): The default value of the input.
+        description (Optional[str]): A brief description of what the input is for.
+        show_default (Union[bool, JinjaTemplate, None]): Determines the default value to be shown.
+        prompt (Union[bool, str]): A boolean or string to prompt the user for input. If `True`, uses the default prompt.
+        confirmation_prompt (Union[bool, str]): If `True`, the user is asked to confirm the input.
+        prompt_required (bool): If `True’, the prompt for input is mandatory.
+        hide_input (bool): If `True’, hides the input value, typically used for sensitive data.
+        is_flag (Optional[bool]): Indicates if the input is a flag. If `True’, the input accepts boolean flag values.
+        flag_value (Optional[Any]): The value associated with the flag if `is_flag` is `True`.
+        multiple (bool): If `True’, allows multiple string values for the input.
+        count (bool): If `True’, counts the occurrences of the input.
+        allow_from_autoenv (bool): If `True’, enables automatic population of the input from environment variables.
+        hidden (bool): If `True’, keeps the input hidden in help messages or documentation.
+        show_choices (bool): If `True’, shows any restricted choices for the input value.
+        show_envvar (bool): If `True’, displays the associated environment variable, if applicable.
+        nargs (int): The number of arguments that the input can accept.
+        should_render (bool): If `True’, renders the input in the user interface or command-line interface.
+
+    Examples:
+        >>> multiline_input = StrInput(name='username', default='user123', description='Enter your username')
+        >>> multiline_input.get_default()
+        'user123'
+    """
+
+    __default: Mapping[str, Any] = {}
+
+    def __init__(
+        self,
+        name: str,
+        shortcut: Optional[str] = None,
+        comment_start="#",
+        editor=default_editor,
+        default: Optional[Union[Any, InputDefault]] = None,
+        callback: Optional[InputCallback] = None,
+        description: Optional[str] = None,
+        show_default: Union[bool, str, None] = None,
+        prompt: Union[bool, str] = True,
+        confirmation_prompt: Union[bool, str] = False,
+        prompt_required: bool = True,
+        hide_input: bool = False,
+        is_flag: Optional[bool] = None,
+        flag_value: Optional[Any] = None,
+        multiple: bool = False,
+        count: bool = False,
+        allow_from_autoenv: bool = True,
+        hidden: bool = False,
+        show_choices: bool = True,
+        show_envvar: bool = False,
+        nargs: int = 1,
+        should_render: bool = True,
+    ):
+        BaseInput.__init__(
+            self,
+            name=name,
+            shortcut=shortcut,
+            default=default,
+            callback=callback,
+            description=description,
+            show_default=show_default,
+            prompt=prompt,
+            confirmation_prompt=confirmation_prompt,
+            prompt_required=prompt_required,
+            hide_input=hide_input,
+            is_flag=is_flag,
+            flag_value=flag_value,
+            multiple=multiple,
+            count=count,
+            allow_from_autoenv=allow_from_autoenv,
+            type=str,
+            hidden=hidden,
+            show_choices=show_choices,
+            show_envvar=show_envvar,
+            nargs=nargs,
+            should_render=should_render,
+        )
+        self._comment_start = comment_start
+        self._editor = editor
+
+    def _wrapped_default(self) -> Any:
+        if self.get_name() not in self.__default:
+            text = super()._wrapped_default()
+            prompt = self._prompt if isinstance(self._prompt, str) else self.get_name()
+            mark_comment = " ".join([self._comment_start, prompt])
+            self.__default[self.get_name()] = edit(
+                editor=self._editor, mark_comment=mark_comment, text=text
+            )
+        return self.__default[self.get_name()]

zrb/task_input/password_input.py

@@ -2,7 +2,7 @@ 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, Optional, Union
-from zrb.task_input.base_input import BaseInput
+from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
 
 logger.debug(colored("Loading zrb.task_input.password_input", attrs=["dark"]))
 
@@ -23,8 +23,9 @@ class PasswordInput(BaseInput):
         name (str): The name of the input, serving as an identifier.
         shortcut (Optional[str]): An optional shortcut string for the input.
         default (Optional[Any]): The default value for the input, expected to be a string if set.
-        description (Optional[str]): A brief description of the input's purpose.
-        show_default (Union[bool, str, None]): Option to display the default value. Can be a boolean or string.
+        callback (Optional[Any]): The default value of the input.
+        description (Optional[str]): A brief description of what the input is for.
+        show_default (Union[bool, JinjaTemplate, None]): Determines the default value to be shown.
         prompt (Union[bool, str]): A boolean or string to prompt the user for input. If `True`, uses the default prompt.
         confirmation_prompt (Union[bool, str]): If `True`, the user is asked to confirm the input.
         prompt_required (bool): If `True`, the prompt for input is mandatory.
@@ -49,7 +50,8 @@ class PasswordInput(BaseInput):
         self,
         name: str,
         shortcut: Optional[str] = None,
-        default: Optional[Any] = None,
+        default: Optional[Union[Any, InputDefault]] = None,
+        callback: Optional[InputCallback] = None,
         description: Optional[str] = None,
         show_default: Union[bool, str, None] = None,
         prompt: Union[bool, str] = True,
@@ -71,6 +73,7 @@ class PasswordInput(BaseInput):
             name=name,
             shortcut=shortcut,
             default=default,
+            callback=callback,
             description=description,
             show_default=show_default,
             prompt=prompt,

zrb/task_input/str_input.py

@@ -2,7 +2,7 @@ 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, Optional, Union
-from zrb.task_input.base_input import BaseInput
+from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
 
 logger.debug(colored("Loading zrb.task_input.str_input", attrs=["dark"]))
 
@@ -22,8 +22,9 @@ class StrInput(BaseInput):
         name (str): The name of the input, used as an identifier.
         shortcut (Optional[str]): An optional shortcut string for the input.
         default (Optional[Any]): The default value for the input, expected to be a string if set.
-        description (Optional[str]): A brief description of the input's purpose.
-        show_default (Union[bool, str, None]): Option to display the default value. Can be a boolean or string.
+        callback (Optional[Any]): The default value of the input.
+        description (Optional[str]): A brief description of what the input is for.
+        show_default (Union[bool, JinjaTemplate, None]): Determines the default value to be shown.
         prompt (Union[bool, str]): A boolean or string to prompt the user for input. If `True`, uses the default prompt.
         confirmation_prompt (Union[bool, str]): If `True`, the user is asked to confirm the input.
         prompt_required (bool): If `True’, the prompt for input is mandatory.
@@ -49,7 +50,8 @@ class StrInput(BaseInput):
         self,
         name: str,
         shortcut: Optional[str] = None,
-        default: Optional[Any] = None,
+        default: Optional[Union[Any, InputDefault]] = None,
+        callback: Optional[InputCallback] = None,
         description: Optional[str] = None,
         show_default: Union[bool, str, None] = None,
         prompt: Union[bool, str] = True,
@@ -72,6 +74,7 @@ class StrInput(BaseInput):
             name=name,
             shortcut=shortcut,
             default=default,
+            callback=callback,
             description=description,
             show_default=show_default,
             prompt=prompt,

zrb/task_input/task_input.py

@@ -1,6 +1,6 @@
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
-from zrb.task_input.base_input import BaseInput
+from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
 
 logger.debug(colored("Loading zrb.task_input.task_input", attrs=["dark"]))
 
@@ -15,8 +15,9 @@ class Input(BaseInput):
         name (str): The name of the input, used as a unique identifier.
         shortcut (Optional[str]): An optional single-character shortcut for the input.
         default (Optional[Any]): The default value of the input.
+        callback (Optional[Any]): The default value of the input.
         description (Optional[str]): A brief description of what the input is for.
-        show_default (Union[bool, JinjaTemplate, None]): Determines whether the default value should be displayed.
+        show_default (Union[bool, JinjaTemplate, None]): Determines the default value to be shown.
         prompt (Union[bool, str]): The prompt text to be displayed when asking for the input.
         confirmation_prompt (Union[bool, str]): A prompt for confirmation if required.
         prompt_required (bool): Indicates whether a prompt is required.

{zrb-0.18.1.dist-info → zrb-0.19.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.18.1
+Version: 0.19.0
 Summary: A Framework to Enhance Your Workflow
 Home-page: https://github.com/state-alchemists/zrb
 License: AGPL-3.0-or-later

{zrb-0.18.1.dist-info → zrb-0.19.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-zrb/__init__.py,sha256=KH6bpJxEldzDMn-39IdUxEs9Ir5qUeqW_iC56iQKPMk,2814
+zrb/__init__.py,sha256=JHeTmm8QkMcg1FhI4eEL4jOGqF1sJ774eR-m8_0KtP8,2894
 zrb/__main__.py,sha256=-_k0XOahDF-06n41Uly-oUMkZ8XDSxO-WUUImWz6GiA,171
 zrb/action/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/action/runner.py,sha256=oizUiLa4wa4CjXppbw_YUFlkAUSwapfoQ1YAo9TEY30,5079
@@ -1157,7 +1157,7 @@ zrb/builtin/project/add/fastapp/crud/_input.py,sha256=LL9qR92qoMS_Tw_rdUTbYmNzHn
 zrb/builtin/project/add/fastapp/crud/_task_factory.py,sha256=xfH5C0KkuhJvilrIzNBJ6LvrcG71lhM3N7ZPm6CW8Js,1481
 zrb/builtin/project/add/fastapp/crud/crud.py,sha256=w1XeYB4RyMeieYVxA8nJ2oWb0nzNOOK6rL8MU-VdVCQ,5184
 zrb/builtin/project/add/fastapp/crud/nodejs/codemod/.gitignore,sha256=FtMORGIYn7FN1hG9twjFEGMMV2ofNbk4PomkNS2jbJc,13
-zrb/builtin/project/add/fastapp/crud/nodejs/codemod/package-lock.json,sha256=jfKLElnb8UsaadSX8wO03h5-9wQrrO_EeoSoNRoFSbQ,11259
+zrb/builtin/project/add/fastapp/crud/nodejs/codemod/package-lock.json,sha256=yWd9ww6RHHhAZBi5V01sbSKF6D8owxHoR1ebHGHs-2A,11620
 zrb/builtin/project/add/fastapp/crud/nodejs/codemod/package.json,sha256=uqz8LlyK32NyMkH2rYAgZYi29pymj_zN5j46YiTDJ2w,369
 zrb/builtin/project/add/fastapp/crud/nodejs/codemod/src/addNav.ts,sha256=LeiRM_woR2rA6Se9zuZgBuo0WgtEFyYqHXQRufltEQ4,1460
 zrb/builtin/project/add/fastapp/crud/nodejs/codemod/src/fastapp/src/frontend/src/lib/config/navData.ts,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -1294,7 +1294,7 @@ zrb/builtin/update.py,sha256=89i_fPUlL27IXczLI7Lr7k4STMpnxyw2je8daCKUTQo,225
 zrb/builtin/version.py,sha256=vjbmSeOSEjT0SgdeQHGslwFCQMukwVZkOOkusZGZNcU,394
 zrb/builtin/watch_changes.py,sha256=Vr__e_T31nnbefcPftvyn78dT3-UXqNRpH0KO-COeKQ,1220
 zrb/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zrb/config/config.py,sha256=6uDxOLmHHstLCosj2miBVxlO9dMTIoXYedqaff8EVBU,1567
+zrb/config/config.py,sha256=pba-BbPFjfeH-U_cZyi3L8lElf1nyCFTYbKAzFJrWaQ,1616
 zrb/helper/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/helper/accessories/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/helper/accessories/color.py,sha256=E5OxlSOaN9skojG4gpD9tlBYyHDFC-YhLi_DoPCBbcg,948
@@ -1332,6 +1332,7 @@ zrb/helper/loader/load_module.py,sha256=qLYFTBKnrxlmgEA_-uepAM16LwpIx3XyfvXSIvJE
 zrb/helper/log.py,sha256=lQBWNWc5UUz4BOzixWOMWjldcCRgycn1Pnn2nTJ7hlg,544
 zrb/helper/map/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/helper/map/conversion.py,sha256=I4VTrtv5c9OpfQ2lc7icxCgduWB46_qBtOh1RdjaPq0,603
+zrb/helper/multilline.py,sha256=hVbl1eqItrB211j-A9MROltC5tVm8ORttQ1rTlZghBA,313
 zrb/helper/python_task.py,sha256=8FSMK5wHkNQUILUkDa-wNjfTYfQYFbItdKDPL35gRZ0,625
 zrb/helper/render_data.py,sha256=sWQIQtdP61RDOoSh2_0ZJkKzDRmEsDLN18ADlhNWoAo,835
 zrb/helper/string/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -1394,17 +1395,18 @@ zrb/task_group/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/task_group/group.py,sha256=uF3tyLABTyyBNyE9FUCfJeYSDnaLFQCis3tuEn5FYho,6109
 zrb/task_input/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/task_input/any_input.py,sha256=-uOq1ONXdhW20FRkC3pzqX081tbfmWjvCc_-d-gCNGY,2087
-zrb/task_input/base_input.py,sha256=kxt2184s8ppC2dsa69J2uLUOUqsdCmXEJiNUIJxKcuQ,5495
-zrb/task_input/bool_input.py,sha256=xlWjqPvHi52TLiFP13wB1SayJlbzmxv31AS-sZJ0jw4,4040
-zrb/task_input/choice_input.py,sha256=GU28ATSayZsmqCW-euAPoWyA-Kh6d5Wf6FwWLXffk5w,4290
+zrb/task_input/base_input.py,sha256=STWgAY4lE8JSIavXsYPlNbGuz_5TVvZiicdCJOZIgeQ,6796
+zrb/task_input/bool_input.py,sha256=8InE55L9ht06q8SBOqdS5Miga59GNidebTCXLXBX8lQ,4192
+zrb/task_input/choice_input.py,sha256=sIu5cT27MpMufVhmV1Qs2WX9V5aml_ymcPb1NItf04Y,4471
 zrb/task_input/constant.py,sha256=VEsnrI0BDdCJ1Z58EJgxXUhZBe5CA8TfURo0cNu5CaQ,200
-zrb/task_input/float_input.py,sha256=rtaowHp8RpiQS8a24ULgtydRu6wkYT1Q7Q_IRcCPD7s,4122
-zrb/task_input/int_input.py,sha256=d2fXcm5fCo09472eMAm6PdzLQD82ZBV9ARq5CjKepAo,4198
-zrb/task_input/password_input.py,sha256=g_g8ZWAzDaHx4h2EHY3UCGvTigC6esAUBzXU0T9nDUk,4192
-zrb/task_input/str_input.py,sha256=BNflOhrJvST9bWK0rGdCi7C7y-QDvHj9ISQMRmujIWU,4200
-zrb/task_input/task_input.py,sha256=DcHgKie5Oo1sUxj41t1ZQjCIK1aAfTgGzaKr7_ap7ZI,2248
-zrb-0.18.1.dist-info/LICENSE,sha256=WfnGCl8G60EYOPAEkuc8C9m9pdXWDe08NsKj3TBbxsM,728
-zrb-0.18.1.dist-info/METADATA,sha256=RnbEITp7ykt9BYdrmFaPEX71dBHXmFfVvL3n8ble_jA,17076
-zrb-0.18.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-zrb-0.18.1.dist-info/entry_points.txt,sha256=xTgXc1kBKYhJHEujdaSPHUcJT3-hbyP1mLgwkv-5sSk,40
-zrb-0.18.1.dist-info/RECORD,,
+zrb/task_input/float_input.py,sha256=Y_pLd0oj1k5FjFqQuTNEIuupGpxzSQfwLfnFD12lvto,4308
+zrb/task_input/int_input.py,sha256=-4GFaTV2E-p_FMGqXWYmXmTeymqGYPd4gMvHAmEQSR8,4361
+zrb/task_input/multiline_input.py,sha256=5EWKdOBmzi8IiVFSBJ9owuShb-UL1IFCwTvmMu1UvcY,5152
+zrb/task_input/password_input.py,sha256=MPNXcrC5A1Qf-QIZ2LIBakdosaHFQ-DpjgkrA0SvCs0,4378
+zrb/task_input/str_input.py,sha256=AzbVbuEebGeQcIrE9lMmJLOVwADmLcngx6cK_GXpo5I,4386
+zrb/task_input/task_input.py,sha256=WTj_qIQyRs-04-VotjNTcVyIuf6b2afInVoCQHoRmr0,2327
+zrb-0.19.0.dist-info/LICENSE,sha256=WfnGCl8G60EYOPAEkuc8C9m9pdXWDe08NsKj3TBbxsM,728
+zrb-0.19.0.dist-info/METADATA,sha256=ISpBH4PJyfyGdbQqKVPVIJSW84k15VMrepAGQy1DWXE,17076
+zrb-0.19.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+zrb-0.19.0.dist-info/entry_points.txt,sha256=xTgXc1kBKYhJHEujdaSPHUcJT3-hbyP1mLgwkv-5sSk,40
+zrb-0.19.0.dist-info/RECORD,,