當(dāng)前位置：首頁(yè) > 人文社科 > 生活经验 >内容正文

生活经验

PEP8 Python

發(fā)布時(shí)間：2023/11/27 生活经验 35 豆豆

生活随笔收集整理的這篇文章主要介紹了 PEP8 Python 小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.

寫(xiě)在前面

對(duì)于代碼而言，相比于寫(xiě)，它更多是讀的。

pep8

一、代碼編排

縮進(jìn)，4個(gè)空格的縮進(jìn)，編輯器都可以完成此功能；
每行最大長(zhǎng)度79，換行可以使用反斜杠，換行點(diǎn)要在操作符的后邊。
類(lèi)和top-level函數(shù)定義之間空兩行；類(lèi)中的方法定義之間空一行；函數(shù)內(nèi)邏輯無(wú)關(guān)段落之間空一行；其他地方盡量不要再空行。

二、文檔編排

模塊內(nèi)容的順序：模塊說(shuō)明和docstring—import—globals&constants—其他定義。其中import部分，又按標(biāo)準(zhǔn)、三方和自己編寫(xiě)順序依次排放，之間空一行。
不要在一句import中多個(gè)庫(kù)，比如import os, sys不推薦。
如果采用from XX import XX引用庫(kù)，可以省略‘module.’，都是可能出現(xiàn)命名沖突，這時(shí)就要采用import XX。

三、空格使用，

避免使用不必要的空格

各種右括號(hào)前不要加空格。
逗號(hào)、冒號(hào)、分號(hào)前不要加空格。
函數(shù)的左括號(hào)前不要加空格。如Func(1)。
序列的左括號(hào)前不要加空格。如list[2]。
操作符左右各加一個(gè)空格，不要為了對(duì)齊增加空格。
函數(shù)默認(rèn)參數(shù)使用的賦值符左右省略空格。
不要將多句語(yǔ)句寫(xiě)在同一行，盡管使用‘；’允許。
if/for/while語(yǔ)句中，即使執(zhí)行語(yǔ)句只有一句，也必須另起一行。

四、注釋

總體原則，錯(cuò)誤的注釋不如沒(méi)有注釋。所以當(dāng)一段代碼發(fā)生變化時(shí)，第一件事就是要修改注釋！
注釋必須使用英文，最好是完整的句子，首字母大寫(xiě)，句后要有結(jié)束符，結(jié)束符后跟兩個(gè)空格，開(kāi)始下一句。如果是短語(yǔ)，可以省略結(jié)束符。

避免無(wú)謂的注釋
行注釋，在一句代碼后加注釋。
```
print 'hello'  # 行注釋
```
塊注釋，在一段代碼前增加的注釋。在‘#’后加一空格。段落之間以只有‘#’的行間隔。
```
# Description : Module config.
# 
# Input : None
#
# Output : None
```

五、文檔描述

為所有的共有模塊、函數(shù)、類(lèi)、方法寫(xiě)docstrings；非共有的沒(méi)有必要，但是可以寫(xiě)注釋（在def的下一行）

單行注釋請(qǐng)參考如下方式

def func():"""Return a and b. tuple"""a = 1b = 2return a, b

六、命名規(guī)范

盡量避免使用小寫(xiě)字母‘l’，大寫(xiě)字母‘O’等容易混淆的字母。
模塊命名盡量短小，使用全部小寫(xiě)的方式，可以使用下劃線。
包命名盡量短小，使用全部小寫(xiě)的方式，不可以使用下劃線。
類(lèi)的命名使用CapWords的方式，模塊內(nèi)部使用的類(lèi)采用_CapWords的方式。
異常命名使用CapWords+Error后綴的方式。
全局變量盡量只在模塊內(nèi)有效，類(lèi)似C語(yǔ)言中的static。實(shí)現(xiàn)方法有兩種，一是__all__機(jī)制;二是前綴一個(gè)下劃線。
函數(shù)命名使用全部小寫(xiě)的方式，可以使用下劃線。
常量命名使用全部大寫(xiě)的方式，可以使用下劃線。
類(lèi)的屬性（方法和變量）命名使用全部小寫(xiě)的方式，可以使用下劃線。
類(lèi)的屬性有3種作用域public、non-public和subclass API，可以理解成C++中的public、private、protected，non-public屬性前，前綴一條下劃線。
類(lèi)的屬性若與關(guān)鍵字名字沖突，后綴一下劃線，盡量不要使用縮略等其他方式。
為避免與子類(lèi)屬性命名沖突，在類(lèi)的一些屬性前，前綴兩條下劃線。比如：類(lèi)Foo中聲明__a,訪問(wèn)時(shí)，只能通過(guò)Foo._Foo__a，避免歧義。如果子類(lèi)也叫Foo，那就無(wú)能為力了。
類(lèi)的方法第一個(gè)參數(shù)必須是self，而靜態(tài)方法第一個(gè)參數(shù)必須是cls。

編程建議

編碼中考慮到其他python實(shí)現(xiàn)的效率等問(wèn)題，比如運(yùn)算符‘+’在CPython（Python）中效率很高，都是Jython中卻非常低，所以應(yīng)該采用.join()的方式。
盡可能使用‘is’‘is not’取代‘==’，比如if x is not None 要優(yōu)于if x。
使用基于類(lèi)的異常，每個(gè)模塊或包都有自己的異常類(lèi)，此異常類(lèi)繼承自Exception。
異常中不要使用裸露的except，except后跟具體的exceptions。
```
try:...
except Exception as ex:raise ex
```
異常中try的代碼盡可能少。

使用startswith() and endswith()代替切片進(jìn)行序列前綴或后綴的檢查。

str = "test123abc"
if str.startwith("test") and str.endwith("abc"):print 'yes'
else:print 'no'# 不要使用下面的方式
if str[:4] == "test" and str[-3:] == 'abc':print 'yes'
else:print 'no'

使用isinstance()比較對(duì)象的類(lèi)型。比如:

test = 'abc123'print isinstance(test, int)  # False
print isinstance(test, str)  # True

轉(zhuǎn)載于:https://www.cnblogs.com/fzw-/p/8016437.html

總結(jié)

以上是生活随笔為你收集整理的PEP8 Python的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。

Python