Skip to content

Kathara.foundation.manager.terminal.core.IConsoleAdapter

Tommaso Caiazzi edited this page Mar 19, 2026 · 1 revision

module Kathara.foundation.manager.terminal.core.IConsoleAdapter


class IConsoleAdapter

Interface for a platform console adapter. Implementations provide the glue between a manager event loop and the underlying platform's console/terminal IO mechanisms.


method IConsoleAdapter.enter_raw

enter_raw() → None

Put the terminal into raw mode.

Returns: None


method IConsoleAdapter.exit_raw

exit_raw() → None

Restore the terminal to its previous mode (reverts "enter_raw").

Returns: None


method IConsoleAdapter.install_input_reader

install_input_reader(
    loop: 'Any',
    on_bytes: 'Callable[[bytes], None]',
    on_close: 'Callable[[], None]'
) → None

Start reading from stdin and route incoming bytes to callbacks (connected to the manager handler).

Args:

  • loop (Any): The asyncio event loop instance used to register readers/tasks.
  • on_bytes (Callable[[bytes], None]): Callback to handle received input bytes.
  • on_close (Callable[[], None]): Callback to handle stdin closing or errors.

Returns: None


method IConsoleAdapter.remove_input_reader

remove_input_reader(loop: 'Any') → None

Stop reading stdin previously configured by "install_input_reader".

Args:

  • loop (Any): The asyncio event loop instance used to deregister.

Returns: None


method IConsoleAdapter.unwatch_resize

unwatch_resize(loop: 'Any') → None

Stop monitoring terminal resize events.

Args:

  • loop (Any): The asyncio event loop instance used to deregister signal handlers or callbacks.

Returns: None


method IConsoleAdapter.watch_resize

watch_resize(loop: 'Any', cb: 'Callable[[int, int], None]') → None

Start monitoring terminal resize events.

Args:

  • loop (Any): The asyncio event loop instance used to register signal handlers or callbacks.
  • cb (Callable[[int, int], None]): Callback to handle the resize.

Returns: None


method IConsoleAdapter.write_stdout

write_stdout(data: 'bytes') → None

Write bytes to stdout.

Args:

  • data (bytes): Bytes to write to stdout.

Returns: None


This file was automatically generated via lazydocs.

Clone this wiki locally