淺談Python中的模塊

模塊
 

為了編寫可維護的代碼，我們把很多函數分組，分別放到不同的文件裡，這樣，每個文件包含的代碼就相對較少，很多編程語言都採用這種組織代碼的方式。在Python中，一個.py文件就稱之為一個模塊（Module）。

使用模塊有什麼好處？

當一個模塊編寫完畢，就可以被其他地方引用。我們在編寫程序的時候，也經常引用其他模塊，包括Python內置的模塊和來自第三方的模塊。

模塊還可以避免函數名和變量名衝突。相同名字的函數和變量完全可以分別存在不同的模塊中。但是也要注意，儘量不要與內置函數名字衝突。

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

假設我們的abc和xyz這兩個模塊名字與其他模塊衝突了，於是我們可以通過包來組織模塊，避免衝突。方法是選擇一個頂層包名，比如mycompany，按照如下目錄存放：

引入了包以後，只要頂層的包名不與別人衝突，那所有模塊都不會與別人衝突。現在，abc.py模塊的名字就變成了mycompany.abc，類似的，xyz.py的模塊名變成了mycompany.xyz。

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

使用模塊

  !/usr/bin/env python3  # -*- 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文件的名稱，例如：

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

工具腳本就是通過sys.argv讀取使用參數

最後，注意到這兩行代碼

  if __name__=='__main__':   test()

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

比如：

如果直接命令行使用python3 hello.py，__name__為__main__，滿足if，執行test()
 如果從test.py導入使用hello.py模塊，__name__就為test，不滿足if，也就不會執行test()

作用域
 

在一個模塊中，我們可能會定義很多函數和變量，但有的函數和變量我們希望給別人使用，有的函數和變量我們希望僅僅在模塊內部使用。在Python中，是通過_前綴來實現的。
 正常的函數和變量名是公開的（public），可以被直接引用，比如：abc，x123，PI等；

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

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

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

換句話說，僅僅是聲明而已，要訪問還是能訪問的，private函數或變量不應該被別人引用，那它們有什麼用呢？

  ef _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。