Python9.2

模塊

在計算機程序的開發過程中，隨着程序代碼越寫越多，在一個文件裏代碼就會越來越長，越來越不容易維護。
爲了編寫可維護的代碼，我們把很多函數分組，分別放到不同的文件裏，這樣，每個文件包含的代碼就相對較少，很多編程語言都採用這種組織代碼的方式。在Python中，一個.py文件就稱之爲一個模塊（Module）。

使用模塊有什麼好處？
最大的好處是大大提高了代碼的可維護性。其次，編寫代碼不必從零開始。當一個模塊編寫完畢，就可以被其他地方引用。我們在編寫程序的時候，也經常引用其他模塊，包括Python內置的模塊和來自第三方的模塊。
使用模塊還可以避免函數名和變量名衝突。相同名字的函數和變量完全可以分別存在不同的模塊中，因此，我們自己在編寫模塊時，不必考慮名字會與其他模塊衝突。但是也要注意，儘量不要與內置函數名字衝突。點這裏查看Python的所有內置函數。

你也許還想到，如果不同的人編寫的模塊名相同怎麼辦？爲了避免模塊名衝突，Python又引入了按目錄來組織模塊的方法，稱爲包（Package）。

舉個例子，一個abc.py的文件就是一個名字叫abc的模塊，一個xyz.py的文件就是一個名字叫xyz的模塊。
現在，假設我們的abc和xyz這兩個模塊名字與其他模塊衝突了，於是我們可以通過包來組織模塊，避免衝突。方法是選擇一個頂層包名，比如mycompany，按照如下目錄存放：
mycompany
├─ init.py
├─ abc.py
└─ xyz.py
引入了包以後，只要頂層的包名不與別人衝突，那所有模塊都不會與別人衝突。現在，abc.py模塊的名字就變成了mycompany.abc，類似的，xyz.py的模塊名變成了mycompany.xyz。

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

類似的，可以有多級目錄，組成多級層次的包結構。比如如下的目錄結構：
mycompany
├─ web
│ ├─ init.py
│ ├─ utils.py
│ └─ www.py
├─ init.py
├─ utils.py
└─ xyz.py
文件www.py的模塊名就是mycompany.web.www，兩個文件utils.py的模塊名分別是mycompany.utils和mycompany.web.utils。

自己創建模塊時要注意命名，不能和Python自帶的模塊名稱衝突。例如，系統自帶了sys模塊，自己的模塊就不可命名爲sys.py，否則將無法導入系統自帶的sys模塊。
mycompany.web也是一個模塊。

總結

模塊是一組Python代碼的集合，可以使用其他模塊，也可以被其他模塊使用。

創建自己的模塊時，要注意：
• 模塊名要遵循Python變量命名規範，不要使用中文、特殊字符；
• 模塊名不要和系統模塊名衝突，最好先查看系統是否已存在該模塊，檢查方法是在Python交互環境執行import abc，若成功則說明系統存在此模塊。

使用模塊

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看看效果：

F:\>python hello.py
Hello, world!
F:\>python hello.py Michael
Hello, Michael!

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

>>> import hello
>>>

導入時，沒有打印Hello, word!，因爲沒有執行test()函數。
調用hello.test()時，才能打印出Hello, word!：

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

作用域

在一個模塊中，我們可能會定義很多函數和變量，但有的函數和變量我們希望給別人使用，有的函數和變量我們希望僅僅在模塊內部使用。在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中，安裝第三方模塊，是通過包管理工具pip完成的。
如果你正在使用Mac或Linux，安裝pip本身這個步驟就可以跳過了。
如果你正在使用Windows，請參考安裝Python一節的內容，確保安裝時勾選了pip和Add python.exe to Path。
在命令提示符窗口下嘗試運行pip，如果Windows提示未找到命令，可以重新運行安裝程序添加pip。

注意：Mac或Linux上有可能並存Python 3.x和Python 2.x，因此對應的pip命令是pip3。

例如，我們要安裝一個第三方庫——Python Imaging Library，這是Python下非常強大的處理圖像的工具庫。不過，PIL目前只支持到Python 2.7，並且有年頭沒有更新了，因此，基於PIL的Pillow項目開發非常活躍，並且支持最新的Python 3。

一般來說，第三方庫都會在Python官方的pypi.python.org網站註冊，要安裝一個第三方庫，必須先知道該庫的名稱，可以在官網或者pypi上搜索，比如Pillow的名稱叫Pillow，因此，安裝Pillow的命令就是：
pip install Pillow
耐心等待下載並安裝後，就可以使用Pillow了。

安裝常用模塊

在使用Python時，我們經常需要用到很多第三方庫，例如，上面提到的Pillow，以及MySQL驅動程序，Web框架Flask，科學計算Numpy等。用pip一個一個安裝費時費力，還需要考慮兼容性。

我們推薦直接使用Anaconda，這是一個基於Python的數據處理和科學計算平臺，它已經內置了許多非常有用的第三方庫，我們裝上Anaconda，就相當於把數十個第三方模塊自動安裝好了，非常簡單易用。

可以從Anaconda官網下載GUI安裝包，安裝包有500~600M，所以需要耐心等待下載。網速慢的同學請移步國內鏡像。下載後直接安裝，Anaconda會把系統Path中的python指向自己自帶的Python，並且，Anaconda安裝的第三方模塊會安裝在Anaconda自己的路徑下，不影響系統已安裝的Python目錄。

除非是以管理員身份爲所有用戶安裝，否則僅勾選“Just Me”並點擊“Next”。

在“Advanced Installation Options”中不要勾選“Add Anaconda to my PATH environment variable.”（“添加Anaconda至我的環境變量。”）。因爲如果勾選，則將會影響其他程序的使用。如果使用Anaconda，則通過打開Anaconda Navigator或者在開始菜單中的“Anaconda Prompt”（類似macOS中的“終端”）中進行使用。
除非打算使用多個版本的Anaconda或者多個版本的Python，否則便勾選“Register Anaconda as my default Python 3.6”。

安裝好Anaconda後，重新打開命令行窗口，輸入python，可以看到Anaconda的信息：

E:\>python
Python 3.7.0 (v3.7.0:1bf9cc5093, Jun 27 2018, 04:59:51) [MSC v.1914 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.

模塊搜索路徑

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

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

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

>>> import sys
>>> sys.path
['', 'E:\\python\\python37.zip', 'E:\\python\\DLLs', 'E:\\python\\lib', 'E:\\python', 'E:\\python\\lib\\site-packages']

如果我們要添加自己的搜索目錄，有兩種方法：
一是直接修改sys.path，添加要搜索的目錄：

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

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

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