前言

在Python社區(qū)文化的澆灌下，演化出了一種獨特的代碼風(fēng)格，去指導(dǎo)如何正確地使用Python，這就是常說的pythonic。一般說地道(idiomatic)的python代碼，就是指這份代碼很pythonic。Python的語法和標(biāo)準(zhǔn)庫設(shè)計，處處契合著pythonic的思想。而且Python社區(qū)十分注重編碼風(fēng)格一的一致性，他們極力推行和處處實踐著pythonic。所以經(jīng)常能看到基于某份代碼P vs NP (pythonic vs non-pythonic)的討論。pythonic的代碼簡練，明確，優(yōu)雅，絕大部分時候執(zhí)行效率高。閱讀pythonic的代碼能體會到“代碼是寫給人看的，只是順便讓機器能運行”暢快。

然而什么是pythonic，就像什么是地道的漢語一樣，切實存在但標(biāo)準(zhǔn)模糊。import this可以看到Tim Peters提出的Python之禪，它提供了指導(dǎo)思想。許多初學(xué)者都看過它，深深贊同它的理念，但是實踐起來又無從下手。PEP 8給出的不過是編碼規(guī)范，對于實踐pythonic還遠(yuǎn)遠(yuǎn)不夠。如果你正被如何寫出pythonic的代碼而困擾，或許這份筆記能給你幫助。

Raymond Hettinger是Python核心開發(fā)者，本文提到的許多特性都是他開發(fā)的。同時他也是Python社區(qū)熱忱的布道師，不遺余力地傳授pythonic之道。這篇文章是網(wǎng)友Jeff Paine整理的他在2013年美國的PyCon的演講的筆記。

術(shù)語澄清：本文所說的集合全都指collection，而不是set。

以下是正文。

本文是Raymond Hettinger在2013年美國PyCon演講的筆記(視頻, 幻燈片)。

示例代碼和引用的語錄都來自Raymond的演講。這是我按我的理解整理出來的，希望你們理解起來跟我一樣順暢！

遍歷一個范圍內(nèi)的數(shù)字

foriin[0,1,2,3,4,5]:

printi **2

foriinrange(6):

printi **2

更好的方法

foriinxrange(6):

printi **2

xrange會返回一個迭代器，用來一次一個值地遍歷一個范圍。這種方式會比range更省內(nèi)存。xrange在Python 3中已經(jīng)改名為range。

遍歷一個集合

colors=['red','green','blue','yellow']

foriinrange(len(colors)):

printcolors[i]

更好的方法

forcolorincolors:

printcolor

反向遍歷

colors=['red','green','blue','yellow']

foriinrange(len(colors)-1,-1,-1):

printcolors[i]

更好的方法

forcolorinreversed(colors):

printcolor

遍歷一個集合及其下標(biāo)

colors=['red','green','blue','yellow']

foriinrange(len(colors)):

printi,'--->',colors[i]

更好的方法

fori,colorinenumerate(colors):

printi,'--->',color

這種寫法效率高，優(yōu)雅，而且?guī)湍闶∪ビH自創(chuàng)建和自增下標(biāo)。

當(dāng)你發(fā)現(xiàn)你在操作集合的下標(biāo)時，你很有可能在做錯事。

遍歷兩個集合

names=['raymond','rachel','matthew']

colors=['red','green','blue','yellow']

n=min(len(names),len(colors))

foriinrange(n):

printnames[i],'--->',colors[i]

forname,colorinzip(names,colors):

printname,'--->',color

更好的方法

forname,colorinizip(names,colors):

printname,'--->',color

zip在內(nèi)存中生成一個新的列表，需要更多的內(nèi)存。izip比zip效率更高。

注意：在Python 3中，izip改名為zip，并替換了原來的zip成為內(nèi)置函數(shù)。

有序地遍歷

colors=['red','green','blue','yellow']

# 正序

forcolorinsorted(colors):

printcolors

# 倒序

forcolorinsorted(colors,reverse=True):

printcolors

自定義排序順序

colors=['red','green','blue','yellow']

def compare_length(c1,c2):

iflen(c1)

iflen(c1)>len(c2):return1

return0

print sorted(colors,cmp=compare_length)

更好的方法

print sorted(colors, key=len)

第一種方法效率低而且寫起來很不爽。另外，Python 3已經(jīng)不支持比較函數(shù)了。

調(diào)用一個函數(shù)直到遇到標(biāo)記值

blocks=[]

whileTrue:

block=f.read(32)

ifblock=='':

break

blocks.append(block)

更好的方法

blocks=[]

forblockiniter(partial(f.read,32),''):

blocks.append(block)

iter接受兩個參數(shù)。第一個是你反復(fù)調(diào)用的函數(shù)，第二個是標(biāo)記值。

譯注：這個例子里不太能看出來方法二的優(yōu)勢，甚至覺得partial讓代碼可讀性更差了。方法二的優(yōu)勢在于iter的返回值是個迭代器，迭代器能用在各種地方，set，sorted，min，max，heapq，sum……

在循環(huán)內(nèi)識別多個退出點

def find(seq,target):

found=False

fori,valueinenumerate(seq):

ifvalue==target:

found=True

break

ifnotfound:

return-1

returni

更好的方法

def find(seq,target):

fori,valueinenumerate(seq):

ifvalue==target:

break

else:

return-1

returni

for執(zhí)行完所有的循環(huán)后就會執(zhí)行else。

譯注：剛了解for-else語法時會困惑，什么情況下會執(zhí)行到else里。有兩種方法去理解else。傳統(tǒng)的方法是把for看作if，當(dāng)for后面的條件為False時執(zhí)行else。其實條件為False時，就是for循環(huán)沒被break出去，把所有循環(huán)都跑完的時候。所以另一種方法就是把else記成nobreak，當(dāng)for沒有被break，那么循環(huán)結(jié)束時會進入到else。

遍歷字典的key

d={'matthew':'blue','rachel':'green','raymond':'red'}

forkind:

printk

forkind.keys():

ifk.startswith('r'):

deld[k]

什么時候應(yīng)該使用第二種而不是第一種方法？當(dāng)你需要修改字典的時候。

如果你在迭代一個東西的時候修改它，那就是在冒天下之大不韙，接下來發(fā)生什么都活該。

d.keys()把字典里所有的key都復(fù)制到一個列表里。然后你就可以修改字典了。

注意：如果在Python 3里迭代一個字典你得顯示地寫：list(d.keys())，因為d.keys()返回的是一個“字典視圖”(一個提供字典key的動態(tài)視圖的迭代器)。詳情請看文檔。

遍歷一個字典的key和value

# 并不快，每次必須要重新哈希并做一次查找

forkind:

printk,'--->',d[k]

# 產(chǎn)生一個很大的列表

fork,vind.items():

printk,'--->',v

更好的方法

fork,vind.iteritems():

printk,'--->',v

iteritems()更好是因為它返回了一個迭代器。

注意：Python 3已經(jīng)沒有iteritems()了，items()的行為和iteritems()很接近。詳情請看文檔。

用key-value對構(gòu)建字典

names=['raymond','rachel','matthew']

colors=['red','green','blue']

d=dict(izip(names,colors))

# {'matthew': 'blue', 'rachel': 'green', 'raymond': 'red'}

Python 3: d = dict(zip(names, colors))

用字典計數(shù)

colors=['red','green','red','blue','green','red']

# 簡單，基本的計數(shù)方法。適合初學(xué)者起步時學(xué)習(xí)。

d={}

forcolorincolors:

ifcolornotind:

d[color]=0

d[color]+=1

# {'blue': 1, 'green': 2, 'red': 3}

更好的方法

d={}

forcolorincolors:

d[color]=d.get(color,0)+1

# 稍微潮點的方法，但有些坑需要注意，適合熟練的老手。

d=defaultdict(int)

forcolorincolors:

d[color]+=1

用字典分組 — 第I部分和第II部分

names=['raymond','rachel','matthew','roger',

'betty','melissa','judith','charlie']

# 在這個例子，我們按name的長度分組

d={}

fornameinnames:

key=len(name)

ifkeynotind:

d[key]=[]

d[key].append(name)

# {5: ['roger', 'betty'], 6: ['rachel', 'judith'], 7: ['raymond', 'matthew', 'melissa', 'charlie']}

d={}

fornameinnames:

key=len(name)

d.setdefault(key,[]).append(name)

更好的方法

d=defaultdict(list)

fornameinnames:

key=len(name)

d[key].append(name)

字典的popitem()是原子的嗎？

d={'matthew':'blue','rachel':'green','raymond':'red'}

whiled:

key,value=d.popitem()

printkey,'-->',value

popitem是原子的，所以多線程的時候沒必要用鎖包著它。

連接字典

defaults={'color':'red','user':'guest'}

parser=argparse.ArgumentParser()

parser.add_argument('-u','--user')

parser.add_argument('-c','--color')

namespace=parser.parse_args([])

command_line_args={k:vfork,vinvars(namespace).items()ifv}

# 下面是通常的作法，默認(rèn)使用第一個字典，接著用環(huán)境變量覆蓋它，最后用命令行參數(shù)覆蓋它。

# 然而不幸的是，這種方法拷貝數(shù)據(jù)太瘋狂。

d=defaults.copy()

d.update(os.environ)

d.update(command_line_args)

更好的方法

d = ChainMap(command_line_args, os.environ, defaults)

ChainMap在Python 3中加入。高效而優(yōu)雅。

提高可讀性

位置參數(shù)和下標(biāo)很漂亮

但關(guān)鍵字和名稱更好

第一種方法對計算機來說很便利

第二種方法和人類思考方式一致

用關(guān)鍵字參數(shù)提高函數(shù)調(diào)用的可讀性

twitter_search('@obama', False, 20, True)

更好的方法

twitter_search('@obama', retweets=False, numtweets=20, popular=True)

第二種方法稍微(微秒級)慢一點，但為了代碼的可讀性和開發(fā)時間，值得。

用namedtuple提高多個返回值的可讀性

# 老的testmod返回值

doctest.testmod()

# (0, 4)

# 測試結(jié)果是好是壞？你看不出來，因為返回值不清晰。

更好的方法

# 新的testmod返回值, 一個namedtuple

doctest.testmod()

# TestResults(failed=0, attempted=4)

namedtuple是tuple的子類，所以仍適用正常的元組操作，但它更友好。

創(chuàng)建一個nametuple

TestResults = namedTuple('TestResults', ['failed', 'attempted'])

unpack序列

p='Raymond','Hettinger',0x30,'python@example.com'

# 其它語言的常用方法/習(xí)慣

fname=p[0]

lname=p[1]

age=p[2]

email=p[3]

更好的方法

fname, lname, age, email = p

第二種方法用了unpack元組，更快，可讀性更好。

更新多個變量的狀態(tài)

def fibonacci(n):

x=0

y=1

foriinrange(n):

printx

t=y

y=x+y

x=t

更好的方法

def fibonacci(n):

x,y=0,1

foriinrange(n):

printx

x,y=y,x+y

第一種方法的問題

x和y是狀態(tài)，狀態(tài)應(yīng)該在一次操作中更新，分幾行的話狀態(tài)會互相對不上，這經(jīng)常是bug的源頭。

操作有順序要求

太底層太細(xì)節(jié)

第二種方法抽象層級更高，沒有操作順序出錯的風(fēng)險而且更效率更高。

同時狀態(tài)更新

tmp_x=x+dx *t

tmp_y=y+dy *t

tmp_dx=influence(m,x,y,dx,dy,partial='x')

tmp_dy=influence(m,x,y,dx,dy,partial='y')

x=tmp_x

y=tmp_y

dx=tmp_dx

dy=tmp_dy

更好的方法

x,y,dx,dy=(x+dx *t,

y+dy *t,

influence(m,x,y,dx,dy,partial='x'),

influence(m,x,y,dx,dy,partial='y'))

效率

優(yōu)化的基本原則

除非必要，別無故移動數(shù)據(jù)

稍微注意一下用線性的操作取代O(n**2)的操作

總的來說，不要無故移動數(shù)據(jù)

連接字符串

names=['raymond','rachel','matthew','roger',

'betty','melissa','judith','charlie']

s=names[0]

fornameinnames[1:]:

s+=', '+name

prints

更好的方法

print ', '.join(names)

更新序列

names=['raymond','rachel','matthew','roger',

'betty','melissa','judith','charlie']

delnames[0]

# 下面的代碼標(biāo)志著你用錯了數(shù)據(jù)結(jié)構(gòu)

names.pop(0)

names.insert(0,'mark')

更好的方法

names=deque(['raymond','rachel','matthew','roger',

'betty','melissa','judith','charlie'])

# 用deque更有效率

delnames[0]

names.popleft()

names.appendleft('mark')

裝飾器和上下文管理

用于把業(yè)務(wù)和管理的邏輯分開

分解代碼和提高代碼重用性的干凈優(yōu)雅的好工具

起個好名字很關(guān)鍵

記住蜘蛛俠的格言：能力越大，責(zé)任越大

使用裝飾器分離出管理邏輯

# 混著業(yè)務(wù)和管理邏輯，無法重用

def web_lookup(url,saved={}):

ifurlinsaved:

returnsaved[url]

page=urllib.urlopen(url).read()

saved[url]=page

returnpage

更好的方法

@cache

def web_lookup(url):

returnurllib.urlopen(url).read()

注意：Python 3.2開始加入了functools.lru_cache解決這個問題。

分離臨時上下文

# 保存舊的，創(chuàng)建新的

old_context=getcontext().copy()

getcontext().prec=50

print Decimal(355)/Decimal(113)

setcontext(old_context)

更好的方法

with localcontext(Context(prec=50)):

print Decimal(355)/Decimal(113)

譯注：示例代碼在使用標(biāo)準(zhǔn)庫decimal，這個庫已經(jīng)實現(xiàn)好了localcontext。

如何打開關(guān)閉文件

f=open('data.txt')

try:

data=f.read()

finally:

f.close()

更好的方法

with open('data.txt')asf:

data=f.read()

如何使用鎖

# 創(chuàng)建鎖

lock=threading.Lock()

# 使用鎖的老方法

lock.acquire()

try:

print'Critical section 1'

print'Critical section 2'

finally:

lock.release()

更好的方法

# 使用鎖的新方法

withlock:

print'Critical section 1'

print'Critical section 2'

分離出臨時的上下文

try:

os.remove('somefile.tmp')

exceptOSError:

pass

更好的方法

with ignored(OSError):

os.remove('somefile.tmp')

ignored是Python 3.4加入的, 文檔。

注意：ignored 實際上在標(biāo)準(zhǔn)庫叫suppress(譯注：contextlib.supress).

試試創(chuàng)建你自己的ignored上下文管理器。

@contextmanager

def ignored(*exceptions):

try:

yield

exceptexceptions:

pass

把它放在你的工具目錄，你也可以忽略異常

譯注：contextmanager在標(biāo)準(zhǔn)庫contextlib中，通過裝飾生成器函數(shù)，省去用__enter__和__exit__寫上下文管理器。詳情請看文檔。

分離臨時上下文

# 臨時把標(biāo)準(zhǔn)輸出重定向到一個文件，然后再恢復(fù)正常

with open('help.txt','w')asf:

oldstdout=sys.stdout

sys.stdout=f

try:

help(pow)

finally:

sys.stdout=oldstdout

更好的寫法

with open('help.txt','w')asf:

with redirect_stdout(f):

help(pow)

redirect_stdout在Python 3.4加入(譯注：contextlib.redirect_stdout)， bug反饋。

實現(xiàn)你自己的redirect_stdout上下文管理器。

@contextmanager

def redirect_stdout(fileobj):

oldstdout=sys.stdout

sys.stdout=fileobj

try:

yield fieldobj

finally:

sys.stdout=oldstdout

簡潔的單句表達(dá)

兩個沖突的原則：

一行不要有太多邏輯

不要把單一的想法拆分成多個部分

Raymond的原則：

一行代碼的邏輯等價于一句自然語言

列表解析和生成器

result=[]

foriinrange(10):

s=i **2

result.append(s)

print sum(result)

更好的方法

print sum(i**2 for i in xrange(10))

第一種方法說的是你在做什么，第二種方法說的是你想要什么。

編譯：0xFEE1C001

www.lightxue.com/transforming-code-into-beautiful-idiomatic-python