1. 程式人生 > 實用技巧 >python檢查程式碼規範和格式化程式碼

python檢查程式碼規範和格式化程式碼

文章目錄

pycodestyle 檢查程式碼規範

官方提供了同名的命令列工具來檢查 Python 程式碼是否違反了 PEP 8 規範,並且對違反規範的地方給出了相應的提示資訊。
規範的名字是 PEP 8 ,這個檢查程式碼風格的命令列工具叫 pep8,這個很容易引起大家的困惑,因此 Python 之父建議將 pep8 重新命名為 pycodestyle,下面我們來看一下 pycodestyle 的用法。

首先通過 pip 安裝一下:

pip install pycodestyle

原始碼如下:
在這裡插入圖片描述

對一個或者多個檔案執行 pycodestyle,列印檢查報告:

pycodestyle --first test_search.py
在這裡插入圖片描述

通過 --show-source 顯示不符合規範的原始碼,以便程式設計師進行修改,具體如下所示:

pycodestyle --show-source test_search.py
在這裡插入圖片描述


autopep8 格式化程式碼

autopep8 能夠將 Python 程式碼自動格式化為 PEP 8 風格,它使用 pycodestyle 工具來決定程式碼中的哪部分需要被格式化,
這能夠修復大部分 pycodestyle 工具中報告的排版問題。autopep8 本身也是一個用 Python 寫的工具

所以我們還是可以用 pip 直接安裝:

pip install autopep8

它的使用方式也很簡單,具體如下所示:

autopep8 --in-place test_search.py
在這裡插入圖片描述