快捷導(dǎo)航

Python 命名規(guī)范與最佳實(shí)踐

更新時(shí)間：2025年03月17日 09:44:39 作者：燃燈工作室

本文介紹了Python命名規(guī)范與最佳實(shí)踐,包括變量名、模塊名、類名、函數(shù)名和常量名的命名規(guī)則,強(qiáng)調(diào)了命名的清晰性、一致性、科學(xué)性和避免使用特殊符號(hào),感興趣的朋友一起看看吧

1. 規(guī)范

1.變量名區(qū)分大小寫(xiě)；

2.嚴(yán)禁使用關(guān)鍵字作為變量名；

3.確定自己的命名風(fēng)格，不可隨意變換；

4.命名應(yīng)該科學(xué)嚴(yán)謹(jǐn)，切勿太長(zhǎng)或者表達(dá)比較模糊；

5.命名中若使用特殊約定或縮寫(xiě)，則要有注釋說(shuō)明；

6.盡量不要使用中文字符和純數(shù)學(xué)字符，避免編碼錯(cuò)誤；

7.名字由英文字母、數(shù)字、下劃線組成，如abc，abc13和_abc等；

8.要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家基本可以理解的縮寫(xiě)；

9.同一軟件產(chǎn)品內(nèi)，應(yīng)規(guī)劃好接口部分(變量、結(jié)構(gòu)、函數(shù)及常量)的命名，防止編譯、鏈接時(shí)產(chǎn)生沖突。

2. 參考

類型	公有/外部成員	私有/內(nèi)部成員
模塊（module）	my_naming_convention	_my_naming_convention
包（package）	my_naming_convention
類（class）	MyNamingConvention	_MyNamingConvention
異常（Exception）	MyNamingConvention
函數(shù)（function）	my_naming_convention()	_my_naming_convention()
全局/類常量（constant）	MY_NAMING_CONVENTION	_MY_NAMING_CONVENTION
全局/類變量（variable）	my_naming_convention	_my_naming_convention

3. 縮寫(xiě)

命名應(yīng)當(dāng)盡量使用全拼寫(xiě)的單詞，縮寫(xiě)的情況有如下兩種：

常用的縮寫(xiě)，如XML、ID等，在命名時(shí)也應(yīng)只大寫(xiě)首字母，如XmlParser。
命名中含有長(zhǎng)單詞，對(duì)某個(gè)單詞進(jìn)行縮寫(xiě)。這時(shí)應(yīng)使用約定成俗的縮寫(xiě)方式。

例如：

function 縮寫(xiě)為 fn

text 縮寫(xiě)為 txt

object 縮寫(xiě)為 obj

count 縮寫(xiě)為 cnt

number 縮寫(xiě)為 num

4. 前導(dǎo)后綴下劃線

一個(gè)前導(dǎo)下劃線：表示非公有。
一個(gè)后綴下劃線：避免關(guān)鍵字沖突。
兩個(gè)前導(dǎo)下劃線：當(dāng)命名一個(gè)類屬性引起名稱沖突時(shí)使用。
兩個(gè)前導(dǎo)和后綴下劃線：“魔”（有特殊用圖）對(duì)象或者屬性，例如__init__或者_(dá)_file__。絕對(duì)不要?jiǎng)?chuàng)造這樣的名字，而只是使用它們。

注意：關(guān)于下劃線的使用存在一些爭(zhēng)議。