faust.utils.terminal
¶
Terminal utilities.
-
faust.utils.terminal.
isatty
(fh: IO) → bool[source]¶ Return True if fh has a controlling terminal.
Notes
Use with e.g.
sys.stdin
.- Return type
-
class
faust.utils.terminal.
Spinner
(file: IO = <_io.TextIOWrapper name='<stderr>' mode='w' encoding='UTF-8'>) → None[source]¶ Progress bar spinner.
-
bell
= '\x08'¶
-
sprites
= ['◢', '◣', '◤', '◥']¶
-
cursor_hide
= '\x1b[?25l'¶
-
cursor_show
= '\x1b[?25h'¶
-
hide_cursor
= True¶
-
stopped
= False¶
-
-
class
faust.utils.terminal.
SpinnerHandler
(spinner: faust.utils.terminal.spinners.Spinner, **kwargs: Any) → None[source]¶ A logger handler that iterates our progress spinner for each log.
-
faust.utils.terminal.
Table
¶ alias of
terminaltables.base_table.BaseTable
-
faust.utils.terminal.
TableDataT
¶ alias of
typing.Sequence
-
faust.utils.terminal.
logtable
(data: Sequence[Sequence[str]], *, title: str, target: IO = None, tty: bool = None, headers: Sequence[str] = None, **kwargs: Any) → str[source]¶ Prepare table for logging.
Will use ANSI escape codes if the log file is a tty.
- Return type
-
faust.utils.terminal.
table
(data: Sequence[Sequence[str]], *, title: str, target: IO = None, tty: bool = None, **kwargs: Any) → terminaltables.base_table.BaseTable[source]¶ Create suitable terminaltables table for target.
- Parameters
data (Sequence[Sequence[str]]) – Table data.
target (IO) – Target should be the destination output file for your table, and defaults to
sys.stdout
. ANSI codes will be used if the target has a controlling terminal, but not otherwise, which is why it’s important to pass the correct output file.
- Return type
BaseTable