VSCode的isort插件:自动整理Python的import语句

17次阅读

isort可自动整理python导入语句。方法包括:一、设为vscode默认格式化工具;二、命令面板手动运行;三、配置.isort.cfg自定义规则;四、绑定快捷键;五、集成pre-commit钩子。

VSCode的isort插件:自动整理Python的import语句

如果您在使用 VSCode 编辑 Python 文件时发现 import 语句顺序混乱、重复或格式不统一,则可能是由于缺少有效的导入管理工具。isort 插件可自动对 import 语句进行分组、排序与格式化,使其符合 PEP 8 及团队约定规范。以下是实现自动整理 import 语句的多种方法:

本文运行环境:macBook air,macOS Sequoia。

一、启用 isort 作为 VSCode 默认 Python 格式化工具

此方法通过配置 VSCode 的 Python 扩展,使保存文件时自动调用 isort 处理 import 语句,无需手动触发命令。

1、打开 VSCode 设置(快捷键 Cmd + ,)。

立即学习Python免费学习笔记(深入)”;

2、在搜索框中输入 python.formatting.provider,将值设为 isort

3、继续搜索 editor.formatOnSave,确保其值为 true

4、确认已安装 Python 扩展与 isort 命令行工具:在终端执行 pip install isort

二、通过命令面板手动运行 isort

此方法适用于临时整理单个文件,或在未启用自动格式化时快速修正 import 结构。

1、在 VSCode 中打开目标 Python 文件。

2、按下 Cmd + Shift + P 打开命令面板。

3、输入并选择 Python: Sort Imports

4、操作完成后,import 区域将按标准顺序重排,包括标准库、第三方库、本地库三段式分隔。

三、配置 isort 配置文件实现自定义规则

此方法允许您定义导入分组逻辑、换行策略、引号风格等细节,使 isort 行为与项目规范严格一致。

1、在项目根目录创建 .isort.cfg 文件。

2、写入如下内容(示例):

[settings]

multi_line_output=3

include_trailing_comma=true

force_grid_wrap=0

use_parentheses=true

3、重启 VSCode 或重新加载窗口以使配置生效。

四、绑定快捷键一键触发 isort

此方法提升操作效率,避免反复调用命令面板,适合高频整理场景。

1、打开 VSCode 快捷键设置(Cmd + K,然后 Cmd + S)。

2、点击右上角“打开键盘快捷方式(jsON)”图标。

3、在数组中添加以下对象

{ “key”: “cmd+alt+i”, “command”: “python.sortImports”, “when”: “editorTextFocus && editorLangId == ‘python'” }

4、保存文件后,在 Python 文件中按下 Cmd + Alt + I 即可立即整理 import。

五、集成 isort 到 pre-commit 钩子实现提交前自动校验

此方法确保所有提交到代码仓库的 Python 文件均经过 isort 处理,从流程层面保障导入一致性。

1、在项目根目录执行 pip install pre-commit

2、创建 .pre-commit-config.yaml 文件,并填入:

repos:

– repo: https://github.com/pycqa/isort

rev: 5.12.0

hooks:

– id: isort

3、运行 pre-commit install 启用钩子。

text=ZqhQzanResources