Python : Module,pythonmodule

來源:互聯網
上載者:User

Python : Module,pythonmodule

          在Python中,一個.py檔案代表一個Module。在Module中可以是任何的符合Python檔案格式的Python指令碼。瞭解Module匯入機制大有用處。

  • 1 Module 組成
    • 1.1 Module 內建全域變數
  • 2 Module 匯入
    • 2.1 匯入及其使用
    • 2.2 一次載入多次匯入
    • 2.3 搜尋路徑
    • 2.4 reload
  • 3 Package
    • 3.1 __init__.py
    • 3.2 __all__
    • 3.3 __path__

 

1 Module組成

         一個.py檔案就是一個module。Module中包括attribute, function等。 這裡說的attribute其實是module的global variable。

在一個ModuleTests.py檔案中:

#!python#-*- coding: utf-8 -*-"""全域變數"""# hello docglobal moduleNamemoduleName = __name__a = 1def printModuleName(): print(a+1) print(__name__) print(moduleName)'''if __name__ == '__main__' : print('current module name is "' + __name__+'"')'''printModuleName()print(a)print(dir())import __builtin__print(__builtin__ == __builtins__)print(__doc__)print(__file__)print(__name__)print(__package__)__name__ = 'hello'print(__name__)View Code

         除了你自己定義的那些全域變數和函數外,每一個module還有一些內建的全域變數。在這個module就包括了三個attribute:a,moduleName,printModuleName。如果該模組被匯入到另一個模組,在另個一模組中,就可以通過某種方式來訪問這三個attribute。

 

1.1 Module 內建全域變數

         每一個模組,都會有一些預設的attribute(全域變數)。dir()函數 是python中的一個頂級函數,勇於查看模組內容。例如上面的例子中,使用dir()查看結果是:

 ['__builtins__', '__doc__', '__file__', '__name__', '__package__', 'a', 'moduleName', 'printModuleName']。其中a, moduleName, printModuleName 是由使用者自訂的。其他的全是內建的。

        1)__name__ :模組的名稱。例如上面的ModuleTests.py,模組的名稱預設就是ModuleTests。在運行時,如果一個module是程式入口,那麼__name__就是”__main__”。它是最常用的。

        2)__builtins__:在Python中有一個內建的module,叫做:__builtin__,它是一個Python的模組。而任何一個Python的模組都有一個__builtins__全域變數,它就是內建模組__builtin__的引用。可以通過如下代碼測試:

import __builtin__print(__builtin__ == __builtins__)

        // 測試結果是True

        3)__doc__:module的文檔說明。即便是Python的初學者都知道Python中的多行注釋是用三對單引號或者雙引號包含的。網上有人說__doc__其實就是注釋,這句話呢說的太隨意容易給人誤解。經過測試,確認__doc__應該是:檔案頭之後、代碼(包含import)之前 的 第一個 多行注釋。

        4)__file__:當前module所在的檔案的路徑。

        5)__package__:當前module所在的包名。如果沒有,為None。

 

2 Module匯入2.1 匯入及其使用

         一個Module可以匯入(import)到其他的Python指令碼中使用。匯入方式有多種:

        1)import module1

        2)import module1 as m1

        3)from module1 import xxx

        4)from module1 import xxx as yyy

        從包(package)匯入,也分為類似的三種:

        1)import p1.p2.p3.module1 

        2)import p1.p2.p3.module1 as m1

        3)from p1.p2.p3.module1 import xxx

        4)from p1.p2.p3.module1 import xxx as yyy

        假設module1有兩個attribue: a1,a2, 兩個function: f1,f2下面來說明這幾種匯入方式的區別:

         方式一是匯入整個module1, 並將賦值給一個變數module1,來供使用。使用時,可以使用module1.a1, module1.a2, module1.f1(params), module.f2(params)

         方式二是在方式一的基礎上,重新命名為m1,也就是說使用時得使用: m1.a1, m1.a2, m1.f1, m1.f2。

         方式三是匯入模組的部分內容(匯入一個或者一些attribute或者function) 。例如 from module1 import a1,匯入完成後,在當前的模組中建立了一個 a1的變數。調用是直接調用a1即可。

         方式四對於匯入一個attribute或者function時,可以重新命名。例如 from module1 import a1 as msg,那麼匯入完畢,就是在當前的模組中建立了一個msg的變數,指向了module1.a1。 我們在調用時,只能通過msg來調用。

  

2.2 一次載入多次匯入

 

       對於上面的4種匯入方式,不論哪一種,都有兩個階段:1)找到module對象,2)按需分配給變數。

       模組本身就是為了複用的。在一個大的項目中,一些基礎的、公用的模組通常會被大量使用,也就是說會被很多的module匯入使用。我們也知道,module是放在py檔案中的。如個一個module被大量匯入時,難道要每一次匯入,都去磁碟上找一py檔案嗎?

       顯然不能這樣設計,如果真的這樣設計,程式的效能將是極差的了。

       對於同樣的問題,Java中的做法是,使用ClassLoader載入類,並採用父載入器委託機制。儘可能的保證,同一個ClassLoader下,在多次引用一個類時,都是同一個。我們可以將該方式稱為一次載入,多地使用。

       Python的設計者,也考慮到這個問題。也採用了類似方案,被我稱為一次載入,多次匯入。我們假設它有一個Module Loader的存在,在首次載入(其實是首次import)時,執行流程如下:

       1)由Module Loader從檢索路徑下找出相應的模組

       2)編譯或者找到合適的位元組碼檔案(.pyc結尾)

       3)解釋執行要匯入的Module,並放入緩衝。

       4)將匯入的Module對象(或者其屬性)分配給當前Module下的變數。

      隨後整個程式中再有執行import該moudle時,只需要從緩衝中拿到該module,然後執行4)。

 

       此外,對於過程2)有這樣4種情況:

       A: 若.py與.pyc都存在:會對.py檔案的最後修改時間與.pyc檔案的最後修改時間比較。執行時間靠後的那個。

       B: 若.py與.pyc都不存在,繼續找,如果最終都沒有找到,出錯。

       C: 若.py存在,.pyc不存在:編譯.py為.pyc。

       D:若.py不存在,.pyc存在,直接執行.pyc。

 

       再者還要說明2點:

       1)一次載入,多次匯入的機制,在Python程式包中提供的互動式命令列裡使用import是不管用的。在互動式下,一次載入只能用於一次匯入。

       2)一般main py是不會被編譯成pyc的,一個模組要想被編譯成pyc,需要import到其他模組才行。

 

2.3 搜尋路徑

       依據Java編程經驗來看,通常程式會將檔案放在不同的地方。Python必然也不例外。Python的搜尋順序為:

       1)  已載入模組的緩衝

       2)  內建模組

       3)  sys.path

       其中sys.path包含以下幾部分:

       1)入口程式的目錄

       2)系統內容變數PYTHONPATH代表的目錄

       3)標準Python庫目錄

       4)任何.pth檔案的內容(如果存在的話)

      

       下面使用命令看一下sys.path的目錄有哪些:

['','C:\\windows\\SYSTEM32\\python27.zip','D:\\Program Files\\Python\\Python27\\DLLs','D:\\Program Files\\Python\\Python27\\lib','D:\\Program Files\\Python\\Python27\\lib\\plat-win','D:\\Program Files\\Python\\Python27\\lib\\lib-tk','D:\\Program Files\\Python\\Python27','D:\\Program Files\\Python\\Python27\\lib\\site-packages']

        如果要載入的module不在上述目錄下,可以通過3鐘手段:

        1)  配置環境變數PYTHONPATH,配置是與環境變數PATH的風格一樣。

        2)  程式動態修改sys.path

        3)  放到site-packages目錄下。

 

2.4 reload()

        有些情況下,我們需要在程式運行是對程式碼做修改。例如我們需要監控某一方法執行快慢,是否存在效能問題時。我們需要在function的開始、結束部分記錄一個startTime,endTime,依此來判定執行效能時。像這樣的情境下,因為Module的載入一次,多長調用的機制,我們修改完代碼,也不會生效。此時就需要一種機制來重新載入module,以達到期望效果。reload() 就可以解決這個問題。

        reload(module) 是一個函數,參數是一個module對象。執行reload,就會等於再一次進行載入。

 

3 Package

 

3.1 __init__.py

        每一個package下必須有一個__init__.py檔案,該檔案用於表明目前的目錄可以作為一個package。

        __init__.py 也是一個python,當首次載入相應的package時,會執行__init__.py。

        __init__.py檔案可以什麼也沒有,也可以指定__all__或(和)__path。

 

3.2 __all__

       __all__的值是一個列表,用於當程式中使用 from pkg1.pkg2.pkg3 import * 時。

       就拿Python_HOME/Lib/下的json包來做實驗,由於該檔案比較大,我就寫出主要部分:

__version__ = '2.0.9'__all__ = [    'dump', 'dumps', 'load', 'loads',    'JSONDecoder', 'JSONEncoder',]__author__ = 'Bob Ippolito <bob@redivi.com>'from .decoder import JSONDecoderfrom .encoder import JSONEncoderdef dump(params):    passdef dumps(params):    passdef load(params):    passdef loads(params):    pass

       目錄結構如下: 

 

       當程式中使用 from json import * 引起json包首次載入時,執行過程如下:

       1)找到json目錄,執行__init__.py 執行完畢後:包下會暴漏出:load,loads,dump.dumps, JSONDecoder, JSONEncoder

       2)尋找* ,即從__all__找出要匯出的變數。

 

       當程式使用Import json.encoder引起json包首次載入時,執行過程如下:

       1)找到json目錄,執行__init__.py 執行完畢後:包下會暴漏出:load,loads,dump.dumps, JSONDecoder, JSONEncoder (以供from json import * 使用)

       2)匯入json包到一個變數裡(此後程式可以直接使用json.encoder, json.decoder,json.scanner)

 

       上述結論,來源於下面的測試案例:

#!python#-*- coding: utf-8 -*-"""Package Import Test"""#from json import *from json import encoderimport jsonprint(json.encoder == encoder)print(json.decoder is None)print(json.scanner is None)print(dir())

 

3.3 __path__ 

       該變數用於配置包下的搜尋位置。例如:

       在Utils下增加2個目錄Linux和Windows, 並各有一個echo.py檔案, 目錄如下 

 Sound/Utils/      |-- Linux        目錄下沒有__init__.py檔案, 不是包, 只是一個普通目錄      |   `-- echo.py      |-- Windows      目錄下沒有__init__.py檔案, 不是包, 只是一個普通目錄      |   `-- echo.py      |-- __init__.py      |-- echo.py      |-- reverse.py      `-- surround.py  

      如果__init__.py是空的,當使用import Sound.Utils.echo匯入echo時,會匯入的是Sound/Utils/echo.py。   

      接下來我將__init__.py做如下修改:

import sys import os print "Sound.Utils.__init__.__path__ before change:", __path__ dirname = __path__[0] if sys.platform[0:5] == 'linux':         __path__.insert( 0, os.path.join(dirname, 'Linux') ) else:         __path__.insert( 0, os.path.join(dirname, 'Windows') ) print "Sound.Utils.__init__.__path__ AFTER change:", __path__

      在Linux上執行import Sound.Utils.echo,那麼搜尋路徑就會變成了: 'Sound/Utils/Linux', 'Sound/Utils'。以此來達到自動化的按需載入響應的module的功能。

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.