enrobie.clients.discord package#

Submodules#

enrobie.clients.discord.client module#

class enrobie.clients.discord.client.DSCClient(robie: Robie, name: str, params: RobieChildParams)[source]#

Bases: RobieClient

Establish and maintain connection with the chat service.

validate() → None[source]#

Perform advanced validation on the parameters provided.

classmethod schema() → Type[DSCClientParams][source]#

Return the configuration parameters relevant for class.

Returns:

Configuration parameters relevant for class.

property params: DSCClientParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property family: Literal['discord']#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property channels: ClientChannels#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property publish: ClientPublish#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property client: Client#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

operate() → None[source]#

Perform the operation related to Robie service threads.

get_message(event: ClientEvent | None = None) → DSCMessage[source]#

Return the new item containing information for operation.

Note

Though parameters are marked optional, that is not necessarily the case; for typing purposes one cannot introduce required parameters outside of the parent.

Parameters:

event – Raw event received from the network peer.

Returns:

New item containing information for operation.

put_message(mqueue: RobieQueue[RobieMessage], event: ClientEvent | None = None) → None[source]#

Insert the new item containing information for operation.

Note

Though parameters are marked optional, that is not necessarily the case; for typing purposes one cannot introduce required parameters outside of the parent.

Parameters:

  • mqueue – Queue instance where the item is received.

  • event – Raw event received from the network peer.

get_command(method: Literal['delete', 'get', 'post', 'patch', 'put'] | None = None, path: str | None = None, params: dict[str, Any] | None = None, json: dict[str, Any] | None = None) → DSCCommand[source]#

Return the new item containing information for operation.

Note

Though parameters are marked optional, that is not necessarily the case; for typing purposes one cannot introduce required parameters outside of the parent.

Returns:

New item containing information for operation.

Parameters:

  • method – Method for operation with the API server.

  • path – Path for the location to upstream endpoint.

  • params – Optional parameters included in request.

  • json – Optional JSON payload included in request.

put_command(cqueue: RobieQueue[RobieCommand], method: Literal['delete', 'get', 'post', 'patch', 'put'] | None = None, path: str | None = None, params: dict[str, Any] | None = None, json: dict[str, Any] | None = None) → None[source]#

Insert the new item containing information for operation.

Note

Though parameters are marked optional, that is not necessarily the case; for typing purposes one cannot introduce required parameters outside of the parent.

Parameters:

  • cqueue – Queue instance where the item is received.

  • method – Method for operation with the API server.

  • path – Path for the location to upstream endpoint.

  • params – Optional parameters included in request.

  • json – Optional JSON payload included in request.

compose(target: str, content: str) → RobieCommand[source]#

Compose the message and transmit using the chat client.

Note

Though parameters are marked optional, that is not necessarily the case; for typing purposes one cannot introduce required parameters outside of the parent.

Parameters:

  • target – Where the composed message will be sent.

  • content – Content that will be source of message.

enrobie.clients.discord.command module#

class enrobie.clients.discord.command.DSCCommand(client: RobieClient, method: Literal['delete', 'get', 'post', 'patch', 'put'], path: str, params: dict[str, Any] | None = None, json: dict[str, Any] | None = None)[source]#

Bases: RobieCommand

Contain information for sharing using the Python queue.

method: Literal['delete', 'get', 'post', 'patch', 'put']#
path: str#
params: dict[str, Any] | None#
json: dict[str, Any] | None#
property family: Literal['discord']#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

enrobie.clients.discord.message module#

class enrobie.clients.discord.message.DSCMessage(client: RobieClient, event: ClientEvent)[source]#

Bases: RobieMessage

Contain information for sharing using the Python queue.

event: ClientEvent#
property family: Literal['discord']#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kind: RobieMessageKinds#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property isme: bool#

Return the boolean indicating message origin from client.

Returns:

Boolean indicating message origin from client.

property hasme: bool#

Return the boolean indicating message mention the client.

Returns:

Boolean indicating message mention the client.

property whome: tuple[str, str] | None#

Return the current nickname of the client on the server.

Returns:

Current nickname of the client on the server.

property author: tuple[str, str] | None#

Return the current nickname of the client on the server.

Returns:

Current nickname of the client on the server.

property anchor: str | None#

Return the unique value for the context with the client.

Returns:

Unique value for the context with the client.

property message: str | None#

Return the string containing the content of the message.

Returns:

String containing the content of the message.

reply(robie: Robie, content: str) → RobieCommand[source]#

Compose the message and transmit using the chat client.

Parameters:

  • robie – Primary class instance for Chatting Robie.

  • content – Content that will be source of message.

enrobie.clients.discord.params module#

class enrobie.clients.discord.params.DSCClientParams[source]#

Bases: RobieClientParams

Process and validate the Robie configuration parameters.

Fields#

Field

Type

Required

Default

Constraints

client

ClientParams

Yes

delay

int

No

15

ge=1, le=300

enable

bool

No

False

intents

int

No

4609

ge=0, le=65535

locate

str | None

No

None

min_length=1

status

StatusPluginIconParams

No

factory
client: Annotated[ClientParams, FieldInfo(annotation=NoneType, required=True, description='Parameters for the base client')]#
intents: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=4609, description='Timeout connecting to server', metadata=[Ge(ge=0), Le(le=65535)])]#
delay: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=15, description='Period to wait for reconnect', metadata=[Ge(ge=1), Le(le=300)])]#
status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#

Module contents#

class enrobie.clients.discord.DSCClient(robie: Robie, name: str, params: RobieChildParams)[source]#

Bases: RobieClient

Establish and maintain connection with the chat service.

validate() → None[source]#

Perform advanced validation on the parameters provided.

classmethod schema() → Type[DSCClientParams][source]#

Return the configuration parameters relevant for class.

Returns:

Configuration parameters relevant for class.

property params: DSCClientParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property family: Literal['discord']#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property channels: ClientChannels#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property publish: ClientPublish#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property client: Client#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

operate() → None[source]#

Perform the operation related to Robie service threads.

get_message(event: ClientEvent | None = None) → DSCMessage[source]#

Return the new item containing information for operation.

Note

Though parameters are marked optional, that is not necessarily the case; for typing purposes one cannot introduce required parameters outside of the parent.

Parameters:

event – Raw event received from the network peer.

Returns:

New item containing information for operation.

put_message(mqueue: RobieQueue[RobieMessage], event: ClientEvent | None = None) → None[source]#

Insert the new item containing information for operation.

Note

Though parameters are marked optional, that is not necessarily the case; for typing purposes one cannot introduce required parameters outside of the parent.

Parameters:

  • mqueue – Queue instance where the item is received.

  • event – Raw event received from the network peer.

get_command(method: Literal['delete', 'get', 'post', 'patch', 'put'] | None = None, path: str | None = None, params: dict[str, Any] | None = None, json: dict[str, Any] | None = None) → DSCCommand[source]#

Return the new item containing information for operation.

Note

Though parameters are marked optional, that is not necessarily the case; for typing purposes one cannot introduce required parameters outside of the parent.

Returns:

New item containing information for operation.

Parameters:

  • method – Method for operation with the API server.

  • path – Path for the location to upstream endpoint.

  • params – Optional parameters included in request.

  • json – Optional JSON payload included in request.

put_command(cqueue: RobieQueue[RobieCommand], method: Literal['delete', 'get', 'post', 'patch', 'put'] | None = None, path: str | None = None, params: dict[str, Any] | None = None, json: dict[str, Any] | None = None) → None[source]#

Insert the new item containing information for operation.

Note

Though parameters are marked optional, that is not necessarily the case; for typing purposes one cannot introduce required parameters outside of the parent.

Parameters:

  • cqueue – Queue instance where the item is received.

  • method – Method for operation with the API server.

  • path – Path for the location to upstream endpoint.

  • params – Optional parameters included in request.

  • json – Optional JSON payload included in request.

compose(target: str, content: str) → RobieCommand[source]#

Compose the message and transmit using the chat client.

Note

Though parameters are marked optional, that is not necessarily the case; for typing purposes one cannot introduce required parameters outside of the parent.

Parameters:

  • target – Where the composed message will be sent.

  • content – Content that will be source of message.

class enrobie.clients.discord.DSCClientParams[source]#

Bases: RobieClientParams

Process and validate the Robie configuration parameters.

Fields#

Field

Type

Required

Default

Constraints

client

ClientParams

Yes

delay

int

No

15

ge=1, le=300

enable

bool

No

False

intents

int

No

4609

ge=0, le=65535

locate

str | None

No

None

min_length=1

status

StatusPluginIconParams

No

factory
client: Annotated[ClientParams, FieldInfo(annotation=NoneType, required=True, description='Parameters for the base client')]#
intents: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=4609, description='Timeout connecting to server', metadata=[Ge(ge=0), Le(le=65535)])]#
delay: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=15, description='Period to wait for reconnect', metadata=[Ge(ge=1), Le(le=300)])]#
status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#