Python命名規範對于不同類型的資料有着一些細微的差別,總的來講有2個方面的命名要求,一方面是從命名字元要求方面來規範的,還有一方面是格式方面來規範的,此外還涉及到一些保留關鍵字我們不能單獨出現在命名中。下面來詳細聊聊。
一、錯誤的Python命名規範
1.命名隻能使用字母和_下劃線開頭-字元方面的要求
錯誤示例
def 5name():
pass
正确示例
def name():
pass
def _name():
pass
def _name5():
pass
2.Python命名不能出現空格-格式方面要求
def _na me5():
pass
三、Python命名不能使用保留關鍵字
了解這一點我們需要對一些保留關鍵詞進行了解:
and:并且辨析
as:重命名
assert:斷言
break:終止程式
class:類
continue:繼續
def:函數
del:删除
elif:條件判斷
else:否則
except:錯誤排除
finally:最終執行
for:循環
from:從......引入
False:錯誤、否、0,與True相反
global:全局
if:如果
import:引入
in:包含
is:是
lambda:抽象函數
nonlocal:外部嵌套函數内的變量
not:非
None:類似于空
or:或者關系
pass:直接跳過
raise:提升
return:傳回
try:錯誤調試
True:真,與False相反
while:循環
with:檔案卹
yield:疊代器
四、Python的規範命名方法
面對上面的各種命名不規範我們如何更好的解決這個問題呢?下面就來給大家介紹幾種比較常用的命名方法。這些方法是我個人總結的,不一定适合每個人,但是是我多年開發習慣養成的正确命名規則,希望對大家的學習有些幫助。
1. 普通變量命名
我一般使用一些比較簡單的方法:首先字母我喜歡小寫和數字來命名變量名,并且遵守見名知意的方法,如下面的幾個示例。
student_age = 18 # 學生年齡
student_name = 'Tom' # 學生姓名
上面兩個一般用于正式開發的時候使用,友善協同開發者快速了解程式,或者後期維護的時候能快速回憶起當初程式的含義。
dog2 = ''
dog3 = ''
上面兩個一般用于簡單的變量中,比如測試一些程式,或者講課中友善快速建構變量時使用。
2.類的命名
一般類的命名我習慣使用首字母大學的方法,如下面的代碼示例。
import abc
class Animal(object, metaclass=abc.ABCMeta):
@abc.abstractmethod
def test1(self):
pass
@abc.abstractclassmethod
def test2(cls):
pass
dog = Animal()
上面的命名方法在我們建構對象的時候能快速鎖定類的來源。
下面是我從網上找的一些命名方式,和我的很相似,大家可以借鑒一下:
- 子產品名盡量短小,并且全部使用小寫字母,不推薦使用下劃線。
- 類名采用單詞首字母大寫形式
- 子產品内部的類采用下劃線
- 函數、類的屬性和方法的命名規則同子產品類似,也是全部使用小寫字母,
- 常量命名時全部使用大寫字母,可以使用下劃線
文章來源:
http://www.wakey.com.cn/document-nominate.html