console

• LivePrintContext
• RemoveLivePart
• add_renderable
• configure_logging
• disable_interactive_shell
• get_live_console
• get_live_print_context
• interactive_shell
• live_print_scope
• log_to_live
• new_task
• print_to_live

Symbol Details

class: RemoveLivePart

• source

  Since: 0.3.0

class RemoveLivePart: ...

Changes

Version	Change
0.3.0	Made public

function: add_renderable

• source
• Example: Mount a dynamic Rich renderable in ask-shell's live region with add_renderable, plus an apply-live demo with CI heartbeats

  Since: 0.3.0

def add_renderable(
    renderable: ConsoleRenderable | RichCast | str, *, order: int = 0, name: str = ""
) -> RemoveLivePart: ...

Changes

Version	Change
0.3.0	Made public

function: configure_logging

• source

  Since: 0.3.0

def configure_logging(
    app: Typer,
    *,
    settings: AskShellSettings | None = None,
    app_pretty_exceptions_enable: bool = False,
    app_pretty_exceptions_show_locals: bool = False,
    skip_except_hook: bool = False,
    use_app_name_command_for_logs: bool = True,
    render_rich_error_on_sys_exit: bool = False,
) -> Handler: ...

Changes

Version	Change
0.3.0	Made public

function: get_live_console

• source

  Since: 0.3.0

def get_live_console() -> Console: ...

Changes

Version	Change
0.3.0	Made public

function: interactive_shell

• source

  Since: 0.3.0

def interactive_shell() -> bool: ...

Changes

Version	Change
0.3.0	Made public

function: log_to_live

• source

  Since: 0.3.0

def log_to_live(
    *objects,
    sep: str = " ",
    end: str = "\n",
    style: str | Style | None = None,
    justify: Literal[default, left, center, right, full] | None = None,
    emoji: bool | None = None,
    markup: bool | None = None,
    highlight: bool | None = None,
    log_locals: bool = False,
    _stack_offset: int = 1,
) -> None: ...

Changes

Version	Change
0.3.0	Made public

class: new_task

• source

  Since: 0.3.0

class new_task:
    description: str
    total: float = 1
    visible: bool = True
    task_fields: dict = ...
    log_after_remove: bool = True
    log_updates: bool = False
    manager: ProgressManager = ...
    completed: float = 0.0

Field	Type	Default	Since
description	str	-	0.3.0
total	float	1	0.3.0
visible	bool	True	0.3.0
task_fields	dict	...	0.3.0
log_after_remove	bool	True	0.3.0
log_updates	bool	False	0.3.0
manager	ProgressManager	...	0.3.0
completed	float	0.0	0.3.0

Changes

Version	Change
0.3.0	Made public

function: print_to_live

• source

  Since: 0.3.0

def print_to_live(
    *objects,
    sep: str = " ",
    end: str = "\n",
    style: str | Style | None = None,
    justify: Literal[default, left, center, right, full] | None = None,
    overflow: Literal[fold, crop, ellipsis, ignore] | None = None,
    no_wrap: bool | None = None,
    emoji: bool | None = None,
    markup: bool | None = None,
    highlight: bool | None = None,
    width: int | None = None,
    height: int | None = None,
    crop: bool = True,
    soft_wrap: bool | None = None,
    new_line_start: bool = False,
): ...

Changes

Version	Change
0.3.0	Made public

function: disable_interactive_shell

• source

  Since: 0.9.0

def disable_interactive_shell() -> None: ...

Force non-interactive mode for the remainder of this process.

Changes

Version	Change
0.9.0	Made public

class: LivePrintContext

• source

  Since: 0.10.0

class LivePrintContext:
    prefix: str = ""
    suppress: bool = False

Field	Type	Default	Since
prefix	str	''	0.10.0
suppress	bool	False	0.10.0

Changes

Version	Change
0.10.0	Made public

function: get_live_print_context

• source

  Since: 0.10.0

def get_live_print_context() -> LivePrintContext | None: ...

Changes

Version	Change
0.10.0	Made public

function: live_print_scope

• source
• Example: Prefix or suppress live-console scroll lines per scope, including across run_pool workers

  Since: 0.10.0

def live_print_scope(*, prefix: str = "", suppress: bool = False) -> Iterator[None]: ...

Changes

Version	Change
0.10.0	Made public