python格式化-Black，一个代码格式化的Python库！

优雅的代码格式化神器 - Black 让你的 代码更规范

大家好啊，我是猫哥！今天要给小伙伴们介绍一个超级实用的 工具 - Black。它就像是一个严格的代码管家，能自动帮我们整理 代码的格式，让代码变得整洁又规范。不管你是独立开发还是团队协作，有了它都能让代码看起来赏心悦目！

什么是 Black？

Black 是 社区非常推崇的代码格式化工具。它最大的特点就是“固执己见”（）- 也就是说，它有一套自己坚持的代码格式标准，不给你太多自定义的选项。这乍一听可能不太友好，但恰恰是这种“霸道”让团队协作变得更简单。

安装和基本使用

我们用 pip 安装 Black：

pip install black

安装好后python格式化，格式化一个 文件超级简单：

black your_file.py

代码格式化实战

来看看 Black 能帮我们做些什么。假设我们有这样一段格式比较混乱的代码：

# 格式化前
def calculate_sum(    a，b，     c)：
    return     a+b+        c
my_list=[1，    2，
    3，4，
        5]
result=calculate_sum(my_list[0]，my_list[1]，
    my_list[2])

使用 Black 格式化后：

# 格式化后
def calculate_sum(a， b， c)：
    return a + b + c
my_list = [1， 2， 3， 4， 5]
result = calculate_sum(my_list[0]， my_list[1]， my_list[2])

看到差别了吗？Black 自动帮我们：

小贴士：Black 默认使用双引号而不是单引号，行长度限制为 88 个字符。这些都是经过社区实践证明的最佳选择！

常用命令参数

Black 还提供了一些实用的命令参数：

# 格式化整个目录
black your_project_directory/
# 只检查而不修改文件
black --check your_file.py
# 显示将要进行的更改
black --diff your_file.py

配合 IDE 使用

在 VS Code 中使用 Black 特别方便python格式化，我们可以设置保存时自动格式化：

安装 插件

在设置中搜索 “ ”

选择 “black” 作为格式化工具

开启 “ On Save”

注意事项：第一次使用 Black 时，可能会觉得它的某些格式化结果不太习惯。建议坚持使用一段时间，慢慢就会感受到它带来的好处！

在项目中集成 Black

对于团队项目，我建议：

在.txt中添加 Black：

black==23.10.0

添加.pre--.yaml配置：

repos：
-   repo： https：//github.com/psf/black
    rev： 23.10.0
    hooks：
    -   id： black

这样可以在提交代码前自动运行 Black 格式化。

为什么要用 Black？

团队协作更顺畅：不用再为代码风格争论

提高代码质量：统一的格式让代码更易读

节省时间：自动化格式化，从此不用手动调整

小伙伴们，今天的 学习之旅就到这里啦！记得动手试试 Black，让它帮你打理代码。有问题随时在评论区问猫哥哦。祝大家学习愉快， 学习节节高！

admin会员

打赏 收藏 海报 链接