怎么在isort Python 代码中的导入语句进行排序和格式化

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS MySQL,集群版 2核4GB 100GB
推荐场景:
搭建个人博客
云原生数据库 PolarDB PostgreSQL 版,企业版 4核16GB
推荐场景:
HTAP混合负载
简介: `isort` 是一个Python工具,用于自动排序和格式化代码中的导入语句,提高代码整洁度和可读性。它支持自动排序、保留空白和注释、自定义排序规则、与多种编辑器集成以及命令行使用。安装`isort`可通过`pip install isort`,使用时可直接在Python代码中导入或通过命令行处理文件。示例展示了如何在代码中使用`isort`进行导入排序,包括基本排序、自定义设置和处理多个文件。`isort`适用于标准库、第三方库和自定义模块的导入排序,还可忽略特定导入,并能与IDE和编辑器插件集成,提升开发效率。

isort 是什么

isort,全称是 "Import Sorting",是一个 Python 工具,用来对 Python 代码中的导入语句进行排序和格式化。它可以帮助我们按照一定的规则对导入的模块进行排序,使得代码更加整洁,易于阅读和维护。

isort 的主要特点包括:

  1. 自动排序isort 可以根据配置的规则自动对导入语句进行排序。
  2. 保持空白isort 能够保持代码中的空白行和注释,不会将其误认为是导入语句。
  3. 自定义排序规则:用户可以根据自己的需求自定义排序规则。
  4. 集成支持isort 可以与多种编辑器和 IDE 集成,如 VSCode、PyCharm 等。
  5. 快捷命令isort 提供了命令行工具,可以快速地对代码进行排序。

使用 isort 可以大大提高代码的可读性和维护性,尤其是在多人协作的大型项目中,能够帮助团队保持统一的编码风格。

如何安装或者引入 isort

在Python中,为了保持代码的整洁和有序,我们通常需要对导入的模块进行排序。isort是一个非常有用的工具,它可以帮助我们自动地完成这个任务。

首先,确保你已经安装了Python环境。然后,可以通过pip命令来安装isort库。打开命令行工具,输入以下命令:

复制代码

pip install isort

安装完成后,你可以在Python代码中通过导入isort模块来使用它。导入的方法如下:

arduino

复制代码

import isort

现在,你已经成功安装并引入了isort,

isort 使用示例

Python 代码的排序是保持代码质量的一个重要方面。isort 是一个强大的Python包,它可以帮助你自动将代码中的导入语句排序并格式化,以保持一致性和可读性。

下面通过一些示例来展示 isort 的使用。

示例 1:基本使用

安装 isort 后,你可以在 Python 文件中导入它并直接使用。下面是一个简单的示例:

ini

复制代码

from isort import sort_imports

# 原始的未排序代码
code_before = """
import os
import sys
from my_module import MyClass

def my_function():
    pass
"""

# 使用 isort 排序后的代码
code_after = sort_imports(code=code_before, library_order=['my_module'])

在这个例子中,code_after 将包含排序并格式化后的导入语句。

示例 2:自定义排序

isort 允许你通过 settings 参数来自定义排序规则。例如,你可以设置特定的排序顺序或者忽略某些模块。

python

复制代码

from isort import sort_imports

# 设置自定义排序规则
settings = {
    "order": ["built_in", "stdlib", " third_party", "my_module"],
    "case_sensitive": False,
    "include_trailing_comma": True,
}

# 原始的未排序代码
code_before = """
import os
import sys
from my_module import MyClass
import another_module

def my_function():
    pass
"""

# 使用 isort 排序后的代码
code_after = sort_imports(code=code_before, settings=settings)

在这个例子中,我们设置了自定义的排序顺序,并且启用了包含尾随逗号的功能。

示例 3:对多个文件进行排序

isort 也可以对多个文件进行排序。你可以使用 --files 参数传递文件列表。

css

复制代码

isort --files my_file.py another_file.py

这将会对 my_file.pyanother_file.py 中的导入语句进行排序。

通过这些示例,你可以看到 isort 如何帮助你保持代码中导入语句的整洁和有序。这对于代码的维护和团队协作是非常有帮助的。

isort的应用场景

isort 是一个强大的 Python 代码排序和格式化工具,能够帮助开发者自动化地按照一定规则对代码中的导入语句进行排序和格式化。这有助于提高代码的可读性和一致性,也是遵循 PEP 8 风格指南的重要一步。

1. 标准库导入排序

在日常开发中,我们经常需要从 Python 的标准库中导入多个模块。使用 isort,可以确保所有的标准库导入语句都按照字母顺序排列,从而使代码更加整洁。

python

复制代码

# 示例:使用 isort 排序标准库导入
import os
import sys
import json
from datetime import datetime

# 运行 isort 后的结果
import json
import os
import sys
from datetime import datetime

2. 第三方库导入排序

对于第三方库的导入,isort 同样适用。它可以自动检测并按照字母顺序排列第三方库的导入语句,这在多人合作的项目中尤其有用,因为它有助于减少因个人编码习惯差异而产生的混乱。

python

复制代码

# 示例:使用 isort 排序第三方库导入
import requests
import numpy as np
import pandas as pd
from flask import Flask

# 运行 isort 后的结果
import numpy as np
import pandas as pd
import requests
from flask import Flask

3. 自定义模块导入排序

在大型项目中,通常会有多个自定义模块。isort 可以确保你的代码中自定义模块的导入顺序是一致的,这对于维护大型项目来说非常有帮助。

python

复制代码

# 示例:使用 isort 排序自定义模块导入
from my_project.module_a import FunctionA
from my_project.module_b import FunctionB
from my_project.module_c import FunctionC

# 运行 isort 后的结果
from my_project.module_a import FunctionA
from my_project.module_b import FunctionB
from my_project.module_c import FunctionC

4. 忽略特定导入

有时候,某些导入语句可能因为特殊的业务逻辑或测试需要而不想被排序。isort 允许你通过配置文件或命令行参数来忽略特定的模块或文件。

python

复制代码

# 示例:使用 isort 忽略特定导入
import ignored_module  # noqa
import unittest

# 运行 isort 时的配置
# --skip-gitignore 忽略 .gitignore 中的模块
# --skip-file-ignore 忽略 .isort.cfg 中的忽略规则

5. 集成到 IDE 和编辑器

许多流行的 IDE 和代码编辑器(如 PyCharm, VSCode 等)都支持 isort 插件,这使得开发者在编写代码的过程中就可以实时地对导入语句进行排序和格式化,极大地提高了开发效率。

bash

复制代码

# 示例:在 IDE 中使用 isort 插件进行排序
# 选中导入语句,使用 IDE 提供的格式化功能

通过这些应用场景的展示,我们可以看到 isort 是一个非常有用的工具,它可以帮助开发者提升代码质量,节省整理代码的时间,并提高团队协作效率。


转载来源:https://juejin.cn/post/7381455296658538559

相关文章
|
15小时前
|
存储 程序员 Python
小白也能用的代码!1行Python,把PPT转成1张长图
大家好,我是程序员晚枫。今天介绍`python-office`库的新功能:仅用1行Python代码将PPT转为单张长图。
25 11
 小白也能用的代码!1行Python,把PPT转成1张长图
|
1天前
|
Python
Python小技巧:一种字符串的排序方式
Python小技巧:一种字符串的排序方式
11 0
|
4天前
|
Python
费德勒权变模型(Fiedler Contingency Model)详解与Python代码示例
费德勒权变模型(Fiedler Contingency Model)详解与Python代码示例
|
4天前
|
Python
指数平滑法详解与Python代码示例
指数平滑法详解与Python代码示例
|
7天前
|
并行计算 算法 Python
Dantzig-Wolfe分解算法解释与Python代码示例
Dantzig-Wolfe分解算法解释与Python代码示例
|
7天前
|
存储 Python
离散事件模拟(Discrete Event Simulation)详解与Python代码示例
离散事件模拟(Discrete Event Simulation)详解与Python代码示例
|
7天前
|
供应链 Python
供需匹配(Demand-Supply Matching)的详细解释与Python代码示例
供需匹配(Demand-Supply Matching)的详细解释与Python代码示例
|
7天前
|
供应链 Python
Demand Forecasting模型解释与Python代码示例
Demand Forecasting模型解释与Python代码示例
|
7天前
|
存储 Python
数据包络分析(Data Envelopment Analysis, DEA)详解与Python代码示例
数据包络分析(Data Envelopment Analysis, DEA)详解与Python代码示例