isort 项目使用教程

isort 项目使用教程

isort A Python utility / library to sort imports. 项目地址: https://gitcode.com/gh_mirrors/is/isort

1. 项目介绍

isort 是一个用于自动排序 Python 导入语句的实用工具和库。它能够将导入语句按字母顺序排列，并自动将它们分组和分类。isort 提供了命令行工具、Python 库以及多种编辑器插件，帮助开发者快速整理代码中的导入语句。

isort 支持 Python 3.8+，并且可以格式化 Python 2 代码。它还提供了与 black 等代码格式化工具的兼容性。

2. 项目快速启动

安装 isort

你可以通过 pip 快速安装 isort：

pip install isort

使用 isort

从命令行使用

1. 对单个文件进行排序：

   isort mypythonfile.py
   

2. 递归应用到所有 Python 文件：

   isort .
   

3. 查看更改而不应用：

   isort mypythonfile.py --diff
   

4. 原子运行（仅在无语法错误时应用更改）：

   isort --atomic .
   

在 Python 代码中使用

你也可以在 Python 代码中直接使用 isort：

import isort

# 对指定文件进行排序
isort.file("mypythonfile.py")

# 对代码字符串进行排序
sorted_code = isort.code("import b\nimport a\n")

3. 应用案例和最佳实践

案例1：自动整理项目中的导入语句

在一个大型项目中，手动整理导入语句是一项繁琐的工作。使用 isort 可以自动化这一过程，确保所有导入语句都按规范排列。

isort .

案例2：与 black 结合使用

isort 可以与 black 结合使用，以确保代码格式的一致性。你可以在项目根目录下创建一个 .pre-commit-config.yaml 文件，配置 pre-commit 钩子来自动运行这两个工具。

repos:
  - repo: https://github.com/psf/black
    rev: 22.3.0
    hooks:
      - id: black
  - repo: https://github.com/PyCQA/isort
    rev: 5.10.1
    hooks:
      - id: isort

最佳实践：使用配置文件

为了确保团队成员使用相同的配置，建议在项目根目录下创建一个 .isort.cfg 文件，定义 isort 的行为。

[settings]
profile = black
multi_line_output = 3
include_trailing_comma = True

4. 典型生态项目

pre-commit

pre-commit 是一个用于管理和维护 Git 钩子的框架。通过配置 pre-commit，你可以在每次提交代码时自动运行 isort，确保代码格式的一致性。

black

black 是一个 Python 代码格式化工具，与 isort 结合使用可以确保代码风格的一致性。isort 提供了与 black 的兼容性配置，使得两者可以无缝协作。

flake8

flake8 是一个用于检查 Python 代码风格和语法的工具。通过配置 flake8，你可以在代码检查过程中同时运行 isort，确保导入语句的正确排序。

通过这些工具的结合使用，你可以构建一个强大的代码质量保障体系，确保项目代码的整洁和一致性。

isort A Python utility / library to sort imports. 项目地址: https://gitcode.com/gh_mirrors/is/isort