black：代码格式化的一键美容师

最新推荐文章于 2025-03-07 12:49:22 发布

爱Python的小朋友

最新推荐文章于 2025-03-07 12:49:22 发布

阅读量1k

点赞数 16

文章标签： python 开发语言前端数据库

本文链接：https://blog.youkuaiyun.com/2301_80799243/article/details/144659357

版权

大家好呀！今天我要给大家介绍一个超级实用的Python代码格式化工具 —— black。你是不是经常为代码格式不统一而烦恼？缩进忽大忽小，换行时机把握不准，团队成员各自风格迥异...别担心，有了black，这些问题都能一键解决！它就像是代码的美容师，让你的Python代码既规范又好看。

black是什么？

black是Python代码格式化工具中的"独裁者"。为什么这么说呢？因为它采用了不可配置的强制格式化风格，你只需要专注写代码，其他的交给black就好。它会自动把你的代码变得清晰、一致且符合PEP 8规范。

首先，让我们安装black：

pip install black

🌟 小贴士：建议将black安装为开发依赖。如果你使用poetry：

poetry add black --dev

基本使用

格式化单个文件

假设我们有一个格式混乱的Python文件：

# 格式化前：messy.py
def calculate_sum(a,b,    c):
    return a+b+c

def hello_world(    ):
    msg    ="Hello, "+"World!"
    print(   msg   )

lst=[1,2,
3,4,
        5]

使用black格式化：

black messy.py

格式化后的代码：

# 格式化后：messy.py
def calculate_sum(a, b, c):
    return a + b + c


def hello_world():
    msg = "Hello, " + "World!"
    print(msg)


lst = [1, 2, 3, 4, 5]

看到区别了吗？black自动：

调整了函数参数的空格
规范了运算符两边的空格
删除了多余的空格
调整了列表的格式
在顶层函数之间添加了两个空行

格式化整个项目

要格式化整个项目，只需指定目录：

black .  # 格式化当前目录下所有Python文件
black src/  # 格式化src目录

配置选项

虽然black的理念是"零配置"，但它还是提供了一些基本配置：

black --line-length 88  # 设置最大行长度（默认88）
black --skip-string-normalization  # 保留字符串引号格式
black --check  # 只检查而不修改文件
black --diff  # 显示将要做出的更改

集成到开发流程

编辑器集成

我最推荐的方式是将black集成到你的编辑器中：

VSCode配置（settings.json）：

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

🎯 小贴士：PyCharm用户可以在设置中搜索"External Tools"添加black。

配置文件

在项目根目录创建pyproject.toml：

[tool.black]
line-length = 88
target-version = ['py37']
include = '\.pyi?$'
extend-exclude = '''
# 添加要排除的文件
/(
    \.eggs
  | \.git
  | \.hg
  | \.mypy_cache
  | \.tox
  | \.venv
  | _build
  | buck-out
  | build
  | dist
)/
'''

Git钩子集成

使用pre-commit自动在提交前格式化：

# .pre-commit-config.yaml
repos:
-   repo: https://github.com/psf/black
    rev: 22.3.0
    hooks:
    -   id: black

常见问题解答

字符串格式化问题：

# black会保留f-string的格式
name = "Python"
formatted = f"Hello, {name}!"  # 这样的格式会保持不变

长行处理：

# 过长的行会被自动换行
result = some_very_long_function_name(first_parameter="value1", second_parameter="value2", third_parameter="value3")

# 格式化后：
result = some_very_long_function_name(
    first_parameter="value1",
    second_parameter="value2",
    third_parameter="value3",
)

实用技巧

保存文件修改时间：

black --fast --diff src/  # 快速检查更改

与其他工具配合：

# 先用black格式化，再用flake8检查
black src/ && flake8 src/

🚨 注意事项：

black会修改文件，首次使用前请确保代码已提交到版本控制
团队项目中，所有成员都应使用相同版本的black
某些特殊情况下如果不想格式化，可以使用# fmt: off和# fmt: on注释

练习题：

创建一个包含不同编码风格的Python文件，使用black格式化并观察变化
配置你的编辑器使用black作为默认格式化工具
尝试在一个小项目中设置pre-commit钩子，体验自动格式化

小伙伴们，今天的Python学习之旅就到这里啦！记得动手敲代码，有问题随时在评论区问我哦。让我们一起把代码写得既规范又漂亮吧！祝大家学习愉快，Python学习节节高！

更多请关注微信公众号SurzZ