enrobie.plugins.autonick package#

Submodules#

enrobie.plugins.autonick.params module#

class enrobie.plugins.autonick.params.AutoNickPluginServiceParams[source]#

Bases: RobieParamsModel

Process and validate the Robie configuration parameters.

Fields#
Field	Type	Required	Default	Constraints
`client`	`str`	Yes		min_length=1
`password`	`str`	Yes		min_length=1
`service`	`str`	No	`'NickServ'`	min_length=1

client: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Client where services exist', metadata=[MinLen(min_length=1)])]#

password: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Identify with nick services', metadata=[MinLen(min_length=1)])]#

service: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='NickServ', description='Nickname of network service', metadata=[MinLen(min_length=1)])]#

class enrobie.plugins.autonick.params.AutoNickPluginParams[source]#

Bases: RobiePluginParams

Process and validate the Robie configuration parameters.

Fields#
Field	Type	Required	Default	Constraints
`clients`	`list`[`str`]	Yes		min_length=1
`enable`	`bool`	No	`False`
`interval`	`int`	No	`5`	ge=5, le=300
`locate`	`str` \| `None`	No	`None`	min_length=1
`services`	`list`[`AutoNickPluginServiceParams`] \| `None`	No	`None`
`status`	`StatusPluginIconParams`	No	factory
`trusted`	`list`[`str`] \| `None`	No	`None`	min_length=1

clients: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='List of clients to enable plugin', metadata=[MinLen(min_length=1)])]#

interval: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=5, description='Interval when nick is validated', metadata=[Ge(ge=5), Le(le=300)])]#

services: Annotated[list[AutoNickPluginServiceParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='How to identify with services')]#

status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#

enrobie.plugins.autonick.plugin module#

class enrobie.plugins.autonick.plugin.AutoNickPlugin(robie: Robie, name: str, params: RobieChildParams)[source]#

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

Note

This plugin maintains configured nickname on server.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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

Return the configuration parameters relevant for class.

Returns:: Configuration parameters relevant for class.

property params: AutoNickPluginParams#

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

operate() → None[source]#: Perform the operation related to Robie service threads.

Module contents#

class enrobie.plugins.autonick.AutoNickPlugin(robie: Robie, name: str, params: RobieChildParams)[source]#

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

Note

This plugin maintains configured nickname on server.

validate() → None[source]#: Perform advanced validation on the parameters provided.

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

Return the configuration parameters relevant for class.

Returns:: Configuration parameters relevant for class.

property params: AutoNickPluginParams#

Return the Pydantic model containing the configuration.

Returns:: Pydantic model containing the configuration.

operate() → None[source]#: Perform the operation related to Robie service threads.

class enrobie.plugins.autonick.AutoNickPluginParams[source]#

Bases: RobiePluginParams

Process and validate the Robie configuration parameters.

Fields#
Field	Type	Required	Default	Constraints
`clients`	`list`[`str`]	Yes		min_length=1
`enable`	`bool`	No	`False`
`interval`	`int`	No	`5`	ge=5, le=300
`locate`	`str` \| `None`	No	`None`	min_length=1
`services`	`list`[`AutoNickPluginServiceParams`] \| `None`	No	`None`
`status`	`StatusPluginIconParams`	No	factory
`trusted`	`list`[`str`] \| `None`	No	`None`	min_length=1

clients: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='List of clients to enable plugin', metadata=[MinLen(min_length=1)])]#

interval: Annotated[int, FieldInfo(annotation=NoneType, required=False, default=5, description='Interval when nick is validated', metadata=[Ge(ge=5), Le(le=300)])]#

services: Annotated[list[AutoNickPluginServiceParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='How to identify with services')]#

status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#