用 ruff 一次性检查并格式化 Python 代码
【摘要】 用 ruff 一次性检查并格式化 Python 代码在 Python 项目里,很多人会同时装上 flake8、isort 和 Black。这几样都能用,但工具一多,配置文件和运行命令就会分散。ruff 把静态检查和格式化放进同一个命令行工具,启动快,也方便在本地和持续集成里使用同一套规则。 安装先在当前环境安装 ruff,例如:pip install ruff更稳妥的做法是把它写进项目的开...
用 ruff 一次性检查并格式化 Python 代码
在 Python 项目里,很多人会同时装上 flake8、isort 和 Black。这几样都能用,但工具一多,配置文件和运行命令就会分散。ruff 把静态检查和格式化放进同一个命令行工具,启动快,也方便在本地和持续集成里使用同一套规则。
安装
先在当前环境安装 ruff,例如:
pip install ruff
更稳妥的做法是把它写进项目的开发依赖,这样同事和流水线会用到同一版本。
先检查,再格式化
在项目根目录执行:
ruff check .
ruff check . --fix
ruff format .
ruff check 负责静态检查,加上 --fix 可以自动修复一部分问题;ruff format 则按统一风格整理代码。建议先在单个目录或几个文件上试跑,确认结果符合预期后再处理整个仓库。
用配置文件固定规则
在项目根目录添加 pyproject.toml 或 ruff.toml,把启用的规则、忽略项和目标 Python 版本写进去。本地编辑器、提交钩子和 CI 都会读同一份配置,避免「我这边能过、流水线不过」的情况。
把 ruff 接到提交前检查或 CI 之后,常见问题能更早被拦住,代码风格也不用再靠口头约定。
【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱:
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
评论(0)