SuperAPI AI 工具集

python-quality-tooling

编程与开发

查看项目

更新于 10-16 01:34

技能介绍

用途:为 Python 项目配置和运行代码质量工具,覆盖静态检查、格式化、类型检查、测试与覆盖率,并统一本地与 CI 的质量门禁。核心原则是建立一套跨本地与 CI 一致、可重复执行的质量关卡。

主要能力与命令:Lint 用 uv run ruff check;自动修复用 uv run ruff check --fix;格式化用 uv run ruff format;类型检查用 uv run ty check;测试用 uv run pytest;覆盖率用 uv run pytest --cov=src --cov-report=term-missing。若仓库采用 prek,则整体门禁用 prek run -a,安装 Git 钩子用 prek install。

使用方式:先将工具安装为开发依赖,提交前运行全部检查,并保持 CI 与本地命令一致。仓库若已标准化使用 prek,优先用 prek run -a 作为唯一质量门禁。合并前的门禁示例依次执行 ruff check --fix、ruff format、ty check,以及带覆盖率的 pytest。

限制与注意:pytest 测试必须是基于函数的,禁止使用基于类的测试或 unittest.TestCase。常见错误包括脱离 uv 直接运行工具导致环境漂移、仓库已统一用 prek 却跳过 prek run -a、只跑一个工具就认为完成。警示信号包括不使用 uv run 而直接调用 ruff/pytest、在同一仓库混用 pre-commit 与 prek 命令、出现 class Test* 形式的类测试。参考文档为 references/quality.md,其中包含完整命令集、CI 示例以及 prek 的安装与使用说明(建议用 uv tool install prek)。具体项目配置细节暂未提供。