Python 研究(Dive Into Python)

许多需要输入源的函数可以只接收一个文件名，并以读方式打开文件，读取文件，处理完成后关闭它。其实它们不是这样的，而是接收一个类文件对象。

在最简单的例子中，类文件对象是任意一个带有 read 方法的对象，这个方法带有一个可选的size参数，并返回一个字符串。调用时如果没有size参数，它从输入源中读取所有东西并将所有数据作为单个字符串返回。调用时如果指定了size参数，它将从输入源中读取size大小的数据并返回这些数据；再次调用的时候，它从余下的地方开始并返回下一块数据。

这就是从真实文件读取数据的工作方式；区别在于你不用把自己局限于真实的文件。输入源可以是任何东西：磁盘上的文件，甚至是一个硬编码的字符串。只要你将一个类文件对象传递给函数，函数只是调用对象的 read 方法，函数可以处理任何类型的输入源，而不需要处理每种类型的特定代码。

你可能纳闷过这和 XML 处理有什么关系，其实 minidom.parse 就是一个可以接收类文件对象的函数。

例 10.1. 从文件中解析 XML

>>> from xml.dom import minidom
>>> fsock = open('binary.xml')    
>>> xmldoc = minidom.parse(fsock) 
>>> fsock.close()                 
>>> print xmldoc.toxml()          
<?xml version="1.0" ?>
<grammar>
<ref id="bit">
  <p>0</p>
  <p>1</p>
</ref>
<ref id="byte">
  <p><xref id="bit"/><xref id="bit"/><xref id="bit"/><xref id="bit"/>\
<xref id="bit"/><xref id="bit"/><xref id="bit"/><xref id="bit"/></p>
</ref>
</grammar>

	首先，你要打开一个磁盘上的文件。这会提供给你一个文件对象。
	将文件对象传递给 minidom.parse ，它调用fsock的 read 方法并从磁盘上的文件读取 XML 文档。
	确保处理完成文件后调用 close 方法。minidom.parse不会替你做这件事。
	在返回的 XML 文档上调用toxml()方法，打印出整个文档的内容。

哦，所有这些看上去象是在浪费大量的时间。毕竟，你已经看过 minidom.parse 可以只接收文件名，并自动执行所有打开文件和关闭无用文件的行为。不错，如果你知道正要解析的是一个本地文件，你可以传递文件名而且 minidom.parse 可以足够聪明的做正确的事情™，这一切都不会有问题。但是请注意，使用类文件分析直接从Internet上来的 XML 文档是多么相似和容易的事情！

例 10.2. 解析来自 URL 的 XML

>>> import urllib
>>> usock = urllib.urlopen('http://slashdot.org/slashdot.rdf') 
>>> xmldoc = minidom.parse(usock)                              
>>> usock.close()                                              
>>> print xmldoc.toxml()                                       
<?xml version="1.0" ?>
<rdf:RDF xmlns="http://my.netscape.com/rdf/simple/0.9/"
 xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">

<channel>
<title>Slashdot</title>
<link>http://slashdot.org/</link>
<description>News for nerds, stuff that matters</description>
</channel>

<image>
<title>Slashdot</title>
<url>http://images.slashdot.org/topics/topicslashdot.gif</url>
<link>http://slashdot.org/</link>
</image>

<item>
<title>To HDTV or Not to HDTV?</title>
<link>http://slashdot.org/article.pl?sid=01/12/28/0421241</link>
</item>

[...snip...]

	如前一章，urlopen 接收一个web页面的 URL 作为参数并返回一个类文件对象。最重要的是，这个对象有一个 read 方法可以返回web页面的 HTML 源代码。
	现在把类文件对象传递给 minidom.parse ，它顺从地调用对象的 read 方法并解析 read 方法返回的 XML 数据。这与 XML 数据现在直接来源于web页面的事实毫不相干。minidom.parse 并不知道web页面，它也不关心web页面；它只知道类文件对象。
	到这里已经处理完毕了，确保将 urlopen 提供给你的类文件对象关闭。
	顺便提一句，这个 URL 是真实的，它真的是一个 XML。它是Slashdot站点（这是一个技术新闻和随笔站点）上当前标题的 XML 表示。

例 10.3. 解析字符串 XML (容易但不灵活的方式)

>>> contents = "<grammar><ref id='bit'><p>0</p><p>1</p></ref></grammar>"
>>> xmldoc = minidom.parseString(contents) 
>>> print xmldoc.toxml()
<?xml version="1.0" ?>
<grammar><ref id="bit"><p>0</p><p>1</p></ref></grammar>

minidom 有一个方法，parseString，它接收一个字符串形式的完整 XML 文档作为参数并解析这个参数。如果你已经将整个 XML 文档放入一个字符串，你可以使用它代替minidom.parse。

OK，所以你可以使用 minidom.parse 函数来解析本地文件和远端 URL，但对于解析字符串，你使用...一个不同的函数。这就是说，你要从文件，URL 或者字符串接收输入，你需要特别的逻辑来判断参数是否是字符串，然后调用 parseString。多不让人满意。

如果有一个方法可以把字符串转换成类文件对象，那么你可以只把这个对象传递给 minidom.parse 就可以了。事实上，有一个模块专门设计用来做这件事：StringIO。

例 10.4. StringIO 介绍

>>> contents = "<grammar><ref id='bit'><p>0</p><p>1</p></ref></grammar>"
>>> import StringIO
>>> ssock = StringIO.StringIO(contents)   
>>> ssock.read()                          
"<grammar><ref id='bit'><p>0</p><p>1</p></ref></grammar>"
>>> ssock.read()                          
''
>>> ssock.seek(0)                         
>>> ssock.read(15)                        
'<grammar><ref i'
>>> ssock.read(15)
"d='bit'><p>0</p"
>>> ssock.read()
'><p>1</p></ref></grammar>'
>>> ssock.close()                         

	StringIO 模块只包含了单个类，也叫 StringIO，它允许你将一个字符串转换为一个类文件对象。这个 StringIO 类在创建实例的时候接收字符串作为参数。
	现在你有了一个类文件对象，你可用它做类文件的所有事情。比如 read 可以返回原始字符串。
	再次调用 read 返回空字符串。真实文件对象的工作方式也是这样的；一旦你读取了整个文件，如果不显式定位到文件的开始位置，就不可能读取到任何其他数据。StringIO 对象以相同的方式进行工作。
	使用 StringIO 对象的 seek 方法，你可以显式的定位到字符串的开始位置，就像在文件中定位一样。
	将一个size参数传递给 read 方法，你还可以以块的形式读取字符串。
	任何时候，read 都将返回字符串的未读剩余部分。所有这些严格地按文件对象的方式工作；，这就是术语类文件对象的来历。

例 10.5. 解析字符串 XML （类文件对象方式）

>>> contents = "<grammar><ref id='bit'><p>0</p><p>1</p></ref></grammar>"
>>> ssock = StringIO.StringIO(contents)
>>> xmldoc = minidom.parse(ssock) 
>>> ssock.close()
>>> print xmldoc.toxml()
<?xml version="1.0" ?>
<grammar><ref id="bit"><p>0</p><p>1</p></ref></grammar>

现在你可以把类文件对象（实际是一个 StringIO）传递给 minidom.parse，它将调用对象的 read 方法并高兴的开始解析，绝不会知道它的输入源源自一个硬编码的字符串。

那么现在你知道了如何使用单个函数，minidom.parse，来解析一个保存在web页面上，本地文件中或硬编码字符串中的 XML 文档。对于一个web页面，使用 urlopen 得到类文件对象；对于本地文件，使用 open ；对于字符串，使用 StringIO。现在让我们进一步并总结一下这些 不同。

例 10.6. openAnything

def openAnything(source):                  
    # try to open with urllib (if source is http, ftp, or file URL)
    import urllib                         
    try:                                  
        return urllib.urlopen(source)      
    except (IOError, OSError):            
        pass                              

    # try to open with native open function (if source is pathname)
    try:                                  
        return open(source)                
    except (IOError, OSError):            
        pass                              

    # treat source as string
    import StringIO                       
    return StringIO.StringIO(str(source))  

	openAnything 函数接收单个参数，source，并返回类文件对象。source是某种类型的字符串；它可能是一个 URL （例如'http://slashdot.org/slashdot.rdf'），一个本地文件的完整或者部分路径名（例如'binary.xml'），或者是一个包含了需要解析 XML 数据的字符串。
	首先，查看source是否是一个 URL 。这里通过强制方式进行：尝试把它当作一个 URL 打开并静静地忽略打开非 URL 引起的错误。感觉上这样做非常好，如果 urllib 将来支持更多的 URL 类型，不用重新编码就可以支持它们。如果 urllib 能够打开source，那么 return 可以立刻把你踢出函数，下面的try语句将不会执行。
	另一方面，如果 urllib 向你呼喊并告诉你source不是一个有效的 URL，你假设它是一个磁盘文件的路径并尝试打开它。再一次，你不用做任何特别的事来检查source是否是一个有效的文件名（总之在不同的平台上，判断文件名有效性的规则变化很大，那么不管怎样做都可能会判断错）。反而，只要盲目地打开文件并静静地捕获任何错误就可以了。
	到这里，你需要假设source是一个其中有硬编码数据的字符串（因为没有什么可以判断的了），所以你可以使用 StringIO 从中创建一个类文件对象并将它返回。（实际上，由于使用了 str 函数，所以source没有必要一定是字符串；它可以是任何对象，你可以使用它的字符串表示形式，通过它的 __str__ 定义的特殊方法。）

现在你可以使用这个 openAnything 函数联合 minidom.parse 构造一个函数，接收一个指向 XML 文档的source，而且无需知道这个source的含义（可以是一个 URL 或是一个本地文件名，或是一个硬编码 XML 文档的字符串形式），并解析它。

class KantGenerator:
    def _load(self, source):
        sock = toolbox.openAnything(source)
        xmldoc = minidom.parse(sock).documentElement
        sock.close()
        return xmldoc