mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-12-23 03:45:44 +08:00
2.6 KiB
2.6 KiB
sidebar_position | description |
---|---|
3 | nonebot.plugin.model 模块 |
nonebot.plugin.model
本模块定义插件相关信息。
class PluginMetadata(<auto>)
-
说明: 插件元信息,由插件编写者提供
-
参数
auto
instance-var name
-
类型: str
-
说明: 插件名称
instance-var description
-
类型: str
-
说明: 插件功能介绍
instance-var usage
-
类型: str
-
说明: 插件使用方法
class-var type
-
类型: str | None
-
说明: 插件类型,用于商店分类
class-var homepage
-
类型: str | None
-
说明: 插件主页
class-var config
-
类型: type[BaseModel] | None
-
说明: 插件配置项
class-var supported_adapters
-
类型: set[str] | None
-
说明
插件支持的适配器模块路径
格式为
<module>[:<Adapter>]
,~
为nonebot.adapters.
的缩写。None
表示支持所有适配器。
class-var extra
-
类型: dict[Any, Any]
-
说明: 插件额外信息,可由插件编写者自由扩展定义
method get_supported_adapters()
-
说明: 获取当前已安装的插件支持适配器类列表
-
参数
empty
-
返回
- set[type[Adapter]] | 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]
-
说明: 子插件集合