Python代碼格式化工具pycodestyle怎么使用

本篇內容介紹了“Python代碼格式化工具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 即可對當前打開的文件斤西瓜代碼格式化，當然，你還可以為其指定一個快捷鍵，使操作起來更方便。

“Python代碼格式化工具pycodestyle怎么使用”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！