GitHub Store
PyCQA

isort

PyCQA

isort 是 Python import 语句排序工具，按字母序自动整理并分组 import，可通过命令行、库调用或编辑器插件使用。

10.0.0b1
发布于
10 天前
6,962
星标
1,240
下载
同步于
8 天前

最新版本

10.0.0b12026年10月19日 03:20测试版
下载慢？可在上方随时切换镜像源

项目说明

项目概述

isort 是一个用于整理 Python import 语句的工具，按字母序自动排序，并按标准库、第三方库、本地库等类型自动分节。它提供命令行工具、Python 库调用以及多种编辑器插件三种使用方式，让项目里的 import 始终整洁有序。isort 需 Python 3.11 以上运行，同时支持格式化 Python 2 代码。

项目 内容
语言 Python
运行要求 Python 3.11+
使用方式 命令行、Python 库、编辑器插件
许可 MIT

把 import 排序这种杂事彻底交给工具。

主要功能

  • 自动排序：按字母序整理 import 语句
  • 分组分节：自动按来源类型将 import 划分为多个区块
  • 差异预览：--diff 先查看将做的修改再决定是否应用
  • 原子模式：--atomic 仅在不会引入语法错误时应用修改
  • 库调用：可在 Python 代码中通过 isort 提供的接口调用
  • 校验模式：--check-only 用于 CI 中校验 import 是否合规
  • 精细配置：支持多行输出模式、缩进、自定义分组等丰富配置
  • 局部跳过：通过 isort:skip 注释跳过指定 import 或整个文件

适用人群

  • Python 开发者
  • 开源项目维护者
  • 代码规范执行者
  • CI 流水线维护者
  • 使用 Black 的团队

快速上手

  1. 安装 isort
pip install isort
  1. 对指定文件排序
isort mypythonfile.py mypythonfile2.py
  1. 递归处理整个项目
isort .
  1. 在 CI 中只校验不修改
isort . --check-only

核心优势

  • 即装即用：默认配置即可满足大多数项目
  • 与 Black 协作：提供与 Black 兼容的配置指南
  • 支持 pre-commit：官方支持 pre-commit 钩子集成
  • 配置精细：几乎所有排序细节都可自定义

系统要求

项目 要求
操作系统 Linux、macOS、Windows
语言环境 Python 3.11 及以上
目标代码 同时支持格式化 Python 2 代码

注意事项

  • 版本要求：运行 isort 需要 Python 3.11 及以上版本
  • 多行模式：multi_line_output 提供 12 种换行样式，按团队规范选择
  • 原子模式默认关闭：--atomic 默认不启用，避免跨 Python 版本误判

历史版本

排序