nonebot2/website/versioned_docs/version-2.0.0rc4/api/plugin/plugin.md
github-actions[bot] 890b2ee22f 🔖 Release 2.0.0rc4
2023-04-01 03:59:10 +00:00

1.7 KiB
Raw Blame History

sidebar_position description
3 nonebot.plugin.plugin 模块

nonebot.plugin.plugin

本模块定义插件对象。

class PluginMetadata(<auto>)

  • 说明: 插件元信息,由插件编写者提供

  • 参数

    auto

instance-var name

  • 类型: str

  • 说明: 插件可阅读名称

instance-var description

  • 类型: str

  • 说明: 插件功能介绍

instance-var usage

  • 类型: str

  • 说明: 插件使用方法

class-var config

  • 类型: type[BaseModel] | None

  • 说明: 插件配置项

class Plugin(<auto>)

  • 说明: 存储插件信息

  • 参数

    auto

instance-var name

  • 类型: str

  • 说明: 插件索引标识NoneBot 使用 文件/文件夹 名称作为标识符

instance-var module

  • 类型: ModuleType

  • 说明: 插件模块对象

instance-var module_name

  • 类型: str

  • 说明: 点分割模块路径

instance-var manager

  • 类型: PluginManager

  • 说明: 导入该插件的插件管理器

class-var matcher

  • 类型: set[type[Matcher]]

  • 说明: 插件加载时定义的 Matcher

class-var parent_plugin

  • 类型: Plugin | None

  • 说明: 父插件

class-var sub_plugins

  • 类型: set[Plugin]

  • 说明: 子插件集合