app/docs/en/dev/api/liteyuki/plugin/load.md

48 lines
841 B
Markdown
Raw Normal View History

2024-08-19 09:43:46 +08:00
---
title: liteyuki.plugin.load
order: 1
icon: laptop-code
category: API
---
### ***def*** `load_plugin(module_path: str | Path) -> Optional[Plugin]`
加载单个插件,可以是本地插件或是通过 `pip` 安装的插件。
2024-08-19 09:55:47 +08:00
2024-08-19 09:43:46 +08:00
参数:
2024-08-19 09:55:47 +08:00
2024-08-19 09:43:46 +08:00
module_path: 插件名称 `path.to.your.plugin`
2024-08-19 09:55:47 +08:00
2024-08-19 09:43:46 +08:00
或插件路径 `pathlib.Path(path/to/your/plugin)`
### ***def*** `load_plugins() -> set[Plugin]`
导入文件夹下多个插件
2024-08-19 09:55:47 +08:00
2024-08-19 09:43:46 +08:00
参数:
2024-08-19 09:55:47 +08:00
2024-08-19 09:43:46 +08:00
plugin_dir: 文件夹路径
2024-08-19 09:55:47 +08:00
2024-08-19 09:43:46 +08:00
ignore_warning: 是否忽略警告,通常是目录不存在或目录为空
### ***def*** `format_display_name(display_name: str, plugin_type: PluginType) -> str`
设置插件名称颜色,根据不同类型插件设置颜色
2024-08-19 09:55:47 +08:00
2024-08-19 09:43:46 +08:00
Args:
2024-08-19 09:55:47 +08:00
2024-08-19 09:43:46 +08:00
display_name: 插件名称
2024-08-19 09:55:47 +08:00
2024-08-19 09:43:46 +08:00
plugin_type: 插件类型
2024-08-19 09:55:47 +08:00
2024-08-19 09:43:46 +08:00
Returns:
2024-08-19 09:55:47 +08:00
2024-08-19 09:43:46 +08:00
str: 设置后的插件名称 <y>name</y>