feat: 新增两个插件生命周期事件钩子 & 为插件metadata.yaml引入dependencies字段 #1925
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
嘿 @Flartiny - 我已经查看了你的更改 - 这里有一些反馈：
- 避免在加载元数据时在
_get_load_order中静默地吞下异常——至少记录堆栈跟踪，这样插件故障就不会被隐藏。 - 从
_get_load_order中提取依赖关系图构建和拓扑排序到更小的辅助方法中，以提高可读性和可测试性。 - 目前，缺少依赖项只会发出警告，但仍然会加载插件——考虑排除或快速失败未解决的依赖项，以避免不可预测的运行时错误。
AI 代理的提示
请解决此代码审查中的评论：
## 总体评论
- 避免在加载元数据时在 `_get_load_order` 中静默地吞下异常——至少记录堆栈跟踪，这样插件故障就不会被隐藏。
- 从 `_get_load_order` 中提取依赖关系图构建和拓扑排序到更小的辅助方法中，以提高可读性和可测试性。
- 目前，缺少依赖项只会发出警告，但仍然会加载插件——考虑排除或快速失败未解决的依赖项，以避免不可预测的运行时错误。帮助我更有用！请点击每个评论上的 👍 或 👎，我将使用反馈来改进你的评论。
Original comment in English
Hey @Flartiny - I've reviewed your changes - here's some feedback:
- Avoid silently swallowing exceptions in
_get_load_orderwhen loading metadata—at minimum log the stack trace so plugin failures aren’t hidden. - Extract the dependency‐graph construction and topological sort from
_get_load_orderinto smaller helper methods to improve readability and testability. - Right now missing dependencies only emit warnings but still load the plugin—consider excluding or failing fast on unresolved dependencies to avoid unpredictable runtime errors.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Avoid silently swallowing exceptions in `_get_load_order` when loading metadata—at minimum log the stack trace so plugin failures aren’t hidden.
- Extract the dependency‐graph construction and topological sort from `_get_load_order` into smaller helper methods to improve readability and testability.
- Right now missing dependencies only emit warnings but still load the plugin—consider excluding or failing fast on unresolved dependencies to avoid unpredictable runtime errors.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
astrbot/core/star/star_manager.py
Outdated
| # 检查这个 handler 是否监听了特定的插件名 | ||
| target_star_name = handler.extras_configs.get("target_star_name") | ||
| if target_star_name: |
There was a problem hiding this comment.
suggestion (code-quality): Use named expression to simplify assignment and conditional (use-named-expression)
| # 检查这个 handler 是否监听了特定的插件名 | |
| target_star_name = handler.extras_configs.get("target_star_name") | |
| if target_star_name: | |
| if target_star_name := handler.extras_configs.get("target_star_name"): |
Original comment in English
suggestion (code-quality): Use named expression to simplify assignment and conditional (use-named-expression)
| # 检查这个 handler 是否监听了特定的插件名 | |
| target_star_name = handler.extras_configs.get("target_star_name") | |
| if target_star_name: | |
| if target_star_name := handler.extras_configs.get("target_star_name"): |
astrbot/core/star/star_manager.py
Outdated
| metadata = self._load_plugin_metadata(plugin_dir_path) | ||
| if metadata: |
There was a problem hiding this comment.
suggestion (code-quality): Use named expression to simplify assignment and conditional (use-named-expression)
| metadata = self._load_plugin_metadata(plugin_dir_path) | |
| if metadata: | |
| if metadata := self._load_plugin_metadata(plugin_dir_path): |
Original comment in English
suggestion (code-quality): Use named expression to simplify assignment and conditional (use-named-expression)
| metadata = self._load_plugin_metadata(plugin_dir_path) | |
| if metadata: | |
| if metadata := self._load_plugin_metadata(plugin_dir_path): |
我认为有一定区别，terminal() 与 initialize()用于控制插件自身在生命周期首尾的活动，而on_star_activated和on_star_deactivated帮助插件在自身生命周期中期了解其他插件的启停情况并作出响应。 接前文，经测试，目前的改动一般情况下运行正常，但存在几处问题：
正尝试基于图结构更好地管理插件间的关联，包括以子图为单位自动进行插件重载等 |
|
引入networkx进行相关操作，这个依赖应该未来的记忆部分也会引入（？ 关于此pr的说明： 现在存在循环依赖时，仍加载全部插件，目的是不影响无关插件的工作。但导致循环依赖的部分插件可能不按预期工作，这点由用户或开发者自行处理。 install_plugin_from_file未经测试（我的Astrbot之前“从压缩包安装”就用不了，可能和docker或者其他未知原因有关。但是从代码上看应该没问题） |
| from .star_handler import star_handlers_registry | ||
| from .updator import PluginUpdator | ||
| from .star_handler import EventType, StarHandlerMetadata | ||
| import networkx as nx |
There was a problem hiding this comment.
这里如果不用 networkx 的话可以实现嘛？可能目前基于图的长期记忆还暂时不会引入。
tips: 抱歉这么久没处理；这个 PR 打算放到 releases/4.0.0 分支中；
There was a problem hiding this comment.
理论上可行, 即在 2340c5c 基础上修改，之前稍微尝试了一下感觉比较冗长（时间有点久了，只记得至少有一处细节手动处理起来比较复杂，而交由networkx管理相对清晰）并且不易扩展（比如目前想到的是依赖项后跟版本号进行更细致的区分）
Motivation
为可能的插件联动做铺垫，方便监控插件生命周期
Modifications
举例来说：有A插件，其功能一定程度上依赖B插件
则A先于B初始化，待B初始化（启用）时，就能触发A中的on_star_activated钩子
此外，系统插件优先初始化
Check
目前仅进行了简单测试（一级依赖），复杂用例与可能导致错误的用例待测试
requirements.txt和pyproject.toml文件相应位置。好的，这是将 pull request 总结翻译成中文的结果：
Sourcery 总结
引入了两个插件生命周期事件钩子用于激活和停用，并支持通过元数据中新的“dependencies”字段实现依赖驱动的插件初始化顺序。
新特性：
on_star_activated事件钩子，用于在指定插件激活时发出通知on_star_deactivated事件钩子，用于在指定插件停用时发出通知dependencies字段，用于指定加载依赖项增强功能：
Original summary in English
Summary by Sourcery
Introduce two plugin lifecycle event hooks for activation and deactivation, and support dependency-driven plugin initialization order via a new 'dependencies' field in metadata.
New Features:
Enhancements: