blab_chatbot_bot_client.settings_format

Defines the expected fields of a configuration file.

Module Contents

Classes

BlabConnectionSettings	Contains settings to interact with BLAB Controller.
BlabWebSocketConnectionSettings	Contains settings to interact with BLAB Controller via WebSocket.
BlabBotClientSettings	Protocol of classes whose instances contain all the settings for a bot client.
BlabWebSocketBotClientSettings	Protocol of classes whose instances contain all the settings for a bot client.

class BlabConnectionSettings

Bases: TypedDict

Contains settings to interact with BLAB Controller.

Initialize self. See help(type(self)) for accurate signature.

class BlabWebSocketConnectionSettings

Bases: BlabConnectionSettings

Contains settings to interact with BLAB Controller via WebSocket.

Initialize self. See help(type(self)) for accurate signature.

BOT_HTTP_SERVER_HOSTNAME: str

Address of the (usually local) HTTP server that the controller will connect to

BOT_HTTP_SERVER_PORT: int

Port of the aforementioned server

BLAB_CONTROLLER_WS_URL: str

BLAB Controller address for WebSocket connections

class BlabBotClientSettings

Bases: Protocol

Protocol of classes whose instances contain all the settings for a bot client.

This class only contains BLAB connection settings, which are shared among all bot clients. Subclasses may add other fields.

BLAB_CONNECTION_SETTINGS: BlabConnectionSettings

Configuration parameters used to connect with BLAB Controller

class BlabWebSocketBotClientSettings

Bases: BlabBotClientSettings, Protocol

Protocol of classes whose instances contain all the settings for a bot client.

This class only contains BLAB WebSocket connection settings, which are shared among all WebSocket bot clients. Subclasses may add other fields.

BLAB_CONNECTION_SETTINGS: BlabWebSocketConnectionSettings

Configuration parameters used to connect with BLAB Controller