9.2. 包

实际上,解析 XML 文档非常简单:只需一行代码。但是,在您开始编写代码之前,您需要先了解一下包。

示例 9.5. 加载 XML 文档(先睹为快)

>>> from xml.dom import minidom 1
>>> xmldoc = minidom.parse('~/diveintopython/common/py/kgp/binary.xml')
1 这是一种您以前从未见过的语法。它看起来几乎像您熟悉和喜爱的 from module import,但 "." 表明它不仅仅是一个简单的导入。事实上,xml 就是所谓的包,domxml 中的嵌套包,而 minidomxml.dom 中的模块。

这听起来很复杂,但实际上并非如此。查看实际的实现可能会有所帮助。包只不过是模块的目录;嵌套包是子目录。包(或嵌套包)中的模块仍然只是 .py 文件,与往常一样,只是它们位于子目录中,而不是 Python 安装的 lib/ 主目录中。

示例 9.6. 包的文件布局

Python21/           root Python installation (home of the executable)
|
+--lib/             library directory (home of the standard library modules)
   |
   +-- xml/         xml package (really just a directory with other stuff in it)
       |
       +--sax/      xml.sax package (again, just a directory)
       |
       +--dom/      xml.dom package (contains minidom.py)
       |
       +--parsers/  xml.parsers package (used internally)

因此,当您说 from xml.dom import minidom 时,Python 会将其理解为“xml 目录中查找 dom 目录,并在该目录中查找 minidom 模块,并将其导入为 minidom”。但 Python 比这更聪明;您不仅可以导入包中包含的整个模块,还可以选择性地从包中包含的模块中导入特定的类或函数。您还可以将包本身作为模块导入。语法都是一样的;Python 会根据包的文件布局确定您的意思,并自动执行正确的操作。

示例 9.7. 包也是模块

>>> from xml.dom import minidom         1
>>> minidom
<module 'xml.dom.minidom' from 'C:\Python21\lib\xml\dom\minidom.pyc'>
>>> minidom.Element
<class xml.dom.minidom.Element at 01095744>
>>> from xml.dom.minidom import Element 2
>>> Element
<class xml.dom.minidom.Element at 01095744>
>>> minidom.Element
<class xml.dom.minidom.Element at 01095744>
>>> from xml import dom                 3
>>> dom
<module 'xml.dom' from 'C:\Python21\lib\xml\dom\__init__.pyc'>
>>> import xml                          4
>>> xml
<module 'xml' from 'C:\Python21\lib\xml\__init__.pyc'>
1 在这里,您要从嵌套包 (xml.dom) 中导入模块 (minidom)。结果是将 minidom 导入到您的 命名空间 中,为了引用 minidom 模块中的类(如 Element),您需要在它们前面加上模块名称。
2 在这里,您要从嵌套包 (xml.dom) 中的模块 (minidom) 中导入类 (Element)。结果是将 Element 直接导入到您的命名空间中。请注意,这不会干扰之前的导入;Element 类现在可以通过两种方式引用(但它仍然是同一个类)。
3 在这里,您要将 dom 包(xml 的嵌套包)本身作为模块导入。包的任何级别都可以被视为模块,您稍后将会看到。它甚至可以有自己的属性和方法,就像您之前看到的模块一样。
4 在这里,您要将根级别的 xml 包作为模块导入。

那么,如何将包(在磁盘上只是一个目录)导入并视为模块(始终是磁盘上的文件)呢?答案是神奇的 __init__.py 文件。您会发现,包不仅仅是目录;它们是包含特定文件 __init__.py 的目录。此文件定义了包的属性和方法。例如,xml.dom 包含一个 Node 类,该类在 xml/dom/__init__.py 中定义。当您将包作为模块导入(如从 xml 导入 dom)时,您实际上是在导入其 __init__.py 文件。

Note
包是一个包含特殊文件 __init__.py 的目录。__init__.py 文件定义了包的属性和方法。它不需要定义任何内容;它可以只是一个空文件,但它必须存在。但是,如果 __init__.py 不存在,则该目录只是一个目录,而不是一个包,并且不能导入或包含模块或嵌套包。

那么,为什么要使用包呢?嗯,它们提供了一种逻辑分组相关模块的方法。作者可以选择将所有 sax 功能放在 xmlsax.py 中,将所有 dom 功能放在 xmldom.py 中,甚至将所有功能放在一个模块中,而不是使用包含 saxdom 包的 xml 包。但这将是笨拙的(在撰写本文时,XML 包有 3000 多行代码)且难以管理(单独的源文件意味着多个人可以同时处理不同的区域)。

如果您发现自己在 Python 中编写了一个大型子系统(或者,更有可能的是,当您意识到您的小型子系统已经发展成为一个大型子系统时),请花一些时间设计一个良好的包架构。这是 Python 擅长的众多事情之一,所以请充分利用它。