英文原文:https://code.visualstudio.com/docs/python/formatting
格式化使源代码更容易被人类阅读。通过强制执行特定的规则和约定(例如行间距、缩进和运算符周围的间距),代码变得更加直观且易于理解。您可以在 autopep8 页面上查看示例。请记住,格式设置不会影响代码本身的功能。
Linting 通过分析代码中常见的语法、风格和功能错误以及非常规编程实践来帮助防止错误。尽管格式化和 linting 之间有一点重叠,但这两种功能是互补的。
Python 扩展支持通过格式化程序扩展(例如 autopep8 和 Black Formatter)对源代码进行格式化。
设置默认格式化程序
安装格式化程序扩展后,您可以按照以下步骤选择它作为 VS Code 中 Python 文件的默认格式化程序:
- 在 VS Code 中打开 Python 文件。
- 右键单击编辑器以显示上下文菜单。
- 选择Format Document With…
- 从下拉菜单中选择Configure Default Formatter…。
- 从列表中选择您喜欢的格式化程序扩展。
或者,您可以通过在 [python] 范围下的 User settings.json 文件中设置“editor.defaultFormatter”,将其设置为所有 Python 文件的默认格式化程序。您可以使用首选项:打开用户设置 (JSON) 命令打开 settings.json。
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter"
}
格式化您的代码
您可以通过右键单击编辑器并选择“格式化文档”或使用 Shift+Alt+F 键盘快捷键来格式化代码。
您还可以将以下设置添加到您的 User settings.json 文件中,以便在保存代码时启用格式设置:
"[python]": {
"editor.formatOnSave": true
}
常规格式设置
每个格式化程序扩展可能有自己的设置,但 autopep8 和 Black Formatter 都支持以下设置:
设置后缀 | 默认值 | 描述 |
---|---|---|
args | [ ] | 要传递给格式化程序的参数。每个参数都应作为数组中的单独字符串传递。例如:black-formatter.args: [“–line-length”, “100”] |
importStrategy | useBundled | 当设置为 useBundled 时,扩展使用其附带的工具版本。当设置为 fromEnvironment 时,它会首先尝试从您选择的 Python 环境加载,否则它将回退到捆绑版本。 |
path | “” | 用于格式化的格式化程序二进制文件的路径。注意:使用此选项可能会减慢格式化速度。 |
interpreter | [ ] | 当设置为 Python 可执行文件的路径时,扩展将使用它来启动格式化程序服务器及其子进程。 |
showNotifications | off | 控制此扩展程序何时显示通知。支持的值包括 off、always、onError 和 onWarning |