Python編碼規范基本內容簡介
Python編程語言的應用,首先需要熟悉的是它的編碼規范。那么接下來我們將會通過一些主要的方面來為大家詳細解讀一下Python編碼規范的一些主要內容,希望給大家帶來一些幫助,方便實際應用。#t#
編碼
在Python編碼規范中,所有的 Python 腳本文件都應在文件頭標上 # -*- coding:utf-8 -*- 。設置編輯器,默認保存為 utf-8 格式。
注釋
業界普遍認同 Python 的注釋分為兩種的概念,一種是由 # 開頭的“真正的”注釋,另一種是 docstrings。前者表明為何選擇當前實現以及這種實現的原理和難點,后者表明如何使用這個包、模塊、類、函數(方法),甚至包括使用示例和單元測試。
堅持適當注釋原則。對不存在技術難點的代碼堅持不注釋,對存在技術難點的代碼必須注釋。但與注釋不同,推薦對每一個包、模塊、類、函數(方法)寫 docstrings,除非代碼一目了然,非常簡單。
縮進
Python 依賴縮進來確定代碼塊的層次,行首空白符主要有兩種:tab 和空格,但嚴禁兩者混用。如果使用 tab 縮進,設定 tab 為 4 個空格。
公司內部推薦使用 4 個空格的 tab 進行縮進。
空格
空格在 Python 代碼中是有意義的,因為 Python 的語法依賴于縮進,在行首的空格稱為前導空格。在這一節不討論前導空格相關的內容,只討論非前導空格。非前導空格在 Python 代碼中沒有意義,但適當地加入非前導空格可以增進代碼的可讀性。
1) 在二元算術、邏輯運算符前后加空格:如 a = b + c;
2) 在一元前綴運算符后不加空格,如 if !flg: pass;
3) “:”用在行尾時前后皆不加空格,如分枝、循環、函數和類定義語言;用在非行尾時兩端加空格,如 dict 對象的定義 d = {‘key’ : ’value’}。
4) 括號(含圓括號、方括號和花括號)前后不加空格,如 do_something(arg1, arg2),而不是 do_something( arg1, arg2 );
5) 逗號后面加一個空格,前面不加空格;s
空行
適當的空行有利于增加代碼的可讀性,加空行可以參考如下幾個Python編碼規范準則:
1) 在類、函數的定義間加空行;
2) 在 import 不同種類的模塊間加工行;
3) 在函數中的邏輯段落間加空行,即把相關的代碼緊湊寫在一起,作為一個邏輯段落,段落間以空行分隔;
斷行
盡管現在的寬屏顯示器已經可以單屏顯示超過 256 列字符,但本規范仍然堅持行的***長度不得超過 78 個字符的標準。折疊長行的方法有以下幾種方法:
1) 為長變量名換一個短名,如:
this.is.a.very.long.variable_name = this.is.another.long.variable_name
應改為:
- variable_name1 = this.is.a.very.long.variable_name
- variable_name2 = this.is.another.variable_name
- variable_name1 = variable_name2s
2) 在括號(包括圓括號、方括號和花括號)內換行,如:
- 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)
如果行長到連***個括號內的參數都放不下,則每個元素都單獨占一行:
- very_very_very_long_variable_name = ui.widgets.Edit( \
- panrent, \
- width, \
- font, \
- color, \
- pos)
3) 在長行加入續行符強行斷行,斷行的位置應在操作符前,且換行后多一個縮進,以使維護人員看代碼的時候看到代碼行首即可判定這里存在換行,如:
- if color == WHITE or color == BLACK \
- or color == BLUE: # 注意 or 操作符在新行的行首而不是舊行的行尾
- do_something(color);
命名
一致的命名可以給開發人員減少許多麻煩,而恰如其分的命名則可以大幅提高代碼的可讀性,降低維護成本。
以上就是我們為大家介紹的有關Python編碼規范的相關內容。