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

本篇內(nèi)容介紹了“Python代碼格式化工具pycodestyle怎么使用”的有關(guān)知識(shí)，在實(shí)際案例的操作過(guò)程中，不少人都會(huì)遇到這樣的困境，接下來(lái)就讓小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧！希望大家仔細(xì)閱讀，能夠?qū)W有所成！

看如下代碼：

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
            ],
        ]

這是一個(gè)不符合 PEP8 的代碼段，用 pycodestyle 可檢測(cè)有哪些地方不符合 PEP8 風(fēng)格

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

pycodestyle 提示我們有兩處地方不符合規(guī)范，第一個(gè)是單行有多個(gè) import，第二個(gè)是類(lèi)與模塊之間需要空兩行，這只是一個(gè)簡(jiǎn)單代碼示例，真正的業(yè)務(wù)代碼可能有上百行甚至幾百行，如果我們要根據(jù) PEP8 規(guī)范逐個(gè)進(jìn)行修改建議會(huì)非常耗時(shí)，而我們的開(kāi)發(fā)過(guò)程中，如果時(shí)刻關(guān)注每一行代碼是否完全遵循 PEP8，將影響開(kāi)發(fā)效率。

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

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

black link.py

這是一款小而美的工具，它并不是完全按照 PEP8 規(guī)范來(lái)格式化，比如默認(rèn)每行代碼的字符數(shù)是88個(gè)，當(dāng)然你可以通過(guò)參數(shù) -l 自定義長(zhǎng)度，能一行顯示完成的代碼會(huì)放在一行，比如有多個(gè)元素的列表

# in:

l = [1,
     2,
     3,
]

# out:

l = [1, 2, 3]

后者把多個(gè)元素放在一行，顯然更易讀，而且代碼更緊湊（如果你的工資是按照代碼行數(shù)來(lái)算的話，不建議這么做），Black 是 PEP8 的嚴(yán)格子集。我的最佳實(shí)踐方式就是使用 PyCharm 自帶的格式化工具配合 Black 使用。因?yàn)?Black 也支持集成到 Pycharm 中。

如何集成 Pycharm

1、 安裝black：

pip install black

2、 找到 black 的安裝路徑

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

3、 添加擴(kuò)展工具，打開(kāi) Preferences->Tools->External Tools ，添加一個(gè)新的擴(kuò)展工具，Program 填 black 的安裝路徑，Arguments 填  $FilePath$

4、選擇 Tools-> External Tools-> Black 即可對(duì)當(dāng)前打開(kāi)的文件斤西瓜代碼格式化，當(dāng)然，你還可以為其指定一個(gè)快捷鍵，使操作起來(lái)更方便。

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