python | black，一个神奇的代码格式化工具 Python 库！

最新推荐文章于 2025-03-26 10:16:10 发布

双木的木

最新推荐文章于 2025-03-26 10:16:10 发布

阅读量1.2k

点赞数 18

分类专栏： python库 python拓展学习文章标签： python 开发语言人工智能机器学习深度学习算法数据可视化

本文链接：https://blog.youkuaiyun.com/csdn_xmj/article/details/141532537

版权

python拓展学习同时被 2 个专栏收录

219 篇文章

订阅专栏

python库

155 篇文章

订阅专栏

本文来源公众号“python”，仅用于学术分享，侵权删，干货满满。

原文链接：black，一个神奇的 Python 库！

大家好，今天为大家分享一个超酷的 Python 库 - black。

Github地址：https://github.com/psf/black

在软件开发过程中，代码风格和一致性对于提高代码可读性和可维护性至关重要。Python 作为一种高度可读的语言，有多种代码风格指南，但手动保持代码风格的一致性可能会非常耗时且容易出错。black 是一个 Python 代码格式化工具，旨在通过自动格式化代码，使其符合 PEP 8 标准，从而提高代码的可读性和一致性。本文将详细介绍 black 库，包括其安装方法、主要特性、基本和高级功能，以及实际应用场景，帮助全面了解并掌握该工具的使用。

安装

要使用 black 库，首先需要安装它。以下是安装步骤：

使用 pip 安装

可以通过 pip 直接安装 black：

pip install black

确认安装

安装完成后，可以通过以下命令确认安装是否成功：

black --version

特性

一致性：通过自动格式化代码，确保代码风格的一致性。
简洁：使用合理的默认配置，简化代码格式化过程。
快速：性能优化良好，能够快速格式化大型代码库。
无配置：大多数情况下不需要额外配置，即可实现最佳格式化效果。
可选配置：对于特定需求，可以使用命令行参数进行配置。

基本功能

格式化单个文件

可以使用 black 格式化单个 Python 文件：

black script.py

格式化整个目录

可以使用 black 格式化整个目录中的所有 Python 文件：

black my_project/

检查代码格式

可以使用 --check 参数检查代码是否符合 black 的格式，而不进行实际格式化：

black --check script.py

显示差异

可以使用 --diff 参数显示格式化前后的差异，而不进行实际格式化：

black --diff script.py

高级功能

忽略特定文件或目录

可以使用 .gitignore 文件中定义的规则忽略特定文件或目录：

black --exclude '/(\.git|\.hg|\.mypy_cache|\.tox|\.venv|build|dist)/' my_project/

设置行长度

可以使用 --line-length 参数设置最大行长度，默认是 88 个字符：

black --line-length 100 script.py

格式化字符串

可以使用 --skip-string-normalization 参数跳过字符串的格式化：

black --skip-string-normalization script.py

使用配置文件

可以将配置写入 pyproject.toml 文件中，方便管理和复用：

[tool.black]
line-length = 100
skip-string-normalization = true

然后在项目目录中运行 black 时，会自动读取配置文件中的设置：

black my_project/

实际应用场景

代码库的统一格式化

在一个团队开发的项目中，通过 black 统一格式化整个代码库，确保代码风格的一致性。

# 在项目根目录运行以下命令
black .

持续集成中的代码检查

在持续集成（CI）过程中，使用 black 检查代码格式，确保所有提交的代码都符合风格规范。

在 CI 配置文件中添加以下步骤：

# 示例 GitHub Actions 配置文件
name: CI

on: [push, pull_request]

jobs:
  format_check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: 3.8
      - name: Install dependencies
        run: pip install black
      - name: Check code format
        run: black --check .

集成开发环境（IDE）中的自动格式化

在集成开发环境（IDE）中配置 black，实现代码自动格式化，提高开发效率。

以 VSCode 为例，可以在 settings.json 中添加以下配置：

{
  "python.formatting.provider": "black",
  "editor.formatOnSave": true
}

总结

black 库是一个功能强大且易于使用的代码格式化工具，能够帮助开发者在各种应用场景中保持代码风格的一致性。通过支持一致性、简洁、快速和可选配置，black 提供了强大的功能和灵活的扩展能力。本文详细介绍了 black 库的安装方法、主要特性、基本和高级功能，以及实际应用场景。希望本文能帮助大家全面掌握 black 库的使用，并在实际项目中发挥其优势。无论是在代码库的统一格式化、持续集成中的代码检查还是集成开发环境中的自动格式化中，black 库都将是一个得力的工具。

THE END !

文章结束，感谢阅读。您的点赞，收藏，评论是我继续更新的动力。大家有推荐的公众号可以评论区留言，共同学习，一起进步。