Python模块（Module）

 一个Python Module(模块)，是一个文件，包含了Python对象定义和Python语句（definitions and statements）。文件名就是模块名加上后缀.py，在模块内部，模块名存储在全局变量__name__中，是一个string，可以直接在module中通过__name__引用到module name。

module是为了重复使用一些对象，比如类，函数，而将这些对象定义放在一个.py文件中，或是将一个较大的工程裁缝为多个.py文件而易于维护，每一个.py文件都是一个module。

1，模块的定义和引入(import)

如下一个fibo.py文件

print ("__name__ :", __name__)
def fib(n):
        a, b = 0, 1
        result = []
        print ("in fib():", __name__)
        while (b<n):
                result.append(b)
                a, b = b, a+b
        print(result)

这个fibo.py就是一个module，它有一个函数定义fib()，和一个语句(statement)，第一行的print语句，我们在当前文件目录运行Python Interpreter就可以去引入这个模块，并执行模块中定义的fib()函数。

>>> import fibo
('__name__ :', 'fibo')         #print语句执行
>>> fibo.fib(10)
('in fib() :', 'fibo')         #fib()函数执行
[1, 1, 2, 3, 5, 8]

可以看到，在import的时候，这个module的语句(statements)执行了，所定义的函数并未执行，在通过module名引用module中的函数定义时，函数才被执行

同样可以在一个script file中引入module，我们在fibo.py所在的目录创建另一个文件calculat.py

from fibo import fib                                                                                                                      
2 for n in range(10, 50, 5):
        fib(n)

然后用Python解释器运行calcute.py得到结果。

这里有两种import 语句，

一种是import module_name1 [as name1], module_name2 [as name2]

一种是from module_name import item1 [as name1], item2 [as name2]

 

2, module的加载

每个module都包含对象定义和一些语句(statements)，这些语句应该是意图要来初始化这个module的，这些语句会在这个module第一次被import的时候执行（多次import只会执行一次,不管是以上两种import的语句中那一种），当这个module被作为一个script来运行的时候也会被执行。

每个module都有自己的private symbol table，当使用第一种import语句import一个module的时候，引入者的local symbol table就加入了这个module，其名字如果没有使用as的话就是被引入的模块名本身。使用第二种import语句这会在引入者的local symbol table中加入具体引用的item，其名称若没使用as则就为item的名称。

 

3，module搜索路径

当遇到一个名为xiaoyu的module需要import的时候，Python Interpreter首先搜寻built-in module中有没有叫这个名的，若是没有，则Interpreter会从一系列的目录中去搜寻这个module(也就是这个.py文件)，这些目录值存储在sys.path中，而sys.path又是用这些值来初始化的：

• 当前目录，即input script所在的目录
• 环境变量PYTHONPATH中存储的值(PYTHONPATH的语法和PATH一样)
• Python包的安装目录，比如我的服务器上django就安装在 /usr/local/lib/python2.7/dist-packages/中，sys.path含有这个目录

Python有一个标准库，其中定义了一系列的module，这些module中的一部分是直接集成在Interpreter中的，这些built-in module主要提供了很重要的但是Python语言又没有提供的功能，比如跟system call有关的sys module就集成在所有平台的Python Interpreter中，在Interpreter中集成哪些module是可以配置的，并且随平台不同而有差别。

在启动Interpreter，sys.path被初始化后，我们可以对它进行修改

>>> import sys
>>> sys.path.append('/root/home/project/code/python')

 

4， 把module作为script来执行

前面我们已经提到了关于module中语句的执行。这里要补充一点东西，通常一个script file指的是调用Python Interpreter时作为参数传递给Interpreter的文件，当然所有的.py文件都是一个module，这样的一个script或是module，其__name__会被Interpreter自动设置为"__main__"。以下是一个测试:

print ("__name__ :", __name__)
def fib(n):
        a, b = 0, 1
        result = []
        print ("in fib() :", __name__)
        while (b<n):
                result.append(b)
                a, b = b, a+b
        print(result)

if __name__ == "__main__":
        import sys
13         fib(int(sys.argv[1]))   

用Python Interpreter直接调用这个script

oot@AY1212240253255e84714:/home/project/code/python# python fibo.py 22
('__name__ :', '__main__')
('in fib() :', '__main__')
[1, 1, 2, 3, 5, 8, 13, 21]

可以看到依然module的语句都会被执行，只是__name__的值一开始就变为了"__main__"，给一个模块加上

if __name == "__main__":

常常是为了测试这个模块，因为这个语句块只有当module被作为script直接传给Interpreter的时候才会被执行。

上面例子中的12行import sys可以看出，Python并没有规定import语句必须写在module的最前面，只是习惯性的我们约定都写在最前面。

 

5. 内置dir()函数（built-in dir() function）

 dir()函数可以用来查看一个module所定义的所有names，试验

>>> dir()
['__builtins__', '__doc__', '__name__', '__package__']
>>> import sys, fibo as fibo_local
('__name__ :', 'fibo')
>>> dir()
['__builtins__', '__doc__', '__name__', '__package__', 'fibo_local', 'sys']
>>> dir(fibo)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'fibo' is not defined
>>> dir(fibo_local)
['__builtins__', '__doc__', '__file__', '__name__', '__package__', 'fib']

 可以看到在import了fibo和sys后，并且fibo是用别名fibo_local来引入的，在引入者module中就定义了sys和fibo_local，可以看到dir(fibo)是抛了NameError异常的，fibo并没有被定义，定义的是fibo_local，这也可以看出import语句对local symbol table是怎样影响的。

 

6, 模块包(package) 

 包(package)可以理解为是组织起来的module的一个层次结构，也就是package是一个directory，它包含sub-package或者是module，而module是.py文件，要让Python Interpreter把一个目录作为package，则该目录下必须有__init__.py文件，__init__.py可以为空，当然也可以有对象定义和语句，用来做初始化工作，__init__.py还有个作用就是设置__all__变量。

package本身就可以来作为一个module使用，只是它所包含的sub-module或module可以通过package name用package.module的名称形式去引用，这更有利于组织一系列相关的module，避免module间定义的名称的混乱。

package在实际工程中非常常用，__init__.py也常常不会为空，而会有对象定义和初始化代码来让这个包，也就是这个module，包含其该有的item定义。以后我们会对package做更多了解。

 

 

参考：

1，http://docs.python.org/3.3/tutorial/modules.html  modules

2，http://docs.python.org/3.3/reference/simple_stmts.html#the-import-statement  import语句

3，http://docs.python.org/3/reference/executionmodel.html Python execution model

4，http://docs.python.org/3/reference/import.html Python import system