python基礎之編碼規範總結

2022-09-25 14:48:15 字數 2025 閱讀 2611

官方文件:

中文翻譯:

每一級縮排4個空格。

續行應該與包裹元素對齊,要麼使用圓括號,方括號,花括號內的隱式行連線來垂直對齊,要麼使用掛行縮排對齊。當使用掛行縮排對齊時,應該考慮到第一行不應該有引數,以及使用縮排程式設計客棧以區分自己是續行。

def lajlomhdong_function_name(var_one, var_two,

var_three, var_four):

print(var_one)

def long_function_name(

var_one, var_two,

var_three, var_four):

print(var_one)

def long_function_name(

var_one, var_two, var_three,

var_four):

print(var_one, var_two, var_three, var_four)

所有行限制的最大字元數為79

沒有結構化限制的大塊文字(文件字元或者注釋),每行的最大字元數限制在72。

with open("file1", "r") as f1, \

open("file2", "r") as f2:

f2.write(f1.read())

頂層函式和類定義,前後用兩個空行隔開。

類裡面方法定義用乙個空行隔開。

class class01:

pass

class class02:

def function_01(self):

pass

def function_02(self):

pass

變數命名

函式命名

類命名

類裡面函式和方法引數程式設計客棧

單引號和雙引號字串是相同的。pep不會為這個給出建議。選擇一條規則並堅持使用下去。當乙個字串中包含單引號或者雙引號字串的時候,使用和最外層不同的符號來避免使用反斜槓,從而提高可讀性。

模組和包匯入規範

模組匯入建議

示例結果

from modu import *

差, 不清楚具體從模組中匯入了哪些內容

from modu import sqrt

稍好import modu

最佳 , 呼叫的時候直接使用modu.sqrt能比較清楚的知道當前方法屬於哪個模組。

import os \n import sys

推薦import os, sys

不推薦from subprocess import popen, pipe

也可以__all__變數

與**相矛盾的注釋比沒有注釋還糟,當**更改時,優先更新對應的注釋!

注釋應該是完整的句子。如果乙個注釋是乙個短語或者句子,它的第乙個單詞應該大寫,除非它是以小寫字母開頭的識別符號(永遠不要改變識別符號的大小寫!)。

如果注釋很短,結尾的句號可以省略。塊注釋一般由完整句子的乙個或多個段落組成,並且每句話結束有個句號。

在句尾結束的時候應該使用兩個空格。

在非英語國家的python程式設計師,請使用英文寫注釋,除非120%的確信你的**不會被使用其他語言的人閱讀。

塊注釋塊注釋通常適用於跟隨它們的某些(或全部)**,並縮排到與**相同的級別。塊注釋的每一行開頭使用乙個#和乙個空格(除非塊注釋內部縮排文字)。

塊注釋內部的段落通常只有乙個#的空行分隔。

行內注釋

有節制地使用行內注釋

行內注釋是與**語句同行的注釋。行內注釋和程式設計客棧**至少要有兩個空格分隔。注釋由#和乙個空格開始。

文件注釋

要為所有的公共模組,函式,類和方法編寫文件說明。

非公共的方法沒有必要,但是應該有乙個描述方法具體作用的注釋。這個注釋應該在def那一行之後。

pep257描述了寫出好的文件注釋的相關約定。特別需要注意的是:多行文件注釋使用的結尾三引號應該是自成一行,例如:

"""這是注釋

注釋的具體內筒

"""對於單行的文件說明,尾部的三引號應該和文件在同一行。

Python編碼規範之命名規範

1 不要使用小寫字母 l el 大寫字母 o oh 或者小寫 i 作為單獨變數名稱。因為一些字型中,上訴字母和數字很難區分 比如 o和0,l和1 2 module應該採用全小寫,並且盡可能短的命名,可以在模組名中使用下劃線以提高可讀性。package應該採用全部小寫,並且也要盡可能短的命名,但不允許...

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...