跳转到内容

isort 格式化

1. 工具定位:专注清理 Import 区块

Section titled “1. 工具定位:专注清理 Import 区块”

isort 是一个用于自动化分类、排序以及格式化 Python 源码文件头部 import 导入块的独立工具。 它通常与 Black 代码格式化器、Flake8 静态检查器一起被视为 Python 现代工程化的“质量三剑客”。

(安装依赖:pip install isort)


isort 的默认行为会将毫无章法的代码引入,根据来源自动重新编排为整齐的几个独立区块:

  1. Python 标准库 (如 os, sys)
  2. 第三方依赖库 (如 django, requests)
  3. 本地第一方包/项目模块
  4. 本地相对路径导入 (from . import module)

终端原位格式化指令

Terminal window
# 扫描指定文件或整个目录,并直接重写保存
isort {source_file_or_directory}

为了达成“开发时无感,保存时自动排序”的极致体验,建议通过配置外部工具 (External Tools) 来接入 IDE。

可完全参考本知识库中关于 Black 的集成方法(参考 Black 挂载教程):

  • Program 指向虚拟环境中的 isort 可执行路径。
  • Arguments 配置为 $FilePath$
  • 搭配宏或者快捷键绑定,实现一次按键同时触发 isort + Black