• 正文
  • 相關(guān)推薦
申請(qǐng)入駐 產(chǎn)業(yè)圖譜

三、python編碼規(guī)范

2024/12/12
601
加入交流群
掃碼加入
獲取工程師必備禮包
參與熱點(diǎn)資訊討論

python編碼規(guī)范

官方網(wǎng)址:https://www.python.org/dev/peps/pep-0008/

官方介紹如下:
本文檔給出了Python主要發(fā)行版中包含標(biāo)準(zhǔn)庫的Python代碼的編碼約定。請(qǐng)參閱有關(guān)Python[1]的C實(shí)現(xiàn)中的C代碼的描述樣式指南的配套信息PEP。

本文檔和PEP 257(文檔字符串約定)改編自Guido的原始Python風(fēng)格指南文章,并添加了一些Barry的風(fēng)格指南[2]。

這種風(fēng)格指南隨著時(shí)間的推移而發(fā)展,因?yàn)檎Z言本身的變化確定了更多的約定,而過去的約定也變得過時(shí)了。

許多項(xiàng)目都有自己的編碼風(fēng)格指南。在發(fā)生任何沖突時(shí),此類特定于項(xiàng)目的指南應(yīng)優(yōu)先用于該項(xiàng)目。

那么,本文是簡單介紹PEP 8和PEP 257介紹。

pep8規(guī)范

格式化pep8快捷鍵:ctrl+alt+L

1、縮進(jìn)

在這里插入圖片描述

#每一級(jí)縮進(jìn)4個(gè)空格(pycharm里是一個(gè)tab)
#對(duì)齊縮進(jìn):參數(shù)對(duì)齊左邊括號(hào)
#懸掛縮進(jìn):4個(gè)空格,對(duì)齊參數(shù)
#層級(jí)縮進(jìn):8個(gè)空格,對(duì)齊參數(shù)

2、行的最大長度

#單行代碼字符數(shù)不要超過79個(gè)字符
#通過“”來隱式換行
#注釋最大72字符

with open(r"D:360downloadswpcachep3.qhimg.combdr__85file01") as file01, 
		open(r"D:360downloadswpcachep3.qhimg.combdr__85file02") as file02:
	content=file01.read()
	file02.write(content)

3、空行

#頂層函數(shù)和類定義,前后用兩個(gè)空行隔開
#類里的方法定義用一個(gè)空行隔開

4、注釋

#寫代碼前先寫注釋,修改代碼也應(yīng)該先修改注釋

在這里插入圖片描述在這里插入圖片描述

def func(n1, n2, n3 ):
	"""自定義函數(shù)
	:n1:參數(shù)1
	:n1:參數(shù)2
	:n1:參數(shù)3
	:return:返回結(jié)果
	"""

5、命名約定
#禁止使用I(小寫的L)、O(大寫的o)、l(大寫的i)

在這里插入圖片描述在這里插入圖片描述

6、字符串引號(hào)

在這里插入圖片描述

7、模塊和包導(dǎo)入規(guī)范

#模塊導(dǎo)入順序:官方庫-》第三方庫-》自定義模塊
#__all__變量:限制導(dǎo)入可以使用這種方法

在這里插入圖片描述在這里插入圖片描述在這里插入圖片描述

pep257規(guī)范

官方文檔:https://www.python.org/dev/peps/pep-0257/

1、工程結(jié)構(gòu)化
#項(xiàng)目名稱,即項(xiàng)目文件夾

在這里插入圖片描述在這里插入圖片描述

相關(guān)推薦