python項目命名規范

參考博客：

python代碼規范和命名規范

https://blog.csdn.net/warm77/article/details/78353632

python編程規范

https://blog.csdn.net/gzlaiyonghao/article/details/2834883?utm_medium=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.nonecase&depth_1-utm_source=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.nonecase

 

首先注意避免的名字

永遠不要使用字母‘l’（小寫的L），‘O’（大寫的O），或者‘I’（大寫的I）作為單字符變量名。
在有些字體里，這些字符無法和數字0和1區分，如果想用‘l’，用‘L’代替。

1.項目名

例如01_python基礎，My_project

2.模塊名

模塊盡量使用小寫命名，首字母保持小寫，盡量不要用下划線(除非多個單詞，且數量不多的情況)（加入下划線可改善可讀性）

# 正確的模塊名
import decoder
import html_parser
 
# 不推薦的模塊名
import Decoder

3.包名

和模塊名的規范相同

4.類名

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

class Farm():
    pass
 
class AnimalFarm(Farm):
    pass
 
class _PrivateFarm(Farm):
    pass

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

在接口被文檔化並且主要被用於調用的情況下，可以使用函數的命名風格代替。
注意，對於內置的變量命名有一個單獨的約定：大部分內置變量是單個單詞（或者兩個單詞連接在一起），首字母大寫的命名法只用於異常名或者內部的常量。

5.函數名&方法

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

def run():
    pass
 
def run_with_env():
    pass

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

class Person():
 
    def _private_func():
        pass

類內部函數命名，用單下划線(_)開頭（該函數可被繼承訪問）

類內私有函數命名，用雙下划線(__)開頭（該函數不可被繼承訪問）

*注意*：混合大小寫僅被允許用於這種風格已經占據優勢的時候，以便保持向后兼容。

6.變量名

變量名盡量小寫, 如有多個單詞，用下划線隔開

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

常量采用全大寫，如有多個單詞，使用下划線隔開

MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600

*注意*：

1.不論是類成員變量還是全局變量，均不使用 m 或 g 前綴。
2.私有類成員使用單一下划線前綴標識，多定義公開成員，少定義私有成員。
3.變量名不應帶有類型信息，因為Python是動態類型語言。如 iValue、names_list、dict_obj 等都是不好的命名。

7.常量

常量使用以下划線分隔的全大寫命名

MAX_OVERFLOW = 100
 
Class FooBar:
 
    def foo_bar(self, print_):
        print(print_)

8.異常

以“Error”作為后綴。

因為異常一般都是類，所有類的命名方法在這里也適用。然而，你需要在異常名后面加上“Error”后綴（如果異常確實是一個錯誤）。

 

附:Google Python命名規范

module_name

package_name

ClassName

method_name

ExceptionName

function_name

GLOBAL_VAR_NAME

instance_var_name

function_parameter_name

local_var_name