Python 基礎之代碼規範(三)

三、命名規範

1. 模塊

• 模塊儘量使用小寫命名，首字母保持小寫，儘量不要用下劃線(除非多個單詞，且數量不多的情況)

# 正確的模塊名
import decoder
import html_parser

# 不推薦的模塊名
import Decoder

2. 類名

• 類名使用駝峯(CamelCase)命名風格，首字母大寫，私有類可用一個下劃線開頭

class Farm():
    pass

class AnimalFarm(Farm):
    pass

class _PrivateFarm(Farm):
    pass

• 將相關的類和頂級函數放在同一個模塊裏. 不像Java, 沒必要限制一個類一個模塊.

3. 函數

• 函數名一律小寫，如有多個單詞，用下劃線隔開

def run():
    pass

def run_with_env():
    pass

• 私有函數在函數前加一個下劃線_

class Person():

    def _private_func():
        pass

4. 變量名

• 變量名儘量小寫, 如有多個單詞，用下劃線隔開

if __name__ == '__main__':
    count = 0
    school_name = ''

• 常量採用全大寫，如有多個單詞，使用下劃線隔開

MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600

5. 常量

• 常量使用以下劃線分隔的大寫命名

MAX_OVERFLOW = 100

Class FooBar:

    def foo_bar(self, print_):
        print(print_)