Python寫碼注意事項

一個好的寫碼習慣是有必要的，且非常的重要。 那什麼是好的寫碼習慣呢？

好的寫碼習慣即 寫的代碼簡潔，易懂，且連貫。

好的寫碼習慣能給人帶來的好處有很多。 比如， 為了方便他人和自己的閱讀理解和修改。為了在這同個項目採取統一的風格，可以解放更多精力在思考上而不是糾結寫這個部分的目的是什麼。

養成好習慣需要注意以下幾個方面：

• Avoid abbreviating variable names. 避免縮寫變數名。
• Write out your function argument names. 寫清楚function裡面的argument名字。
• Document your classes and methods. 對於class和methods寫好文檔。
• Comment your code. 注釋你的代碼。
• Refactor repeated lines of code into reusable functions or methods. 重複的代碼包裝成function和method 以便復用。
• Keep functions and methods short. A good rule of thumb is that scrolling should not be necessary to read an entire function or method. 保持function和method簡短。好的評判標準就是不需要下滑滾動條來讀完整個function和method。

遵守對應編程語言的規範

PEP8是Python的官方的規範文檔。建議閱讀PEP 8 -- Style Guide for Python Code 。這個可以通過使用一些PEP8插件來完成或者用於一個自帶檢查風格的文本編輯器即可。

注意：新的代碼請遵守PEP8規範，如果舊的代碼遵守的是之前的版本，那麼請依舊沿用之前的規範。

Tips: 可以在使用 Flake8 來檢查您的代碼質量。Flake8 由Tarek Ziadé 建立，現在由 PyCQA group來維護。

每行79字元長度限制

PEP8規定開源項目建議每行只含79個字元長度。私人項目可放寬至99個字元。更多訊息請閱讀：Maximum Line Length

如果你在用Python特定的開源庫，請查閱他們自己的規範。如果他們限制字元數為119 每行，請遵守該開源庫規範。

Import 引入模組或庫

引用模組建議根據以下順序：

1. Standard library imports 標準庫引入
2. Related third-party imports 相關第三方庫引入
3. Local application or library specific imports 本地應用或庫引入

Use Explicit Relative Imports 使用清晰的相對引入

#Import Type： absolute importn#Usage: Use when importing from outside the current appn#Code： nfrom core.views import FoodMixinnn#Import Type： explicit relative import n#Usage: Use when importing from another module in the current appn#Code： nfrom .models import WaffleConenn#Import Type： absolute importn#Usage: Often used when importing from another module in the current appn#Code： nfrom models import WaffleConen

第二種 和 第三種之間，建議使用第二種格式。

Avoid Using Import * 避免使用 Import *

防止引入其他庫的時候導致無法預測甚至有時候是災難性的結果。

其他命名衝突

如果你從不同個庫中引用同個名字的function的時候， 可以通過以下方式來避免：

from A import C as ACnfrom B import B as BCn

推薦閱讀：