SuperAPI AI 工具集

python-code-style

编程与开发

查看项目

更新于 10-15 23:57

技能介绍

用途:该技能是这套技术栈中 Python 代码风格的唯一负责人,规定“良好风格的 Python 长什么样”,即用 ruff 做 lint 与格式化、用 numpydoc 写文档字符串。它是显式手动执行的:由 Claude 对刚改动的文件运行 ruff,不涉及 hook。

主要能力:对本次改动的 Python 文件按顺序运行三步——pixi run ruff format <files>、pixi run ruff check --fix <files>、pixi run ruff check <files>;为公共函数与类编写 numpydoc 格式文档字符串;把被改动文件的注释改写为面向数据科学问题的说明,并清除工作流/流程类元信息;在新项目中放置 ruff.toml 模板。

使用方式:在项目环境中运行上述三条命令(pixi 项目用 pixi run,uv/poetry/conda 用等价方式)。初始配置需先读取 .agents/skills/python-code-style/templates/ruff.toml,再原样写入项目根目录的 ruff.toml,并用 pixi run ruff check --show-settings . 验证。

适用场景:src/<pkg>/、experiments/、audit/、data/eda.py 及顶层 *.py 脚本等用户自有代码。

限制:不配置 PostToolUse/PreToolUse hook;不用 black/isort/flake8/pydocstyle/pylint 替代 ruff;不 lint 用户代码之外的路径(如 .pixi/、.venv/、node_modules/、生成文件);每个文件最多两次修复尝试,同一警告持续存在则停止并上报;不凭记忆编写 ruff.toml;不擅自调用 warnings.filterwarnings;类型检查(mypy/pyright)不在范围内。