python 编码规范
?
縮進(jìn)
用4個(gè)空格來(lái)縮進(jìn)代碼
?
分號(hào)
不要在行尾加分號(hào), 也不要用分號(hào)將兩條命令放在同一行。
行長(zhǎng)度
每行不超過(guò)80個(gè)字符
以下情況除外：
l?長(zhǎng)的導(dǎo)入模塊語(yǔ)句
l?注釋里的URL
不要使用反斜杠連接行。
Python會(huì)將?圓括號(hào), 中括號(hào)和花括號(hào)中的行隱式的連接起來(lái)?, 你可以利用這個(gè)特點(diǎn). 如果需要, 你可以在表達(dá)式外圍增加一對(duì)額外的圓括號(hào)。
?
?
?
?
命名規(guī)范
避免的情況：
?
命名約定
?
PEP8 命名:
?
Python之父Guido推薦的規(guī)范
(所謂"內(nèi)部(Internal)"表示僅模塊內(nèi)可用, 或者, 在類(lèi)內(nèi)是保護(hù)或私有的
| Type | Public | Internal |
| Modules | lower_with_under | _lower_with_under |
| Packages | lower_with_under | ? |
| Classes | CapWords | _CapWords |
| Exceptions | CapWords | ? |
| Functions | lower_with_under() | _lower_with_under() |
| Global/Class Constants | CAPS_WITH_UNDER | _CAPS_WITH_UNDER |
| Global/Class Variables | lower_with_under | _lower_with_under |
| Instance Variables | lower_with_under | _lower_with_under (protected) or __lower_with_under (private) |
| Method Names | lower_with_under() | _lower_with_under() (protected) or __lower_with_under() (private) |
| Function/Method Parameters | lower_with_under | ? |
| Local Variables | lower_with_under | ? |
?
?
注釋
確保對(duì)模塊, 函數(shù), 方法和行內(nèi)注釋使用正確的風(fēng)格
文檔字符串
Python有一種獨(dú)一無(wú)二的的注釋方式: 使用文檔字符串. 文檔字符串是包, 模塊, 類(lèi)或函數(shù)里的第一個(gè)語(yǔ)句. 這些字符串可以通過(guò)對(duì)象的__doc__成員被自動(dòng)提取, 并且被pydoc所用. (你可以在你的模塊上運(yùn)行pydoc試一把, 看看它長(zhǎng)什么樣). 我們對(duì)文檔字符串的慣例是使用三重雙引號(hào)"""(?PEP-257?). 一個(gè)文檔字符串應(yīng)該這樣組織: 首先是一行以句號(hào), 問(wèn)號(hào)或驚嘆號(hào)結(jié)尾的概述(或者該文檔字符串單純只有一行). 接著是一個(gè)空行. 接著是文檔字符串剩下的部分, 它應(yīng)該與文檔字符串的第一行的第一個(gè)引號(hào)對(duì)齊. 下面有更多文檔字符串的格式化規(guī)范.
函數(shù)和方法
下文所指的函數(shù),包括函數(shù), 方法, 以及生成器.
一個(gè)函數(shù)必須要有文檔字符串, 除非它滿足以下條件:
l?外部不可見(jiàn)
l?非常短小
l?簡(jiǎn)單明了
文檔字符串：
應(yīng)該包含函數(shù)做什么, 以及輸入和輸出的詳細(xì)描述. 通常, 不應(yīng)該描述"怎么做", 除非是一些復(fù)雜的算法. 文檔字符串應(yīng)該提供足夠的信息, 當(dāng)別人編寫(xiě)代碼調(diào)用該函數(shù)時(shí), 他不需要看一行代碼, 只要看文檔字符串就可以了. 對(duì)于復(fù)雜的代碼, 在代碼旁邊加注釋會(huì)比使用文檔字符串更有意義.
關(guān)于函數(shù)的幾個(gè)方面應(yīng)該在特定的小節(jié)中進(jìn)行描述記錄， 這幾個(gè)方面如下文所述. 每節(jié)應(yīng)該以一個(gè)標(biāo)題行開(kāi)始. 標(biāo)題行以冒號(hào)結(jié)尾. 除標(biāo)題行外, 節(jié)的其他內(nèi)容應(yīng)被縮進(jìn)2個(gè)空格.
Args:
列出每個(gè)參數(shù)的名字, 并在名字后使用一個(gè)冒號(hào)和一個(gè)空格, 分隔對(duì)該參數(shù)的描述.如果描述太長(zhǎng)超過(guò)了單行80字符,使用2或者4個(gè)空格的懸掛縮進(jìn)(與文件其他部分保持一致). 描述應(yīng)該包括所需的類(lèi)型和含義. 如果一個(gè)函數(shù)接受*foo(可變長(zhǎng)度參數(shù)列表)或者**bar (任意關(guān)鍵字參數(shù)), 應(yīng)該詳細(xì)列出*foo和**bar.
Returns: (或者 Yields: 用于生成器)
描述返回值的類(lèi)型和語(yǔ)義. 如果函數(shù)返回None, 這一部分可以省略.
Raises:
列出與接口有關(guān)的所有異常.
示例：
def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):
????"""Fetches rows from a Bigtable.
?
????Retrieves rows pertaining to the given keys from the Table instance
????represented by big_table. ?Silly things may happen if
????other_silly_variable is not None.
?
????Args:
????????big_table: An open Bigtable Table instance.
????????keys: A sequence of strings representing the key of each table row
????????????to fetch.
????????other_silly_variable: Another optional variable, that has a much
????????????longer name than the other args, and which does nothing.
?
????Returns:
????????A dict mapping keys to the corresponding table row data
????????fetched. Each row is represented as a tuple of strings. For
????????example:
?
????????{'Serak': ('Rigel VII', 'Preparer'),
?????????'Zim': ('Irk', 'Invader'),
?????????'Lrrr': ('Omicron Persei 8', 'Emperor')}
?
????????If a key from the keys argument is missing from the dictionary,
????????then that row was not found in the table.
?
????Raises:
????????IOError: An error occurred accessing the bigtable.Table object.
????"""
????pass
?
類(lèi)
類(lèi)應(yīng)該在其定義下有一個(gè)用于描述該類(lèi)的文檔字符串. 如果你的類(lèi)有公共屬性(Attributes), 那么文檔中應(yīng)該有一個(gè)屬性(Attributes)段. 并且應(yīng)該遵守和函數(shù)參數(shù)相同的格式.
示例：
class SampleClass(object):
????"""Summary of class here.
?
????Longer class information....
????Longer class information....
?
????Attributes:
????????likes_spam: A boolean indicating if we like SPAM or not.
????????eggs: An integer count of the eggs we have laid.
????"""
?
????def __init__(self, likes_spam=False):
????????"""Inits SampleClass with blah."""
????????self.likes_spam = likes_spam
????????self.eggs = 0
?
????def public_method(self):
????????"""Performs operation blah."""
?
塊注釋和行注釋
最需要寫(xiě)注釋的是代碼中那些技巧性的部分. 如果你在下次?代碼審查?的時(shí)候必須解釋一下, 那么你應(yīng)該現(xiàn)在就給它寫(xiě)注釋. 對(duì)于復(fù)雜的操作, 應(yīng)該在其操作開(kāi)始前寫(xiě)上若干行注釋. 對(duì)于不是一目了然的代碼, 應(yīng)在其行尾添加注釋.
# We use a weighted dictionary search to find out where i is in
# the array. ?We extrapolate position based on the largest num
# in the array and the array size and then do binary search to
# get the exact number.
?
if i & (i-1) == 0: ???????# true if i is a power of 2
為了提高可讀性, 注釋?xiě)?yīng)該至少離開(kāi)代碼2個(gè)空格.
?
模塊導(dǎo)入
Import 語(yǔ)句應(yīng)該按順序劃分成三個(gè)部分，分別表示標(biāo)準(zhǔn)庫(kù)模塊，第三方模塊及自用模塊，在每個(gè)部分中，各import語(yǔ)句應(yīng)該按模塊的字母順序來(lái)排列
其他建議
?
類(lèi)
如果一個(gè)類(lèi)不繼承自其它類(lèi), 就顯式的從object繼承. 嵌套類(lèi)也一樣
繼承自?object?是為了使屬性(properties)正常工作, 并且這樣可以保護(hù)你的代碼, 使其不受Python 3000的一個(gè)特殊的潛在不兼容性影響. 這樣做也定義了一些特殊的方法, 這些方法實(shí)現(xiàn)了對(duì)象的默認(rèn)語(yǔ)義, 包括?__new__, __init__, __delattr__, __getattribute__, __setattr__, __hash__, __repr__, and __str__?
?
字符串
避免在大循環(huán)中用+和+=拼接字符串，這樣做會(huì)創(chuàng)建不必要的臨時(shí)對(duì)象，且會(huì)使得代碼運(yùn)行時(shí)間以二次方增長(zhǎng)，作為替代方案, 你可以將每個(gè)子串加入列表, 然后在循環(huán)結(jié)束后用?.join?連接列表.?
?
?
使用with語(yǔ)句
為了確保文件句柄能在不用時(shí)關(guān)閉，請(qǐng)使用with...as語(yǔ)句
with open("hello.txt") as hello_file:
????for line in hello_file:
????????print line?
轉(zhuǎn)載于:https://www.cnblogs.com/linyihai/p/8671606.html
總結(jié)
以上是生活随笔為你收集整理的python 编码规范的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇： 数据结构与算法 —— 链表linked
- 下一篇： Pythonic---------详细讲