fix: respect type annotations when parsing command parameters - #9866
Open
Waterwzy wants to merge 2 commits into
Open
fix: respect type annotations when parsing command parameters#9866Waterwzy wants to merge 2 commits into
Waterwzy wants to merge 2 commits into
Conversation
Parameter conversion was driven by the runtime type of the default value instead of the declared annotation, so digit input like 123 was passed as int to parameters annotated as str (e.g. Optional[str] = None). Conversion now follows the annotation; defaults are only used as fallbacks when the argument is omitted. Annotation-only bool parameters also parse true/false/yes/no/1/0 correctly now.
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="astrbot/core/star/filter/command.py" line_range="178" />
<code_context>
+ raise ValueError(
+ f"参数 {param_name} 必须是布尔值(true/false, yes/no, 1/0)。",
+ )
+ if isinstance(target, type):
+ # Plain type: convert via its constructor (int/float/custom)
+ return target(raw_value)
+ # No annotation: infer the target from the default value type
+ if isinstance(target, bool):
</code_context>
<issue_to_address>
**issue (bug_risk):** A custom annotated type whose constructor rejects input with `TypeError` causes `_convert_param()` to propagate that exception instead of converting it into the parameter-validation `ValueError`; the command then reaches the generic plugin-handler error path rather than reporting a parameter type error.
**Triggers:** When a command parameter uses a custom annotation and its constructor raises `TypeError` for malformed user input.
**Suggested fix:** Catch `TypeError` alongside `ValueError` and re-raise the standardized parameter-validation error.
```suggestion
except (ValueError, TypeError):
```
</issue_to_address>Sourcery assessment
Approval pending. 1 finding to address first.
Blocking findings: astrbot/core/star/filter/command.py:178
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Parameter conversion was driven by the runtime type of the default value instead of the declared annotation, so digit input like 123 was passed as int to parameters annotated as str (e.g. Optional[str] = None). Conversion now follows the annotation; defaults are only used as fallbacks when the argument is omitted. Annotation-only bool parameters also parse true/false/yes/no/1/0 correctly now.
Modifications / 改动点
astrbot/core/star/filter/command.pytests/test_command_filter.py更新原断言
增加4个回归测试
This is NOT a breaking change. / 这不是一个破坏性变更。
Screenshots or Test Results / 运行截图或测试结果
插件中定义指令:
输入
/helloworld 101日志输出:
在之前版本的输出:
说明目前版本能够正确识别插件自身的类型注解
Checklist / 检查清单
😊 If there are new features added in the PR, I have discussed it with the authors through issues/emails, etc.
/ 如果 PR 中有新加入的功能,已经通过 Issue / 邮件等方式和作者讨论过。
👀 My changes have been well-tested, and "Verification Steps" and "Screenshots" have been provided above.
/ 我的更改经过了良好的测试,并已在上方提供了“验证步骤”和“运行截图”。
🤓 I have ensured that no new dependencies are introduced, OR if new dependencies are introduced, they have been added to the appropriate locations in
requirements.txtandpyproject.toml./ 我确保没有引入新依赖库,或者引入了新依赖库的同时将其添加到
requirements.txt和pyproject.toml文件相应位置。😮 My changes do not introduce malicious code.
/ 我的更改没有引入恶意代码。
Summary by Sourcery
Fix command parameter parsing to prioritize declared type annotations while retaining backward-compatible behavior for untyped parameters.
Bug Fixes:
Enhancements:
Tests: