nonebot2/website/versioned_docs/version-2.3.1/api/plugin/index.md
noneflow[bot] 622e8e8af3 🔖 Release 2.3.1
2024-05-20 14:19:50 +00:00

3.0 KiB

sidebar_position description
0 nonebot.plugin 模块

nonebot.plugin

本模块为 NoneBot 插件开发提供便携的定义函数。

快捷导入

为方便使用,本模块从子模块导入了部分内容,以下内容可以直接通过本模块导入:

def get_plugin(plugin_id)

  • 说明

    获取已经导入的某个插件。

    如果为 load_plugins 文件夹导入的插件,则为文件(夹)名。

    如果为嵌套的子插件,标识符为 父插件标识符:子插件文件(夹)名

  • 参数

    • plugin_id (str): 插件标识符,即 Plugin.id_
  • 返回

def get_plugin_by_module_name(module_name)

  • 说明

    通过模块名获取已经导入的某个插件。

    如果提供的模块名为某个插件的子模块,同样会返回该插件。

  • 参数

  • 返回

def get_loaded_plugins()

  • 说明: 获取当前已导入的所有插件。

  • 参数

    empty

  • 返回

def get_available_plugin_names()

  • 说明: 获取当前所有可用的插件标识符(包含尚未加载的插件)。

  • 参数

    empty

  • 返回

    • set[str]

def get_plugin_config(config)

  • 说明: 从全局配置获取当前插件需要的配置项。

  • 参数

    • config (type[C])
  • 返回

    • C