1. 程式人生 > 其它 >[Python]編碼規範性(五)——命名(包和模組、類、函式)

[Python]編碼規範性(五)——命名(包和模組、類、函式)

命名規範推薦

  • Packages:lower_with_under
  • Modules:lower_with_under
  • Class:CapWords(UpperCamelCase)
  • Exceptions:CapWords
  • Functions:lower_with_under()
  • Global/Class Constants:CAPS_WITH_UNDER
  • Global/Class Variables:lower_with_under
  • Instance Variables:lower_with_under
  • Method Names:lower_with_under()
  • Function/Method Parameters
    :lower_with_under
  • Local Variables:lower_with_under

包和模組:

(必須遵守)(規則):

1、包(Packages)、模組(Module)名使用意義完整的英文描述,採用小寫加下劃線(lower_with_under)的風格命名;

說明:模組應該用小寫加下劃線的方式(如:lower_with_under.py)命名;

儘管很多現存的模組使用類似於CapWords.py這樣的命名,但現在已經不鼓勵這樣做,因為如果模組名碰巧和類名一致,這會讓人產生困擾;

類:

(必須遵守)(規則):

類(Class)名使用意義完整的英文描述,採用大寫字母開頭的單詞(CapWords)風格命名;

說明:類沿用面嚮物件語言最常用的CapWords風格命名——UpperCamelCase(大駝峰命名法)

示例:

Class SampleClass(object):
    pass

函式:

(必須遵守)(規則):

函式(Function)、方法(Method)、函式引數(Function Parameters)使用意義完整的英文描述,採用小寫加下劃線(lower_with_under)的風格命名;

說明:函式、方法採用小寫加下劃線的風格命名,與類名做區分;

函式採用小寫加下劃線的風格命名,與一般變數的命名風格保持一致;

模組內部使用的函式用單下劃線(_)開頭,表示函式是protected的(使用from module import *時不會包含);

def sample_public_function(sample_parameter):
    pass

def sample_internal_function(sample_parameter):
    pass

class SampleClass(object):
    def sample_member_method(self, sample_parameter):
        pass