如何禁用 Ruff 格式化器对函数参数的自动换行(保留单行声明)

浅宇吖_9331

浅宇吖_9331

2026-11-11

513人浏览

原创

如何禁用 Ruff 格式化器对函数参数的自动换行(保留单行声明)

Ruff 默认会将带尾随逗号的函数参数强制格式化为多行,可通过配置 skip-magic-trailing-comma = true 禁用该行为;同时需同步关闭 isort 的 split-on-trailing-comma 以避免配置冲突。

ruff 默认会将带尾随逗号的函数参数强制格式化为多行,可通过配置 `skip-magic-trailing-comma = true` 禁用该行为;同时需同步关闭 isort 的 `split-on-trailing-comma` 以避免配置冲突。

Ruff 的格式化器(ruff format)遵循“魔法尾随逗号”(magic trailing comma)规则:当函数参数列表末尾存在逗号时,它会主动将参数展开为多行格式,以提升可读性与版本控制友好性。虽然这是有意设计的行为,但在某些团队规范或遗留代码风格中,你可能希望保持单行函数签名(如 def get_foo(a: object, b: tuple, c: int,) -> dict: 不被拆分)。

要彻底禁用此行为,请在项目根目录的 pyproject.toml 中添加以下配置:

[tool.ruff.format]
skip-magic-trailing-comma = true

[tool.ruff.lint.isort]
split-on-trailing-comma = false

✅ 第一行 skip-magic-trailing-comma = true 告诉 Ruff 忽略尾随逗号对格式化的触发作用,从而保留原始单行结构(只要未超出 line-length 限制)。
⚠️ 第二行是必需的协同配置:因为 Ruff 内置的 isort 模块默认启用 split-on-trailing-comma = true,若不显式设为 false,将与 format.skip-magic-trailing-comma 产生逻辑冲突,导致运行时警告(如你遇到的 incompatible with the formatter 提示)。

? 小提示:该配置仅影响格式化(ruff format),不影响 lint 检查。若你还希望禁止 lint 阶段对尾随逗号的风格建议(例如 COM812),可额外添加:

[tool.ruff.lint.rules]
# 禁用 "trailing comma on function call" 相关警告(可选)
ignore = ["COM812"]

完成配置后,重新运行 ruff format myfile.py,你的函数定义将不再被自动拆分为多行,原始紧凑风格得以保留,同时消除警告,确保 CI/CD 和本地开发环境行为一致。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1911

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5284

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1849

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

32017

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3787

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3807

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1263

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2943

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.3万人学习