nonebot.plugin.plugin
本模块定义插件对象。
class PluginMetadata(name, description, usage, config=None, extra=<factory>)
说明
插件元信息,由插件编写者提供
参数
name
(str)description
(str)usage
(str)config
(Type[pydantic.main.BaseModel] | None)extra
(dict[Any, Any])
class-var config
类型: Type[pydantic.main.BaseModel] | None
说明: 插件配置项
instance-var name
类型: str
说明: 插件可阅读名称
instance-var description
类型: str
说明: 插件功能介绍
instance-var usage
类型: str
说明: 插件使用方法
class Plugin(name, module, module_name, manager, matcher=<factory>, parent_plugin=None, sub_plugins=<factory>, metadata=None)
说明
存储插件信息
参数
name
(str)module
(module)module_name
(str)manager
(PluginManager)matcher
(set[Type[nonebot.internal.matcher.matcher.Matcher]])parent_plugin
(Plugin | None)sub_plugins
(set[Plugin])metadata
(PluginMetadata | None)
class-var parent_plugin
类型: Plugin | None
说明: 父插件
instance-var name
类型: str
说明: 插件索引标识,NoneBot 使用 文件/文件夹 名称作为标识符
instance-var module
类型: module
说明: 插件模块对象
instance-var module_name
类型: str
说明: 点分割模块路径
instance-var manager
类型: PluginManager
说明: 导入该插件的插件管理器
instance-var matcher
类型: set[Type[nonebot.internal.matcher.matcher.Matcher]]
说明: 插件内定义的
Matcher
instance-var sub_plugins
类型: set[Plugin]
说明: 子插件集合