使用模組

[BettyBDChiang參與者]

轉載自廖雪峰的官方網站

Python本身就內置了很多非常有用的模組，只要安裝完畢，這些模組就可以立刻使用。
我們以內建的sys模組為例，編寫一個hello的模組：

#!/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]。

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

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。

[作者]

文章