命名規范

應該避免的名稱

以下命名應該盡量避免

  • 單字符名稱, 除了計數器和迭代器.
if __name__ == '__main__':
    # 不推薦的寫法
    # 盡量避免單字符變量名
    s = "hello world!"
  • 包/模塊名中的連字符(-)
# 錯誤的包名
# 引用文件 html-parser.py
import html-parser

# 正確的寫法
# 文件名應為 html_parser.py
import html_parser
  • 雙下劃線開頭并結尾的名稱(Python保留, 例如__init__)
  • 應避免使用小寫字母l(L),大寫字母O(o)或I(i)單獨作為一個變量的名稱,以區分數字1和0
if __name__ == '__main__':
    # 不推薦的寫法
    # 盡量避免l、O 等容易混淆的字母
    l = 1
    O = 0
    l = (O + 1)*l
  • 當參數名稱和Python保留字沖突,可在最后添加一個下劃線,而不是使用縮寫或自造的詞
# 如果變量名和python保留字沖突,則在末尾添加下劃線
# 切記不要自己造詞,或者使用縮寫
def print_():
    ... ...

if __name__ == '__main__':
    str_ = "hello world!"
    print_(str_)

命名約定

模塊

  • 模塊盡量使用小寫命名,首字母保持小寫,盡量不要用下劃線(除非多個單詞,且數量不多的情況)
# 正確的模塊名
import decoder
import html_parser

# 不推薦的模塊名
import Decoder

類名

  • 類名使用駝峰(CamelCase)命名風格,首字母大寫,私有類可用一個下劃線開頭
class Farm():
    pass

class AnimalFarm(Farm):
    pass

class _PrivateFarm(Farm):
    pass
  • 將相關的類和頂級函數放在同一個模塊里. 不像Java, 沒必要限制一個類一個模塊.

函數

  • 函數名一律小寫,如有多個單詞,用下劃線隔開
def run():
    pass

def run_with_env():
    pass
  • 私有函數在函數前加一個下劃線_
class Person():

    def _private_func():
        pass

變量名

  • 變量名盡量小寫, 如有多個單詞,用下劃線隔開
if __name__ == '__main__':
    count = 0
    school_name = ''
  • 常量采用全大寫,如有多個單詞,使用下劃線隔開
MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • 1、引言 數據庫設計過程中表、字段等的命名規范也算是設計規范的一部分,不過設計規范更多的是為了確保數據庫設計的合理...
    SnowflakeCloud閱讀 41,086評論 0 48
  • 還記得剛開始coding的時候,命名都是漢語拼音,所以有的時候想看懂它的意思,就要讀一遍甚至好幾遍才知道,這還是在...
    leo62閱讀 9,021評論 2 19
  • python 中變量的命名規范 模塊名: 小寫字母,單詞之間用_分割 ad_stats.py 包名: 和模塊名一樣...
    步_塵閱讀 2,526評論 0 0
  • 序:團隊開發有一套自己的命名規范,方便大家review和code,今天我總結一下,后面有需要用到的,可以直接按這套...
    tomatozheng閱讀 2,389評論 0 1
  • [TOC] 說明 python源碼和其他一些書籍,命名各種個性,沒有一個比較統一的命名規范。于是總結了一些,供參考...
    木貓尾巴閱讀 64,443評論 0 22