歡迎光臨
每天分享高質量文章

推薦一個小而美的Python代碼格式化工具

導讀:代碼可讀性是評判代碼質量的標準之一,有一個衡量代碼質量的標準是 Martin 提出的 “WTF” 定律,即每分鐘爆出 “WTF” 的次數。你在讀別人代碼或者做 Code Review 的時候有沒有 “WTF” 衝動呢?

作者:劉志軍

來源:Python之禪(ID:VTtalk)

為了幫助開發者統一代碼風格,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


這是一款小而美的工具,它並不是完全按照 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 ,添加一個新的擴展工具,Program 填 black 的安裝路徑,Arguments 填  $FilePath$。


4、選擇 Tools-> External Tools-> Black 即可對當前打開的檔案斤西瓜代碼格式化,當然,你還可以為其指定一個快捷鍵,使操作起來更方便。


值得註意的是,該工具只支持 Python3.6 環境,同時還處在 beta 版本,更多信息可參考文件:
https://github.com/ambv/black

推薦閱讀

學計算機哪家強?清華竟是2018全球第1!你的母校上榜沒?

關於Python的一切:2018年,你讀這8本書就夠了

小學生都能懂的人工智慧:5本書給你劇透未來世界

LeCun:智慧的精華在於預測能力!“預測學習”瞭解一下!

Q: 讀別人代碼的時候,你什麼感覺?

歡迎留言與大家分享

覺得不錯,請把這篇文章分享給你的朋友

轉載 / 投稿請聯繫:baiyu@hzbook.com

更多精彩,請在後臺點擊“歷史文章”查看

赞(0)

分享創造快樂