black: 一个不妥协的Python代码格式化工具

By 刘志军, 2019-10-10, 分类: Python技术

black

代码可读性是评判代码质量的标准之一,有一个衡量代码质量的标准是 Martin 提出的 “WFT” 定律,即每分钟爆出 “WTF” 的次数。你在读别人代码或者做 Code Review 的时候有没有 “WTF” 冲动呢?

为了帮助开发者统一代码风格,Python 社区提出了 PEP8 代码编码风格,它并没有强制要求大家必须遵循,Python 官方同时推出了一个检查代码风格是否符合 PEP8 的工具,名字也叫 pep8,后来被重命名为了 pycodestyle。

看如下代码:

import time, datetime

class ListNode:
    def __init__(self, val):
        self.val = val
        self.next = None

    # in python next is a reversed word
    def reverse(self, head):
        prev = None
        while head:
            temp = head.next
            head.next = prev
            prev = head
            head = temp

        a = [
            [
                1,
                u'hello world',
                0
            ],
            [
                2,
                "hello python",
                0
            ],
        ]

这是一个不符合 PEP8 的代码段,用 pycodestyle 可检测有哪些地方不符合 PEP8 风格

$ pycodestyle link.py
link.py:1: [E401] multiple imports on one line
link.py:3: [E302] expected 2 blank lines, found 1

pycodestyle 提示我们有两处地方不符合规范,第一个是单行有多个 import,第二个是类与模块之间需要空两行,这只是一个简单代码示例,真正的业务代码可能有上百行甚至几百行,如果我们要根据 PEP8 规范逐个进行修改建议会非常耗时,而我们的开发过程中,如果时刻关注每一行代码是否完全遵循 PEP8,将影响开发效率。

而有这么一款工具 Black,号称不妥协的代码格式化工具,为什么叫不妥协呢?因为它检测到不符合规范的代码风格直接就帮你全部格式化好,根本不需要你确定,直接替你做好决定。它也是 requests 作者最喜欢的工具之一

使用非常简单,安装成功后,和其他系统命令一样使用,只需在 black 命令后面指定需要格式化的文件或者目录就ok

black link.py

black.png

这是一款简而美的工具,它并不是完全按照 PEP8 规范来格式化,比如默认每行代码的字符数是88个,当然你可以通过参数 -l 自定义长度,能一行显示完成的代码会放在一行,比如有多个元素的列表

# in:

l = [1,
     2,
     3,
]

# out:

l = [1, 2, 3]

后者把多个元素放在一行,显然更易读,而且代码更紧凑,Black 是 PEP8 的严格子集。目前我的最佳实践方式就是 PyCharm 自带的格式化工具配合 Black 使用。因为 Black 也支持集成到 Pycharm 中来。

如何集成 Pycharm

1、 安装black:

pip install black

2、 找到 black 的安装路径

 $ which black  # linux/mac
 $ where black  # windows

3、 添加扩展工具,打开 Preferences->Tools->External Tools ,添加一个新的扩展工具

WX20180521-063746@2x.png

4、选择 Tools-> External Tools-> Black 即可对代码进行格式化,当然,你还可以为其指定一个快捷键,使操作更方便。

WX20180521-063926@2x.png

值得注意的是,该工具只支持 Python3.6 环境,同时还处在 beta 版本,更多信息可参考文档: https://github.com/ambv/black


有问题可以扫描二维码和我交流

关注公众号「Python之禅」,回复「1024」免费获取Python资源

python之禅