python __init__.py和__all__

__init__.py是建立python包時用的,詳見文章:http://www.cnblogs.com/tqsummer/archive/2011/01/24/1943273.htmlhtml

python中的Module是比較重要的概念。常見的狀況是,事先寫好一個.py文 件,在另外一個文件中須要import時,將事先寫好的.py文件拷貝 到當前目錄,或者是在sys.path中增長事先寫好的.py文件所在的目錄,而後import。這樣的作法,對於少數文件是可行的,但若是程序數目很 多,層級很複雜,就很吃力了。
有沒有辦法,像Java的Package同樣,將多個.py文件組織起來,以便在外部統一調用,和在內部互相調用呢?答案是有的。
主要是用到python的包的概念,python __init__.py在包裏起一個比較重要的做用
要弄明白這個問題,首先要知道,python在執行import語句時,到底進行了什麼操做,按照python的文檔,它執行了以下操做:
第1步,建立一個新的,空的module對象(它可能包含多個module);
第2步,把這個module對象插入sys.module中
第3步,裝載module的代碼(若是須要,首先必須編譯)
第4步,執行新的module中對應的代碼。

在執行第3步時,首先要找到module程序所在的位置,其原理爲:
如 果須要導入的module的名字是m1,則解釋器必須找到m1.py,它首先在當前目錄查找,而後是在環境變量PYTHONPATH中查找。 PYTHONPATH能夠視爲系統的PATH變量一類的東西,其中包含若干個目錄。若是PYTHONPATH沒有設定,或者找不到m1.py,則繼續搜索 與python的安裝設置相關的默認路徑,在Unix下,一般是/usr/local/lib/python。
事實上,搜索的順序是:當前路徑 (以及從當前目錄指定的sys.path),而後是PYTHONPATH,而後是python的安裝設置相關的默認路徑。正由於存在這樣的順序,若是當前 路徑或PYTHONPATH中存在與標準module一樣的module,則會覆蓋標準module。也就是說,若是當前目錄下存在xml.py,那麼執 行import xml時,導入的是當前目錄下的module,而不是系統標準的xml。

瞭解了這些,咱們就能夠先構建一個package,以普通module的方式導入,就能夠直接訪問此package中的各個module了。

Python中的package定義很簡單,其層次結構與程序所在目錄的層次結構相同,這一點與Java相似,惟一不一樣的地方在於,python中的package必須包含一個__init__.py的文件。
例如,咱們能夠這樣組織一個package:

package1/
    __init__.py
    subPack1/
        __init__.py
        module_11.py
        module_12.py
        module_13.py
    subPack2/
        __init__.py
        module_21.py
        module_22.py
    ……

__init__.py能夠爲空,只要它存在,就代表此目錄應被做爲一個package處理。固然,__init__.py中也能夠設置相應的內容,下文詳細介紹。

好了,如今咱們在module_11.py中定義一個函數:

def funA():
    print "funcA in module_11"
    return

在頂層目錄(也就是package1所在的目錄,固然也參考上面的介紹,將package1放在解釋器可以搜索到的地方)運行python:

>>>from package1.subPack1.module_11 import funcA
>>>funcA()
funcA in module_11

這樣,咱們就按照package的層次關係,正確調用了module_11中的函數。

細心的用戶會發現,有時在import語句中會出現通配符*,導入某個module中的全部元素,這是怎麼實現的呢?
答案就在__init__.py中。咱們在subPack1的__init__.py文件中寫

__all__ = ['module_13', 'module_12']

而後進入python

>>>from package1.subPack1 import *
>>>module_11.funcA()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: No module named module_11

也就是說,以*導入時,package內的module是受__init__.py限制的。

好了,最後來看看,如何在package內部互相調用。
若是但願調用同一個package中的module,則直接import便可。也就是說,在module_12.py中,能夠直接使用

import module_11

若是不在同一個package中,例如咱們但願在module_21.py中調用module_11.py中的FuncA,則應該這樣:

from module_11包名.module_11 import funcApython

二、__all__函數

在模塊(*.py)中使用意爲導出__all__列表裏的類、函數、變量等成員,不然將導出modualA中全部不如下劃線開頭(私有)的成員,在模塊中使用__all__屬性可避免在相互引用時的命名衝突post

相關文章
相關標籤/搜索