apologiesserver.util

Shared utilities.

Module Contents

apologiesserver.util.log

apologiesserver.util.homedir() → str

Get the current user’s home directory.

apologiesserver.util.mask(data: str | bytes | None) → str

Mask the player id in JSON data, since it’s a secret we don’t want logged.

apologiesserver.util.extract(data: str | apologiesserver.interface.Message | websockets.typing.Data) → apologiesserver.interface.Message

async apologiesserver.util.close(websocket: websockets.asyncio.connection.Connection) → None

Close a websocket.

async apologiesserver.util.send(websocket: websockets.asyncio.connection.Connection, message: str | apologiesserver.interface.Message) → None

Send a response to a websocket.

async apologiesserver.util.receive(websocket: websockets.asyncio.connection.Connection, timeout_sec: int | None = None) → apologiesserver.interface.Message | None

apologiesserver.util.setup_logging(*, quiet: bool, verbose: bool, debug: bool, logfile_path: str | None = None) → None

Set up Python logging.