python的編碼規範是比較混亂的。python自己、第三方庫以及每個開發人員都沒有嚴格統一起來,五花八門的。python中我最反感的就是python的命名總是非常喜歡用一些單詞縮寫甚至用乙個字母來表示,如果是第一次見到這個名字很難猜到這個名字想要表達什麼意思,也不確定這個縮寫究竟是哪個單詞的縮寫。 python總是給我一種非常不重視可讀性的壞印象。
總的來數python的編碼規範和c的規範比較相似。
下面列舉一些比較重要的規範:
統一使用4個空格進行縮排,將ide中的tab用4個空格表示。
每行**不易過長,像pycharm中有一條分隔線,一行**超過分隔線使用反斜槓\換行
import語句應該放在檔案頭部,置於模組說明及docstring之後,於全域性變數之前
導入庫按組匯入,可以分為三組,每組使用空格分開:
標準庫匯入
第三方庫匯入 site-packages
本地模組
# 第一組:標準庫
import os
import sys
import json
# 第二組:第三方庫
import requests
import numpy
import pandas
# 第三組:本地模組
from
.models import ordermodel
包
名一般使用小寫字母,如果包名是多個單詞,可以再分成子包,也可以把所有單詞拼在一起作為乙個單詞
模組名全部使用小寫字母,如果有多個單詞可以直接不使用任何分隔符全部拼接在一起,也可以使用下劃線來分隔每個單詞
列名使用駝峰(camelcase)命名風格,私有類可用乙個下劃線開頭
函式名一律小寫,如有多個單詞,用下劃線隔開, 私有函式在函式前加乙個下劃線_
變數名盡量小寫, 如有多個單詞,用下劃線隔開
常量採用全大寫,如有多個單詞,使用下劃線隔開
注釋主要寫明函式,模組的功能,輸入引數和輸出返回值, 函式中如果使用了關鍵字引數一定要寫好都支援哪些關鍵字
func(arg1, arg2)
:"""在這裡寫函式的一句話總結(如: 計算平均值).
這裡是具體描述.
引數----------
arg1 : int
arg1的具體描述
arg2 : int
arg2的具體描述
返回值-------
int返回值的具體描述
"""
python命名規範
常量 常量名所有字母大寫,由下劃線連線各個單詞,如 white 0xffffff this is a constant 1 變數 1.普通變數 全部小寫,由下劃線連線各個單詞,如 1color white 2this is a variable 1 2.保護成員變數 單下劃線作字首,意思是只有類物件...
Python命名規範
常量 常量名所有字母大寫,由下劃線連線各個單詞,如 white 0xffffff this is a constant 1 變數 1.普通變數 全部小寫,由下劃線連線各個單詞,如 1color white 2this is a variable 1 2.保護成員變數 單下劃線作字首,意思是只有類物件...
python命名規範
常量 常量名所有字母大寫,由下劃線連線各個單詞,如 white 0xffffff this is a constant 1 變數 1.普通變數 全部小寫,由下劃線連線各個單詞,如 1color white 2this is a variable 1 2.保護成員變數 單下劃線作字首,意思是只有類物件...