本文轉(zhuǎn)自：http://www.blogjava.net/lincode/archive/2011/02/02/343859.html

Python 的代碼風(fēng)格由 PEP 8 描述。這個(gè)文檔描述了 Python 編程風(fēng)格的方方面面。在遵守這個(gè)文檔的條件下，不同程序員編寫的 Python 代碼可以保持最大程度的相似風(fēng)格。這樣就易于閱讀，易于在程序員之間交流。

1 變量

常量 : 大寫加下劃線

USER_CONSTANT
對(duì)于不會(huì)發(fā)生改變的全局變量，使用大寫加下劃線。

私有變量 : 小寫和一個(gè)前導(dǎo)下劃線
_private_value
Python 中不存在私有變量一說(shuō)，若是遇到需要保護(hù)的變量，使用小寫和一個(gè)前導(dǎo)下劃線。但這只是程序員之間的一個(gè)約定，用于警告說(shuō)明這是一個(gè)私有變量，外部類不要去訪問(wèn)它。但實(shí)際上，外部類還是可以訪問(wèn)到這個(gè)變量。

內(nèi)置變量 : 小寫，兩個(gè)前導(dǎo)下劃線和兩個(gè)后置下劃線
__class__
兩個(gè)前導(dǎo)下劃線會(huì)導(dǎo)致變量在解釋期間被更名。這是為了避免內(nèi)置變量和其他變量產(chǎn)生沖突。用戶定義的變量要嚴(yán)格避免這種風(fēng)格。以免導(dǎo)致混亂。

2 函數(shù)和方法

總體而言應(yīng)該使用，小寫和下劃線。但有些比較老的庫(kù)使用的是混合大小寫，即首單詞小寫，之后每個(gè)單詞第一個(gè)字母大寫，其余小寫。但現(xiàn)在，小寫和下劃線已成為規(guī)范。

私有方法 ： 小寫和一個(gè)前導(dǎo)下劃線
def _secrete(self):
print "don't test me."
這里和私有變量一樣，并不是真正的私有訪問(wèn)權(quán)限。同時(shí)也應(yīng)該注意一般函數(shù)不要使用兩個(gè)前導(dǎo)下劃線(當(dāng)遇到兩個(gè)前導(dǎo)下劃線時(shí)，Python 的名稱改編特性將發(fā)揮作用)。特殊函數(shù)后面會(huì)提及。

特殊方法 ： 小寫和兩個(gè)前導(dǎo)下劃線，兩個(gè)后置下劃線

def __add__(self, other):
return int.__add__(other)
這種風(fēng)格只應(yīng)用于特殊函數(shù)，比如操作符重載等。

函數(shù)參數(shù) : 小寫和下劃線，缺省值等號(hào)兩邊無(wú)空格

def connect(self, user=None):
self._user = user

3 類

類總是使用駝峰格式命名，即所有單詞首字母大寫其余字母小寫。類名應(yīng)該簡(jiǎn)明，精確，并足以從中理解類所完成的工作。常見(jiàn)的一個(gè)方法是使用表示其類型或者特性的后綴，例如:
SQLEngine
MimeTypes

對(duì)于基類而言，可以使用一個(gè) Base 或者 Abstract 前綴
BaseCookie
AbstractGroup

class UserProfile(object):
def __init__(self, profile):
return self._profile = profile

def profile(self):
return self._profile

4 模塊和包

除特殊模塊 __init__ 之外，模塊名稱都使用不帶下劃線的小寫字母。
若是它們實(shí)現(xiàn)一個(gè)協(xié)議，那么通常使用lib為后綴，例如:
import smtplib

import os
import sys

5 關(guān)于參數(shù)

5.1 不要用斷言來(lái)實(shí)現(xiàn)靜態(tài)類型檢測(cè)
斷言可以用于檢查參數(shù)，但不應(yīng)僅僅是進(jìn)行靜態(tài)類型檢測(cè)。 Python 是動(dòng)態(tài)類型語(yǔ)言，靜態(tài)類型檢測(cè)違背了其設(shè)計(jì)思想。斷言應(yīng)該用于避免函數(shù)不被毫無(wú)意義的調(diào)用。

5.2 不要濫用 *args 和 **kwargs
*args 和 **kwargs 參數(shù)可能會(huì)破壞函數(shù)的健壯性。它們使簽名變得模糊，而且代碼常常開(kāi)始在不應(yīng)該的地方構(gòu)建小的參數(shù)解析器。

6 其他

6.1 使用 has 或 is 前綴命名布爾元素

is_connect = True
has_member = False

6.2 用復(fù)數(shù)形式命名序列

members = ['user_1', 'user_2']

6.3 用顯式名稱命名字典

person_address = {'user_1':'10 road WD', 'user_2' : '20 street huafu'}

6.4 避免通用名稱
諸如 list, dict, sequence 或者 element 這樣的名稱應(yīng)該避免。

6.5 避免現(xiàn)有名稱
諸如 os, sys 這種系統(tǒng)已經(jīng)存在的名稱應(yīng)該避免。

7 一些數(shù)字
一行列數(shù) : PEP 8 規(guī)定為 79 列，這有些苛刻了。根據(jù)自己的情況，比如不要超過(guò)滿屏?xí)r編輯器的顯示列數(shù)。這樣就可以在不動(dòng)水平游標(biāo)的情況下，方便的查看代碼。

一個(gè)函數(shù) : 不要超過(guò) 30 行代碼, 即可顯示在一個(gè)屏幕類，可以不使用垂直游標(biāo)即可看到整個(gè)函數(shù)。
一個(gè)類 : 不要超過(guò) 200 行代碼，不要有超過(guò) 10 個(gè)方法。
一個(gè)模塊 不要超過(guò) 500 行。

8 驗(yàn)證腳本

可以安裝一個(gè) pep8 腳本用于驗(yàn)證你的代碼風(fēng)格是否符合 PEP8。

http://pypi.python.org/pypi/pep8/#downloads

>>easy_install pep8

>>pep8 -r --ignore E501 Test.py

這個(gè)命令行的意思是，重復(fù)打出錯(cuò)誤，并且忽略 501 錯(cuò)誤(代碼超過(guò) 79 行)。

Ubuntu上的安裝可以用命令

sudo apt-get install pep8

總結(jié)

以上是生活随笔為你收集整理的Python 代码风格 和 PEP8【转】的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。