使用模组

[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。

[作者]

文章