如何在 Ruff 格式化中保留多行链式调用与函数调用的换行结构

梦明大大_8766

梦明大大_8766

2026-10-20

160人浏览

原创

如何在 Ruff 格式化中保留多行链式调用与函数调用的换行结构

Ruff 当前不支持全局禁用换行重排,但可通过 # fmt: skip 注释精准跳过特定表达式的格式化,从而保留可读性强的多行链式调用或参数列表。

ruff 当前不支持全局禁用换行重排,但可通过 # fmt: skip 注释精准跳过特定表达式的格式化,从而保留可读性强的多行链式调用或参数列表。

Ruff 的格式化器(ruff format)以简洁、一致为设计目标,因此默认会将符合长度限制的多行链式调用(如 .str.strip().str.replace(...))或带换行的函数调用(如 pd.melt(df, id_vars=[...]))自动折叠为单行。虽然这提升了代码的紧凑性,但在处理复杂数据转换逻辑时,多行结构能显著提升可维护性与可读性——尤其是涉及 pandas 链式操作或嵌套字典/参数时。

遗憾的是,截至当前最新稳定版本(v0.7+),Ruff 并未提供类似 --preserve-linebreaks 或配置项来全局禁用换行优化。官方 GitHub 仓库中已明确确认该功能暂未实现(参见 issue #8598)。skip-magic-trailing-comma 等选项仅影响逗号行为,无法阻止换行折叠。

不过,存在一个轻量、精准且被社区验证有效的替代方案:在需要保留格式的表达式末尾添加 # fmt: skip 注释。该指令作用于其所在行的整个语句(包括跨多行的表达式),Ruff 将完全跳过对该语句的格式化,同时不影响其余代码。

以下为实际应用示例:

ColaOS
ColaOS

一款AI工具,主要用于首个有灵魂的智能体操作系统,适合需要提升相关任务效率的用户。

下载
import pandas as pd

df = pd.DataFrame(
    {
        "A": [" a: yu", "b: stuff  ", "c: more_stuff"],
        "B": [4, 5, 6],
        "C": [7, 8, 9],
    }
)

# ✅ 多行链式调用保持原样
df["A"] = (
    df["A"]
    .str.strip()
    .str.replace(":", "")
    .str[0]
)  # fmt: skip

# ✅ 多行函数调用不受干扰
new_df = pd.melt(
    df,
    id_vars=["A"]
)  # fmt: skip

print(new_df)

⚠️ 注意事项:

  • # fmt: skip 必须写在语句的最后一行末尾(即闭合括号 ) 或 ] 所在行),不可放在中间或单独成行;
  • 它作用于整个语句,而非某一行,因此适用于 if、for、赋值、函数调用等多种复合结构;
  • 相比 # fmt: off/on 块注释,# fmt: skip 更细粒度、无侵入性,避免大段代码脱离格式管控;
  • 若项目中此类语句较多,建议结合编辑器插件(如 VS Code 的 Ruff 扩展)快速插入注释,提升效率。

总结而言,虽然 Ruff 尚未提供“禁止触碰换行”的全局开关,但 # fmt: skip 是目前最务实、可控且低维护成本的解决方案。它在坚守自动化格式化原则的同时,为开发者保留了对关键可读性结构的手动干预权——真正的工程平衡之道,不在于全有或全无,而在于精准留白。

相关专题

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

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

2023.07.20

1771

4

python能做什么
python能做什么

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

2023.07.25

4584

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

27097

23

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

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

2023.08.04

3287

5

python eval
python eval

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

2023.08.04

3287

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2543

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
php-src源码分析探索
php-src源码分析探索

共6课时 | 0.7万人学习