InquirerPrompt 0.3.0__py3-none-any.whl

InquirerPy/containers/spinner.py

@@ -0,0 +1,109 @@
+"""Module contains spinner related resources.
+
+Note:
+    The spinner is not a standalone spinner to run in the terminal
+    but rather a `prompt_toolkit` :class:`~prompt_toolkit.layout.Window` that displays a spinner.
+
+    Use library such as `yaspin <https://github.com/pavdmyt/yaspin>`_ if you need a plain spinner.
+"""
+
+import asyncio
+from typing import TYPE_CHECKING, Callable, List, NamedTuple, Optional, Tuple, Union
+
+from prompt_toolkit.filters.utils import to_filter
+from prompt_toolkit.layout.containers import ConditionalContainer, Window
+from prompt_toolkit.layout.controls import FormattedTextControl
+
+if TYPE_CHECKING:
+    from prompt_toolkit.filters.base import Filter
+
+__all__ = ["SPINNERS", "SpinnerWindow"]
+
+
+class SPINNERS(NamedTuple):
+    """Presets of spinner patterns.
+
+    See Also:
+        https://github.com/pavdmyt/yaspin/blob/master/yaspin/data/spinners.json
+
+    This only contains some basic ones thats ready to use. For more patterns, checkout the
+    URL above.
+
+    Examples:
+        >>> from InquirerPy import inquirer
+        >>> from InquirerPy.spinner import SPINNERS
+        >>> inquirer.select(message="", choices=lambda _: [1, 2, 3], spinner_pattern=SPINNERS.dots)
+    """
+
+    dots = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
+    dots2 = ["⣾", "⣽", "⣻", "⢿", "⡿", "⣟", "⣯", "⣷"]
+    line = ["-", "\\", "|", "/"]
+    line2 = ["⠂", "-", "–", "—", "–", "-"]
+    pipe = ["┤", "┘", "┴", "└", "├", "┌", "┬", "┐"]
+    star = ["✶", "✸", "✹", "✺", "✹", "✷"]
+    star2 = ["+", "x", "*"]
+    flip = ["_", "_", "_", "-", "`", "`", "'", "´", "-", "_", "_", "_"]
+    hamburger = ["☱", "☲", "☴"]
+    grow_vertical = ["▁", "▃", "▄", "▅", "▆", "▇", "▆", "▅", "▄", "▃"]
+    grow_horizontal = ["▏", "▎", "▍", "▌", "▋", "▊", "▉", "▊", "▋", "▌", "▍", "▎"]
+    box_bounce = ["▖", "▘", "▝", "▗"]
+    triangle = ["◢", "◣", "◤", "◥"]
+    arc = ["◜", "◠", "◝", "◞", "◡", "◟"]
+    circle = ["◡", "⊙", "◠"]
+
+
+class SpinnerWindow(ConditionalContainer):
+    """Conditional `prompt_toolkit` :class:`~prompt_toolkit.layout.Window` that displays a spinner.
+
+    Args:
+        loading: A :class:`~prompt_toolkit.filters.Condition` to indicate if the spinner should be visible.
+        redraw: A redraw function (i.e. :meth:`~prompt_toolkit.application.Application.invalidate`) to refresh the UI.
+        pattern: List of pattern to display as the spinner.
+        delay: Spinner refresh frequency.
+        text: Loading text to display.
+    """
+
+    def __init__(
+        self,
+        loading: "Filter",
+        redraw: Callable[[], None],
+        pattern: Optional[Union[List[str], SPINNERS]] = None,
+        delay: float = 0.1,
+        text: str = "",
+    ) -> None:
+        self._loading = to_filter(loading)
+        self._spinning = False
+        self._redraw = redraw
+        self._pattern = pattern or SPINNERS.line
+        self._char = self._pattern[0]
+        self._delay = delay
+        self._text = text or "Loading ..."
+
+        super().__init__(
+            content=Window(content=FormattedTextControl(text=self._get_text)),
+            filter=self._loading,
+        )
+
+    def _get_text(self) -> List[Tuple[str, str]]:
+        """Dynamically get the text for the :class:`~prompt_toolkit.layout.Window`.
+
+        Returns:
+            Formatted text.
+        """
+        return [
+            ("class:spinner_pattern", self._char),
+            ("", " "),
+            ("class:spinner_text", self._text),
+        ]
+
+    async def start(self) -> None:
+        """Start the spinner."""
+        if self._spinning:
+            return
+        self._spinning = True
+        while self._loading():
+            for char in self._pattern:
+                await asyncio.sleep(self._delay)
+                self._char = char
+                self._redraw()
+        self._spinning = False

InquirerPy/containers/validation.py

@@ -0,0 +1,60 @@
+"""Module contains :class:`.ValidationWindow` which can be used to display error."""
+
+from typing import Optional
+
+from prompt_toolkit.filters.base import FilterOrBool
+from prompt_toolkit.formatted_text.base import AnyFormattedText
+from prompt_toolkit.layout.containers import ConditionalContainer, Float, Window
+from prompt_toolkit.layout.controls import FormattedTextControl
+
+
+class ValidationWindow(ConditionalContainer):
+    """Conditional `prompt_toolkit` :class:`~prompt_toolkit.layout.Window` that displays error.
+
+    Args:
+        invalid_message: Error message to display when error occured.
+        filter: Condition to display the error window.
+    """
+
+    def __init__(
+        self, invalid_message: AnyFormattedText, filter: FilterOrBool, **kwargs
+    ) -> None:
+        super().__init__(
+            Window(
+                FormattedTextControl(invalid_message), dont_extend_height=True, **kwargs
+            ),
+            filter=filter,
+        )
+
+
+class ValidationFloat(Float):
+    """:class:`~prompt_toolkit.layout.Float` wrapper around :class:`.ValidationWindow`.
+
+    Args:
+        invalid_message: Error message to display when error occured.
+        filter: Condition to display the error window.
+        left: Distance to left.
+        right: Distance to right.
+        bottom: Distance to bottom.
+        top: Distance to top.
+    """
+
+    def __init__(
+        self,
+        invalid_message: AnyFormattedText,
+        filter: FilterOrBool,
+        left: Optional[int] = None,
+        right: Optional[int] = None,
+        bottom: Optional[int] = None,
+        top: Optional[int] = None,
+        **kwargs
+    ) -> None:
+        super().__init__(
+            content=ValidationWindow(
+                invalid_message=invalid_message, filter=filter, **kwargs
+            ),
+            left=left,
+            right=right,
+            bottom=bottom,
+            top=top,
+        )

InquirerPy/enum.py

@@ -0,0 +1,8 @@
+"""Module contains common constants."""
+
+INQUIRERPY_KEYBOARD_INTERRUPT: str = "INQUIRERPY_KEYBOARD_INTERRUPT"
+
+INQUIRERPY_POINTER_SEQUENCE: str = "\u276f"
+INQUIRERPY_FILL_CIRCLE_SEQUENCE: str = "\u25c9"
+INQUIRERPY_EMPTY_CIRCLE_SEQUENCE: str = "\u25cb"
+INQUIRERPY_QMARK_SEQUENCE: str = "\u003f"

InquirerPy/exceptions.py

@@ -0,0 +1,25 @@
+"""Module contains exceptions that will be raised by `InquirerPy`."""
+
+
+class InvalidArgument(Exception):
+    """Provided argument is invalid.
+
+    Args:
+        message: Exception message.
+    """
+
+    def __init__(self, message: str = "invalid argument"):
+        self._message = message
+        super().__init__(self._message)
+
+
+class RequiredKeyNotFound(Exception):
+    """Missing required keys in dictionary.
+
+    Args:
+        message: Exception message.
+    """
+
+    def __init__(self, message="required key not found"):
+        self.message = message
+        super().__init__(self.message)

InquirerPy/inquirer.py

@@ -0,0 +1,31 @@
+"""Servers as another entry point for `InquirerPy`.
+
+See Also:
+    :ref:`index:Alternate Syntax`.
+
+`inquirer` directly interact with individual prompt classes. It’s more flexible, easier to customise and also provides IDE type hintings/completions.
+"""
+
+__all__ = [
+    "checkbox",
+    "confirm",
+    "expand",
+    "filepath",
+    "fuzzy",
+    "text",
+    "select",
+    "number",
+    "rawlist",
+    "secret",
+]
+
+from InquirerPy.prompts import CheckboxPrompt as checkbox
+from InquirerPy.prompts import ConfirmPrompt as confirm
+from InquirerPy.prompts import ExpandPrompt as expand
+from InquirerPy.prompts import FilePathPrompt as filepath
+from InquirerPy.prompts import FuzzyPrompt as fuzzy
+from InquirerPy.prompts import InputPrompt as text
+from InquirerPy.prompts import ListPrompt as select
+from InquirerPy.prompts import NumberPrompt as number
+from InquirerPy.prompts import RawlistPrompt as rawlist
+from InquirerPy.prompts import SecretPrompt as secret

InquirerPy/prompts/__init__.py

@@ -0,0 +1,25 @@
+"""Module contains import of all prompts classes."""
+
+__all__ = [
+    "CheckboxPrompt",
+    "ConfirmPrompt",
+    "ExpandPrompt",
+    "FilePathPrompt",
+    "FuzzyPrompt",
+    "InputPrompt",
+    "ListPrompt",
+    "NumberPrompt",
+    "RawlistPrompt",
+    "SecretPrompt",
+]
+
+from InquirerPy.prompts.checkbox import CheckboxPrompt
+from InquirerPy.prompts.confirm import ConfirmPrompt
+from InquirerPy.prompts.expand import ExpandPrompt
+from InquirerPy.prompts.filepath import FilePathPrompt
+from InquirerPy.prompts.fuzzy import FuzzyPrompt
+from InquirerPy.prompts.input import InputPrompt
+from InquirerPy.prompts.list import ListPrompt
+from InquirerPy.prompts.number import NumberPrompt
+from InquirerPy.prompts.rawlist import RawlistPrompt
+from InquirerPy.prompts.secret import SecretPrompt

InquirerPy/prompts/checkbox.py

@@ -0,0 +1,249 @@
+"""Module contains the class to create a checkbox prompt."""
+
+from typing import Any, Callable, List, Optional, Tuple, Union
+
+from prompt_toolkit.validation import ValidationError
+
+from InquirerPy.base import FakeDocument, InquirerPyUIListControl
+from InquirerPy.enum import (
+    INQUIRERPY_EMPTY_CIRCLE_SEQUENCE,
+    INQUIRERPY_FILL_CIRCLE_SEQUENCE,
+    INQUIRERPY_POINTER_SEQUENCE,
+)
+from InquirerPy.prompts.list import ListPrompt
+from InquirerPy.separator import Separator
+from InquirerPy.utils import (
+    InquirerPyKeybindings,
+    InquirerPyListChoices,
+    InquirerPyMessage,
+    InquirerPySessionResult,
+    InquirerPyStyle,
+    InquirerPyValidate,
+)
+
+__all__ = ["CheckboxPrompt"]
+
+
+class InquirerPyCheckboxControl(InquirerPyUIListControl):
+    """An :class:`~prompt_toolkit.layout.UIControl` class that displays a list of choices.
+
+    Reference the parameter definition in :class:`.CheckboxPrompt`.
+    """
+
+    def __init__(
+        self,
+        choices: InquirerPyListChoices,
+        default: Any,
+        pointer: str,
+        enabled_symbol: str,
+        disabled_symbol: str,
+        session_result: Optional[InquirerPySessionResult],
+    ) -> None:
+        """Initialise required attributes and call base class."""
+        self._pointer = pointer
+        self._enabled_symbol = enabled_symbol
+        self._disabled_symbol = disabled_symbol
+        super().__init__(
+            choices=choices,
+            default=default,
+            session_result=session_result,
+            multiselect=True,
+        )
+
+    def _format_choices(self) -> None:
+        pass
+
+    def _get_hover_text(self, choice) -> List[Tuple[str, str]]:
+        display_choices = []
+        display_choices.append(("class:pointer", self._pointer))
+        if self._pointer:
+            display_choices.append(("", " "))
+        if not isinstance(choice["value"], Separator):
+            display_choices.append(
+                (
+                    "class:checkbox",
+                    (
+                        self._enabled_symbol
+                        if choice["enabled"]
+                        else self._disabled_symbol
+                    ),
+                )
+            )
+            if self._enabled_symbol and self._disabled_symbol:
+                display_choices.append(("", " "))
+        display_choices.append(("[SetCursorPosition]", ""))
+        display_choices.append(("class:pointer", choice["name"]))
+        return display_choices
+
+    def _get_normal_text(self, choice) -> List[Tuple[str, str]]:
+        display_choices = []
+        display_choices.append(("", len(self._pointer) * " "))
+        if self._pointer:
+            display_choices.append(("", " "))
+        if not isinstance(choice["value"], Separator):
+            display_choices.append(
+                (
+                    "class:checkbox",
+                    (
+                        self._enabled_symbol
+                        if choice["enabled"]
+                        else self._disabled_symbol
+                    ),
+                )
+            )
+            if self._enabled_symbol and self._disabled_symbol:
+                display_choices.append(("", " "))
+            display_choices.append(("", choice["name"]))
+        else:
+            display_choices.append(("class:separator", choice["name"]))
+        return display_choices
+
+
+class CheckboxPrompt(ListPrompt):
+    """Create a prompt which displays a list of checkboxes to toggle.
+
+    A wrapper class around :class:`~prompt_toolkit.application.Application`.
+
+    User can toggle on/off on each checkbox.
+
+    Works very similar to :class:`~InquirerPy.prompts.list.ListPrompt` with `multiselect` enabled,
+    the main difference is visual/UI and also when not toggling anything, the result will be empty.
+
+    Args:
+        message: The question to ask the user.
+            Refer to :ref:`pages/dynamic:message` documentation for more details.
+        choices: List of choices to display and select.
+            Refer to :ref:`pages/dynamic:choices` documentation for more details.
+        style: An :class:`InquirerPyStyle` instance.
+            Refer to :ref:`Style <pages/style:Alternate Syntax>` documentation for more details.
+        vi_mode: Use vim keybinding for the prompt.
+            Refer to :ref:`pages/kb:Keybindings` documentation for more details.
+        default: Set the default value of the prompt.
+            This will be used to determine which choice is highlighted (current selection),
+            The default value should be the value of one of the choices.
+            Refer to :ref:`pages/dynamic:default` documentation for more details.
+        separator: Separator symbol. Custom symbol that will be used as a separator between the choice index number and the choices.
+        qmark: Question mark symbol. Custom symbol that will be displayed infront of the question before its answered.
+        amark: Answer mark symbol. Custom symbol that will be displayed infront of the question after its answered.
+        pointer: Pointer symbol. Customer symbol that will be used to indicate the current choice selection.
+        enabled_symbol: Checkbox ticked symbol. Custom symbol which indicate the checkbox is ticked.
+        disabled_symbol: Checkbox not ticked symbol. Custom symbol which indicate the checkbox is not ticked.
+        instruction: Short instruction to display next to the question.
+        long_instruction: Long instructions to display at the bottom of the prompt.
+        validate: Add validation to user input.
+            The main use case for this prompt would be when `multiselect` is True, you can enforce a min/max selection.
+            Refer to :ref:`pages/validator:Validator` documentation for more details.
+        invalid_message: Error message to display when user input is invalid.
+            Refer to :ref:`pages/validator:Validator` documentation for more details.
+        transformer: A function which performs additional transformation on the value that gets printed to the terminal.
+            Different than `filter` parameter, this is only visual effect and won’t affect the actual value returned by :meth:`~InquirerPy.base.simple.BaseSimplePrompt.execute`.
+            Refer to :ref:`pages/dynamic:transformer` documentation for more details.
+        filter: A function which performs additional transformation on the result.
+            This affects the actual value returned by :meth:`~InquirerPy.base.simple.BaseSimplePrompt.execute`.
+            Refer to :ref:`pages/dynamic:filter` documentation for more details.
+        height: Preferred height of the prompt.
+            Refer to :ref:`pages/height:Height` documentation for more details.
+        max_height: Max height of the prompt.
+            Refer to :ref:`pages/height:Height` documentation for more details.
+        border: Create border around the choice window.
+        keybindings: Customise the builtin keybindings.
+            Refer to :ref:`pages/kb:Keybindings` for more details.
+        show_cursor: Display cursor at the end of the prompt.
+            Set to False to hide the cursor.
+        cycle: Return to top item if hit bottom during navigation or vice versa.
+        wrap_lines: Soft wrap question lines when question exceeds the terminal width.
+        raise_keyboard_interrupt: Raise the :class:`KeyboardInterrupt` exception when `ctrl-c` is pressed. If false, the result
+            will be `None` and the question is skiped.
+        mandatory: Indicate if the prompt is mandatory. If True, then the question cannot be skipped.
+        mandatory_message: Error message to show when user attempts to skip mandatory prompt.
+        session_result: Used internally for :ref:`index:Classic Syntax (PyInquirer)`.
+
+    Examples:
+        >>> from InquirerPy import inquirer
+        >>> result = inquirer.checkbox(message="Select:", choices=[1, 2, 3]).execute()
+        >>> print(result)
+        [1]
+    """
+
+    def __init__(
+        self,
+        message: InquirerPyMessage,
+        choices: InquirerPyListChoices,
+        default: Any = None,
+        style: Optional[InquirerPyStyle] = None,
+        vi_mode: bool = False,
+        qmark: str = "?",
+        amark: str = "?",
+        pointer: str = INQUIRERPY_POINTER_SEQUENCE,
+        enabled_symbol: str = INQUIRERPY_FILL_CIRCLE_SEQUENCE,
+        disabled_symbol: str = INQUIRERPY_EMPTY_CIRCLE_SEQUENCE,
+        border: bool = False,
+        instruction: str = "",
+        long_instruction: str = "",
+        transformer: Optional[Callable[[Any], Any]] = None,
+        filter: Optional[Callable[[Any], Any]] = None,
+        height: Optional[Union[int, str]] = None,
+        max_height: Optional[Union[int, str]] = None,
+        validate: Optional[InquirerPyValidate] = None,
+        invalid_message: str = "Invalid input",
+        keybindings: Optional[InquirerPyKeybindings] = None,
+        show_cursor: bool = True,
+        cycle: bool = True,
+        wrap_lines: bool = True,
+        raise_keyboard_interrupt: bool = True,
+        mandatory: bool = True,
+        mandatory_message: str = "Mandatory prompt",
+        session_result: Optional[InquirerPySessionResult] = None,
+    ) -> None:
+        self.content_control = InquirerPyCheckboxControl(
+            choices=choices,
+            default=default,
+            pointer=pointer,
+            enabled_symbol=enabled_symbol,
+            disabled_symbol=disabled_symbol,
+            session_result=session_result,
+        )
+        super().__init__(
+            message=message,
+            choices=choices,
+            style=style,
+            border=border,
+            vi_mode=vi_mode,
+            qmark=qmark,
+            amark=amark,
+            instruction=instruction,
+            long_instruction=long_instruction,
+            transformer=transformer,
+            filter=filter,
+            height=height,
+            max_height=max_height,
+            validate=validate,
+            invalid_message=invalid_message,
+            multiselect=True,
+            keybindings=keybindings,
+            show_cursor=show_cursor,
+            cycle=cycle,
+            wrap_lines=wrap_lines,
+            raise_keyboard_interrupt=raise_keyboard_interrupt,
+            mandatory=mandatory,
+            mandatory_message=mandatory_message,
+            session_result=session_result,
+        )
+
+    def _handle_enter(self, event) -> None:
+        """Override this method to force empty array result.
+
+        When user does not select anything, exit with empty list.
+
+        Args:
+            event: Keypress event.
+        """
+        try:
+            fake_document = FakeDocument(self.result_value)
+            self._validator.validate(fake_document)  # type: ignore
+        except ValidationError:
+            self._invalid = True
+        else:
+            self.status["answered"] = True
+            self.status["result"] = self.result_name
+            event.app.exit(result=self.result_value)