pysaleryd.helpers package

Submodules

pysaleryd.helpers.error_cache module

class pysaleryd.helpers.error_cache.ErrorCache

Bases: object

Error cache, caches previous data until frame is complete

property data

Return current error messages

Returns:

error messages

Return type:

list[str]

handle(message: Message) → list[str] | None

Handle error message, return error messages if frame is completed

pysaleryd.helpers.task module

class pysaleryd.helpers.task.TaskList

Bases: object

Helper class to keep references and work with Tasks

add(*tasks: Task, remove_when_done=True) → None

Add reference to tasks

Parameters:

• tasks (~asyncio.Task) – tasks to add

• remove_when_done (bool, optional) – remove reference when task completes, defaults to True

async cancel() → None

Cancel all tasks

clear() → None

Clear task list

remove(*tasks: Task) → None

Remove references to tasks :param tasks: tasks to remove :type tasks: asyncio.Task

async wait(*args, **kwargs) → None

Wait for tasks. Wrapper around wait()

pysaleryd.helpers.task.task_manager(*args, cancel_on_exit=False, **kwargs)

Context manager for tasks

Parameters:

cancel_on_exit (bool, optional) – cancel tasks on exit context, defaults to False

Yield:

the task list

Return type:

TaskList

pysaleryd.helpers.websocket module

Reconnecting websocket client

class pysaleryd.helpers.websocket.ReconnectingWebsocketClient(host: str, port: int, on_message: Callable[[str], Coroutine[None, str, None]], on_state_change: Callable[[State | None], Coroutine[None, State | None, None]] | None = None, on_connect: Callable[[], Coroutine[None, None, None]] | None = None, connect_timeout=15)

Bases: object

Reconnecting websocket client

async close()

Close connection and perform clean up

async connect() → None

Connect to server

async send(message: str) → None

Add message to send queue

property state: State | None

State of connection

Module contents