本地与CI环境isort排序结果不一致导致CI检查失败求助

本地执行python -m isort .或poetry run isort .后的代码排序结果，与CI环境中的输出不一致，导致CI通过python -m isort --check-only .检查代码格式时失败。

示例对比 #

CI期望的正确排序：

import azure
import pytest

from my_package_name.example import Example1, Example2

本地错误排序结果：

import azure

import pytest
from my_package_name.example import Example1, Example2

常见原因及解决办法 #

• isort版本不匹配
  不同版本的isort可能调整了排序规则，导致输出差异。解决方式：在项目依赖中固定isort的具体版本，比如在pyproject.toml（Poetry项目）中添加：

  [tool.poetry.dependencies]
  isort = "5.12.0"
  

  或在requirements.txt中写入isort==5.12.0，确保本地和CI安装完全相同的版本。

• 配置文件不一致
  本地可能存在全局isort配置（如~/.isort.cfg），或CI未正确加载项目根目录的配置文件（如.isort.cfg、pyproject.toml中的[tool.isort]段）。解决方式：

  1. 在项目根目录添加明确的配置文件，比如pyproject.toml中配置：

     [tool.isort]
     profile = "black"
     line_length = 88
     sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"]
     

  2. CI执行isort时，确保工作目录在项目根目录，能读取到配置文件。
  3. 分别在本地和CI执行isort --show-config，对比生效的配置是否一致。

• Python版本差异
  不同Python版本下，isort对部分模块的分类逻辑可能变化（比如标准库的归属）。解决方式：统一本地和CI使用的Python版本，比如均采用3.10.x版本。

• 依赖包环境不一致
  isort会根据已安装的包判断模块是第三方库还是本地包，若本地和CI的依赖包存在差异，会导致分类不同。解决方式：

  1. 使用poetry lock生成poetry.lock，或pip freeze > requirements.txt生成依赖锁定文件。
  2. CI中严格按锁定文件安装依赖，比如执行poetry install --no-root或pip install -r requirements.txt。

内容的提问来源于stack exchange，提问作者Ben Butterworth