杰瑞科技汇

Sublime如何一键格式化Python代码?

使用 Sublime Text 内置的格式化工具 (简单但功能有限)

Sublime Text 自带一个基础的代码格式化工具,它可以进行简单的缩进和空格调整。

Sublime如何一键格式化Python代码?-图1
(图片来源网络,侵删)

优点:

  • 无需安装任何插件。
  • 速度快。

缺点:

  • 功能非常基础,无法进行深度重构(无法将 if a: b 拆分为多行)。
  • 风格选项少,通常只能处理缩进。

操作步骤:

  1. 选中代码:用鼠标选中你想要格式化的 Python 代码,如果只想格式化整个文件,可以按 Ctrl+A (Windows/Linux) 或 Cmd+A (Mac) 全选。

  2. 打开命令面板

    Sublime如何一键格式化Python代码?-图2
    (图片来源网络,侵删)
    • Ctrl+Shift+P (Windows/Linux) 或 Cmd+Shift+P (Mac)。
  3. 执行格式化命令

    • 在命令面板中输入 Indentation: Reindent Lines 并回车。
    • 或者,使用快捷键 Ctrl+] (Windows/Linux) 或 Cmd+] (Mac) 来增加缩进,Ctrl+[ (Windows/Linux) 或 Cmd+[ (Mac) 来减少缩进,全选后使用这些快捷键可以达到类似效果。

这个方法只适合处理简单的缩进问题,对于日常 Python 开发来说远远不够。


安装并使用 Python Prettier 插件 (强烈推荐)

这是目前 Sublime Text 中格式化 Python 代码的最佳实践,它通过调用一个强大的外部工具 Prettier 来完成格式化,Prettier 可以智能地处理代码布局、换行、引号等几乎所有格式问题。

Prettier 本身是为 JavaScript 设计的,但通过一个叫做 prettier-plugin-python 的插件,它完美地支持了 Python。

Sublime如何一键格式化Python代码?-图3
(图片来源网络,侵删)

详细步骤:

第 1 步:安装 Package Control

如果你是第一次使用 Sublime Text,或者没有安装过 Package Control,请先安装它,Package Control 是 Sublime Text 的包管理器,可以方便地安装各种插件。

  1. 访问官网:https://packagecontrol.io/installation
  2. 网站会自动检测你的操作系统和 Sublime Text 版本,并生成一段 Python 代码。
  3. 打开 Sublime Text,通过菜单 View > Show Console 或快捷键 `Ctrl+`` (反引号) 打开控制台。
  4. 将网站上生成的代码复制并粘贴到控制台中,然后按回车。
  5. 重启 Sublime Text,Package Control 就安装好了。

第 2 步:安装 Prettier 和相关插件

  1. Ctrl+Shift+P (Windows/Linux) 或 Cmd+Shift+P (Mac) 打开命令面板。

  2. 输入 Package Control: Install Package 并回车。

  3. 等待加载完成后,在新的输入框中搜索并安装以下 两个 插件:

    • Prettier: 这是 Prettier 的核心插件,负责调用 Prettier 程序。
    • Python Prettier: 这是一个桥梁插件,它告诉 Prettier 插件如何去处理 .py 文件,并确保 prettier-plugin-python 被正确调用。

    重要提示:必须同时安装 PrettierPython Prettier,只安装 Prettier 是无法格式化 Python 代码的。

第 3 步:安装 Prettier 的 Python 支持库

这一步是真正让 Prettier 支持 Python 的关键。

  1. 打开你的系统终端(Windows 的 CMD 或 PowerShell,Mac/Linux 的 Terminal)。
  2. 执行以下命令来安装 Prettier 的 Python 插件:
    npm install -g prettier-plugin-python
    • 如果你没有安装 Node.js 和 npm,需要先安装它们,Prettier 是一个 Node.js 包。
    • -g 参数表示全局安装,这样 Sublime Text 的 Prettier 插件就能找到它。

第 4 步:配置 Sublime Text 和 Prettier (可选但推荐)

为了让 Prettier 更好地工作,建议创建一个配置文件。

  1. 在你的项目根目录下创建一个名为 .prettierrc 的文件。

  2. 在这个文件中,你可以定义你喜欢的代码风格。

    {
      "parser": "python",
      "printWidth": 88,
      "tabWidth": 4,
      "useTabs": false,
      "singleQuote": false,
      "trailingComma": "none"
    }
    • printWidth: 一行代码的最大长度,超过后会自动换行。
    • tabWidth: 一个缩进等于多少个空格。
    • useTabs: true 表示使用 Tab 键缩进,false 表示使用空格,Python 社区普遍推荐使用空格。
    • singleQuote: true 使用单引号,false 使用双引号,Python 社区普遍推荐使用双引号。

第 5 步:使用 Prettier 格式化代码

现在一切都配置好了!你可以通过以下几种方式格式化 Python 代码:

  • 方法 A (推荐):使用快捷键

    • 默认快捷键是 Ctrl+Shift+H (Windows/Linux) 或 Cmd+Shift+H (Mac),选中代码后按此快捷键,只会格式化选中的部分,不选中任何代码则会格式化整个文件。
  • 方法 B:使用右键菜单

    • 选中代码后,点击右键,选择 Prettier: Format Code
  • 方法 C:使用命令面板

    • Ctrl+Shift+P,输入 Prettier: Format Code 并回车。

总结与对比

特性 方法一 (内置工具) 方法二 (Prettier 插件)
功能 基础,仅缩进 强大,智能换行、引号、括号等
安装 无需安装 需要安装 Package Control 和 3 个包
配置 可通过 .prettierrc 高度自定义
智能程度 ,能理解代码结构,自动优化布局
推荐度 ⭐ (仅作应急) ⭐⭐⭐⭐⭐ (强烈推荐)

最终建议: 花 10 分钟按照 方法二 的步骤配置好 Prettier,它会极大地提升你的 Python 开发体验,让你的代码始终保持整洁、规范,并且符合 PEP 8 等主流风格指南。

分享:
扫描分享到社交APP
上一篇
下一篇