SuperAPI AI 工具集

code-quality

测试与质量

查看项目

更新于 10-15 17:22

技能介绍

用途:在 Python 项目中统一代码风格、发现潜在问题并做静态类型检查。激活时机包括格式化代码、运行 linter、添加类型注解、修复代码风格问题以及搭建质量工具链。

主要能力:Black 负责零配置代码格式化,速度快且可自动改写;Ruff 是基于 Rust 的 linter,可替代 flake8、isort、pylint 等 50 多个工具,速度极快且多数规则可自动修复;mypy 提供静态类型检查,速度中等、不自动修复。

使用方式:安装命令为 uv add --dev black ruff mypy。常用命令:uv run black . 格式化,uv run black --check . 干跑检查,uv run black --diff . 查看改动;uv run ruff check . 检查,uv run ruff check --fix . 自动修复,uv run ruff check --show-source . 显示上下文;uv run mypy . 类型检查。全部检查可串联:uv run black . && uv run ruff check . && uv run mypy .。CI 严格模式用 uv run black --check . && uv run ruff check . && uv run mypy --strict .。

配置:可在 pyproject.toml 中统一配置三个工具,如 Black 的 line-length、target-version,Ruff 的 select/ignore 与 per-file-ignores,mypy 的 python_version、warn_return_any 等。可用 # noqa: F401 忽略 Ruff 规则,用 # fmt: off / # fmt: on 关闭 Black 格式化。

适用场景与建议:适合开发提交前检查与 CI/CD 流水线。建议渐进采用:先上 Black,再加 Ruff 基础规则并逐步扩展,最后引入 mypy 并逐步提高严格度。常见问题包括 F401 未使用导入、F841 未使用变量、I001 导入排序、B008 可变默认参数。

限制:资料未提供具体版本兼容范围、性能基准数据及与特定 IDE 的集成细节,相关配置需参考项目内 AgentUsage/code_quality.md 与 AgentUsage/code_style_guide.md。