API的設(shè)計(jì)是一個(gè)藝術(shù)活。往往需要其簡(jiǎn)單、易懂、整潔、不累贅。
很多時(shí)候,我們?cè)诘讓臃庋b一個(gè)方法給高層用,而其它的方法只是為了輔助這個(gè)方法的。
也就是說我們只需要暴露這個(gè)方法就行,不用關(guān)心這個(gè)方法是怎么實(shí)現(xiàn)的,不用關(guān)心其它輔助方法的存在。
在Python中,有幾種策略來保持命名空間的整潔。
1.變量命名用下劃線_開頭
下劃線_開頭的變量在其它模塊from xxx import *的時(shí)候不被import。
如果你看decimal的源碼,就會(huì)發(fā)現(xiàn)多次把import 的模塊弄成下劃線_開頭的別名。
http://hg.python.org/cpython/file/2.7/Lib/decimal.py
比如
import copy as _copyimport math as _mathimport numbers as _numbers
這不是蛋疼,是為了不污染命名空間
2.定義__all__
python的魔術(shù)方法實(shí)在是靈活。
假設(shè)我模塊中有3個(gè)方法a(),b(),c()
我只是要暴露a而已,不需要暴露b和c。
這時(shí)__all__=[a]
在其它模塊from xxxmodule import *的時(shí)候就只import了a了。
而且在開發(fā)者閱讀源碼的時(shí)候,看到了__all__,一下子就知道要暴露的是哪些方法,而不是一堆代碼無從下手。
3.在使用了這個(gè)變量后刪掉
通過del xxx刪掉。
這樣在dir(xxxmodule)的時(shí)候就減少了dir出來滿屏的變量了。
同樣在decimal的源碼,可以看到使用了正則表達(dá)式模塊re之后,用del re刪掉了。
還有一種方法就是把import語句放在函數(shù)內(nèi),將其限制在局部作用域中。感覺這種方法不pythonic,就不推薦了。
新聞熱點(diǎn)
疑難解答
圖片精選