apologiesserver.util

Shared utilities.

Module Contents

apologiesserver.util.log

apologiesserver.util.homedir() → str

Get the current user’s home directory.

apologiesserver.util.mask(data: Optional[Union[str, bytes]]) → str

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

apologiesserver.util.extract(data: Union[str, apologiesserver.interface.Message, websockets.typing.Data]) → apologiesserver.interface.Message

async apologiesserver.util.close(websocket: websockets.legacy.protocol.WebSocketCommonProtocol) → None

Close a websocket.

async apologiesserver.util.send(websocket: websockets.legacy.protocol.WebSocketCommonProtocol, message: Union[str, apologiesserver.interface.Message]) → None

Send a response to a websocket.

async apologiesserver.util.receive(websocket: websockets.legacy.protocol.WebSocketCommonProtocol, timeout_sec: Optional[int] = None) → Optional[apologiesserver.interface.Message]

apologiesserver.util.setup_logging(quiet: bool, verbose: bool, debug: bool, logfile_path: Optional[str] = None) → None

Set up Python logging.