click._termui_impl Namespace Reference

Classes
class	Editor
class	ProgressBar

Functions
None	pager (cabc.Iterable[str] generator, bool|None color=None)
bool	_pipepager (cabc.Iterable[str] generator, list[str] cmd_parts, bool|None color)
bool	_tempfilepager (cabc.Iterable[str] generator, list[str] cmd_parts, bool|None color)
None	_nullpager (t.TextIO stream, cabc.Iterable[str] generator, bool|None color)
int	open_url (str url, bool wait=False, bool locate=False)
None	_translate_ch_to_exc (str ch)
cabc.Iterator[int]	raw_terminal ()
str	getchar (bool echo)

Variables
	V = t.TypeVar("V")
str	BEFORE_BAR = "\r"
str	AFTER_BAR = "\n"

Detailed Description

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.

Function Documentation

_nullpager()

None click._termui_impl._nullpager ( t.TextIO  stream, cabc.Iterable[str]  generator, bool | None   color  )

protected

Simply print unformatted text.  This is the ultimate fallback.

_pipepager()

bool click._termui_impl._pipepager ( cabc.Iterable[str]  generator, list[str]  cmd_parts, bool | None   color  )

protected

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

Returns `True` if the command was found, `False` otherwise and thus another
pager should be attempted.

_tempfilepager()

bool click._termui_impl._tempfilepager ( cabc.Iterable[str]  generator, list[str]  cmd_parts, bool | None   color  )

protected

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

Returns `True` if the command was found, `False` otherwise and thus another
pager should be attempted.

pager()

None click._termui_impl.pager	(	cabc.Iterable[str]	generator,
		bool | None	color = None
	)

Decide what method to use for paging through text.