snakia.core.tui

Classes

Canvas(width, height[, default_value])	A canvas is a 2D array of characters.
CanvasChar([char, fg_color, bg_color, bold, ...])
RenderContext(renderer)
RenderTarget(*args, **kwargs)
Renderer(target)
Widget()

class snakia.core.tui.Canvas(width, height, default_value=CanvasChar(' '))

Bases: object

A canvas is a 2D array of characters.

__init__(width, height, default_value=CanvasChar(' '))

clear()

Clear the canvas.

Return type:

None

copy_from(other, x=0, y=0)

Copy the given canvas to the current canvas.

Return type:

None

draw_filled_rect(x, y, width, height, char)

Draw a filled rectangle.

Return type:

None

draw_line_h(x, y, length, char)

Draw a horizontal line.

Return type:

None

draw_line_v(x, y, length, char)

Draw a vertical line.

Return type:

None

draw_rect(x, y, width, height, char)

Draw a rectangle.

Return type:

None

draw_text(x, y, text, char)

Draw text on the canvas.

Return type:

None

fill(value, /)

Fill the canvas with the given value.

Return type:

None

get(x, y, /)

Get the character at the given position.

Return type:

CanvasChar

get_column(x, /)

Get the column at the given position.

Return type:

Iterable[CanvasChar]

get_row(y, /)

Get the row at the given position.

Return type:

Iterable[CanvasChar]

get_subcanvas(x, y, width, height)

Get a subcanvas from the current canvas.

Return type:

Canvas

height: Final[int]

is_valid_position(x, y)

Check if the given position is valid.

Return type:

bool

set(x, y, value, /)

Set the character at the given position.

Return type:

None

set_area(x, y, width, height, value)

Set the area at the given position.

Return type:

None

set_column(x, value, /)

Set the column at the given position.

Return type:

None

set_row(y, value, /)

Set the row at the given position.

Return type:

None

property total: int

width: Final[int]

class snakia.core.tui.CanvasChar(char=' ', fg_color=None, bg_color=None, bold=False, italic=False, underline=False)

Bases: object

__init__(char=' ', fg_color=None, bg_color=None, bold=False, italic=False, underline=False)

bg_color: str | None

bold: bool

char: str

fg_color: str | None

italic: bool

underline: bool

class snakia.core.tui.RenderContext(renderer)

Bases: object

__init__(renderer)

render(canvas)

Return type:

None

class snakia.core.tui.RenderTarget(*args, **kwargs)

Bases: Protocol

__init__(*args, **kwargs)

flush()

Return type:

None

write(text)

Return type:

None

class snakia.core.tui.Renderer(target)

Bases: ABC

__init__(target)

abstract clear_screen()

Return type:

None

abstract hide_cursor()

Return type:

None

abstract render(canvas)

Return type:

None

abstract set_cursor_position(x, y)

Return type:

None

abstract show_cursor()

Return type:

None

class snakia.core.tui.Widget

Bases: ABC

__init__()

final async_state(default_value)

Return type:

AsyncBindable[TypeVar(T)]

abstract on_render()

Return type:

Canvas

final render()

Return type:

Canvas

final state(default_value)

Return type:

Bindable[TypeVar(T)]

Modules

canvas
char
render
renderer
widget
widgets