Python代碼規范和命名規范

Python代碼規范和命名規范

[e-mail]

http://www.cnblogs.com/swje/

作者：Zhouwan

 2018-4-1

Python之父Guido推薦命名規范包括如下幾點：

1.文件名、模塊名和包名采用小寫字母並且以下划線分隔單詞的形式；

　　如:regex_syntax,py_compile,_winreg

2.類名或異常名采用每個單詞首字母大寫的方式

　　 如：BaseServer,ForkingMixIn,KeyboardInterrupt

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

3.全局或者類常量，全部使用大寫字母，並且以下划線分隔單詞；

　　 如：MAX_LOAD

4.其余變量命名包括方法名，函數名，普通變量名則是采用全部小寫字母，並且以下划線分隔單詞的形式命名。

　　如：my_thread

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

5.以上的內容如果是內部的，則使用下划線開頭命名。

　　如：__init__,__new__ 參考：

 

1、編碼

• 如無特殊情況, 文件一律使用 UTF-8 編碼
• 如無特殊情況, 文件頭部必須加入#-*-coding:utf-8-*-標識

2、引號

簡單說，自然語言使用雙引號，機器標示使用單引號，因此 代碼里 多數應該使用 單引號

• 自然語言 使用雙引號 "..."
  例如錯誤信息；很多情況還是 unicode，使用u"你好世界"
• 機器標識 使用單引號 '...'
  例如 dict 里的 key
• 正則表達式 使用原生的雙引號 r"..."
• 文檔字符串 (docstring) 使用三個雙引號 """......"""

3、空行

• 模塊級函數和類定義之間空兩行；
• 類成員函數之間空一行；

class A:

    def __init__(self):
        pass

    def hello(self):
        pass

def main():
    pass

• 可以使用多個空行分隔多組相關的函數
• 函數中可以使用空行分隔出邏輯相關的代碼

其他代碼規范詳見https://blog.csdn.net/warm77/article/details/78353632

 

參考：https://blog.csdn.net/it_dream_er/article/details/51999302