nb_cli.plugin

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

快捷导入

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

• load_plugin => load_plugin
• load_plugins => load_plugins
• load_all_plugins => load_all_plugins
• load_from_toml => load_from_toml
• require => require
• PluginMetadata => PluginMetadata

def get_plugin(name)

• 说明

  获取已经导入的某个插件。 如果为 load_plugins 文件夹导入的插件，则为文件(夹)名。

• 参数

  • name (str): 插件名，即 {ref}nb_cli.plugin.Plugin.name。

• 返回

  • Plugin | None

def get_plugin_by_module_name(module_name)

• 说明

  通过模块名获取已经导入的某个插件。 如果提供的模块名为某个插件的子模块，同样会返回该插件。

• 参数

  • module_name (str): 模块名，即 {ref}nb_cli.plugin.Plugin.module_name。

• 返回

  • Plugin | None

def get_loaded_plugins()

• 说明

  获取当前已导入的所有插件。

• 返回

  • set[Plugin]

def get_available_plugin_names()

• 说明

  获取当前所有可用的插件名（包含尚未加载的插件）。

• 返回

  • set[str]