Command Palette

Search for a command to run...

Python

Python 格式化器

调整 Python 的缩进、换行和空白。

格式选项
选择缩进、换行长度和空白清理方式。

可选 2/4/8 空格或 Tab 缩进。

为可读性折行,可使用预设或自定义长度。

清理不一致的前导空白并保持块结构。

自动为 else/except 等块调整缩进并在冒号后增加缩进。

在格式化前去除每行末尾的空格。

将连续空行压缩到设定的最大值。

最大连续

折行时优先在逗号或括号位置断开。

在括号/方括号内换行时额外缩进。

在运算符两侧添加一致的空格。

输入代码
粘贴或输入 Python 代码以重新整理缩进、空白和换行。
保留 docstring、注释和多行字符串。
格式化结果
查看并复制整理后的 Python 代码。
使用“全选”或“复制”把结果放入编辑器。

What

Python 格式化器 定义

Python 格式化器会统一缩进和空格,让代码更易读。

Cases

常见使用场景

1

分享前美化脚本

2

统一代码片段风格

3

更快阅读凌乱代码

How To

如何格式化 Python 代码

整理缩进、换行与空白的分步指南。

1

粘贴代码

粘贴要格式化的 Python 代码。

2

选择选项

选择缩进与换行等选项。

3

格式化并复制

执行格式化并复制结果。

Knowledge

了解 Python 代码风格

什么是 PEP 8?
PEP 8 是 Python 的官方风格指南。它建议使用 4 空格缩进、79 字符行宽限制以及特定的命名规范。遵循 PEP 8 可以使 Python 代码更具可读性,并在不同项目间保持一致。
Python 缩进
Python 使用缩进来定义代码块(不同于其他语言中的大括号)。混用空格和制表符会导致错误。PEP 8 建议每个缩进级别使用 4 个空格。大多数编辑器都可以配置为强制执行此规则。
命名规范
Python 使用:函数和变量用 snake_case,类用 PascalCase,常量用 UPPERCASE。私有属性以下划线开头 (_private)。名称修饰属性使用双下划线 (__private)。
Python 格式化工具
流行的工具包括:Black(强制风格、确定性)、autopep8(符合 PEP 8)、YAPF(可配置风格)和 isort(进口排序)。许多项目因 Black 的“唯一种方式”哲学而选择它。
Docstrings
Python 使用三引号字符串进行文档标注。Docstrings 描述模块、类和函数。流行的格式包括 Google 风格、NumPy 风格和 Sphinx/reStructuredText。Sphinx 等工具可以从 docstrings 生成文档。

FAQ

Python 格式化 FAQ

支持哪些缩进?
支持 Tab 或 2/4/8 空格,可在开启时自动调整 else/except 等块。
docstring 或多行字符串会改变吗?
三引号字符串会被保留,结束后恢复格式化。
折行策略是什么?
长行会在逗号或空格处按设定宽度折行,并为续行添加缩进。
可以保留多余空行吗?
开启“限制空行”并设置允许的连续数量即可控制空行。
Python 的背景是什么?
Python 由 Guido van Rossum 于 1991 年创建,因可读性和内置库丰富而至今仍是最流行的语言之一。
现在 Python 的流行度如何?
受数据科学、后端和自动化生态推动,Python 常年位于 TIOBE 和 Stack Overflow 等榜单前列。
Python 格式化在哪些场景最有用?
代码审查、CI 格式化步骤、新手教学,以及整理脚本或笔记本用于发布时,都能从一致的格式中受益。
维护 Python 代码风格的建议?
遵循 PEP 8 默认值,保持缩进一致,并在 CI 中运行格式化工具,让编辑器与流水线保持一致。
Python 格式化器