python3自學筆記6-模塊

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

一、使用模塊有什麼好處？

最大的好處是大大提高了代碼的可維護性。

編寫代碼不必從零開始。

使用模塊還可以避免函數名和變量名衝突。

相同名字的函數和變量完全可以分別存在不同的模塊中，因此，我們自己在編寫模塊時，不必考慮名字會與其他模塊衝突。但是也要注意，儘量不要與內置函數名字衝突。點這裏查看Python的所有內置函數。

爲了避免模塊名衝突，Python又引入了按目錄來組織模塊的方法，稱爲包（Package）。

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

二、 使用模塊

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

一個典型的模塊的基本結構如下：

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

' a test module '

__author__ = 'TaoGuan'

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模塊的標準文件模板，當然也可以全部刪掉不寫，但是，按標準辦事肯定沒錯。
後面開始就是真正的代碼部分。

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

if __name__=='__main__':
    test()

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

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

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

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

$ python3
Python 3.4.3 (v3.4.3:9b73f1c3e601, Feb 23 2015, 02:52:03) 
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> 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本身這個步驟就可以跳過了。

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

一般來說，第三方庫都會在Python官方的pypi.python.org網站註冊，要安裝一個第三方庫，必須先知道該庫的名稱，可以在官網或者pypi上搜索，比如Pillow的名稱叫Pillow，因此，安裝Pillow的命令就是：

pip install Pillow

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

五、模塊搜索路徑

當我們試圖加載一個模塊時，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/Frameworks/Python.framework/Versions/3.7/lib/python37.zip', 
'/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7', 
'/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/lib-dynload', 
'/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages']

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

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

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

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