🔖 Release 2.0.0rc2

website/versioned_docs/version-2.0.0rc2/api/plugin/plugin.md

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