Python編程之模塊

在Python中，一個.py文件就稱之爲一個模塊（Module）

每一個包目錄下面都會有一個__init__.py的文件，這個文件是必須存在的，否則，Python就把這個目錄當成普通目錄，而不是一個包。__init__.py可以是空文件，也可以有Python代碼，因爲__init__.py本身就是一個模塊，而它的模塊名就是mycompany

一、使用模塊

Python本身就內置了很多非常有用的模塊，只要安裝完畢，這些模塊就可以立刻使用。

我們以內建的sys模塊爲例，編寫一個hello的模塊：

#!/usr/bin/env python
# -*- coding: utf-8 -*-

' a test module '

__author__ = 'Michael Liao'

import sys

def test():
    args = sys.argv
    if len(args)==1:
        print 'Hello, world!'
    elif len(args)==2:
        print 'Hello, %s!' % args[1]
    else:
        print 'Too many arguments!'

if __name__=='__main__':
    test()

第1行和第2行是標準註釋，第1行註釋可以讓這個hello.py文件直接在Unix/Linux/Mac上運行，第2行註釋表示.py文件本身使用標準UTF-8編碼；

第4行是一個字符串，表示模塊的文檔註釋，任何模塊代碼的第一個字符串都被視爲模塊的文檔註釋；

第6行使用__author__變量把作者寫進去，這樣當你公開源代碼後別人就可以瞻仰你的大名；

以上就是Python模塊的標準文件模板，當然也可以全部刪掉不寫，但是，按標準辦事肯定沒錯。

後面開始就是真正的代碼部分。

你可能注意到了，使用sys模塊的第一步，就是導入該模塊：

import sys

導入sys模塊後，我們就有了變量sys指向該模塊，利用sys這個變量，就可以訪問sys模塊的所有功能。

sys模塊有一個argv變量，用list存儲了命令行的所有參數。argv至少有一個元素，因爲第一個參數永遠是該.py文件的名稱，例如：

運行python hello.py獲得的sys.argv就是['hello.py']；

運行python hello.py Michael獲得的sys.argv就是['hello.py', 'Michael]。

最後，注意到這兩行代碼：

if __name__=='__main__':
    test()

當我們在命令行運行hello模塊文件時，Python解釋器把一個特殊變量__name__置爲__main__，而如果在其他地方導入該hello模塊時，if判斷將失敗，因此，這種if測試可以讓一個模塊通過命令行運行時執行一些額外的代碼，最常見的就是運行測試。

我們可以用命令行運行hello.py看看效果：

$ python hello.py
Hello, world!
$ python hello.py Michael
Hello, Michael!

如果啓動Python交互環境，再導入hello模塊：

$ python
Python 2.7.5 (default, Aug 25 2013, 00:04:04) 
[GCC 4.2.1 Compatible Apple LLVM 5.0 (clang-500.0.68)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import hello
>>>

導入時，沒有打印Hello, word!，因爲沒有執行test()函數。

調用hello.test()時，才能打印出Hello, word!：

>>> hello.test()
Hello, world!

1、別名

導入模塊時，還可以使用別名，這樣，可以在運行時根據當前環境選擇最合適的模塊。比如Python標準庫一般會提供StringIO和cStringIO兩個庫，這兩個庫的接口和功能是一樣的，但是cStringIO是C寫的，速度更快，所以，你會經常看到這樣的寫法：

try:
    import cStringIO as StringIO
except ImportError: # 導入失敗會捕獲到ImportError
    import StringIO

這樣就可以優先導入cStringIO。如果有些平臺不提供cStringIO，還可以降級使用StringIO。導入cStringIO時，用import ... as ...指定了別名StringIO，因此，後續代碼引用StringIO即可正常工作。

還有類似simplejson這樣的庫，在Python 2.6之前是獨立的第三方庫，從2.6開始內置，所以，會有這樣的寫法：

try:
    import json # python >= 2.6
except ImportError:
    import simplejson as json # python <= 2.5

由於Python是動態語言，函數簽名一致接口就一樣，因此，無論導入哪個模塊後續代碼都能正常工作。

2、作用域

在一個模塊中，我們可能會定義很多函數和變量，但有的函數和變量我們希望給別人使用，有的函數和變量我們希望僅僅在模塊內部使用。在Python中，是通過_前綴來實現的。

正常的函數和變量名是公開的（public），可以被直接引用，比如：abc，x123，PI等；

類似__xxx__這樣的變量是特殊變量，可以被直接引用，但是有特殊用途，比如上面的__author__，__name__就是特殊變量，hello模塊定義的文檔註釋也可以用特殊變量__doc__訪問，我們自己的變量一般不要用這種變量名；

類似_xxx和__xxx這樣的函數或變量就是非公開的（private），不應該被直接引用，比如_abc，__abc等；

之所以我們說，private函數和變量“不應該”被直接引用，而不是“不能”被直接引用，是因爲Python並沒有一種方法可以完全限制訪問private函數或變量，但是，從編程習慣上不應該引用private函數或變量。

private函數或變量不應該被別人引用，那它們有什麼用呢？請看例子：

def _private_1(name):
    return 'Hello, %s' % name

def _private_2(name):
    return 'Hi, %s' % name

def greeting(name):
    if len(name) > 3:
        return _private_1(name)
    else:
        return _private_2(name)

我們在模塊裏公開greeting()函數，而把內部邏輯用private函數隱藏起來了，這樣，調用greeting()函數不用關心內部的private函數細節，這也是一種非常有用的代碼封裝和抽象的方法，即：

外部不需要引用的函數全部定義成private，只有外部需要引用的函數才定義爲public。

二、安裝第三方模塊

在Python中，安裝第三方模塊，是通過setuptools這個工具完成的。Python有兩個封裝了setuptools的包管理工具：easy_install和pip。目前官方推薦使用pip。

現在，讓我們來安裝一個第三方庫——Python Imaging Library，這是Python下非常強大的處理圖像的工具庫。一般來說，第三方庫都會在Python官方的pypi.python.org網站註冊，要安裝一個第三方庫，必須先知道該庫的名稱，可以在官網或者pypi上搜索，比如Python Imaging Library的名稱叫PIL，因此，安裝Python Imaging Library的命令就是：

pip install PIL

耐心等待下載並安裝後，就可以使用PIL了。

有了PIL，處理圖片易如反掌。隨便找個圖片生成縮略圖：

>>> import Image
>>> im = Image.open('test.png')
>>> print im.format, im.size, im.mode
PNG (400, 300) RGB
>>> im.thumbnail((200, 100))
>>> im.save('thumb.jpg', 'JPEG')

其他常用的第三方庫還有MySQL的驅動：MySQL-python，用於科學計算的NumPy庫：numpy，用於生成文本的模板工具Jinja2，等等。

模塊搜索路徑

當我們試圖加載一個模塊時，Python會在指定的路徑下搜索對應的.py文件，如果找不到，就會報錯：

>>> import mymodule
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: No module named mymodule

默認情況下，Python解釋器會搜索當前目錄、所有已安裝的內置模塊和第三方模塊，搜索路徑存放在sys模塊的path變量中：

>>> import sys
>>> sys.path
['', '/Library/Python/2.7/site-packages/pycrypto-2.6.1-py2.7-macosx-10.9-intel.egg', '/Library/Python/2.7/site-packages/PIL-1.1.7-py2.7-macosx-10.9-intel.egg', ...]

如果我們要添加自己的搜索目錄，有兩種方法：

一是直接修改sys.path，添加要搜索的目錄：

>>> import sys
>>> sys.path.append('/Users/michael/my_py_scripts')

這種方法是在運行時修改，運行結束後失效。

第二種方法是設置環境變量PYTHONPATH，該環境變量的內容會被自動添加到模塊搜索路徑中。設置方式與設置Path環境變量類似。注意只需要添加你自己的搜索路徑，Python自己本身的搜索路徑不受影響。

三、使用__future__

Python提供了__future__模塊，把下一個新版本的特性導入到當前版本，於是我們就可以在當前版本中測試一些新版本的特性。