Python 命名規(guī)范與最佳實踐
更新時間：2025年03月17日 09:44:39 作者：燃燈工作室
本文介紹了Python命名規(guī)范與最佳實踐,包括變量名、模塊名、類名、函數(shù)名和常量名的命名規(guī)則,強調(diào)了命名的清晰性、一致性、科學性和避免使用特殊符號,感興趣的朋友一起看看吧
1. 規(guī)范
1.變量名區(qū)分大小寫；
2.嚴禁使用關鍵字作為變量名；
3.確定自己的命名風格，不可隨意變換；
4.命名應該科學嚴謹，切勿太長或者表達比較模糊；
5.命名中若使用特殊約定或縮寫，則要有注釋說明；
6.盡量不要使用中文字符和純數(shù)學字符，避免編碼錯誤；
7.名字由英文字母、數(shù)字、下劃線組成，如abc，abc13和_abc等；
8.要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫；
9.同一軟件產(chǎn)品內(nèi)，應規(guī)劃好接口部分(變量、結(jié)構(gòu)、函數(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. 縮寫
命名應當盡量使用全拼寫的單詞，縮寫的情況有如下兩種：
常用的縮寫，如XML、ID等，在命名時也應只大寫首字母，如XmlParser。
命名中含有長單詞，對某個單詞進行縮寫。這時應使用約定成俗的縮寫方式。
例如：
function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num
4. 前導后綴下劃線
- 一個前導下劃線：表示非公有。
- 一個后綴下劃線：避免關鍵字沖突。
- 兩個前導下劃線：當命名一個類屬性引起名稱沖突時使用。
- 兩個前導和后綴下劃線：“魔”（有特殊用圖）對象或者屬性，例如__init__或者__file__。絕對不要創(chuàng)造這樣的名字，而只是使用它們。
注意：關于下劃線的使用存在一些爭議。
5. 應該避免的名稱
- 單字母名稱, 除了計數(shù)器和迭代器.
- 包/模塊名中的連字符(-)
- 雙下劃線開頭并結(jié)尾的名稱(Python 保留, 例如__init__)
到此這篇關于Python 命名規(guī)范與最佳實踐的文章就介紹到這了,更多相關Python 命名規(guī)范內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
jupyter-lab設置自啟動及遠程連接開發(fā)環(huán)境
本文主要介紹了jupyter-lab設置自啟動及遠程連接開發(fā)環(huán)境，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-02-02
Python實現(xiàn)判斷變量是否是函數(shù)方式
這篇文章主要介紹了Python實現(xiàn)判斷變量是否是函數(shù)方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-02-02
這篇文章主要介紹了python數(shù)字圖像處理之骨架提取與分水嶺算法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-04-04
Python 進程調(diào)用(subprocess)的實現(xiàn)
在Python編程中,subprocess庫是一個功能強大的工具,它允許我們創(chuàng)建新進程、連接到其輸入/輸出/錯誤管道,并獲取其返回代碼,下面就來詳細的介紹一下,感興趣的可以了解一下2025-10-10
這篇文章主要介紹了Python PO設計模式的具體使用，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-08-08
這篇文章主要為大家介紹了Python進程和守護進程，具有一定的參考價值，感興趣的小伙伴們可以參考一下，希望能夠給你帶來幫助2021-12-12
當我們想要執(zhí)行一個?py?文件的時候，只需要在命令行中輸入?python?xxx.py?即可，但你有沒有想過這背后的流程是怎樣的呢？本文主要賀和大家來聊聊Python中的字節(jié)碼，感興趣的可以了解一下2022-12-12
python中實現(xiàn)php的var_dump函數(shù)功能
這篇文章主要介紹了python中實現(xiàn)php的var_dump函數(shù)功能,var_dump函數(shù)在PHP中調(diào)試時非常實用,本文介紹在Python中實現(xiàn)這個函數(shù),需要的朋友可以參考下2015-01-01
這篇文章主要為大家詳細介紹了python實現(xiàn)批量移動文件，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-04-04
這篇文章介紹了Django框架中表單的用法，文中通過示例代碼介紹的非常詳細。對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-06-06