PEP8 在python中的編碼規範

2021-10-01 02:05:54 字數 1923 閱讀 2059

**編排

縮排。4個空格的縮排(編輯器都可以完成此功能),不使用tap,更不能混合使用tap和空格。

每行最大長度79,換行可以使用反斜槓,最好使用圓括號。換行點要在操作符的後邊敲回車。

類和top-level函式定義之間空兩行;類中的方法定義之間空一行;函式內邏輯無關段落之間空一行;其他地方盡量不要再空行。

文件編排

模組內容的順序:模組說明和docstring—import—globals&constants—其他定義。其中import部分,又按標準、三方和自己編寫順序依次排放,之間空一行。

不要在一句import中多個庫,比如import os, sys不推薦。

如果採用from xx import xx引用庫,可以省略『module.』,都是可能出現命名衝突,這時就要採用import xx。

空格的使用

總體原則,避免不必要的空格。

各種右括號前不要加空格。

逗號、冒號、分號前不要加空格。

函式的左括號前不要加空格。如func(1)。

序列的左括號前不要加空格。如list[2]。

操作符左右各加乙個空格,不要為了對齊增加空格。

函式預設引數使用的賦值符左右省略空格。

不要將多句語句寫在同一行,儘管使用『;』允許。

if/for/while語句中,即使執行語句只有一句,也必須另起一行。

注釋

總體原則,錯誤的注釋不如沒有注釋。所以當一段**發生變化時,第一件事就是要修改注釋!注釋必須使用英文,最好是完整的句子,首字母大寫,句後要有結束符,結束符後跟兩個空格,開始下一句。如果是短語,可以省略結束符。

塊注釋,在一段**前增加的注釋。在『#』後加一空格。段落之間以只有『#』的行間隔。比如:

行注釋,在一句**後加注釋。比如:(但是這種方式盡量少使用)

x = x + 1 # increment x

避免無謂的注釋。

文件描述

為所有的共有模組、函式、類、方法寫docstrings;非共有的沒有必要,但是可以寫注釋(在def的下一行)。

如果docstring要換行,參考如下例子,詳見pep 257

「」"return a foobang

optional plotz says to frobnicate the bizbaz first.

「」"命名規範

總體原則,新編**必須按下面命名風格進行,現有庫的編碼盡量保持風格。

盡量單獨使用小寫字母『l』,大寫字母『o』等容易混淆的字母。

模組命名盡量短小,使用全部小寫的方式,可以使用下劃線。

包命名盡量短小,使用全部小寫的方式,不可以使用下劃線。

4.類的命名使用capwords的方式,模組內部使用的類採用_capwords的方式。

異常命名使用capwords+error字尾的方式。

全域性變數盡量只在模組內有效,類似c語言中的static。實現方法有兩種,一是all機制;二是字首乙個下劃線。

函式命名使用全部小寫的方式,可以使用下劃線。

常量命名使用全部大寫的方式,可以使用下劃線。

類的屬性(方法和變數)命名使用全部小寫的方式,可以使用下劃線。

類的屬性有3種作用域public、non-public和subclass api,可以理解成c++中的public、private、protected,non-public屬性前,字首一條下劃線。

類的屬性若與關鍵字名字衝突,字尾一下劃線,盡量不要使用縮略等其他方式。

為避免與子類屬性命名衝突,在類的一些屬性前,字首兩條下劃線。比如:類foo中宣告__a,訪問時,只能通過foo._foo__a,避免歧義。如果子類也叫foo,那就無能為力了。

類的方法第乙個引數必須是self,而靜態方法第乙個引數必須是cls。

Python的編碼規範PEP8

pep8 python 編碼規範 一 編排 1 縮排。4個空格的縮排 編輯器都可以完成此功能 不使用tap,更不能混合使用tap和空格。2 每行最大長度79,換行可以使用反斜槓,最好使用圓括號。換行點要在操作符的後邊敲回車。3 類和top level函式定義之間空兩行 類中的方法定義之間空一行 函式...

PEP8編碼規範

pep8 python 編碼規範 一 編排 1 縮排。4個空格的縮排 編輯器都可以完成此功能 不使用tap,更不能混合使用tap和空格。2 每行最大長度79,換行可以使用反斜槓,最好使用圓括號。換行點要在操作符的後邊敲回車。3 類和top level函式定義之間空兩行 類中的方法定義之間空一行 函式...

PEP8編碼規範

一 編排 1 縮排。4個空格的縮排 編輯器都可以完成此功能 不使用tap,更不能混合使用tap和空格。2 每行最大長度79,換行可以使用反斜槓,最好使用圓括號。換行點要在操作符的後邊敲回車。3 類和top level函式定義之間空兩行 類中的方法定義之間空一行 函式內邏輯無關段落之間空一行 其他地方...