zrb 0.28.1__py3-none-any.whl → 1.0.0a8__py3-none-any.whl

zrb/task_input/base_input.py

@@ -1,185 +0,0 @@
-from collections.abc import Callable, Mapping
-from typing import Any, Optional, Union
-
-from zrb.config.config import SHOW_PROMPT
-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.jinja import is_probably_jinja
-from zrb.helper.typecheck import typechecked
-from zrb.task_input.any_input import AnyInput
-from zrb.task_input.constant import RESERVED_INPUT_NAMES
-
-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):
-    """
-    Base class for all Input.
-
-    Input is an interface for a Task to read user input at the beginning of the execution.
-
-    Attributes:
-        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 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.
-        hide_input (bool): If True, the input value will be hidden (e.g., for passwords).
-        is_flag (Optional[bool]): Specifies whether the input is a flag.
-        flag_value (Optional[Any]): The value to be used if the input is a flag.
-        multiple (bool): Allows multiple values for this input if True.
-        count (bool): If True, counts the occurrences of the input.
-        allow_from_autoenv (bool): If True, allows values to be automatically sourced from the environment.
-        type (Optional[Any]): The expected type of the input value.
-        hidden (bool): If True, the input is hidden and not rendered.
-        show_choices (bool): Indicates whether to show available choices for the input.
-        show_envvar (bool): If True, shows the corresponding environment variable.
-        nargs (int): Number of arguments expected for this input.
-        should_render (bool): Determines whether the input should be rendered.
-
-    Examples:
-        >>> from zrb import Input, Task
-        >>> task = Task(
-        >>>     name='task',
-        >>>     inputs=[
-        >>>         Input(name='delay', default=10, description='Delay')
-        >>>     ]
-        >>> )
-    """
-
-    __value_cache: Mapping[str, Any] = {}
-    __default_cache: Mapping[str, Any] = {}
-
-    def __init__(
-        self,
-        name: str,
-        shortcut: Optional[str] = None,
-        default: Optional[Union[Any, InputDefault]] = None,
-        callback: Optional[InputCallback] = None,
-        description: Optional[str] = None,
-        show_default: Union[bool, str] = True,
-        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,
-        type: Optional[Any] = None,
-        hidden: bool = False,
-        show_choices: bool = True,
-        show_envvar: bool = False,
-        nargs: int = 1,
-        should_render: bool = True,
-    ):
-        if name in RESERVED_INPUT_NAMES:
-            raise ValueError(f"Forbidden input name: {name}")
-        self._name = name
-        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
-        self._confirmation_prompt = confirmation_prompt
-        self._prompt_required = prompt_required
-        self._hide_input = hide_input
-        self._is_flag = is_flag
-        self._flag_value = flag_value
-        self._multiple = multiple
-        self._count = count
-        self._allow_from_autoenv = allow_from_autoenv
-        self._hidden = hidden
-        self._show_choices = show_choices
-        self._show_envvar = show_envvar
-        self._nargs = nargs
-        self.__should_render = should_render
-
-    def get_name(self) -> str:
-        return self._name
-
-    def get_default(self) -> Any:
-        if callable(self._default):
-            return self._default(self.__value_cache)
-        return self._default
-
-    def get_param_decl(self) -> list[str]:
-        param_decl: list[str] = [f"--{self._name}"]
-        if self._shortcut is not None:
-            param_decl.append(f"-{self._shortcut}")
-        return param_decl
-
-    def get_options(self) -> Mapping[str, Any]:
-        options: Mapping[str, Any] = {
-            "help": self._help,
-            "type": self._type,
-            "show_default": self._get_calculated_show_default(),
-            "confirmation_prompt": self._confirmation_prompt,
-            "prompt_required": self._prompt_required,
-            "hide_input": self._hide_input,
-            "is_flag": self._is_flag,
-            "flag_value": self._flag_value,
-            "multiple": self._multiple,
-            "count": self._count,
-            "allow_from_autoenv": self._allow_from_autoenv,
-            "hidden": self._hidden,
-            "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:
-        var_name = to_variable_name(self.get_name())
-        if var_name not in self.__value_cache:
-            if callable(self._callback):
-                result = self._callback(self.__value_cache, value)
-                self.__value_cache[var_name] = result
-                return result
-            self.__value_cache[var_name] = value
-            return value
-        return self.__value_cache[var_name]
-
-    def _wrapped_default(self) -> Any:
-        var_name = to_variable_name(self.get_name())
-        if var_name not in self.__default_cache:
-            if callable(self._default):
-                default = self._default(self.__value_cache)
-                self.__default_cache[var_name] = default
-                return default
-            self.__default_cache[var_name] = self._default
-            return self._default
-        return self.__default_cache[var_name]
-
-    def _get_calculated_show_default(self) -> str:
-        if self._show_default != True:
-            return self._show_default
-        if callable(self._default) or (
-            self.__should_render and is_probably_jinja(self._default)
-        ):
-            return colored("Autogenerated", color="yellow")
-        return f"{self._default}"
-
-    def should_render(self) -> bool:
-        return self.__should_render
-
-    def is_hidden(self) -> bool:
-        return False

zrb/task_input/bool_input.py

@@ -1,95 +0,0 @@
-from typing import Any, Optional, Union
-
-from zrb.helper.accessories.color import colored
-from zrb.helper.log import logger
-from zrb.helper.typecheck import typechecked
-from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
-
-logger.debug(colored("Loading zrb.task_input.bool_input", attrs=["dark"]))
-
-# flake8: noqa E501
-
-
-@typechecked
-class BoolInput(BaseInput):
-    """
-    A specialized input class for handling boolean values in a task input context.
-
-    This class extends `BaseInput` and provides specific functionality for boolean type inputs,
-    including support for default values, prompts, flags, and various customization options.
-
-    Args:
-        name (str): The name of the input.
-        shortcut (Optional[str]): A shortcut string 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 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.
-        hide_input (bool): If `True`, the input is hidden (useful for sensitive information).
-        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 values for the input.
-        count (bool): If `True`, counts the occurrences of the input.
-        allow_from_autoenv (bool): If `True`, allows the input to be automatically populated from the environment.
-        hidden (bool): If `True`, the input is not shown in help messages or documentation.
-        show_choices (bool): If `True`, displays the choices available for the input.
-        show_envvar (bool): Indicates whether to display the environment variable associated with this input.
-        nargs (int): The number of arguments that the input can accept.
-        should_render (bool): If `True`, the input is rendered in the UI or command-line interface.
-
-    Examples:
-        >>> bool_input = BoolInput(name='confirm', prompt='Do you agree?', default=False)
-        >>> bool_input.get_default()
-        False
-    """
-
-    def __init__(
-        self,
-        name: str,
-        shortcut: Optional[str] = None,
-        default: Optional[Union[Any, InputDefault]] = None,
-        callback: Optional[InputCallback] = None,
-        description: Optional[str] = None,
-        show_default: Union[bool, str] = True,
-        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=bool,
-            hidden=hidden,
-            show_choices=show_choices,
-            show_envvar=show_envvar,
-            nargs=nargs,
-            should_render=should_render,
-        )

zrb/task_input/choice_input.py

@@ -1,101 +0,0 @@
-from collections.abc import Iterable
-from typing import Any, Optional, Union
-
-import click
-
-from zrb.helper.accessories.color import colored
-from zrb.helper.log import logger
-from zrb.helper.typecheck import typechecked
-from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
-
-logger.debug(colored("Loading zrb.task_input.choice_input", attrs=["dark"]))
-
-# flake8: noqa E501
-
-
-@typechecked
-class ChoiceInput(BaseInput):
-    """
-    A specialized input class for handling choice-based inputs in a task input context.
-
-    This class extends `BaseInput` and provides functionality for inputs where the user
-    must select from a predefined set of choices. It includes support for default values,
-    prompts, flags, and various customization options.
-
-    Args:
-        name (str): The name of the input.
-        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.
-        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.
-        hide_input (bool): If `True`, the input is hidden (useful for sensitive information).
-        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 values for the input.
-        count (bool): If `True`, counts the occurrences of the input.
-        allow_from_autoenv (bool): If `True`, allows the input to be automatically populated from the environment.
-        hidden (bool): If `True`, the input is not shown in help messages or documentation.
-        show_choices (bool): If `True`, displays the available choices to the user.
-        show_envvar (bool): Indicates whether to display the environment variable associated with this input.
-        nargs (int): The number of arguments that the input can accept.
-        should_render (bool): If `True`, the input is rendered in the UI or command-line interface.
-
-    Examples:
-        >>> choice_input = ChoiceInput(name='color', choices=['red', 'green', 'blue'], default='red')
-        >>> choice_input.get_default()
-        'red'
-    """
-
-    def __init__(
-        self,
-        name: str,
-        shortcut: Optional[str] = None,
-        choices: Iterable[Any] = [],
-        default: Optional[Union[Any, InputDefault]] = None,
-        callback: Optional[InputCallback] = None,
-        description: Optional[str] = None,
-        show_default: Union[bool, str] = True,
-        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=click.Choice(choices),
-            hidden=hidden,
-            show_choices=show_choices,
-            show_envvar=show_envvar,
-            nargs=nargs,
-            should_render=should_render,
-        )

zrb/task_input/constant.py

@@ -1,6 +0,0 @@
-from zrb.helper.accessories.color import colored
-from zrb.helper.log import logger
-
-logger.debug(colored("Loading zrb.task_input.constant", attrs=["dark"]))
-
-RESERVED_INPUT_NAMES = ("_task", "_args")

zrb/task_input/float_input.py

@@ -1,95 +0,0 @@
-from typing import Any, Optional, Union
-
-from zrb.helper.accessories.color import colored
-from zrb.helper.log import logger
-from zrb.helper.typecheck import typechecked
-from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
-
-logger.debug(colored("Loading zrb.task_input.float_input", attrs=["dark"]))
-
-# flake8: noqa E501
-
-
-@typechecked
-class FloatInput(BaseInput):
-    """
-     A specialized input class designed to handle floating-point numbers in a task input context.
-
-    Extending `BaseInput`, this class facilitates the handling of float-type inputs, accommodating
-    various features like default values, prompts, flags, and customization options.
-
-    Args:
-        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.
-        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`, the input is hidden, useful for sensitive information.
-        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 float values for the input.
-        count (bool): If `True`, counts the occurrences of the input.
-        allow_from_autoenv (bool): If `True`, allows the input to be automatically populated from the environment.
-        hidden (bool): If `True`, the input is not shown in help messages or documentation.
-        show_choices (bool): If `True`, displays the available choices to the user (relevant if there are restricted float choices).
-        show_envvar (bool): Indicates whether to display the environment variable associated with this input.
-        nargs (int): The number of arguments that the input can accept.
-        should_render (bool): If `True`, the input is rendered in the UI or command-line interface.
-
-    Examples:
-        >>> float_input = FloatInput(name='threshold', default=0.5, description='Set the threshold value')
-        >>> float_input.get_default()
-        0.5
-    """
-
-    def __init__(
-        self,
-        name: str,
-        shortcut: Optional[str] = None,
-        default: Optional[Union[Any, InputDefault]] = None,
-        callback: Optional[InputCallback] = None,
-        description: Optional[str] = None,
-        show_default: Union[bool, str] = True,
-        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=float,
-            hidden=hidden,
-            show_choices=show_choices,
-            show_envvar=show_envvar,
-            nargs=nargs,
-            should_render=should_render,
-        )

zrb/task_input/int_input.py

@@ -1,96 +0,0 @@
-from typing import Any, Optional, Union
-
-from zrb.helper.accessories.color import colored
-from zrb.helper.log import logger
-from zrb.helper.typecheck import typechecked
-from zrb.task_input.base_input import BaseInput, InputCallback, InputDefault
-
-logger.debug(colored("Loading zrb.task_input.int_input", attrs=["dark"]))
-
-# flake8: noqa E501
-
-
-@typechecked
-class IntInput(BaseInput):
-    """
-    A specialized input class for handling integer values in task inputs.
-
-    `IntInput` extends `BaseInput` to specifically handle inputs where integer values are required.
-    It supports various features like default values, prompts, flags, and other customization options,
-    making it suitable for tasks that require numerical input in the form of integers.
-
-    Args:
-        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.
-        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.
-        hide_input (bool): If `True`, hides the input value, typically used for sensitive information.
-        is_flag (Optional[bool]): Indicates if the input functions as a flag, taking boolean values.
-        flag_value (Optional[Any]): The value associated with the input when used as a flag.
-        multiple (bool): If `True`, allows entering multiple integer values.
-        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:
-        >>> int_input = IntInput(name='age', default=30, description='Enter your age')
-        >>> int_input.get_default()
-        30
-    """
-
-    def __init__(
-        self,
-        name: str,
-        shortcut: Optional[str] = None,
-        default: Optional[Union[Any, InputDefault]] = None,
-        callback: Optional[InputCallback] = None,
-        description: Optional[str] = None,
-        show_default: Union[bool, str] = True,
-        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=int,
-            hidden=hidden,
-            show_choices=show_choices,
-            show_envvar=show_envvar,
-            nargs=nargs,
-            should_render=should_render,
-        )