通常,編碼格式聲明是必要的。如果python源文件沒有聲明編碼格式,python解釋器默認使用ASCII編碼,壹旦源文件包含非ASCII編碼的字符,python解釋器就會報錯。以UTF-8為例,以下兩種編碼格式聲明符合規則。
縮回
使用4個空格縮進。永遠不要使用制表符,也不要把制表符和空格混在壹起。對於行連接的情況,我通常使用4個空格的懸掛縮進。例如:
引用
自然語言使用雙引號。
使用單引號進行機器識別。
正則表達式使用雙引號。
空行
編碼格式聲明、模塊導入、常量和全局變量聲明、頂層定義和執行代碼之間有兩行空行。
頂級定義之間有兩個空行,方法定義之間有壹個空行。
在壹個函數或方法中,可以在必要的地方留白,以增強節奏感,但應該避免連續的空行。
導入模塊
導入應該總是放在文件的頂部,模塊註釋和文檔字符串之後,模塊全局變量和常量之前。進口應按從最常見到最不常見的順序分組,各組之間有壹個空行。
標準庫導入
第三方庫的導入
應用程序指定的導入
命名規範
盡量使用小寫的模塊名,保持首字母小寫,盡量不要加下劃線。
類名以CamelCase風格命名,首字母大寫。私有類可以以下劃線開頭。
函數名都是小寫的。如果有多個單詞,用下劃線分隔。
私有函數可以以下劃線開頭。
變量名應該盡可能小寫。如果有多個單詞,用下劃線分隔。
常數都是大寫的。如果有多個單詞,使用下劃線將它們分開。