508-black

508-black

Black是一款自动化的Python代码格式化工具,旨在通过强制一致的代码格式来提高代码的可读性和维护性.

1. 安装Black

首先，需要使用pip安装Black。在终端或命令提示符中执行以下命令：

1

pip install black

2. 创建配置文件

为了定制Black的行为，可以创建一个名为pyproject.toml的配置文件。在项目根目录下执行以下命令：

1

touch pyproject.toml

3. 基本配置

在pyproject.toml中，可以配置Black的一些基本选项

例如行宽度（line-length）和目标Python版本（target-version）。

1
2
3
4

# pyproject.toml
[tool.black]
line-length = 88
target-version = ['py38']

4. 更多配置

exclude： 用于指定要忽略的文件或目录。

 skip-string-normalization： 如果不希望对字符串进行规范化，可以使用此选项。

 use-tabs： 如果项目使用制表符而不是空格，请启用此选项。

1
2
3
4
5
6
7
8

# pyproject.toml
[tool.black]
exclude = '''
/tests/
/docs/
'''
skip-string-normalization = true
use-tabs = true

5. 运行Black

配置完成后，可以在终端中运行Black，以格式化项目中的所有符合条件的Python文件。

1

black .

6. 编辑器集成

Black与许多流行的代码编辑器集成得很好。在许多编辑器中，你可以通过配置使Black在保存文件时自动运行。

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

1
2
3

// settings.json
"editor.formatOnSave": true,
"python.formatting.provider": "black"

这样配置后，每次保存Python文件时，Black都会自动格式化代码。