代碼可讀性是評判代碼質量的標準之一，有一個衡量代碼質量的標準是 Martin 提出的 “WFT” 定律，即每分鐘爆出 “WTF” 的次數(shù)。你在讀別人代碼或者做 Code Review 的時候有沒有 “WTF” 沖動呢？

為了幫助開發(fā)者統(tǒng)一代碼風格，Python 社區(qū)提出了 PEP8 代碼編碼風格，它并沒有強制要求大家必須遵循，Python 官方同時推出了一個檢查代碼風格是否符合 PEP8 的工具，名字也叫 pep8，后來被重命名為了 pycodestyle。

看如下代碼：

import time, datetimeclass ListNode:def __init__(self, val):self.val = valself.next = None# in python next is a reversed worddef reverse(self, head):prev = Nonewhile head:temp = head.nexthead.next = prevprev = headhead = tempa = [[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 提示我們有兩處地方不符合規(guī)范，第一個是單行有多個 import，第二個是類與模塊之間需要空兩行，這只是一個簡單代碼示例，真正的業(yè)務代碼可能有上百行甚至幾百行，如果我們要根據(jù) PEP8 規(guī)范逐個進行修改建議會非常耗時，而我們的開發(fā)過程中，如果時刻關注每一行代碼是否完全遵循 PEP8，將影響開發(fā)效率。

而有這么一款工具 Black，號稱不妥協(xié)的代碼格式化工具，為什么叫不妥協(xié)呢？因為它檢測到不符合規(guī)范的代碼風格直接就幫你全部格式化好，根本不需要你確定，直接替你做好決定。它也是 requests 作者最喜歡的工具之一

使用非常簡單，安裝成功后，和其他系統(tǒng)命令一樣使用，只需在 black 命令后面指定需要格式化的文件或者目錄就ok

black link.py

這是一款簡而美的工具，它并不是完全按照 PEP8 規(guī)范來格式化，比如默認每行代碼的字符數(shù)是88個，當然你可以通過參數(shù) -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 ，添加一個新的擴展工具

4、選擇 Tools-> External Tools-> Black 即可對代碼進行格式化，當然，你還可以為其指定一個快捷鍵，使操作更方便。

值得注意的是，該工具只支持 Python3.6 環(huán)境，同時還處在 beta 版本，更多信息可參考文檔： https://github.com/ambv/black

首發(fā)鏈接：https://foofish.net/black.html

總結

以上是生活随笔為你收集整理的工具 每分钟_black: 一个不妥协的Python代码格式化工具的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內容還不錯，歡迎將生活随笔推薦給好友。