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

add(message: str)

Add error message

Parameters:

message (str) – error message

begin_frame()

Begin new frame

property data

Return current error messages

Returns:

error messages

Return type:

list[str]

end_frame()

Mark data frame as complete

pysaleryd.helpers.task module

class pysaleryd.helpers.task.TaskList

Bases: object

Helper class to keep references and work with Tasks

append(*tasks: Task, remove_when_done=True)

Add reference to tasks

Parameters:

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

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

cancel()

Cancel all tasks

remove(*tasks: Task)

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

async wait(*args, **kwargs)

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: Coroutine[None, str, None], on_state_change: Coroutine[None, State, None] = None, on_connect: Coroutine[None, None, None] = None, connect_timeout=15)

Bases: object

Reconnecting websocket client

close()

Close connection and perform clean up

connect()

Connect to server

async runner()

Send and receive messages on websocket

async send(message: str)

Add message to send queue

property state

State of connection

Module contents