Python編碼規(guī)范有哪些

Python編碼規(guī)范有哪些，針對(duì)這個(gè)問(wèn)題，這篇文章詳細(xì)介紹了相對(duì)應(yīng)的分析和解答，希望可以幫助更多想解決這個(gè)問(wèn)題的小伙伴找到更簡(jiǎn)單易行的方法。

編碼

在Python編碼規(guī)范中，所有的 Python 腳本文件都應(yīng)在文件頭標(biāo)上 # -*- coding:utf-8 -*- 。設(shè)置編輯器，默認(rèn)保存為 utf-8 格式。

注釋

業(yè)界普遍認(rèn)同 Python 的注釋分為兩種的概念，一種是由 # 開頭的“真正的”注釋，另一種是 docstrings。前者表明為何選擇當(dāng)前實(shí)現(xiàn)以及這種實(shí)現(xiàn)的原理和難點(diǎn)，后者表明如何使用這個(gè)包、模塊、類、函數(shù)（方法），甚至包括使用示例和單元測(cè)試。

堅(jiān)持適當(dāng)注釋原則。對(duì)不存在技術(shù)難點(diǎn)的代碼堅(jiān)持不注釋，對(duì)存在技術(shù)難點(diǎn)的代碼必須注釋。但與注釋不同，推薦對(duì)每一個(gè)包、模塊、類、函數(shù)（方法）寫 docstrings，除非代碼一目了然，非常簡(jiǎn)單。

縮進(jìn)

Python 依賴縮進(jìn)來(lái)確定代碼塊的層次，行首空白符主要有兩種：tab 和空格，但嚴(yán)禁兩者混用。如果使用 tab 縮進(jìn)，設(shè)定 tab 為 4 個(gè)空格。
公司內(nèi)部推薦使用 4 個(gè)空格的 tab 進(jìn)行縮進(jìn)。

空格

空格在 Python 代碼中是有意義的，因?yàn)?Python 的語(yǔ)法依賴于縮進(jìn)，在行首的空格稱為前導(dǎo)空格。在這一節(jié)不討論前導(dǎo)空格相關(guān)的內(nèi)容，只討論非前導(dǎo)空格。非前導(dǎo)空格在 Python 代碼中沒(méi)有意義，但適當(dāng)?shù)丶尤敕乔皩?dǎo)空格可以增進(jìn)代碼的可讀性。

1） 在二元算術(shù)、邏輯運(yùn)算符前后加空格：如 a = b + c；

2） 在一元前綴運(yùn)算符后不加空格，如 if !flg: pass；

3） “:”用在行尾時(shí)前后皆不加空格，如分枝、循環(huán)、函數(shù)和類定義語(yǔ)言；用在非行尾時(shí)兩端加空格，如 dict 對(duì)象的定義 d = {‘key’ : ’value’}。

4） 括號(hào)（含圓括號(hào)、方括號(hào)和花括號(hào)）前后不加空格，如 do_something(arg1, arg2)，而不是 do_something( arg1, arg2 )；

5） 逗號(hào)后面加一個(gè)空格，前面不加空格；s

空行

適當(dāng)?shù)目招杏欣谠黾哟a的可讀性，加空行可以參考如下幾個(gè)Python編碼規(guī)范準(zhǔn)則：

1） 在類、函數(shù)的定義間加空行；

2） 在 import 不同種類的模塊間加工行；

3） 在函數(shù)中的邏輯段落間加空行，即把相關(guān)的代碼緊湊寫在一起，作為一個(gè)邏輯段落，段落間以空行分隔；

斷行

盡管現(xiàn)在的寬屏顯示器已經(jīng)可以單屏顯示超過(guò) 256 列字符，但本規(guī)范仍然堅(jiān)持行的***長(zhǎng)度不得超過(guò) 78 個(gè)字符的標(biāo)準(zhǔn)。折疊長(zhǎng)行的方法有以下幾種方法：

1) 為長(zhǎng)變量名換一個(gè)短名，如：

this.is.a.very.long.variable_name = this.is.another.long.variable_name

應(yīng)改為：

variable_name1 = this.is.a.very.long.variable_name  variable_name2 = this.is.another.variable_name  variable_name1 = variable_name2s

2) 在括號(hào)（包括圓括號(hào)、方括號(hào)和花括號(hào)）內(nèi)換行，如：

class Edit(CBase):  def __init__(self, parent, width,   font = FONT, color = BLACK, pos = POS, style = 0):

或：

very_very_very_long_variable_name = Edit(parent, \  width, \  font, \  color, \  pos)

如果行長(zhǎng)到連***個(gè)括號(hào)內(nèi)的參數(shù)都放不下，則每個(gè)元素都單獨(dú)占一行：

very_very_very_long_variable_name = ui.widgets.Edit( \  panrent, \  width, \  font, \  color, \  pos)

3) 在長(zhǎng)行加入續(xù)行符強(qiáng)行斷行，斷行的位置應(yīng)在操作符前，且換行后多一個(gè)縮進(jìn)，以使維護(hù)人員看代碼的時(shí)候看到代碼行首即可判定這里存在換行，如：

if color == WHITE or color == BLACK \  or color == BLUE: # 注意 or 操作符在新行的行首而不是舊行的行尾  do_something(color);

命名

一致的命名可以給開發(fā)人員減少許多麻煩，而恰如其分的命名則可以大幅提高代碼的可讀性，降低維護(hù)成本。

關(guān)于Python編碼規(guī)范有哪些問(wèn)題的解答就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，如果你還有很多疑惑沒(méi)有解開，可以關(guān)注億速云行業(yè)資訊頻道了解更多相關(guān)知識(shí)。