Python代码格式化工具Black介绍 - 文章 - 开发者社区

Black 是一个 Python 代码格式化工具，以其简洁和一致的格式化风格而闻名。它被设计为一个“零妥协”的代码格式化程序，意味着它会自动地将代码格式化为一种统一的风格，而不需要用户进行任何配置。Black 严格遵循 PEP 8 -- Python 的官方编码风格指南，并且也兼容 Python 代码的一些现代格式化习惯。

以下是 Black 的一些主要特点和使用方法：

主要特点：

自动格式化 ：Black 自动调整代码格式，包括缩进、空格、行长等，以符合预设的规范。
一致性 ：Black 保证了整个项目中代码风格的一致性，减少了因风格不一致而产生的争议。
简洁：Black 的配置选项较少，鼓励使用默认的格式化风格。
易于使用 ：通过命令行工具即可使用，也很容易集成到各种开发环境和编辑器中。
高性能 ：Black 能够快速格式化大型项目。

安装：

可以通过 pip 安装 Black：

  
pip install black

基本使用：

在命令行中，可以对特定文件进行格式化：

  
black my_script.py

或者对整个目录进行格式化：

  
black my_project/

配置：

虽然 Black 默认不需要太多配置，但用户仍然可以通过 pyproject.toml 文件来自定义一些行为，如忽略某些文件或目录、自定义行长度等。

注意：

Black 是专门为 Python 语言设计的代码格式化工具，因此它不适用于前端代码，如 HTML、CSS 或 JavaScript。Black 的格式化规则和逻辑是依据 Python 语言的语法和 PEP 8 编码风格指南来实现的，这些规则对于其他编程语言并不适用。

Pycharm中配置Black工具

先安装black插件 (pip install black)。

然后打开Pycharm，打开设置页面，Tool->Black：

picture.image

然后，也可以在设置页面的External Tools 下面再额外的配置一个Black的工具选项：

picture.image

填写 Black 配置信息 ：

Name ：可以自定义工具名称，例如 Black格式化代码。
Program ：指定 Black 可执行文件的路径。如果你通过 pip 安装了 Black，它可能位于 Scripts 目录下，例如 D:\Software\Python\Python312\Scripts\black.exe（Windows 系统）
Arguments ：填写 $FilePath$ ，这表示 Black 将格式化当前文件的路径。
Working directory ：填写 $ProjectFileDir$ ，这表示 Black 将在项目的文件目录中运行。

picture.image