Python---pep8規範

來源:互聯網
上載者:User

標籤:python 編碼   邏輯   逗號   oob   nts   完整   not   input   str   

 

pep8規範 官方文檔:https://www.python.org/dev/peps/pep-0008/

PEP8中文翻譯:http://www.cnblogs.com/ajianbeyourself/p/4377933.html 以下內容轉自 https://www.douban.com/note/134971609/  PEP8 Python 編碼規範

一 代碼編排
1 縮排。4個空格的縮排(編輯器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格。
2 每行最大長度79,換行可以使用反斜線,最好使用圓括弧。換行點要在操作符的後邊敲斷行符號。
3 類和top-level函數定義之間空兩行;類中的方法定義之間空一行;函數內邏輯無關段落之間空一行;其他地方盡量不要再空行。

二 文檔編排
1 模組內容的順序:模組說明和docstring—import—globals&constants—其他定義。其中import部分,又按標準、三方和自己編寫順序依次排放,之間空一行。
2 不要在一句import中多個庫,比如import os, sys不推薦。
3 如果採用from XX import XX引用庫,可以省略‘module.’,都是可能出現命名衝突,這時就要採用import XX。

三 空格的使用
        總體原則,避免不必要的空格。
1 各種右括弧前不要加空格。
2 逗號、冒號、分號前不要加空格。
3 函數的左括弧前不要加空格。如Func(1)。
4 序列的左括弧前不要加空格。如list[2]。
5 操作符左右各加一個空格,不要為了對齊增加空格。
6 函數預設參數使用的賦值符左右省略空格。
7 不要將多句語句寫在同一行,儘管使用‘;’允許。
8 if/for/while語句中,即使執行語句只有一句,也必須另起一行。

四 注釋
        總體原則,錯誤的注釋不如沒有注釋。所以當一段代碼發生變化時,第一件事就是要修改注釋!
        注釋必須使用英文,最好是完整的句子,首字母大寫,句後要有結束符,結束符後跟兩個空格,開始下一句。如果是短語,可以省略結束符。
1 塊注釋,在一段代碼前增加的注釋。在‘#’後加一空格。段落之間以只有‘#’的行間隔。比如:
# Description : Module config.

# Input : None
#
# Output : None
2 行注釋,在一句代碼後加註釋。比如:x = x + 1# Increment x
但是這種方式盡量少使用。
3 避免無謂的注釋。

五 文檔描述
1 為所有的共有模組、函數、類、方法寫docstrings;非共有的沒有必要,但是可以寫注釋(在def的下一行)。
2 如果docstring要換行,參考如下例子,詳見PEP 257
"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

六 命名規範
        總體原則,新編代碼必須按下面命名風格進行,現有庫的編碼盡量保持風格。
1 盡量單獨使用小寫字母‘l’,大寫字母‘O’等容易混淆的字母。
2 模組命名盡量短小,使用全部小寫方式,可以使用底線。
3 包命名盡量短小,使用全部小寫方式,不可以使用底線。
4 類的命名使用CapWords的方式,模組內部使用的類採用_CapWords的方式。
5 異常命名使用CapWords+Error尾碼的方式。
6 全域變數盡量只在模組內有效,類似C語言中的static。實現方法有兩種,一是__all__機制;二是首碼一個底線。
7 函數命名使用全部小寫方式,可以使用底線。
8 常量命名使用全部大寫的方式,可以使用底線。
9 類的屬性(方法和變數)命名使用全部小寫方式,可以使用底線。
9 類的屬性有3種範圍public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public屬性前,首碼一條底線。
11 類的屬性若與關鍵字名字衝突,尾碼一底線,盡量不要使用縮減等其他方式。
12 為避免與子類屬性命名衝突,在類的一些屬性前,首碼兩條底線。比如:類Foo中聲明__a,訪問時,只能通過Foo._Foo__a,避免歧義。如果子類也叫Foo,那就無能為力了。
13 類的方法第一個參數必須是self,而靜態方法第一個參數必須是cls。

七 編碼建議
1 編碼中考慮到其他python實現的效率等問題,比如運算子‘+’在CPython(Python)中效率很高,都是Jython中卻非常低,所以應該採用.join()的方式。
2 儘可能使用‘is’‘is not’取代‘==’,比如if x is not None 要優於if x。
3 使用基於類的異常,每個模組或包都有自己的異常類,此異常類繼承自Exception。
4 異常中不要使用裸露的except,except後跟具體的exceptions。 5 異常中try的代碼儘可能少。比如:
try:
value = collection[key]
except KeyError:
return key_not_found(key)
else:
return handle_value(value)
要優於
try:
# Too broad!
return handle_value(collection[key])
except KeyError:
# Will also catch KeyError raised by handle_value()
return key_not_found(key)
6 使用startswith() and endswith()代替切片進行序列首碼或尾碼的檢查。比如:
Yes: if foo.startswith(‘bar‘):優於
No: if foo[:3] == ‘bar‘:
7 使用isinstance()比較對象的類型。比如
Yes: if isinstance(obj, int): 優於
No: if type(obj) is type(1):
8 判斷序列空或不空,有如下規則
Yes: if not seq:
if seq:
優於
No: if len(seq)
if not len(seq)
9 字串不要以空格收尾。
10 位元據判斷使用 if boolvalue的方式。

Python---pep8規範

相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.