pocketutils.tools.console_tools

Complexity

Total Complexity

10

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	ConsoleUtils.clear_line()	0	12	2
A	ConsoleUtils.prompt_yes_no()	0	14	4
A	ConsoleUtils.confirm()	0	25	4

# SPDX-FileCopyrightText: Copyright 2020-2023, Contributors to pocketutils
# SPDX-PackageHomePage: https://github.com/dmyersturnbull/pocketutils
# SPDX-License-Identifier: Apache-2.0
"""

"""

import logging
import sys
from collections.abc import Callable
from dataclasses import dataclass
from typing import Any, ClassVar, Self

logger = logging.getLogger("pocketutils")

__all__ = ["ConsoleUtils", "ConsoleTools"]


@dataclass(slots=True, frozen=True)
class ConsoleUtils:
    CURSOR_UP_ONE: ClassVar[str] = "\x1b[1A"
    ERASE_LINE: ClassVar[str] = "\x1b[2K"

    def prompt_yes_no(self: Self, msg: str, writer: Callable[[str], Any] = sys.stdout.write) -> bool:
        """
        Asks for "yes" or "no" via `input`.
        Consider using `typer.prompt` instead.
        """
        while True:
            writer(msg + " ")
            command = input("")
            if command.lower() == "yes":
                return True
            elif command.lower() == "no":
                return False
            else:
                writer("Enter 'yes' or 'no'.\n")

    def confirm(
        self: Self,
        msg: str = "Confirm? [yes/no]",
        *,
        input_fn: Callable[[str], str] = input,
        writer: Callable[[str], Any] = sys.stdout.write,
    ) -> bool:
        """
        Asks for a confirmation from the user using the builtin `input`.

        Consider using `typer.prompt` instead.
            msg: If None, no message is written
            input_fn: Function to get the user input (its argument is always '')
            writer: Print using this function (should not print a newline by default)

        Returns:
            True if the user answered 'yes'; False otherwise
        """
        while True:
            writer(msg + " ")
            command = input_fn("").lower()
            if command in ["yes", "y"]:
                return True
            elif command in ["no", "n"]:
                return False

    def clear_line(self: Self, n: int = 1, writer: Callable[[str], None] = sys.stdout.write) -> None:
        """
        Writes control characters to stdout to delete the previous line and move the cursor up.
        This only works in a shell.

        Args:
            n: The number of lines to erase
            writer: Function to call (passing the string)
        """
        for _ in range(n):
            writer(ConsoleTools.CURSOR_UP_ONE)
            writer(ConsoleTools.ERASE_LINE)


ConsoleTools = ConsoleUtils()