click._termui_impl

module documentation
(source)

This module contains implementations for the termui module. To keep the import time of Click down, some infrequently used functionality is placed in this module and only imported as needed.

Class Editor Undocumented
Class ProgressBar No class docstring; 0/3 property, 0/28 instance variable, 2/16 methods documented
Function getchar Undocumented
Function open_url Undocumented
Function pager Decide what method to use for paging through text.
Function raw_terminal Undocumented
Constant AFTER_BAR Undocumented
Constant BEFORE_BAR Undocumented
Constant V Undocumented
Function _nullpager Simply print unformatted text. This is the ultimate fallback.
Function _pipepager Page through text by feeding it to another program. Invoking a pager through this might support colors.
Function _tempfilepager Page through text by invoking a program on a temporary file.
Function _translate_ch_to_exc Undocumented
def getchar(echo): (source)

Undocumented

Parameters
echo:boolUndocumented
Returns
strUndocumented
def open_url(url, wait=False, locate=False): (source)

Undocumented

Parameters
url:strUndocumented
wait:boolUndocumented
locate:boolUndocumented
Returns
intUndocumented
def pager(generator, color=None): (source)

Decide what method to use for paging through text.

Parameters
generator:t.Iterable[str]Undocumented
color:t.Optional[bool]Undocumented
@contextlib.contextmanager
def raw_terminal(): (source)

Undocumented

Returns
t.Iterator[int]Undocumented
AFTER_BAR: str = (source)

Undocumented

Value
'''
'''
BEFORE_BAR: str = (source)

Undocumented

Value
'\r'
V = (source)

Undocumented

Value
t.TypeVar('V')
def _nullpager(stream, generator, color): (source)

Simply print unformatted text. This is the ultimate fallback.

Parameters
stream:t.TextIOUndocumented
generator:t.Iterable[str]Undocumented
color:t.Optional[bool]Undocumented
def _pipepager(generator, cmd, color): (source)

Page through text by feeding it to another program. Invoking a pager through this might support colors.

Parameters
generator:t.Iterable[str]Undocumented
cmd:strUndocumented
color:t.Optional[bool]Undocumented
def _tempfilepager(generator, cmd, color): (source)

Page through text by invoking a program on a temporary file.

Parameters
generator:t.Iterable[str]Undocumented
cmd:strUndocumented
color:t.Optional[bool]Undocumented
def _translate_ch_to_exc(ch): (source)

Undocumented

Parameters
ch:strUndocumented
Returns
t.Optional[BaseException]Undocumented