1. 程式人生 > >Python實操(3):python程式設計規範

Python實操(3):python程式設計規範

       選擇pythoncharm作為Python開發ide也是在網上查了好長時間,這兩天瞭解到visual studio code強大、易用,同時也一直用visual studio做c/c++開發,所以決定把以後的開發平臺切換到微軟系。換平臺以後發現,先前在pythoncharm寫的東西,在visual studio code上一堆問題,百度一下才明確沒有遵循PEP8。“行有行規”,既然準備深究一下python,規則還是必須要了解,遵循的。PEP8就不具體介紹了,本篇旨在記錄自己實操中出現的問題及解決辦法,後續學習中不斷更新補充。
這裡列幾條要求:
一行列數 : PEP 8 規定為 79 列(這個有時候看著不爽,我修改為120);
一個函式 : 不要超過 30 行程式碼, 即可顯示在一個螢幕類,可以不使用垂直遊標即可看到整個函式;
一個類 : 不要超過 200 行程式碼,不要有超過 10 個方法;
一個模組 : 不要超過 500 行;

       一句import:不要匯入多個庫

一個函式或類:前後要空兩行

一個.py檔案:檔案最後有且僅有一個空行


列出實際遇到的錯誤及解決方案:

(1) indentation is not a multiple of four

空格的個數應該是4的倍數,核對一下是否多敲或者少一個空格;

(2)line too long (114 > 79 characters)

方法一Python行寬為80,可以將段落分行,yapf進行格式化,如visual studio code中快捷鍵為“alt+shift + f”進行格式化;

方法二 在visual studio code 中也可以在:檔案->首選項->設定 將python configuration 中的“python.linting.flake8Args:[]”,複製到右邊的使用者設定區然後在中括號裡新增“--max-line-length=120”,如"python.linting.flake8Args": ["--max-line-length=120"],

(3)E502:the backslash is redundant between brackets

由於一行太長,所以通過"\"將其分為兩行,然後就提示這個錯誤;是因為雖然這一行很長,但是“\”分開的部分是處於“()”之間的,系統可以自動判決,所以就不需要加"\"了。

(4)E305:expected 2 blank lines after class or function definition, found 1

提示比較明確,就是一個類或者函式定義的後邊要空出兩行

(5)inline comment should start with '# '

要求在用“#”加註釋的時候,後邊要加一個空格;

說實話規矩有點多,一開始不習慣有點帶上手銬的感覺,但必要的編碼習慣在增強程式碼可讀性時還是必要的,寫的程式碼最終是要給別人看的。