python編程規(guī)范和tip

一、分號

拋棄語句末的分號,也意味著一行不允許寫倆個語句

二、空:空格、空行、縮進(jìn)

  1. 使用四個空格來縮進(jìn)

  2. 一個語句寫成多行的時候,第二行要么懸掛縮進(jìn),要么四個空格

  3. 類方法間一個空行,類或全局函數(shù)之間兩個空行

  4. 『:』、『,』后邊有一個空格

  5. 雙目運算符左右各一個空格

三、注釋:

  1. 文件聲明必須用"""的方式,格式如下,包括版權(quán)聲明、功能介紹、作者聯(lián)系方式、時間

[圖片上傳中...(image-119efd-1656486236250-1)]

  1. 對外接口必須使用docstring,包括功能、輸入?yún)?shù)及返回值語義、可能拋出的異常

[圖片上傳中...(image-1fa4a3-1656486236250-0)]

  1. 內(nèi)部借口自行選擇,盡量有必須使用docstring。

四、包引用

  1. 禁止只導(dǎo)入某一個函數(shù)或者類

  2. 每行只寫一個庫

  3. 自上而下的導(dǎo)入順序分為:標(biāo)準(zhǔn)庫、第三方庫、自建庫

五、標(biāo)識符

  1. 局部變量全部小寫

  2. 全局變量全部大寫

  3. 變量的單詞間用_,函數(shù)的單詞間才駝峰(首字母大寫)

六、函數(shù)

  1. 僅可以把基本類型作為輸入?yún)?shù)的默認(rèn)值

  2. 構(gòu)造函數(shù)如果復(fù)雜就定義一個init方法

  3. protected變量/方法明明為_abc,private變量命名為__abc,在被import時不會被導(dǎo)入

  4. 必須有基類,沒有的話就object

七、異常

  1. 禁止使用雙參數(shù)方式或者字符型式拋出異常(那怎么拋呢?)

  2. 盡量指catch自定義異常,除非再次拋出異常否則不允許catch全部異常

  3. 禁止使用excapt XXX,e而是使用xcapt XXX as e

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容