ohnope.plugins.nickserv package

Submodules

ohnope.plugins.nickserv.params module

Functions and routines associated with rawberth Oh-nope IRC Services.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

pydantic model ohnope.plugins.nickserv.params.NickServParams

Bases: RobiePluginParams

Process and validate the core configuration parameters.

Show JSON schema

{
   "title": "NickServParams",
   "description": "Process and validate the core configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": true,
         "description": "Determine if service enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "locate": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "For which plugin are parameters",
         "examples": [
            "enrobie.plugins.AinswerPlugin",
            "enrobie.plugins.AutoJoinPlugin",
            "enrobie.plugins.AutoNickPlugin",
            "enrobie.plugins.StatusPlugin"
         ],
         "title": "Locate"
      },
      "trusted": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Users are trusted by the plugin",
         "title": "Trusted"
      },
      "nickname": {
         "default": "NickServ",
         "description": "What nickname for the service",
         "minLength": 1,
         "title": "Nickname",
         "type": "string"
      },
      "realname": {
         "default": "Nickname registration",
         "description": "What realname for the service",
         "minLength": 1,
         "title": "Realname",
         "type": "string"
      },
      "unique": {
         "default": "NICKS0",
         "description": "Unique identifier for service",
         "minLength": 1,
         "title": "Unique",
         "type": "string"
      },
      "status": {
         "$ref": "#/$defs/StatusPluginIconParams",
         "description": "Icon used per chat platform"
      }
   },
   "$defs": {
      "StatusPluginIconParams": {
         "additionalProperties": false,
         "description": "Contain information for constructing the chat messages.",
         "properties": {
            "irc": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Icon used for the chat platform",
               "title": "Irc"
            },
            "dsc": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Icon used for the chat platform",
               "title": "Dsc"
            },
            "mtm": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Icon used for the chat platform",
               "title": "Mtm"
            }
         },
         "title": "StatusPluginIconParams",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

• extra: str = forbid

Fields:

• enable (Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')])

• locate (Annotated[Optional[str], Field(None, description='For which plugin are parameters', examples=['enrobie.plugins.AinswerPlugin', 'enrobie.plugins.AutoJoinPlugin', 'enrobie.plugins.AutoNickPlugin', 'enrobie.plugins.StatusPlugin'], min_length=1)])

• nickname (Annotated[str, FieldInfo(annotation=NoneType, required=False, default='NickServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])])

• realname (Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Nickname registration', description='What realname for the service', metadata=[MinLen(min_length=1)])])

• status (Annotated[enrobie.plugins.status.params.StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')])

• trusted (Annotated[Optional[list[str]], Field(None, description='Users are trusted by the plugin', min_length=1)])

• unique (Annotated[str, FieldInfo(annotation=NoneType, required=False, default='NICKS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])])

field enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')] = True

Determine if service enabled

field locate: Annotated[str | None, Field(None, description='For which plugin are parameters', examples=['enrobie.plugins.AinswerPlugin', 'enrobie.plugins.AutoJoinPlugin', 'enrobie.plugins.AutoNickPlugin', 'enrobie.plugins.StatusPlugin'], min_length=1)] = None

For which plugin are parameters

Constraints:

• min_length = 1

field nickname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='NickServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])] = 'NickServ'

What nickname for the service

Constraints:

• min_length = 1

field realname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Nickname registration', description='What realname for the service', metadata=[MinLen(min_length=1)])] = 'Nickname registration'

What realname for the service

Constraints:

• min_length = 1

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

Icon used per chat platform

field trusted: Annotated[list[str] | None, Field(None, description='Users are trusted by the plugin', min_length=1)] = None

Users are trusted by the plugin

Constraints:

• min_length = 1

field unique: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='NICKS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])] = 'NICKS0'

Unique identifier for service

Constraints:

• min_length = 1

ohnope.plugins.nickserv.plugin module

Functions and routines associated with rawberth Oh-nope IRC Services.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class ohnope.plugins.nickserv.plugin.NickServ(robie: Robie, name: str, params: RobieChildParams)

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

operate() → None

Perform the operation related to Homie service threads.

property params: NickServParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

Module contents

Functions and routines associated with rawberth Oh-nope IRC Services.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class ohnope.plugins.nickserv.NickServ(robie: Robie, name: str, params: RobieChildParams)

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

operate() → None

Perform the operation related to Homie service threads.

property params: NickServParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

pydantic model ohnope.plugins.nickserv.NickServParams

Bases: RobiePluginParams

Process and validate the core configuration parameters.

Show JSON schema

{
   "title": "NickServParams",
   "description": "Process and validate the core configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": true,
         "description": "Determine if service enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "locate": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "For which plugin are parameters",
         "examples": [
            "enrobie.plugins.AinswerPlugin",
            "enrobie.plugins.AutoJoinPlugin",
            "enrobie.plugins.AutoNickPlugin",
            "enrobie.plugins.StatusPlugin"
         ],
         "title": "Locate"
      },
      "trusted": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Users are trusted by the plugin",
         "title": "Trusted"
      },
      "nickname": {
         "default": "NickServ",
         "description": "What nickname for the service",
         "minLength": 1,
         "title": "Nickname",
         "type": "string"
      },
      "realname": {
         "default": "Nickname registration",
         "description": "What realname for the service",
         "minLength": 1,
         "title": "Realname",
         "type": "string"
      },
      "unique": {
         "default": "NICKS0",
         "description": "Unique identifier for service",
         "minLength": 1,
         "title": "Unique",
         "type": "string"
      },
      "status": {
         "$ref": "#/$defs/StatusPluginIconParams",
         "description": "Icon used per chat platform"
      }
   },
   "$defs": {
      "StatusPluginIconParams": {
         "additionalProperties": false,
         "description": "Contain information for constructing the chat messages.",
         "properties": {
            "irc": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Icon used for the chat platform",
               "title": "Irc"
            },
            "dsc": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Icon used for the chat platform",
               "title": "Dsc"
            },
            "mtm": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Icon used for the chat platform",
               "title": "Mtm"
            }
         },
         "title": "StatusPluginIconParams",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

• extra: str = forbid

Fields:

• enable (Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')])

• locate (Annotated[Optional[str], Field(None, description='For which plugin are parameters', examples=['enrobie.plugins.AinswerPlugin', 'enrobie.plugins.AutoJoinPlugin', 'enrobie.plugins.AutoNickPlugin', 'enrobie.plugins.StatusPlugin'], min_length=1)])

• nickname (Annotated[str, FieldInfo(annotation=NoneType, required=False, default='NickServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])])

• realname (Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Nickname registration', description='What realname for the service', metadata=[MinLen(min_length=1)])])

• status (Annotated[enrobie.plugins.status.params.StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')])

• trusted (Annotated[Optional[list[str]], Field(None, description='Users are trusted by the plugin', min_length=1)])

• unique (Annotated[str, FieldInfo(annotation=NoneType, required=False, default='NICKS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])])

field enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')] = True

Determine if service enabled

field locate: Annotated[str | None, Field(None, description='For which plugin are parameters', examples=['enrobie.plugins.AinswerPlugin', 'enrobie.plugins.AutoJoinPlugin', 'enrobie.plugins.AutoNickPlugin', 'enrobie.plugins.StatusPlugin'], min_length=1)] = None

For which plugin are parameters

Constraints:

• min_length = 1

field nickname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='NickServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])] = 'NickServ'

What nickname for the service

Constraints:

• min_length = 1

field realname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Nickname registration', description='What realname for the service', metadata=[MinLen(min_length=1)])] = 'Nickname registration'

What realname for the service

Constraints:

• min_length = 1

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

Icon used per chat platform

field trusted: Annotated[list[str] | None, Field(None, description='Users are trusted by the plugin', min_length=1)] = None

Users are trusted by the plugin

Constraints:

• min_length = 1

field unique: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='NICKS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])] = 'NICKS0'

Unique identifier for service

Constraints:

• min_length = 1