.config/coc/extensions/node_modules/coc-pyright/node_modules/pyright/dist/typeshed-fallback/stubs/click/click/termui.pyi

   1 from typing import IO, Any, Callable, Generator, Iterable, Text, TypeVar, overload
   2
   3 from click._termui_impl import ProgressBar as _ProgressBar
   4 from click.core import _ConvertibleType
   5
   6 def hidden_prompt_func(prompt: str) -> str: ...
   7 def _build_prompt(text: str, suffix: str, show_default: bool = ..., default: str | None = ...) -> str: ...
   8 def prompt(
   9     text: str,
  10     default: str | None = ...,
  11     hide_input: bool = ...,
  12     confirmation_prompt: bool = ...,
  13     type: _ConvertibleType | None = ...,
  14     value_proc: Callable[[str | None], Any] | None = ...,
  15     prompt_suffix: str = ...,
  16     show_default: bool = ...,
  17     err: bool = ...,
  18     show_choices: bool = ...,
  19 ) -> Any: ...
  20 def confirm(
  21     text: str, default: bool = ..., abort: bool = ..., prompt_suffix: str = ..., show_default: bool = ..., err: bool = ...
  22 ) -> bool: ...
  23 def get_terminal_size() -> tuple[int, int]: ...
  24 def echo_via_pager(
  25     text_or_generator: str | Iterable[str] | Callable[[], Generator[str, None, None]], color: bool | None = ...
  26 ) -> None: ...
  27
  28 _T = TypeVar("_T")
  29
  30 @overload
  31 def progressbar(
  32     iterable: Iterable[_T],
  33     length: int | None = ...,
  34     label: str | None = ...,
  35     show_eta: bool = ...,
  36     show_percent: bool | None = ...,
  37     show_pos: bool = ...,
  38     item_show_func: Callable[[_T], str] | None = ...,
  39     fill_char: str = ...,
  40     empty_char: str = ...,
  41     bar_template: str = ...,
  42     info_sep: str = ...,
  43     width: int = ...,
  44     file: IO[Any] | None = ...,
  45     color: bool | None = ...,
  46 ) -> _ProgressBar[_T]: ...
  47 @overload
  48 def progressbar(
  49     iterable: None = ...,
  50     length: int | None = ...,
  51     label: str | None = ...,
  52     show_eta: bool = ...,
  53     show_percent: bool | None = ...,
  54     show_pos: bool = ...,
  55     item_show_func: Callable[[Any], str] | None = ...,
  56     fill_char: str = ...,
  57     empty_char: str = ...,
  58     bar_template: str = ...,
  59     info_sep: str = ...,
  60     width: int = ...,
  61     file: IO[Any] | None = ...,
  62     color: bool | None = ...,
  63 ) -> _ProgressBar[int]: ...
  64 def clear() -> None: ...
  65 def style(
  66     text: Text,
  67     fg: Text | None = ...,
  68     bg: Text | None = ...,
  69     bold: bool | None = ...,
  70     dim: bool | None = ...,
  71     underline: bool | None = ...,
  72     blink: bool | None = ...,
  73     reverse: bool | None = ...,
  74     reset: bool = ...,
  75 ) -> str: ...
  76 def unstyle(text: Text) -> str: ...
  77
  78 # Styling options copied from style() for nicer type checking.
  79 def secho(
  80     message: str | None = ...,
  81     file: IO[Any] | None = ...,
  82     nl: bool = ...,
  83     err: bool = ...,
  84     color: bool | None = ...,
  85     fg: str | None = ...,
  86     bg: str | None = ...,
  87     bold: bool | None = ...,
  88     dim: bool | None = ...,
  89     underline: bool | None = ...,
  90     blink: bool | None = ...,
  91     reverse: bool | None = ...,
  92     reset: bool = ...,
  93 ) -> None: ...
  94 def edit(
  95     text: str | None = ...,
  96     editor: str | None = ...,
  97     env: str | None = ...,
  98     require_save: bool = ...,
  99     extension: str = ...,
 100     filename: str | None = ...,
 101 ) -> str: ...
 102 def launch(url: str, wait: bool = ..., locate: bool = ...) -> int: ...
 103 def getchar(echo: bool = ...) -> Text: ...
 104 def pause(info: str = ..., err: bool = ...) -> None: ...