一、配置文件
1.1 配置文件的位置和优先级
- Ruff支持
pyproject.toml
、ruff.toml
和.ruff.toml
三种文件(同时出现时,右边的优先级高); - 最近的配置文件生效,父级的将被忽略;
- 可使用 extend 继承其他配置;
- 命令行指定参数时,会覆盖配置文件中的选项(即命令行优先级更高);
- 可使用
target-version = "py38"
语法来指定目标 Python 版本,以避免 Ruff 对当前版本不支持的特性报错。
1.2 VSCode 中 Ruff 插件和 pip Ruff 包的作用
VSCode
中Ruff
的插件提供了可视化的Ruff检查与修正能力。pip install ruff
后提供了命令行的检查和修正能力。
1.3 命令行常见用法
ruff check
检查语法ruff check --fix
检查语法,并修复ruff format
格式化代码
1.4 禁用警告
有些时候,我们一些代码写法不符合规范,但是自己确定要这样写,这个时候想消除 Ruff 告警的话,可以使用以下配置。
- 单行禁用所有告警:
# noqa
- 单行禁用指定告警:
# noqa: D400, D415
- 文件禁用所有告警:
# ruff: noqa
- 文件禁用指定告警:
# ruff: noqa: D400, D415