4.2. Introducing sgmllib.py

4.2. `sgmllib.py` 介绍

HTML 处理分成三步：将 HTML 分解成它的组成片段，对片段进行加工，接着将片段再重新合成 HTML。第一步是通过 sgmllib.py 来完成的，它是标准 Python 库的一部分。

理解本章的关键是要知道HTML不只是文本，更是结构化文本。这种结构来源于开始与结束标记的或多或少分级序列。通常你并不以这种方式处理HTML，而是以文本方式在一个文本编辑中对其进行处理，或以可视的方式在一个浏览器中进行浏览或页面编辑工具中进行编辑。sgmllib.py 表现出了HTML的结构。

sgmllib.py 包含一个重要的类：SGMLParser。SGMLParser 将HTML分解成有用的片段，象开始标记和结束标记。一旦它成功地分解出某个数据为一个有用的片段，它会根据所发现的数据，调用一个自身内部的方法。为了使用这个分析器，你需要子类化 SGMLParser 类，并且覆盖这些方法。这就是当我说它表示了HTML结构的意思：HTML的结构决定了方法调用的次序和传给每个方法的参数。

SGMLParser 将 HTML 分析成 8 类数据，然后对每一类调用单独的方法：

开始标记(Start tag): 是一个开始一个块的 HTML 标记，象 <html>，<head>，<body>，或 <pre> 等，或是一个独一的标记，象 <br> 或 <img> 等。当它找到一个开始标记 tagname，SGMLParser 将查找名为 start_tagname 或 do_tagname 的方法。例如，当它找到一个 <pre> 标记，它将查找一个 start_pre 或 do_pre 的方法。如果找到了，SGMLParser 会使用这个标记的属性列表来调用这个方法；否则，它用这个标记的名字和属性列表来调用 unknown_starttag 方法。
结束标记(End tag): 是结束一个块的 HTML 标记，象 </html>，</head>，</body>，或</pre>等。当找到一个结束标记时，SGMLParser 将查找名为 end_tagname 的方法。如果找到，SGMLParser 调用这个方法，否则它使用标记的名字来调用 unknown_endtag 。
字符引用(Character reference): 用字符的十进制或等同的十六进制来表示的转义字符，象  。当找到，SGMLParser 使用十进制或等同的十六进制字符文本来调用handle_charref 。
实体引用(Entity reference): HTML 实体，象 ©。当找到，SGMLParser 使用 HTML 实体的名字来调用 handle_entityref 。
注释(Comment): HTML 注释, 包括在  之间。当找到，SGMLParser 用注释内容来调用 handle_comment 。
处理指令(Processing instruction): HTML 处理指令，包括在 <? ... > 之间。当找到，SGMLParser 用处理指令内容来调用 handle_pi 。
声明(Declaration): HTML 声明，如 DOCTYPE，包括在 <! ... > 之间。当找到，SGMLParser 用声明内容来调用 handle_decl 。
文本数据(Text data): 文本块。不满足其它 7 种类别的任何东西。当找到，SGMLParser 用文本来调用 handle_data 。


	Python 2.0 存在一个 bug，即 `SGMLParser` 完全不能识别声明(`handle_decl` 永远不会调用)，这就意味着 `DOCTYPE` 被静静地忽略掉了。在这错误在 Python 2.1 中改正了。

sgmllib.py 所附带的一个测试套件举例说明了这一点。你可以运行 sgmllib.py，在命令行下传入一个 HTML 文件的名字，然后它会在分析标记和其它元素的同时将它们打印出来。它的实现是通过子类化 SGMLParser 类，然后定义 unknown_starttag，unknown_endtag，handle_data 和其它方法来实现的。这些方法简单地打印出它们的参数。


	在 Windows 下的 Python IDE中，你可以在“Run script”对话框中指定命令行参数。用空格将多个参数分开。

例 4.4. sgmllib.py 的样例测试

下面是一个片段，来自本书的 HTML 版本的目录，toc.html。

<h1>
  <a name='c40a'></a>
  Dive Into Python
</h1>
<p class='pubdate'>
  28 Feb 2001
</p>
<p class='copyright'>
  Copyright copy 2000, 2001 by 
  <a href='mailto:f8dy@diveintopython.org' title='send e-mail to the author'>
    Mark Pilgrim
  </a>
</p>
<p>
  <a name='c40ab2b4'></a>
  <b></b>
</p>
<p>
  This book lives at 
  <a href='http://diveintopython.org/'>
    http://diveintopython.org/
  </a>
  .
  If you're reading it somewhere else, you may not have the latest version.
</p>

通过 sgmllib.py 的测试套件来运行它，会得到这样的输出：

start tag: <h1>
start tag: <a name="c40a" >
end tag: </a>
data: 'Dive Into Python'
end tag: </h1>
start tag: <p class="pubdate" >
data: '28 Feb 2001'
end tag: </p>
start tag: <p class="copyright" >
data: 'Copyright '
*** unknown entity ref: &copy;
data: ' 2000, 2001 by '
start tag: <a href="mailto:f8dy@diveintopython.org" title="send e-mail to the author" >
data: 'Mark Pilgrim'
end tag: </a>
end tag: </p>
start tag: <p>
start tag: <a name="c40ab2b4" >
end tag: </a>
start tag: <b>
end tag: </b>
end tag: </p>
start tag: <p>
data: 'This book lives at '
start tag: <a href="http://diveintopython.org/" >
data: 'http://diveintopython.org/'
end tag: </a>
data: ".\012If you're reading it somewhere else, you may not have the lates"
data: 't version.\012'
end tag: </p>

下面是本章其它部分的路标：

子类化 SGMLParser 来创建从 HTML 文档中抽取感兴趣的数据的类。
子类化 SGMLParser 来创建 BaseHTMLProcessor，它覆盖了所有8个处理方法，然后使用它们从片段中重建原始的 HTML。
子类化 BaseHTMLProcessor 来创建 Dialectizer，它增加了一些方法，专门用来处理指定的 HTML 标记，然后覆盖了 handle_data 方法，提供了用来处理 HTML 标记之间文本块的框架。
子类化 Dialectizer 来创建定义了文本处理规则的类。这些规则被 Dialectizer.handle_data 使用。
编写一个测试套件，它可以从 http://diveintopython.org/ 处抓取一个真正的 web 页面，然后处理它。

4.2. sgmllib.py 介绍

4.2. `sgmllib.py` 介绍