Python 指南

向前： 5. 数据结构 向上： Python 指南 向后： 7. 输入和输出

章节目录

6.1 深入模块
- 6.1.1 模块搜索路径
- 6.1.2 “编译”Python 文件
6.2 标准模块
6.3 dir() 函数
6.4 包

6. 模块

如果你退出Python解释器重新进入，以前创建的一切定义（变量和函数）就全部丢失了。因此，如果你想写一些长久保存的程序，最好使用一个文本编辑器来编写程序，把保存好的文件输入解释器。我们称之为创建一个脚本。程序变得更长一些了，你可能为了方便维护而把它分离成几个文件。你也可能想要在几个程序中都使用一个常用的函数，但是不想把它的定义复制到每一个程序里。

为了支持这些需要，Python提供了一个方法可以从文件中获取定义，在脚本或者解释器的一个交互式实例中使用。这样的文件被称为实例；模块中的定义可以导入到另一个模块或主模块中（在脚本执行时可以调用的变量集位于最高级，并且处于计算器模式）

模块是包括Python定义和声明的文件。文件名就是模块名加上.py后缀。模块的模块名（做为一个字符串）可以由全局变量__name__得到。例如，你可以用自己惯用的文件编辑器在当前目录下创建一个叫fibo.py的文件，录入如下内容：

# Fibonacci numbers module

def fib(n):    # write Fibonacci series up to n
    a, b = 0, 1
    while b < n:
        print b,
        a, b = b, a+b

def fib2(n): # return Fibonacci series up to n
    result = []
    a, b = 0, 1
    while b < n:
        result.append(b)
        a, b = b, a+b
    return result

现在进入Python解释器用如下命令导入这个模块：

>>> import fibo

这样做不会直接把fibo中的函数导入当前的语义表；，它只是引入了模块名fibo。你可以通过模块名按如下方式访问这个函数：

>>> fibo.fib(1000)
1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987
>>> fibo.fib2(100)
[1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
>>> fibo.__name__
'fibo'

如果你想要直接调用函数，通常可以给它赋一个本地名称：

>>> fib = fibo.fib
>>> fib(500)
1 1 2 3 5 8 13 21 34 55 89 144 233 377

6.1 深入模块

模块可以像函数定义一样包含执行语句。这些语句通常用于初始化模块。它们只在模块第一次导入时执行一次。^6.1

对应于定义模块中所有函数的全局语义表，每一个模块有自己的私有语义表。因此，模块作者可以在模块中使用一些全局变量，不会因为与用户的全局变量冲突而引发错误。另一方面，如果你确定你需要这个，可以像引用模块中的函数一样获取模块中的全局变量，形如：modname.itemname。

模块可以导入（import）其它模块。习惯上所有的import语句都放在模块（或脚本，等等）的开头，但这并不是必须的。被导入的模块名入在本模块的全局语义表中。

import语句的一个变体直接从被导入的模块中导入命名到本模块的语义表中。例如：

>>> from fibo import fib, fib2
>>> fib(500)
1 1 2 3 5 8 13 21 34 55 89 144 233 377

这样不会从局域语义表中导入模块名（例如，fibo没有定义）。

这里还有一个变体从模块定义中导入所有命名：

>>> from fibo import *
>>> fib(500)
1 1 2 3 5 8 13 21 34 55 89 144 233 377

这样可以导入所有除了以下划线（_）开头的命名。

6.1.1 模块搜索路径

导入一个叫spam的模块时，解释器先在当前目录中搜索名为spam.py的文件，然后在环境变量PYTHONPATH指琮的目录列表中搜索，然后是环境变量PATH中的路径列表。如果PYTHONPATH没有设置，或者文件没有找到，接下来搜索安装目录，在UNIX中，通常是 .:/usr/local/lib/python。

实际上，解释器由sys.path变量指定的路径目录搜索模块，该变量初始化时默认包含了输入脚本（或者当前目录），PATHPATH和安装目录。这样就允许Python程序（原文如此，programs；我猜想应该是“programer”，程序员－－译者）了解如何修改或替换模块搜索目录。需要注意的是由于这些目录中包含有搜索路径中运行的脚本，所以这些脚本不应该和标准模块重名，否则在导入模块时Python会尝试把这些脚本当作模块来加载。这通常会引发一个错误。请参见 6.2节“标准模块”以了解更多的信息。

6.1.2 “编译”Python文件

对于引用了大量标准模块的短程序，有一个提高启动速度有重要方法，如果在spam.py目录下存在一个名为spam.pyc的文件，它会被视为spam模块的预“编译”（``byte-compiled'' ，二进制编译）版本。用于创建spam.pyc的这一版spam.py的修改时间记录在spam.pyc文件中，如果两者不匹配，.pyc文件就被忽略。

通常你不需要为创建spam.pyc文件做任何工作。一旦spam.py成功编译，就会试图编译对应版本的spam.pyc。如果有任何原因导致写入不成功，返回的spam.pyc文件就会视为无效，随后即被忽略。spam.pyc文件的内容是平台独立的，所以Python模块目录可以在不同架构的机器之间共享。

部分高级技巧：

以-O参数调用Python解释器时，会生成优化代码并保存在.pyo文件中。通用的优化器没有太多帮助；它只是删除了断言（assert）语句。使用-O参数，所有的代码都会被优化；.pyc文件被忽略，.py文件被编译为优化代码。
向Python解释器传递两个 -O 参数（-OO）会执行完全优化的二进制优化编译，这偶尔会生成错误的程序。当前，压缩的.pyo文件只是从二进制代码中删除了__doc__字符串。因为某些程序依赖于这些变量的可用性，你应该只在确定无误的场合使用这一选项。
来自.pyc文件或.pyo文件中的程序不会比来自.py文件的运行更快；.pyc或.pyo文件只是在它们加载的时候更快一些。
通过脚本名在命令行运行脚本时，不会为该脚本向创建.pyc或.pyo文件的二进制代码。当然，把脚本的主要代码移进一个模块里，然后用一个小的解构脚本导入这个模块，就可以提高脚本的启动速度。也可以直接在命令行中指定一个.pyc或乾.pyo文件。
对于同一个模块（这里指例程spam－－译者），可以只有spam.pyc文件（或者spam.pyo，在使用 -O 参数时）而没有spam.py文件。这样可以打包发布比较于逆向工程的Python代码库。
compileall模块可以为指定目录中的所有模块创建.pyc文件（或者使用-O参数创建.pyo文件）。

6.2 标准模块

Python带有一个标准模块库，并发布有独立的文档，名为 Python 库参考手册 （此后称其为“库参考手册”）。有一些模块内置于解释器之中，这些操作的访问接口不是语言内核的一部分，但是已经内置于解释器了。这既是为了提高效率，也是为了给系统调用等操作系统原生访问提供接口。这类模块集合是一个依赖于底层平台的配置选项。例如，amoeba模块只提供对Amoeba原生系统的支持。有一个具体的模块值得注意：sys ，这个模块内置于所有的Python解释器。变量 sys.ps1 和 sys.ps2 定义了主提示符和副助提示符字符串：

>>> import sys
>>> sys.ps1
'>>> '
>>> sys.ps2
'... '
>>> sys.ps1 = 'C> '
C> print 'Yuck!'
Yuck!
C>

这两个变量只在解释器的交互模式下有意义（此处原文为：These two variables are only defined if the interpreter is in interactive mode. ）。

变量sys.path 是解释器模块搜索路径的字符串列表。它由环境变量PYTHONPATH初始化，如果PYTHONPATH没有内定，就由内置的默认值初始化。你可以用标准和字符串操作修改它：

>>> import sys
>>> sys.path.append('/ufs/guido/lib/python')

6.3 `dir()` 函数

内置函数dir()用于按模块名搜索模块定义，它返回一个字符串类型的存储列表：

>>> import fibo, sys
>>> dir(fibo)
['__name__', 'fib', 'fib2']
>>> dir(sys)
['__displayhook__', '__doc__', '__excepthook__', '__name__', '__stderr__',
 '__stdin__', '__stdout__', '_getframe', 'api_version', 'argv', 
 'builtin_module_names', 'byteorder', 'callstats', 'copyright',
 'displayhook', 'exc_clear', 'exc_info', 'exc_type', 'excepthook',
 'exec_prefix', 'executable', 'exit', 'getdefaultencoding', 'getdlopenflags',
 'getrecursionlimit', 'getrefcount', 'hexversion', 'maxint', 'maxunicode',
 'meta_path', 'modules', 'path', 'path_hooks', 'path_importer_cache',
 'platform', 'prefix', 'ps1', 'ps2', 'setcheckinterval', 'setdlopenflags',
 'setprofile', 'setrecursionlimit', 'settrace', 'stderr', 'stdin', 'stdout',
 'version', 'version_info', 'warnoptions']

无参数调用时，dir()函数返回你当前定义的名称：

>>> a = [1, 2, 3, 4, 5]
>>> import fibo, sys
>>> fib = fibo.fib
>>> dir()
['__name__', 'a', 'fib', 'fibo', 'sys']

应该该列表列出了所有类型的名称：变量，模块，函数，等等：

dir()不会列出内置函数和变量名。如果你想列出这此内容，它们在标准模块__buildin__中定义：

>>> import __builtin__
>>> dir(__builtin__)
['ArithmeticError', 'AssertionError', 'AttributeError',
 'DeprecationWarning', 'EOFError', 'Ellipsis', 'EnvironmentError',
 'Exception', 'False', 'FloatingPointError', 'IOError', 'ImportError',
 'IndentationError', 'IndexError', 'KeyError', 'KeyboardInterrupt',
 'LookupError', 'MemoryError', 'NameError', 'None', 'NotImplemented',
 'NotImplementedError', 'OSError', 'OverflowError', 'OverflowWarning',
 'PendingDeprecationWarning', 'ReferenceError',
 'RuntimeError', 'RuntimeWarning', 'StandardError', 'StopIteration',
 'SyntaxError', 'SyntaxWarning', 'SystemError', 'SystemExit', 'TabError',
 'True', 'TypeError', 'UnboundLocalError', 'UnicodeError', 'UserWarning',
 'ValueError', 'Warning', 'ZeroDivisionError', '__debug__', '__doc__',
 '__import__', '__name__', 'abs', 'apply', 'bool', 'buffer',
 'callable', 'chr', 'classmethod', 'cmp', 'coerce', 'compile', 'complex',
 'copyright', 'credits', 'delattr', 'dict', 'dir', 'divmod',
 'enumerate', 'eval', 'execfile', 'exit', 'file', 'filter', 'float',
 'getattr', 'globals', 'hasattr', 'hash', 'help', 'hex', 'id',
 'input', 'int', 'intern', 'isinstance', 'issubclass', 'iter',
 'len', 'license', 'list', 'locals', 'long', 'map', 'max', 'min',
 'object', 'oct', 'open', 'ord', 'pow', 'property', 'quit',
 'range', 'raw_input', 'reduce', 'reload', 'repr', 'round',
 'setattr', 'slice', 'staticmethod', 'str', 'string', 'sum', 'super',
 'tuple', 'type', 'unichr', 'unicode', 'vars', 'xrange', 'zip']

6.4 包

包通常是使用用“圆点模块名”的结构化模块命名空间。例如，名为A.B的模块表示了名为“A”的包中名为“B”的子模块。正如同用模块来保存不同的模块架构可以避免全局变量之间的相互冲突，使用圆点模块名保存像NunPy或Python Imaging Library之类的不同类库架构可以避免模块之间的命名冲突。

假设你现在想要设计一个模块集（一个“包”）来统一处理声音文件和声音数据。存在几种不同的声音格式（通常由它们的扩展名来标识，例如：.wav，.aiff，.au），于是，为了在不同类型的文件格式之间转换，你需要维护一个不断增长的包集合。可能你还想要对声音数据做很多不同的操作（例如混音，添加回声，应用平衡功能，创建一个人造效果），所以你要加入一个无限流模块来执行这些操作。你的包可能会是这个样子（通过分级的文件体系来进行分组）：

Sound/                          Top-level package
      __init__.py               Initialize the sound package
      Formats/                  Subpackage for file format conversions
              __init__.py
              wavread.py
              wavwrite.py
              aiffread.py
              aiffwrite.py
              auread.py
              auwrite.py
              ...
      Effects/                  Subpackage for sound effects
              __init__.py
              echo.py
              surround.py
              reverse.py
              ...
      Filters/                  Subpackage for filters
              __init__.py
              equalizer.py
              vocoder.py
              karaoke.py
              ...

导入模块时，Python通过sys.path中的目录列表来搜索存放包的子目录。

必须要有一个__init__.py 文件的存在，才能使Python视该目录为一个包；这是为了防止某些目录使用了“string”这样的通用名而无意中在随后的模块搜索路径中覆盖了正确的模块。最简单的情况下，__init__.py 可以只是一个空文件，不过它也可能包含了包的初始化代码，或者设置了 __all__ 变量，后面会有相关介绍。

包用户可以从包中导入合法的模块，例如：

import Sound.Effects.echo

这样就导入了Sound.Effects.echo子模块。它必需通过完整的名称来引用。

Sound.Effects.echo.echofilter(input, output, delay=0.7, atten=4)

导入包时有一个可以选择的方式：

from Sound.Effects import echo

这样就加载了echo子模块，并且使得它在没有包前缀的情况下也可以使用，所以它可以如下方式调用：

echo.echofilter(input, output, delay=0.7, atten=4)

还有另一种变体用于直接导入函数或变量：

from Sound.Effects.echo import echofilter

这样就又一次加载了echo子模块，但这样就可以直接调用它的 echofilter() 函数：

echofilter(input, output, delay=0.7, atten=4)

需要注意的是使用 from package import item 方式导入包时，这个子项（item）既可以是包中的一个子模块（或一个子包），也可以是包中定义的其它命名，像函数、类或变量。import 语句首先核对是否包中有这个子项，如果没有，它假定这是一个模块，并尝试加载它。如果没有找到它，会引发一个 ImportError 异常。

相反，使用类似import item.subitem.subsubitem 这样的语法时，这些子项必须是包，最后的子项可以是包或模块，但不能是前面子项中定义的类、函数或变量。

6.4.1 从包中导入全部信息（Importing * From a Package）

那么当用户写下from Sound.Effects import *时会发生什么事？理想中，总是希望在文件系统中找出包中所有的子模块，然后导入它们。不幸的是，这个操作在Mac 和 Windows 平台上工作的并不太好，这些文件系统的文件大小写并不敏感！在这些平台上没有什么方法可以确保一个叫ECHO.PY的文件应该导入为模块echo、Echo或ECHO。（例如，Windows 95有一个讨厌的习惯，它会把所有的文件名都显示为首字母大写的风格。） DOS 8+3文件名限制又给长文件名模块带来了另一个有趣的问题。

对于包的作者来说唯一的解决方案就是给提供一个明确的包索引。import语句按如下条件进行转换：执行from packae import * 时，如果包中的__init__.py代码定义了一个名为__all__的链表，就会按照链表中给出的模块名进行导入。新版本的包发布时作者可以任意更新这个链表。如果包作者不想import * 的时候导入他们的包中所有模块，那么也可能会决定不支持它（import *）。例如，Sounds/Effects/__init__.py 这个文件可能包括如下代码：

__all__ = ["echo", "surround", "reverse"]

这意味着 from Sound.Effects import * 语句会从Sound 包中导入以上三个已命名的子模块。

如果没有定义 __all__ ，from Sound.Effects import * 语句不会从Sound.Effects包中导入所有的子模块。Effects 导入到当前的命名空间，只能确定的是导入了 Sound.Effects 包（可能会运行 __init__.py中的初始化代码）以及包中定义的所有命名会随之导入。这样就从__init__.py中导入了每一个命名（以及明确导入的子模块）。同样也包括了前述的import语句从包中明确导入的子模块，考虑以下代码：

import Sound.Effects.echo
import Sound.Effects.surround
from Sound.Effects import *

在这个例子中，echo和surround模块导入了当前的命名空间，这是因为执行from ... import语句时它们已经定义在Sound.Effects包中了（定义了__all__时也会同样工作）。

需要注意的是习惯上不主张从一个包或模块中用import * 导入所有模块，因为这样的通常意味着可读性会很差。然而，在交互会话中这样做可以减少输入，相对来说确定的模块被设计成只导出确定的模式中命名的那一部分。

记住，from Package import specific_submodule没有错误！事实上，除非导入的模块需要使用其它包中的同名子模块，否则这是受到推荐的写法。

6.4.2 内置包（Intra-package）参考

子模块之间经常需要互相引用。例如，surround 模块可能会引用echo 模块。事实上，这样的引用如此普遍，以致于import语句会先搜索包内部，然后才是标准模块搜索路径。因此surround module 可以简单的调用import echo 或者 from echo import echofilter。如果没有在当前的包中发现要导入的模块，import语句会依据指定名寻找一个顶级模块。

如果包中使用了子包结构（就像示例中的Sound包），不存在什么从邻近的包中引用子模块的便捷方法－－必须使用子包的全名。例如，如果Sound.Filters.vocoder 包需要使用Sound.Effects 包中的echosa模块，它可以使用from Sound.Effects import echo。

6.4.3 多重路径中的包

包支持一个另为特殊的变量， __path__。 在包的__init__.py文件代码执行之前，该变量初始化一个目录名列表。该变量可以修改，它作用于包中的子包和模块的搜索功能。

这个功能可以用于扩展包中的模块集，不过它不常用。

Footnotes

... somewhere.^6.1: 事实上函数定义既是“声明”又是“可执行体”；执行体由函数在模块全局语义表中的命名导入。（In fact function definitions are also `statements' that are `executed'; the execution enters the function name in the module's global symbol table. ）