如何使用Ruff在指定目录中忽略特定规则

来源:草根站长作者:厦门程序员头衔:程序员
导读:本期聚焦于小伙伴创作的《如何使用Ruff在指定目录中忽略特定规则》,敬请观看详情,探索知识的价值。以下视频、文章将为您系统阐述其核心内容与价值。如果您觉得《如何使用Ruff在指定目录中忽略特定规则》有用,将其分享出去将是对创作者最好的鼓励。

Ruff作为Python生态中高性能的代码检查和格式化工具,支持通过配置文件灵活调整检查规则,其中就包括在指定目录中忽略特定规则的能力,能够满足不同模块差异化的代码质量要求。

如何使用Ruff在指定目录中忽略特定规则

Ruff基础配置说明

Ruff的配置文件支持pyproject.tomlruff.toml.ruff.toml三种格式,其中pyproject.toml是Python项目常用的统一配置文件,推荐优先使用。所有规则忽略相关的配置都需要在配置文件的对应段落中定义。

指定目录忽略特定规则的实现方式

要实现在指定目录中忽略特定规则,核心是使用Ruff配置中的per-file-ignores字段,该字段可以针对不同的文件路径匹配模式,设置对应的忽略规则列表。

配置语法说明

per-file-ignores的键值对格式为:文件路径匹配模式 = 要忽略的规则ID列表,多个规则之间用英文逗号分隔。路径匹配支持glob通配符,比如tests/*可以匹配tests目录下的所有文件,legacy/**可以匹配legacy目录及其所有子目录下的文件。

具体配置示例

假设我们的项目结构如下,需要在tests目录忽略PLR0913(函数参数过多)和PLR0915(函数过长)规则,在legacy目录忽略E501(行过长)规则:

# ruff.toml 配置示例
# 全局忽略的规则,所有文件都会生效
ignore = []

# 针对指定目录忽略特定规则
[per-file-ignores]
# 匹配tests目录下的所有文件,忽略对应规则
"tests/*" = ["PLR0913", "PLR0915"]
# 匹配legacy目录及其所有子目录下的文件,忽略对应规则
"legacy/**" = ["E501"]

如果使用pyproject.toml作为配置文件,写法如下:

# pyproject.toml 配置示例
[tool.ruff]
# 全局忽略的规则
ignore = []

[tool.ruff.per-file-ignores]
"tests/*" = ["PLR0913", "PLR0915"]
"legacy/**" = ["E501"]

配置验证方法

配置完成后,可以通过以下方式验证配置是否生效:

  • 在对应目录下创建包含违反目标规则的测试文件,执行ruff check 目录路径命令,查看是否没有报出对应的规则错误
  • 执行ruff check --show-settings命令,查看输出的配置信息中per-file-ignores字段是否和我们的配置一致

比如我们在tests目录下创建一个包含过多参数的函数,执行检查命令:

# tests/test_demo.py
# 该函数有6个参数,违反PLR0913规则,但配置后应该不会被Ruff报出
def demo_func(a, b, c, d, e, f):
    pass

执行ruff check tests/test_demo.py,如果没有输出PLR0913相关的错误提示,说明配置生效。

注意事项

需要注意per-file-ignores的路径匹配是相对于配置文件的路径,如果配置文件在项目根目录,那么路径直接写目录名即可。另外规则ID需要填写Ruff官方定义的完整规则ID,比如E501而不是E501_,可以通过ruff rule 规则ID命令查看规则的详细信息,确认ID是否正确。

RuffPython代码检查规则忽略指定目录修改时间:2026-07-19 13:54:20

免责声明:​ 已尽一切努力确保本网站所含信息的准确性。网站内容多为原创整理与精心编撰,观点力求客观中立。本站旨在免费分享,内容仅供个人学习、研究或参考使用。若引用了第三方作品,版权归原作者所有。如内容涉及您的权益,请联系我们处理。
内容垂直聚焦
专注技术核心技术栏目,确保每篇文章深度聚焦于实用技能。从代码技巧到架构设计,为用户提供无干扰的纯技术知识沉淀,精准满足专业提升需求。
知识结构清晰
覆盖从开发到部署的全链路。AI、前端、编程、数据库、服务器、建站、系统层层递进,构建清晰学习路径,帮助用户系统化掌握开发与运维所需的核心技术。
深度技术解析
拒绝泛泛而谈,深入技术细节与实践难点。无论是数据库优化还是服务器配置,均结合真实场景与代码示例进行剖析,致力于提供可直接应用于工作的解决方案。
专业领域覆盖
精准对应开发生命周期。从前端界面到后端编程,从数据库操作到服务器运维,形成完整闭环,一站式满足全栈工程师和运维人员的技术需求。
即学即用高效
内容强调实操性,步骤清晰、代码完整。用户可根据教程直接复现和应用于自身项目,显著缩短从学习到实践的距离,快速解决开发中的具体问题。
持续更新保障
专注既定技术方向进行长期、稳定的内容输出。确保各栏目技术文章持续更新迭代,紧跟主流技术发展趋势,为用户提供经久不衰的学习价值。