Repolode
asottile

asottile/add-trailing-comma

一个 Python 工具和 pre-commit 钩子,可自动为多行调用、字面量和定义补全末尾逗号。

Star
373
Fork
28
未关闭 Issue
0
最近提交
3天前

这是什么?

add-trailing-comma 会自动改写 Python 源文件,为多行函数调用、元组、列表、字典和集合字面量、函数与类定义、from 导入、with 语句以及 match 分支补上末尾逗号。安装后既可以作为命令行工具单独运行,也可以在项目的 pre-commit 配置中作为钩子使用。

工具还会把括号统一成一种格式:左括号保留在行尾,每个参数比函数名多缩进一级,右括号独占一行开头。对于单行字面量,它会去掉多余的逗号。这样增删一个参数只会改动一行,版本控制中的 diff 更小,git blame 也更清晰。

项目支持 PEP 695 类型参数语法和 match 语句。

核心功能

  • 01为函数调用、字面量、函数与类定义以及导入语句自动补全末尾逗号。
  • 02支持 with 语句、match 分支和 PEP 695 类型参数。
  • 03将括号统一为每个参数独占一行的格式。
  • 04删除单行字面量中多余的末尾逗号。
  • 05可作为 pre-commit 钩子使用,也可通过 pip 安装为独立命令。

适用场景

  • 在 Python 项目中统一多行代码的格式风格。
  • 在长函数调用中增删参数时,保持版本控制 diff 最小化。
  • 在 pre-commit 工作流中自动执行格式检查和修复。

快速上手

  1. 1

    使用 pip 安装该工具

    pip install add-trailing-comma
  2. 2

    可选:在 .pre-commit-config.yaml 中将其添加为 pre-commit 钩子

收录于专题

标签

常见问题

add-trailing-comma 是什么?
一个 Python 工具和 pre-commit 钩子,可自动为多行调用、字面量和定义补全末尾逗号。 add-trailing-comma 会自动改写 Python 源文件,为多行函数调用、元组、列表、字典和集合字面量、函数与类定义、from 导入、with 语句以及 match 分支补上末尾逗号。安装后既可以作为命令行工具单独运行,也可以在项目的 pre-commit 配置中作为钩子使用。
add-trailing-comma 可以免费使用吗?用的什么许可证?
add-trailing-comma 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
add-trailing-comma 还在维护吗?
活跃维护中。add-trailing-comma 最近一次提交是在 2026年11月4日。
add-trailing-comma 适合用来做什么?
在 Python 项目中统一多行代码的格式风格。 在长函数调用中增删参数时,保持版本控制 diff 最小化。 在 pre-commit 工作流中自动执行格式检查和修复。
add-trailing-comma 怎么安装和运行?
使用 pip 安装该工具: pip install add-trailing-comma 可选:在 .pre-commit-config.yaml 中将其添加为 pre-commit 钩子
在哪里获取 add-trailing-comma?
源代码和安装说明在 GitHub 上:https://github.com/asottile/add-trailing-comma

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目