SuperAPI AI 工具集

formatting

编程与开发

查看项目

更新于 10-15 23:32

技能介绍

用途:为 Python 项目提供统一、有主见的代码格式化方案,可选 Black 或 Ruff Format。

主要能力:统一代码风格;减少评审中的格式噪音;在 CI 中执行格式检查。核心原则是整个项目只选一个格式化工具:Black 是经典选择,Ruff Format 更快且与 Ruff 集成。

使用方式:安装并运行。Black:uv pip install black 后执行 black .;Ruff:uv pip install ruff 后执行 ruff format .。

配置:Black 在 pyproject.toml 的 [tool.black] 下设置 line-length、target-version、include、extend-exclude 等;Ruff Format 在 [tool.ruff.format] 下设置 quote-style、indent-style、line-ending 等。

最佳实践:只用一个格式化工具,避免工具冲突;本地运行而非只依赖 CI;接入 pre-commit 尽早发现问题;使用专门的格式化提交以减少评审噪音。

限制与排错:出现冲突时移除其他格式化工具;行宽频繁变动时需在各工具间对齐 line-length。参考文档:https://black.readthedocs.io/en/stable/ 与 https://docs.astral.sh/ruff/formatter/。