click._termui_impl

module documentation

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.
Constant AFTER​_BAR Undocumented
Constant BEFORE​_BAR Undocumented
Constant V Undocumented
Class ​Editor Undocumented
Class ​Progress​Bar No class docstring; 0/3 property, 0/28 instance variable, 2/16 methods documented
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
Function getchar Undocumented
Function open​_url Undocumented
Function pager Decide what method to use for paging through text.
Function raw​_terminal Undocumented
AFTER_BAR: str =

Undocumented

Value
'''
'''
BEFORE_BAR: str =

Undocumented

Value
'\r'
V =

Undocumented

Value
t.TypeVar('V')
def _nullpager(stream, generator, color):
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):
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):
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):

Undocumented

Parameters
ch:strUndocumented
Returns
t.Optional[BaseException]Undocumented
def getchar(echo):

Undocumented

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

Undocumented

Parameters
url:strUndocumented
wait:boolUndocumented
locate:boolUndocumented
Returns
intUndocumented
def pager(generator, color=None):
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():

Undocumented

Returns
t.Iterator[int]Undocumented