conntextual.curses package

Submodules

conntextual.curses.base module

A module implementing a base application.

class conntextual.curses.base.AppBase(name: str, average_depth: int = 10, metrics: PeriodicTaskMetrics = None, period_s: float = 1.0, env: ChannelEnvironment = None, period_controls: dict[str, int | float | bool | dict[str, int | float | bool]] | str = 'period', markdown: str = None, config: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = None)

Bases: ArbiterTask

A base TUI application.

app: AppInfo

property cursor: Cursor

Get this instance’s cursor.

async dispatch() → bool

Dispatch an iteration of this task.

draw() → None

Draw the application.

async handle_char(char: int) → None

Handle user input.

async init(app: AppInfo) → None

Initialize this task with application information.

input_queue: Queue[int]

property window: Any

Get this instance’s window.

conntextual.curses.tui module

A module implementing a basic TUI application.

class conntextual.curses.tui.Tui(name: str, average_depth: int = 10, metrics: PeriodicTaskMetrics = None, period_s: float = 1.0, env: ChannelEnvironment = None, period_controls: dict[str, int | float | bool | dict[str, int | float | bool]] | str = 'period', markdown: str = None, config: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = None)

Bases: AppBase

A simple TUI application.

draw() → None

Draw the application.

Module contents

A module implementing a curses-based user interface.

class conntextual.curses.TuiApp

Bases: TaskFactory[Tui]

A TUI application factory.

kind

alias of Tui

async conntextual.curses.run(app: AppInfo) → int

Run a textual application.