VSCode | 设置保存时自动格式化 Python 文件

文章目录

• • [Step1：安装 Black Formatter 扩展](#Step1：安装 Black Formatter 扩展)
  • [Step2：配置 Black Formatter 扩展](#Step2：配置 Black Formatter 扩展)
  • [Step3：使用 Black Formatter 扩展](#Step3：使用 Black Formatter 扩展)
  • • 手动格式化
    • 保存时自动格式化

---

• 官方指南： https://vscode.js.cn/docs/python/formatting

• Cursor 好像还不支持？

Step1：安装 Black Formatter 扩展

输入 Black Formatter 以进行搜索，安装如下图所示的扩展 (安装 Version 2024.6.0) ：

处理报错：

命令 "使用...格式化文档" 导致错误

TypeError: 'type' object is not subscriptable

参考：VSCode 代码格式化插件 Black 失效问题

Step2：配置 Black Formatter 扩展

先随便打开一个 .py 文件，所有操作都需在该页面中进行 (关键)

再使用快捷键 Ctrl+Shift+P 打开命令面板，并选择 使用...格式化文档，如下图所示：

选择 配置默认格式化程序...，如下图所示：

最后再选择 Black Formatter。

Step3：使用 Black Formatter 扩展

手动格式化

如下图所示，在 .py 文件中右键单击，选择 格式化文档 即可：

保存时自动格式化

如下图所示，打开 "设置"，点击右上角图标即可打开 settings.json 文件：

在 settings.json 文件中添加如下配置即可：

"[python]": {
    "editor.formatOnSave": true
}

此后 Ctrl+S 保存文件时即可自动格式化 .py 文件。

---

END