jauderho/black

Black Docker镜像文档

镜像概述

Black是一款不妥协的Python代码格式化工具，该Docker镜像提供了Black的便捷部署方式。它能够自动将Python代码格式化为符合规范的统一风格，无需人工调整，有效减少团队协作中的代码风格争议，提升开发效率。

核心功能与特性

• 自动代码格式化：无需手动干预，自动将Python代码调整为符合PEP 8及Black特有规范的风格
• 不妥协特性：几乎无配置选项，强制统一代码风格，避免因格式偏好产生的团队分歧
• 多平台支持：提供跨平台镜像，适配不同架构的运行环境
• 定期更新：最新的多平台镜像至少每周重建一次，确保工具版本及依赖保持最新

使用场景

• Python项目开发中，快速格式化单个文件或整个项目代码
• 集成到CI/CD流程，在代码提交或构建前自动执行格式化检查
• 团队协作时，通过统一的自动化工具确保代码风格一致性
• 个人开发中，减少手动调整格式的时间，专注于逻辑实现

使用方法

基本运行命令

通过docker run命令直接运行容器格式化代码：

bash
docker run --rm -it -v $(pwd):/data --user $(id -u):$(id -g) jauderho/black:latest <FILENAME>

参数说明

• --rm：容器退出后自动删除，避免残留容器文件
• -it：启用交互式终端，支持实时查看格式化输出
• -v $(pwd):/data：将当前工作目录挂载到容器内的/data目录，使容器可访问本地代码文件
• --user $(id -u):$(id -g)：指定运行用户ID和组ID，避免因容器内权限问题导致本地文件所有权变更
• jauderho/black:latest：使用最新版本的Black镜像
• <FILENAME>：需格式化的Python文件名（若指定目录如.，则格式化该目录下所有Python文件）

使用示例

1. 格式化单个文件
   格式化当前目录下的example.py文件：

   bash
   docker run --rm -it -v $(pwd):/data --user $(id -u):$(id -g) jauderho/black:latest example.py
   

2. 格式化整个目录
   格式化当前目录下所有Python文件：

   bash
   docker run --rm -it -v $(pwd):/data --user $(id -u):$(id -g) jauderho/black:latest .
   

镜像信息

• 构建状态：https://github.com/jauderho/dockerfiles/workflows/black/badge.svg](https://github.com/jauderho/dockerfiles/actions?query=workflow%3Ablack)
• 版本：
• Docker拉取量：
• 镜像大小：

镜像维护

最新的多平台镜像至少每周重建一次，确保工具版本及依赖组件持续更新。用户可通过jauderho/black:latest标签获取最新稳定版本。