命名規範

命名規格

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_)