avid.common.console_abstraction

Functions

confirm_ask(question[, default, console])

Ask for yes/no confirmation using rich if available, fallback otherwise

create_columns(renderables)

Create a columns object using rich if available, fallback otherwise

create_padding(renderable[, pad])

Create a padding object using rich if available, fallback otherwise

create_panel(content[, title])

Create a panel object using rich if available, fallback otherwise

create_pretty(obj[, indent_size, max_width])

Create a pretty object using rich if available, fallback otherwise

create_table([title])

Create a table object using rich if available, fallback otherwise

create_traceback_from_exception(exc_type, ...)

Create a traceback object using rich if available, fallback otherwise

get_logging_handler([level])

Get appropriate logging handler based on rich availability

inspect(obj[, console, private, docs])

Inspect an object, with rich formatting if available

is_rich_object(obj)

Check if an object is a rich-compatible object

prompt_ask(question[, default, password, ...])

Ask for user input using rich if available, fallback otherwise

Classes

ColumnsType

alias of ConsoleColumns

ConfirmType

alias of ConsoleConfirm

Console([file, width])

Console abstraction that uses rich if available, falls back to simple stdout otherwise.

ConsoleColumns(renderables)

Abstraction for column layout that works with or without rich

ConsoleConfirm()

Abstraction for yes/no confirmation that works with or without rich

ConsolePadding(renderable[, pad])

Abstraction for padding that works with or without rich

ConsolePanel(content[, title])

Abstraction for panel creation that works with or without rich

ConsolePretty(obj[, indent_size, max_width])

Abstraction for pretty printing that works with or without rich

ConsolePrompt()

Abstraction for user prompts that works with or without rich

ConsoleTable([title])

Abstraction for table creation that works with or without rich

ConsoleTraceback(exc_type, exc_value, ...)

Abstraction for traceback formatting that works with or without rich

PaddingType

alias of ConsolePadding

PanelType

alias of ConsolePanel

PrettyType

alias of ConsolePretty

Progress([console, transient, ...])

Progress abstraction that uses rich if available, provides simple fallback otherwise

PromptType

alias of ConsolePrompt

TableType

alias of ConsoleTable

TracebackType

alias of ConsoleTraceback