Flake8 是方便使用的 Python 程式碼檢查工具,能夠檢查程式碼是否符合 PEP8 標準。
PEP8 是 Python 官方的程式碼風格指南,包含了許多規範,例如縮排、命名規則、空格使用、註釋等。
而這些規範都只是建議,並不是強制要求。
其中,E501 是 PEP8 中的一個規範,表示每行程式碼的長度不應超過 79 個字元。
這個規範的目的是為了提高程式碼的可讀性,避免程式碼過長而難以閱讀。
然而對於個人開發者來說,E501 規範對某些人而言可能過於嚴格。
尤其是對於需常使用長變數/函數名稱、長字串 (例如 URL)或長註釋的程式碼,雖然不會影響執行但是看到一堆紅色警告會讓人感到困擾。
以下是如何在 VSCode 中設定 Flake8,修改或禁用 E501 警告的步驟。
以下紀錄兩個方法,擇一即可。對於編輯 json 設定檔有恐懼的人,可以使用圖形化設定介面操作。
配置文件設定
- 禁用 E501 規範:
settings.json { "flake8.args": [ "--ignore=E501" // 增加這一行即可禁用 E501 規範 ] } - 修改 E501 規範的字元限制:
settings.json { "flake8.args": [ "--max-line-length=120" // 增加這一行修改字元限制由 79 改為 120 ] }
圖形化設定介面操作
- 開啟 VSCode,按下
Ctrl + ,進入設定頁面。
(或是點擊左下角齒輪圖示,選擇「設定」) - 搜尋
Flake8:Args,找到Flake8: Args設定項目。 - 選擇「新增項目」
- 輸入需要的參數:
- 禁用 E501 規範:
--ignore=E501 - 修改 E501 規範的字元限制 (由 79 改為 120 為例):
--max-line-length=120
- 禁用 E501 規範:
- 點擊確定後,Flake8 即會根據新的設定進行程式碼檢查。