html.parser
源代码: Lib/html/parser.py
此模块定义一个类 HTMLParser
它是解析HTML(超文本标记语言)和XHTML格式文本文件的基础。
- class html.parser.HTMLParser(*, convert_charrefs=True)
创建能够分析无效标记的分析器实例。
如果 convert_charrefs 是
True
(the default), all character references (except the ones inscript
/style
元素)自动转换为相应的Unicode字符。安
HTMLParser
当遇到开始标记、结束标记、文本、注释和其他标记元素时,将向实例提供HTML数据并调用处理程序方法。用户应该子类HTMLParser
并重写其方法以实现所需的行为。此分析器不检查结束标记是否匹配开始标记,也不为通过关闭外部元素隐式关闭的元素调用结束标记处理程序。
在 3.4 版更改: convert_charrefs 添加了关键字参数。
在 3.5 版更改: 参数的默认值 convert_charrefs 现在是
True
.
HTML解析器应用程序示例
作为一个基本示例,下面是一个使用 HTMLParser
类以打印遇到的开始标记、结束标记和数据::
from html.parser import HTMLParser
class MyHTMLParser(HTMLParser):
def handle_starttag(self, tag, attrs):
print("Encountered a start tag:", tag)
def handle_endtag(self, tag):
print("Encountered an end tag :", tag)
def handle_data(self, data):
print("Encountered some data :", data)
parser = MyHTMLParser()
parser.feed('<html><head><title>Test</title></head>'
'<body><h1>Parse me!</h1></body></html>')
然后输出为:
Encountered a start tag: html
Encountered a start tag: head
Encountered a start tag: title
Encountered some data : Test
Encountered an end tag : title
Encountered an end tag : head
Encountered a start tag: body
Encountered a start tag: h1
Encountered some data : Parse me!
Encountered an end tag : h1
Encountered an end tag : body
Encountered an end tag : html
HTMLParser
方法
HTMLParser
实例具有以下方法:
- HTMLParser.feed(data)
向分析器提供一些文本。它被处理到由完整的元素组成的范围内;不完整的数据被缓冲,直到有更多的数据被输入或
close()
被称为。 data 必须是str
.
- HTMLParser.close()
强制处理所有缓冲数据,就好像它后面跟着文件结束标记一样。此方法可以由派生类重新定义,以在输入结束时定义其他处理,但重新定义的版本应始终调用
HTMLParser
基类方法close()
.
- HTMLParser.get_starttag_text()
返回最近打开的开始标记的文本。这通常不需要用于结构化处理,但在处理“部署后”的HTML或以最小的更改(属性之间的空白可以保留等)重新生成输入时可能很有用。
当遇到数据或标记元素并打算在子类中重写时,将调用以下方法。基类实现什么都不做(除了 handle_startendtag()
):
- HTMLParser.handle_starttag(tag, attrs)
调用此方法来处理标记的开头(例如
<div id="main">
)这个 tag 参数是转换为小写的标记的名称。这个 阿特斯 参数是
(name, value)
包含在标记内找到的属性的对<>
括号。这个 name 将转换为小写,并在 value 已删除,字符和实体引用已被替换。例如,对于标记
<A HREF="https://www.cwi.nl/">
,此方法将被调用为handle_starttag('a', [('href', 'https://www.cwi.nl/')])
.来自的所有实体引用
html.entities
在属性值中被替换。
- HTMLParser.handle_startendtag(tag, attrs)
类似
handle_starttag()
,但当解析器遇到XHTML样式的空标记时调用 (<img ... />
)此方法可以被需要此特定词汇信息的子类重写;默认实现只调用handle_starttag()
和handle_endtag()
.
- HTMLParser.handle_entityref(name)
调用此方法以处理表单的命名字符引用
&name;
(例如)>
在哪里 name 是一般的实体引用(例如'gt'
)如果 convert_charrefs 是True
.
- HTMLParser.handle_charref(name)
调用此方法来处理窗体的十进制和十六进制数字字符引用
&#NNN;
和&#xNNN;
. 例如,十进制等价于>
是>
,而十六进制是>
;在这种情况下,该方法将接收'62'
或'x3E'
. 如果 convert_charrefs 是True
.
- HTMLParser.handle_comment(data)
当遇到注释(例如
<!--comment-->
)例如,注释
<!-- comment -->
将导致用参数调用此方法' comment '
.Internet Explorer条件注释(Condcoms)的内容也将发送到此方法,因此
<!--[if IE 9]>IE9-specific content<![endif]-->
,此方法将接收'[if IE 9]>IE9-specific content<![endif]'
.
- HTMLParser.handle_decl(decl)
调用此方法来处理HTML doctype声明(例如
<!DOCTYPE html>
)这个 decl 参数将是声明的全部内容
<!...>
标记(例如)'DOCTYPE html'
)
- HTMLParser.handle_pi(data)
遇到处理指令时调用的方法。这个 data 参数将包含整个处理指令。例如,对于处理指令
<?proc color='red'>
,此方法将被调用为handle_pi("proc color='red'")
.它将被派生类重写;基类实现什么也不做。注解
这个
HTMLParser
类使用sgml语法规则来处理指令。使用尾随的XHTML处理指令'?'
将导致'?'
包括在 data .
实例
以下类实现了一个解析器,将用于演示更多示例:
from html.parser import HTMLParser
from html.entities import name2codepoint
class MyHTMLParser(HTMLParser):
def handle_starttag(self, tag, attrs):
print("Start tag:", tag)
for attr in attrs:
print(" attr:", attr)
def handle_endtag(self, tag):
print("End tag :", tag)
def handle_data(self, data):
print("Data :", data)
def handle_comment(self, data):
print("Comment :", data)
def handle_entityref(self, name):
c = chr(name2codepoint[name])
print("Named ent:", c)
def handle_charref(self, name):
if name.startswith('x'):
c = chr(int(name[1:], 16))
else:
c = chr(int(name))
print("Num ent :", c)
def handle_decl(self, data):
print("Decl :", data)
parser = MyHTMLParser()
正在分析doctype::
>>> parser.feed('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" '
... '"http://www.w3.org/TR/html4/strict.dtd">')
Decl : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"
分析具有几个属性和标题的元素:
>>> parser.feed('<img src="python-logo.png" alt="The Python logo">')
Start tag: img
attr: ('src', 'python-logo.png')
attr: ('alt', 'The Python logo')
>>>
>>> parser.feed('<h1>Python</h1>')
Start tag: h1
Data : Python
End tag : h1
的内容 script
和 style
元素按原样返回,无需进一步分析::
>>> parser.feed('<style type="text/css">#python { color: green }</style>')
Start tag: style
attr: ('type', 'text/css')
Data : #python { color: green }
End tag : style
>>> parser.feed('<script type="text/javascript">'
... 'alert("<strong>hello!</strong>");</script>')
Start tag: script
attr: ('type', 'text/javascript')
Data : alert("<strong>hello!</strong>");
End tag : script
正在分析注释::
>>> parser.feed('<!-- a comment -->'
... '<!--[if IE 9]>IE-specific content<![endif]-->')
Comment : a comment
Comment : [if IE 9]>IE-specific content<![endif]
解析命名和数字字符引用并将它们转换为正确的字符(注意:这3个引用都等效于 '>'
):
>>> parser.feed('>>>')
Named ent: >
Num ent : >
Num ent : >
将不完整的块送入 feed()
作品,但 handle_data()
可能会被多次调用(除非 convert_charrefs 设置为 True
):
>>> for chunk in ['<sp', 'an>buff', 'ered ', 'text</s', 'pan>']:
... parser.feed(chunk)
...
Start tag: span
Data : buff
Data : ered
Data : text
End tag : span
分析无效的HTML(例如未加引号的属性)也可以:
>>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>')
Start tag: p
Start tag: a
attr: ('class', 'link')
attr: ('href', '#main')
Data : tag soup
End tag : p
End tag : a