"""A parser for HTML and XHTML."""
# This file is based on sgmllib.py, but the API is slightly different.
# XXX There should be a way to distinguish between PCDATA (parsed
# character data -- the normal case), RCDATA (replaceable character
# data -- only char and entity references and end tags are special)
# and CDATA (character data -- only end tags are special).
from html import unescape
# Regular expressions used for parsing
interesting_normal = re.compile('[&<]')
incomplete = re.compile('&[a-zA-Z#]')
entityref = re.compile('&([a-zA-Z][-.a-zA-Z0-9]*)[^a-zA-Z0-9]')
charref = re.compile('&#(?:[0-9]+|[xX][0-9a-fA-F]+)[^0-9a-fA-F]')
starttagopen = re.compile('<[a-zA-Z]')
piclose = re.compile('>')
commentclose = re.compile(r'--\s*>')
# 1) if you change tagfind/attrfind remember to update locatestarttagend too;
# 2) if you change tagfind/attrfind and/or locatestarttagend the parser will
# explode, so don't do it.
# see http://www.w3.org/TR/html5/tokenization.html#tag-open-state
# and http://www.w3.org/TR/html5/tokenization.html#tag-name-state
tagfind_tolerant = re.compile(r'([a-zA-Z][^\t\n\r\f />\x00]*)(?:\s|/(?!>))*')
attrfind_tolerant = re.compile(
r'((?<=[\'"\s/])[^\s/>][^\s/=>]*)(\s*=+\s*'
r'(\'[^\']*\'|"[^"]*"|(?![\'"])[^>\s]*))?(?:\s|/(?!>))*')
locatestarttagend_tolerant = re.compile(r"""
<[a-zA-Z][^\t\n\r\f />\x00]* # tag name
(?:[\s/]* # optional whitespace before attribute name
(?:(?<=['"\s/])[^\s/>][^\s/=>]* # attribute name
(?:\s*=+\s* # value indicator
(?:'[^']*' # LITA-enclosed value
|"[^"]*" # LIT-enclosed value
|(?!['"])[^>\s]* # bare value
(?:\s*,)* # possibly followed by a comma
\s* # trailing whitespace
endendtag = re.compile('>')
# the HTML 5 spec, section 8.1.2.2, doesn't allow spaces between
# </ and the tag name, so maybe this should be fixed
endtagfind = re.compile(r'</\s*([a-zA-Z][-.a-zA-Z0-9:_]*)\s*>')
class HTMLParser(_markupbase.ParserBase):
"""Find tags and other markup and call handler functions.
Start tags are handled by calling self.handle_starttag() or
self.handle_startendtag(); end tags by self.handle_endtag(). The
data between tags is passed from the parser to the derived class
by calling self.handle_data() with the data as argument (the data
may be split up in arbitrary chunks). If convert_charrefs is
True the character references are converted automatically to the
corresponding Unicode character (and self.handle_data() is no
longer split in chunks), otherwise they are passed by calling
self.handle_entityref() or self.handle_charref() with the string
containing respectively the named or numeric reference as the
CDATA_CONTENT_ELEMENTS = ("script", "style")
def __init__(self, *, convert_charrefs=True):
"""Initialize and reset this instance.
If convert_charrefs is True (the default), all character references
are automatically converted to the corresponding Unicode characters.
self.convert_charrefs = convert_charrefs
"""Reset this instance. Loses all unprocessed data."""
self.interesting = interesting_normal
_markupbase.ParserBase.reset(self)
r"""Feed data to the parser.
Call this as often as you want, with as little or as much text
as you want (may include '\n').
self.rawdata = self.rawdata + data
"""Handle any buffered data."""
def get_starttag_text(self):
"""Return full source of start tag: '<...>'."""
return self.__starttag_text
def set_cdata_mode(self, elem):
self.cdata_elem = elem.lower()
self.interesting = re.compile(r'</\s*%s\s*>' % self.cdata_elem, re.I)
def clear_cdata_mode(self):
self.interesting = interesting_normal
# Internal -- handle data as far as reasonable. May leave state
# and data to be processed by a subsequent call. If 'end' is
# true, force handling all data as if followed by EOF marker.
if self.convert_charrefs and not self.cdata_elem:
# if we can't find the next <, either we are at the end
# or there's more text incoming. If the latter is True,
# we can't pass the text to handle_data in case we have
# a charref cut in half at end. Try to determine if
# this is the case before proceeding by looking for an
# & near the end and see if it's followed by a space or ;.
amppos = rawdata.rfind('&', max(i, n-34))
not re.compile(r'[\s;]').search(rawdata, amppos)):
break # wait till we get all the text
match = self.interesting.search(rawdata, i) # < or &
if self.convert_charrefs and not self.cdata_elem:
self.handle_data(unescape(rawdata[i:j]))
self.handle_data(rawdata[i:j])
startswith = rawdata.startswith
if starttagopen.match(rawdata, i): # < + letter
k = self.parse_starttag(i)
elif startswith("</", i):
elif startswith("<!--", i):
k = self.parse_comment(i)
elif startswith("<?", i):
elif startswith("<!", i):
k = self.parse_html_declaration(i)
k = rawdata.find('>', i + 1)
k = rawdata.find('<', i + 1)
if self.convert_charrefs and not self.cdata_elem:
self.handle_data(unescape(rawdata[i:k]))
self.handle_data(rawdata[i:k])
elif startswith("&#", i):
match = charref.match(rawdata, i)
name = match.group()[2:-1]
self.handle_charref(name)
if not startswith(';', k-1):
if ";" in rawdata[i:]: # bail by consuming &#
self.handle_data(rawdata[i:i+2])
i = self.updatepos(i, i+2)
match = entityref.match(rawdata, i)
self.handle_entityref(name)
if not startswith(';', k-1):
match = incomplete.match(rawdata, i)
# match.group() will contain at least 2 chars
if end and match.group() == rawdata[i:]:
i = self.updatepos(i, i + 1)
# not the end of the buffer, and can't be confused
# with some other construct
i = self.updatepos(i, i + 1)
assert 0, "interesting.search() lied"
if end and i < n and not self.cdata_elem:
if self.convert_charrefs and not self.cdata_elem:
self.handle_data(unescape(rawdata[i:n]))
self.handle_data(rawdata[i:n])
self.rawdata = rawdata[i:]
# Internal -- parse html declarations, return length or -1 if not terminated
# See w3.org/TR/html5/tokenization.html#markup-declaration-open-state
# See also parse_declaration in _markupbase
def parse_html_declaration(self, i):
assert rawdata[i:i+2] == '<!', ('unexpected call to '
'parse_html_declaration()')
if rawdata[i:i+4] == '<!--':
# this case is actually already handled in goahead()
return self.parse_comment(i)
elif rawdata[i:i+3] == '<![':
return self.parse_marked_section(i)
elif rawdata[i:i+9].lower() == '<!doctype':
gtpos = rawdata.find('>', i+9)
self.handle_decl(rawdata[i+2:gtpos])
return self.parse_bogus_comment(i)
# Internal -- parse bogus comment, return length or -1 if not terminated
# see http://www.w3.org/TR/html5/tokenization.html#bogus-comment-state
def parse_bogus_comment(self, i, report=1):
assert rawdata[i:i+2] in ('<!', '</'), ('unexpected call to '
pos = rawdata.find('>', i+2)
self.handle_comment(rawdata[i+2:pos])
# Internal -- parse processing instr, return end or -1 if not terminated
assert rawdata[i:i+2] == '<?', 'unexpected call to parse_pi()'
match = piclose.search(rawdata, i+2) # >
self.handle_pi(rawdata[i+2: j])
# Internal -- handle starttag, return end or -1 if not terminated
def parse_starttag(self, i):
self.__starttag_text = None
endpos = self.check_for_whole_start_tag(i)
self.__starttag_text = rawdata[i:endpos]
# Now parse the data between i+1 and j into a tag and attrs
match = tagfind_tolerant.match(rawdata, i+1)
assert match, 'unexpected call to parse_starttag()'
self.lasttag = tag = match.group(1).lower()
m = attrfind_tolerant.match(rawdata, k)
attrname, rest, attrvalue = m.group(1, 2, 3)
elif attrvalue[:1] == '\'' == attrvalue[-1:] or \
attrvalue[:1] == '"' == attrvalue[-1:]:
attrvalue = attrvalue[1:-1]
attrvalue = unescape(attrvalue)
attrs.append((attrname.lower(), attrvalue))
end = rawdata[k:endpos].strip()
if end not in (">", "/>"):
lineno, offset = self.getpos()
if "\n" in self.__starttag_text:
lineno = lineno + self.__starttag_text.count("\n")
offset = len(self.__starttag_text) \
- self.__starttag_text.rfind("\n")
offset = offset + len(self.__starttag_text)
self.handle_data(rawdata[i:endpos])
# XHTML-style empty tag: <span attr="value" />
self.handle_startendtag(tag, attrs)
self.handle_starttag(tag, attrs)
if tag in self.CDATA_CONTENT_ELEMENTS:
# Internal -- check to see if we have a complete starttag; return end
def check_for_whole_start_tag(self, i):
m = locatestarttagend_tolerant.match(rawdata, i)
if rawdata.startswith("/>", j):
if rawdata.startswith("/", j):
if next in ("abcdefghijklmnopqrstuvwxyz=/"
"ABCDEFGHIJKLMNOPQRSTUVWXYZ"):
# end of input in or before attribute value, or we have the
raise AssertionError("we should not get here!")
# Internal -- parse endtag, return end or -1 if incomplete
def parse_endtag(self, i):
assert rawdata[i:i+2] == "</", "unexpected call to parse_endtag"
match = endendtag.search(rawdata, i+1) # >
match = endtagfind.match(rawdata, i) # </ + tag + >
if self.cdata_elem is not None:
self.handle_data(rawdata[i:gtpos])
# find the name: w3.org/TR/html5/tokenization.html#tag-name-state
namematch = tagfind_tolerant.match(rawdata, i+2)
# w3.org/TR/html5/tokenization.html#end-tag-open-state
if rawdata[i:i+3] == '</>':
return self.parse_bogus_comment(i)
tagname = namematch.group(1).lower()
# consume and ignore other stuff between the name and the >
# Note: this is not 100% correct, since we might have things like
# </tag attr=">">, but looking for > after tha name should cover
# most of the cases and is much simpler
gtpos = rawdata.find('>', namematch.end())
self.handle_endtag(tagname)
elem = match.group(1).lower() # script or style
if self.cdata_elem is not None:
if elem != self.cdata_elem:
self.handle_data(rawdata[i:gtpos])
self.handle_endtag(elem.lower())
# Overridable -- finish processing of start+end tag: <tag.../>
def handle_startendtag(self, tag, attrs):
self.handle_starttag(tag, attrs)
# Overridable -- handle start tag
def handle_starttag(self, tag, attrs):
# Overridable -- handle end tag
def handle_endtag(self, tag):
# Overridable -- handle character reference
def handle_charref(self, name):
# Overridable -- handle entity reference
def handle_entityref(self, name):
# Overridable -- handle data
def handle_data(self, data):
# Overridable -- handle comment
def handle_comment(self, data):
# Overridable -- handle declaration
def handle_decl(self, decl):
# Overridable -- handle processing instruction
def handle_pi(self, data):
def unknown_decl(self, data):
# Internal -- helper to remove special character quoting
warnings.warn('The unescape method is deprecated and will be removed '
'in 3.5, use html.unescape() instead.',
DeprecationWarning, stacklevel=2)
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
