一起來漲知識呀!
PEP8 Python 編碼規範
1.代碼編排
- 縮進。4個空格的縮進,不使用Tap,更不能混合使用Tap和空格。
- 每行最大長度79,換行可以使用反斜槓,最好使用圓括號【注意:並沒有找到如何用圓括號換行的資料,但是我覺得應該指的是,用圓括號將是一行的東西括在一起】。換行點要在操作符的後邊敲回車。【並沒有找到操作符的定義】
- 類和top-level函數定義之間空兩行;類中的方法定義之間空一行;函數內邏輯無關段落之間空一行;其他地方儘量不要再空行。
2.文檔編排
- module(一個py文件)內容的順序:模塊說明,docstring,import xxx(按標準、第三方和自己編寫順序依次排放,之間空一行。),全局變量,常量,其他(類、函數等)定義
- 不要在一句import中多個庫,比如import os, sys。
- 如果採用from XX import XX引用庫,可以省略‘module.’,但是可能出現命名衝突,這時就要採用import XX(推薦)。
3.空格的使用
- 各種右括號前不要加空格。
- 逗號、冒號、分號前不要加空格。
- 函數的左括號前不要加空格。如Func(1)。
- 序列的左括號前不要加空格。如list[2]。
- 操作符左右各加一個空格,不要爲了對齊增加空格。
- 函數默認參數使用的賦值符左右省略空格。
- 不要將多句語句寫在同一行。
- if/for/while語句中,即使執行語句只有一句,也必須另起一行。
4.註釋
[我覺得不太重要呢]
- 總體原則,錯誤的註釋不如沒有註釋。所以當一段代碼發生變化時,第一件事就是要修改註釋!
- 註釋必須使用英文,最好是完整的句子,首字母大寫,句後要有結束符,結束符後跟兩個空格,開始下一句。如果是短語,可以省略結束符。
- 塊註釋,在一段代碼前增加的註釋。在‘#’後加一空格。段落之間以只有‘#’的行間隔。比如:
- 行註釋,在一句代碼後加註釋。 比如:
x = x + 1 # Increment x
但是這種方式儘量少使用。 - 避免無謂的註釋。
5.命名規範
- 總體原則,新編代碼必須按下面命名風格進行,現有庫的編碼儘量保持風格。
- 儘量單獨使用小寫字母‘l’,大寫字母‘O’等容易混淆的字母。
- 模塊(module)命名儘量短小,使用全部小寫的方式,可以使用下劃線。
- 包(package)命名儘量短小,使用全部小寫的方式,不可以使用下劃線。
- 類的命名使用CapWords的方式,模塊內部使用的類採用_CapWords的方式。
- 異常命名使用CapWords+Error後綴的方式。
- 全局變量儘量只在模塊內有效,類似C語言中的static。實現方法有兩種,一是__all__機制;二是前綴一個下劃線。
[__all__機制以及下劃線]:
在模塊(*.py)中使用意爲導出__all__列表裏的類、函數、變量等成員,
否則將導出modualA中所有不以下劃線開頭(私有)的成員,
在模塊中使用__all__屬性可避免在相互引用時的命名衝突
modualA.py
#
__all__=["fun1","class1"]
...
#end file modualA.py
使用:
from modualA import *
導入模塊modualA裏的所有成員(如果定義了__all__那麼就導出列表中的所有,否則默認導出不以下劃線開頭
的所有成員)
- 函數命名使用全部小寫的方式,可以使用下劃線。
- 常量命名使用全部大寫的方式,可以使用下劃線。
- 類的屬性(方法和變量)命名使用全部小寫的方式,可以使用下劃線。
- 類的屬性有3種作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public屬性前,前綴一條下劃線。
【python 中類屬性的三種作用域】
參考資料:https://blog.csdn.net/jpch89/article/details/87982358
- 類的屬性若與關鍵字名字衝突,後綴一下劃線,儘量不要使用縮略等其他方式。
- 爲避免與子類屬性命名衝突,在類的一些屬性前,前綴兩條下劃線。比如:類Foo中聲明__a,訪問時,只能通過Foo._Foo__a,避免歧義。如果子類也叫Foo,那就無能爲力了。【看不懂】
- 類的方法第一個參數必須是self,而靜態方法第一個參數必須是cls。
【類中靜態方法@staticmethod 使用和好處介紹】參考資料https://www.cnblogs.com/kennyhr/p/3935465.html
6.編碼建議
- 編碼中考慮到其他python實現的效率等問題,比如運算符‘+’在CPython(Python)中效率很高,都是Jython中卻非常低,所以應該採用.join()的方式。
- 儘可能使用‘is’‘is not’取代‘==’,比如if x is not None 要優於if x。
【其實上面的說法有點問題,"is"和“==”還是有用法的區別的】參考資料:https://www.cnblogs.com/kiko0o0/p/8135184.html
在 Python 中會用到對象之間比較,可以用 ==,也可以用 is 。但是它們的區別是什麼呢?
-
is 比較的是兩個實例對象是不是完全相同,它們是不是同一個對象,佔用的內存地址是否相同。
-
== 比較的是兩個對象的內容是否相等,即內存地址可以不一樣,內容一樣就可以了。
-
例子:
-
is 與 == 相比有一個比較大的優勢,就是計算速度快,因爲它不能重載,不用進行特殊的函數調用,少了函數調用的開銷而直接比較兩個整數 id。
-
其餘例子:
總結
1、is 比較兩個對象的 id 值是否相等,是否指向同一個內存地址;
2、== 比較的是兩個對象的內容是否相等,值是否相等;
3、小整數對象[-5,256]在全局解釋器範圍內被放入緩存供重複使用;
4、is 運算符比 == 效率高,在變量和None進行比較時,應該使用 is。
- 使用基於類的異常,每個模塊或包都有自己的異常類,此異常類繼承自Exception。
- 異常中不要使用裸露的except,except後跟具體的exceptions。
- 異常中try的代碼儘可能少。比如:
- 使用startswith() and endswith()代替切片進行序列前綴或後綴的檢查。比如:
- 使用isinstance()比較對象的類型。比如
- 判斷序列空或不空,有如下規則
- 字符串不要以空格收尾。
- 二進制數據判斷使用
if boolvalue
的方式。