Python命名規則

原文來自這裏: Naming Conventions

總的規則

  命名是給人看的,所以應該突出它的使用情況,而不是實現情況。也就是說,命名應該以問題爲導向。

命名風格

  b  單個小寫字母

  B  單個大寫字母

  lowercase  小寫情況

  lower_case_with_underscores 帶下劃線的小寫情況

  UPPERCASE  大寫情況

  UPPER_CASE_WITH_UNDERSCORES  帶下劃線的大寫情況

  CapitalizedWords  駝峯式

  mixedCase  混合情況,和駝峯式不同,首字母小寫

  Capitalized_Words_With_Underscores  帶下劃線的駝峯是結構

  _single_leading_underscore  以單下劃線開頭的變量,在from M import * 的時候不會被導入

  single_trailing_underscore_  以單下劃線結尾的變量,用來避免python中的關鍵字,如class_是避免class

  __double_leading_underscore  以雙下劃線開頭的變量,涉及到python中的名稱改正

  __double_leading_and_trailing_underscore__  以雙下劃線開始和結尾的變量,涉及到python中“魔術”對象和屬性,比如 __init__,__import__等

命名規則

避免使用的名字

小寫字母‘l’ 大寫字母‘O’,大寫字母‘I’ 爲了避免引起混亂,比如有的和數字1比較像,有的和數字0比較像。

ascii兼容性

必須和ascii兼容

包和模塊命名規則

包:package,模塊:module。 包是一個含有__init__的文件夾,模塊是一個.py結尾的文件。

模塊應該使用全部小寫的名字,當名字長的時候可以使用下劃線。包也是用小寫字母,但是並不鼓勵使用下劃線。

類名稱

類名應該使用駝峯式結構。

類變量名稱

PEP 484類變量使用短小的駝峯式結構,推薦添加後綴_co和_contra。

異常變量

異常屬於類,所以類當中使用的名稱適合異常,但是如果異常屬於錯誤,通常再後面加Error。

全局變量

和函數命名方法相同

函數和變量的名稱

函數應該使用小寫名稱,並且用下劃線隔開。變量命名和函數相同。有的時候使用混合結構即首字母小寫的駝峯式結構,爲了兼容一些代碼。

函數和方法的參數

方法是一種放在類中的函數。實例方法第一個參數爲self,類方法第一個參數爲cls。如果參數和關鍵字相同,後面加一個下劃線作爲後綴。,其它情況和變量命名相同。

方法和實例變量

實例變量是直接定義在類中的變量,不在任何方法中定義。

使用函數的規則:小寫字母並且用下劃線分開。當方法和實例變量不是公開的,前面加一個前綴_。

常量

全部大寫,多的話用下劃線隔開。

繼承的情況

 。。。未翻譯


公共和內部的接口

使用__all__來包含那些公共的接口,同樣,加前綴_,也表明這是一個內部接口。


總結一下,python當中除了類使用駝峯結構外,大部分變量,函數的命名都採用小寫字母然後用下劃線隔開的形式。










發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章