Python 命名規(guī)范與最佳實踐
更新時間：2025年03月17日 09:44:39 作者：燃燈工作室
本文介紹了Python命名規(guī)范與最佳實踐,包括變量名、模塊名、類名、函數(shù)名和常量名的命名規(guī)則,強調了命名的清晰性、一致性、科學性和避免使用特殊符號,感興趣的朋友一起看看吧
1. 規(guī)范
1.變量名區(qū)分大小寫；
2.嚴禁使用關鍵字作為變量名；
3.確定自己的命名風格，不可隨意變換；
4.命名應該科學嚴謹，切勿太長或者表達比較模糊；
5.命名中若使用特殊約定或縮寫，則要有注釋說明；
6.盡量不要使用中文字符和純數(shù)學字符，避免編碼錯誤；
7.名字由英文字母、數(shù)字、下劃線組成，如abc，abc13和_abc等；
8.要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫；
9.同一軟件產品內，應規(guī)劃好接口部分(變量、結構、函數(shù)及常量)的命名，防止編譯、鏈接時產生沖突。
2. 參考
| 類型 | 公有/外部成員 | 私有/內部成員 |
|---|---|---|
| 模塊（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ù)器和迭代器.
- 包/模塊名中的連字符(-)
- 雙下劃線開頭并結尾的名稱(Python 保留, 例如__init__)
到此這篇關于Python 命名規(guī)范與最佳實踐的文章就介紹到這了,更多相關Python 命名規(guī)范內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
在Python這門語言中，生成器毫無疑問是最有用的特性之一。與此同時，也是使用的最不廣泛的Python特性之一。究其原因，主要是因為，在其他主流語言里面沒有生成器的概念。本文將詳細介紹python迭代器與生成器2021-06-06
這篇文章主要介紹了django中添加日志功能，本文通過實例代碼給大家介紹的非常詳細，具有一定的參考借鑒價值,需要的朋友可以參考下2020-02-02
collections 是 Python 的一個內置模塊，所謂內置模塊的意思是指 Python 內部封裝好的模塊，無需安裝即可直接使用。本文將詳解介紹Collections的使用方式，需要的可以參考一下2022-03-03
Python腳本如何在bilibili中查找彈幕發(fā)送者
這篇文章主要介紹了如何在bilibili中查找彈幕發(fā)送者,本文給大家分享小編寫的一個python腳本來實現(xiàn)bilibili彈幕發(fā)送者，需要的朋友可以參考下2020-06-06
這篇文章主要介紹了使用Python+Appuim 清理微信,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-01-01
在Python程序和Flask框架中使用SQLAlchemy的教程
SQLAlchemy為Python程序與SQL語句之間建立了映射,是Python操作數(shù)據(jù)庫的利器,這里我們將來看在Python程序和Flask框架中使用SQLAlchemy的教程,需要的朋友可以參考下2016-06-06
這篇文章主要介紹了python中的全局變量用法,詳細分析了Python全局變量使用中的利弊與相關技巧,需要的朋友可以參考下2015-06-06
工作需要,查詢某一行中的最大值及其索引,本文主要介紹了pandas求行最大值及其索引的實現(xiàn),具有一定的參考價值,感興趣的可以了解一下2024-04-04
本文介紹Python-Selenium自動化爬蟲,Selenium是一個Web的自動化測試工具，最初是為網(wǎng)站自動化測試而開發(fā)的，Selenium?可以直接運行在瀏覽器上,它支持所有主流的瀏覽器,可以接收指令,讓瀏覽器自動加載頁面,獲取需要的數(shù)據(jù),甚至頁面截屏,xiamian?neir?需要的朋友可以參考下2022-01-01
下面小編就為大家?guī)硪黄狿ython裝飾器實現(xiàn)幾類驗證功能做法實例。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-05-05