如何阻止 Ruff 将函数参数格式化为多行?

浅芳吖_1444

浅芳吖_1444

2026-11-11

844人浏览

原创

如何阻止 Ruff 将函数参数格式化为多行?

Ruff 默认会因尾部逗号(magic trailing comma)将函数参数自动换行;通过启用 format.skip-magic-trailing-comma = true 并同步禁用 isort 的 split-on-trailing-comma,即可保留单行函数签名。

ruff 默认会因尾部逗号(magic trailing comma)将函数参数自动换行;通过启用 `format.skip-magic-trailing-comma = true` 并同步禁用 isort 的 `split-on-trailing-comma`,即可保留单行函数签名。

Ruff 的格式化器(ruff format)遵循 PEP 8 风格指南中关于“可读性优先”的原则,当函数签名末尾存在逗号(如 c: int,)时,它会触发“魔法尾部逗号”(magic trailing comma)机制,强制将参数展开为多行结构——这是有意设计的行为,旨在提升长参数列表的可维护性。

但若你偏好紧凑风格(例如团队规范或代码审查要求),可通过配置全局禁用该行为。关键在于两个协同设置:

✅ 第一步:禁用格式化器的魔法尾部逗号逻辑
在 pyproject.toml 中启用 skip-magic-trailing-comma:

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

⚠️ 注意:仅设置此项会导致与 isort(Ruff 内置的导入排序模块)冲突,触发如下警告:

warning: The isort option 'isort.split-on-trailing-comma' is incompatible with the formatter 'format.skip-magic-trailing-comma=true'...

这是因为 isort 默认也依赖尾部逗号判断是否拆分导入语句,二者语义冲突。

✅ 第二步:同步关闭 isort 的尾部逗号拆分行为
添加以下配置,确保导入语句也不因尾部逗号被拆分:

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

完整推荐配置片段如下:

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

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

配置生效后,运行 ruff format myfile.py,原函数:

def get_foo(a: object, b: tuple, c: int,) -> dict:
    return {"result": a}

将保持单行格式(尾部逗号仍被保留,但不再触发换行):

def get_foo(a: object, b: tuple, c: int,) -> dict:
    return {"result": a}

? 额外提示:

  • 此配置不影响其他格式化规则(如缩进、空格、换行等),仅约束“是否因尾部逗号强制换行”;
  • 若你使用 .ruff.toml 而非 pyproject.toml,配置路径完全一致;
  • 修改配置后建议运行 ruff check --fix + ruff format 双重清理,确保 lint 与 format 行为一致。

通过这一组合配置,你既能维持代码简洁性,又能避免工具链内部警告,实现可预测、可控的格式化体验。

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

5304

7

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

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

2023.07.31

1849

3

python教程
python教程

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

2023.08.03

32037

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万人学习