xcgd/isort

isort 工具Docker镜像文档

镜像概述

本镜像为包含isort工具的轻量级Docker镜像。isort是一款用于对Python代码中的导入语句进行自动排序、分组和格式化的工具，可帮助开发者保持一致的代码风格，提高代码可读性和维护性。

核心功能

• 提供isort工具：集成最新稳定版isort，支持Python导入语句的排序、分组和格式化
• 轻量级设计：基于精简基础镜像构建，镜像体积小，启动速度快
• 简单易用：无需复杂配置即可快速使用，支持命令行参数直接调用
• 兼容性良好：兼容主流Python版本及常见代码风格规范（如PEP 8）

使用场景

• Python项目开发：在本地开发环境中快速格式化Python文件的导入语句
• CI/CD流程集成：作为代码检查环节的一部分，自动检测并修正导入语句格式问题
• 团队协作：统一团队代码导入风格，减少代码评审中的格式相关争议
• 临时格式化需求：无需在本地安装isort，通过容器快速处理单个或多个Python文件

使用方法

基本使用

通过docker run命令运行容器，挂载本地Python文件或目录，执行isort格式化操作：

bash
# 格式化单个Python文件（当前目录下的example.py）
docker run --rm -v $(pwd):/app simple-isort-image isort /app/example.py

# 格式化指定目录下的所有Python文件
docker run --rm -v $(pwd):/app simple-isort-image isort /app/src/

# 检查文件格式（仅报告问题，不修改文件）
docker run --rm -v $(pwd):/app simple-isort-image isort --check /app/example.py

# 显示格式化差异（不修改文件，仅输出与原文件的差异）
docker run --rm -v $(pwd):/app simple-isort-image isort --diff /app/example.py

自定义配置

isort支持通过配置文件（如pyproject.toml、.isort.cfg等）自定义排序规则。将配置文件挂载到容器中即可应用自定义配置：

bash
# 使用当前目录下的pyproject.toml配置文件
docker run --rm -v $(pwd):/app simple-isort-image isort --settings-path /app/pyproject.toml /app/example.py

常用命令行参数

isort支持多种命令行参数，可直接在容器运行命令中添加：

• --check：仅检查格式问题，不修改文件
• --diff：显示格式化前后的差异对比
• --profile <profile>：使用预定义配置文件（如black、google、flake8等）
• --line-length <length>：设置每行最大字符数
• --multi-line <style>：设置多行导入的格式风格（如VERTICAL_HANGING_INDENT）

示例：使用black风格配置格式化文件

bash
docker run --rm -v $(pwd):/app simple-isort-image isort --profile black /app/example.py

注意事项

• 确保挂载的本地目录或文件具有正确的读写权限，避免因权限问题导致操作失败
• 对于大型项目，建议将常用配置写入pyproject.toml并随项目一起挂载，以保持格式化规则的一致性
• 如需使用特定版本的isort，可通过镜像标签指定（如未提供多版本标签，默认使用最新稳定版）