Python編碼規範和Python風格規範

2022-05-19 05:50:02 字數 1623 閱讀 2017

一、原因

1、長期的工作中,發現大多數程式設計師的**可讀性差

2、不同的程式設計師之間的協作很重要,**可讀性必須很好

3、版本公升級時,要基於原始碼公升級

4、不友好的**會影響python的執行效率

二、基於的規範

1、pep 8: style guide for python code---------python的編碼風格建議

2、google python style guide--------------goole python編碼風格建議

三、python語言規範

1. imports 僅僅用做包和模組的匯入,包的匯入每個盡量獨佔一行

2. packages 匯入模組盡量使用模組的全路徑

3. exceptions 必須小心使用

4. global variables 避免使用全域性變數

5. generator 

6. lambda 函式僅僅適用於一行**能實現的簡單函式

7. true or false 盡量使用,'',{},0,none來隱式表示false

四、python風格規範 

1、**編排

1 縮排:4個空格實現縮排,盡量不使用tab,禁止混用tab和空格

2 行:每行最大長度不超過79,換行可以使用反斜槓(\)。最好使用圓括號將換行內容括起來,不建議使用「;」

3 空行:類和top-level函式定義之間空兩行;類中的方法定義之間空一行;函式內邏輯無關段落之間空一行;其他地方盡量不要再空行。

4 空格:括號內的第乙個位置,不要空格。緊靠右括號的位置也不要空格。冒號(:)、逗號(,)、分號(;)之前不要加空格。切片木有引數,不要加空格等

5 括號:對於單元素tuple一定要加,和括號

2、命名規範

module_name

package_name  

classname  

method_name  

exceptionname

function_name

global_constant_name

global_var_name

instance_var_name

function_parameter_name

local_var_name

3、注釋規範

1.塊注釋,在一段**前增加的注釋。在『#』後加一空格。段落之間以只有『#』的行間隔。比如:

# description : module config.     #     # input : none     #     # output : none

2. 行注釋,在一句**後加注釋。比如:x = x + 1 # increment x 但是這種方式盡量少使用。

3. 避免無謂的注釋。

4、程式設計建議

1. 字串拼接,盡量使用join。使用str的方法而不是內建方法。使用startswith或endswith拉檢查字首和字尾

2. 單例物件,盡量使用is 、is not,不要使用==

3. 使用is not而不是not is

4. 使用def來定義函式,而不是將匿名函式賦給某個變數

5. 盡量使**整齊,簡潔

6. 使用isinstance()來判斷instance的型別

Python編碼規範

usr bin python 應用程式要定義main函式而不要直接寫指令碼 def main dosomething if name main main 如果是全域性變數,則需要顯式加上 global python 的注釋分為兩種的概念,一種是由 開頭的 真正的 注釋,另一種是 docstrings...

Python編碼規範

usr bin python 應用程式要定義main函式而不要直接寫指令碼 def main dosomething if name main main 如果是全域性變數,則需要顯式加上 global python 的注釋分為兩種的概念,一種是由 開頭的 真正的 注釋,另一種是 docstrings...

python編碼規範

pep8編碼標準 編寫 1,使用4個空格進行退進,不使用tab鍵,不允許tab和空格混用 2,每行最大長度79位元組,超過部分使用反斜槓折行 3,類和全域性函式定義間隔兩個空行,類內方法定義間隔乙個空行,類內方法定義間隔乙個空行,其他地方不加空行 文件編排 1.import 部分按標準,三方和自己編...