sgmllib
index
/usr/lib/python2.2/sgmllib.py

A parser for SGML, using the derived class as a static DTD.

 
Modules
            
markupbase
re
 
Classes
            
markupbase.ParserBase
SGMLParser
TestSGMLParser
exceptions.RuntimeError(exceptions.StandardError)
SGMLParseError
 
class SGMLParseError(exceptions.RuntimeError)
      Exception raised for all parse errors.
 
  
Method resolution order:
SGMLParseError
exceptions.RuntimeError
exceptions.StandardError
exceptions.Exception

Data and non-method functions defined here:
__doc__ = 'Exception raised for all parse errors.'
__module__ = 'sgmllib'

Methods inherited from exceptions.Exception:
__getitem__(...)
__init__(...)
__str__(...)
 
class SGMLParser(markupbase.ParserBase)
       
   Methods defined here:
__init__(self, verbose=0)
Initialize and reset this instance.
close(self)
Handle the remaining data.
error(self, message)
feed(self, data)
Feed some data to the parser.
 
        Call this as often as you want, with as little or as much text
        as you want (may include '
').  (This just saves the text,
        all the processing is done by goahead().)
finish_endtag(self, tag)
# Internal -- finish processing of end tag
finish_shorttag(self, tag, data)
# Internal -- finish parsing of <tag/data/ (same as <tag>data</tag>)
finish_starttag(self, tag, attrs)
# Internal -- finish processing of start tag
# Return -1 for unknown tag, 0 for open-only tag, 1 for balanced tag
get_starttag_text(self)
goahead(self, end)
# 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.
handle_charref(self, name)
Handle character reference, no need to override.
handle_comment(self, data)
# Example -- handle comment, could be overridden
handle_data(self, data)
# Example -- handle data, should be overridden
handle_decl(self, decl)
# Example -- handle declaration, could be overridden
handle_endtag(self, tag, method)
# Overridable -- handle end tag
handle_entityref(self, name)
Handle entity references.
 
There should be no need to override this method; it can be
tailored by setting up the self.entitydefs mapping appropriately.
handle_pi(self, data)
# Example -- handle processing instruction, could be overridden
handle_starttag(self, tag, method, attrs)
# Overridable -- handle start tag
parse_comment(self, i, report=1)
# Internal -- parse comment, return length or -1 if not terminated
parse_endtag(self, i)
# Internal -- parse endtag
parse_pi(self, i)
# Internal -- parse processing instr, return length or -1 if not terminated
parse_starttag(self, i)
# Internal -- handle starttag, return length or -1 if not terminated
report_unbalanced(self, tag)
# Example -- report an unbalanced </...> tag.
reset(self)
Reset this instance. Loses all unprocessed data.
setliteral(self, *args)
Enter literal mode (CDATA).
 
Intended for derived classes only.
setnomoretags(self)
Enter literal mode (CDATA) till EOF.
 
Intended for derived classes only.
unknown_charref(self, ref)
unknown_endtag(self, tag)
unknown_entityref(self, ref)
unknown_starttag(self, tag, attrs)
# To be overridden -- handlers for unknown objects

Data and non-method functions defined here:
_SGMLParser__starttag_text = None
__doc__ = None
__module__ = 'sgmllib'
_decl_otherchars = '='
entitydefs = {'amp': '&', 'apos': "'", 'gt': '>', 'lt': '<', 'quot': '"'}

Methods inherited from markupbase.ParserBase:
_parse_doctype_attlist(self, i, declstartpos)
# Internal -- scan past <!ATTLIST declarations
_parse_doctype_element(self, i, declstartpos)
# Internal -- scan past <!ELEMENT declarations
_parse_doctype_entity(self, i, declstartpos)
# Internal -- scan past <!ENTITY declarations
_parse_doctype_notation(self, i, declstartpos)
# Internal -- scan past <!NOTATION declarations
_parse_doctype_subset(self, i, declstartpos)
# Internal -- scan past the internal subset in a <!DOCTYPE declaration,
# returning the index just past any whitespace following the trailing ']'.
_scan_name(self, i, declstartpos)
# Internal -- scan a name token and the new position and the token, or
# return -1 if we've reached the end of the buffer.
getpos(self)
Return current line number and offset.
parse_declaration(self, i)
# Internal -- parse declaration (for use by subclasses).
unknown_decl(self, data)
# To be overridden -- handlers for unknown objects
updatepos(self, i, j)
# Internal -- update line number and offset.  This should be
# called for each piece of data exactly once, in order -- in other
# words the concatenation of all the input strings to this
# function should be exactly the entire input.
 
class TestSGMLParser(SGMLParser)
       
  
Method resolution order:
TestSGMLParser
SGMLParser
markupbase.ParserBase

Methods defined here:
__init__(self, verbose=0)
close(self)
flush(self)
handle_comment(self, data)
handle_data(self, data)
unknown_charref(self, ref)
unknown_endtag(self, tag)
unknown_entityref(self, ref)
unknown_starttag(self, tag, attrs)

Data and non-method functions defined here:
__doc__ = None
__module__ = 'sgmllib'

Methods inherited from SGMLParser:
error(self, message)
feed(self, data)
Feed some data to the parser.
 
        Call this as often as you want, with as little or as much text
        as you want (may include '
').  (This just saves the text,
        all the processing is done by goahead().)
finish_endtag(self, tag)
# Internal -- finish processing of end tag
finish_shorttag(self, tag, data)
# Internal -- finish parsing of <tag/data/ (same as <tag>data</tag>)
finish_starttag(self, tag, attrs)
# Internal -- finish processing of start tag
# Return -1 for unknown tag, 0 for open-only tag, 1 for balanced tag
get_starttag_text(self)
goahead(self, end)
# 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.
handle_charref(self, name)
Handle character reference, no need to override.
handle_decl(self, decl)
# Example -- handle declaration, could be overridden
handle_endtag(self, tag, method)
# Overridable -- handle end tag
handle_entityref(self, name)
Handle entity references.
 
There should be no need to override this method; it can be
tailored by setting up the self.entitydefs mapping appropriately.
handle_pi(self, data)
# Example -- handle processing instruction, could be overridden
handle_starttag(self, tag, method, attrs)
# Overridable -- handle start tag
parse_comment(self, i, report=1)
# Internal -- parse comment, return length or -1 if not terminated
parse_endtag(self, i)
# Internal -- parse endtag
parse_pi(self, i)
# Internal -- parse processing instr, return length or -1 if not terminated
parse_starttag(self, i)
# Internal -- handle starttag, return length or -1 if not terminated
report_unbalanced(self, tag)
# Example -- report an unbalanced </...> tag.
reset(self)
Reset this instance. Loses all unprocessed data.
setliteral(self, *args)
Enter literal mode (CDATA).
 
Intended for derived classes only.
setnomoretags(self)
Enter literal mode (CDATA) till EOF.
 
Intended for derived classes only.

Data and non-method functions inherited from SGMLParser:
_SGMLParser__starttag_text = None
_decl_otherchars = '='
entitydefs = {'amp': '&', 'apos': "'", 'gt': '>', 'lt': '<', 'quot': '"'}

Methods inherited from markupbase.ParserBase:
_parse_doctype_attlist(self, i, declstartpos)
# Internal -- scan past <!ATTLIST declarations
_parse_doctype_element(self, i, declstartpos)
# Internal -- scan past <!ELEMENT declarations
_parse_doctype_entity(self, i, declstartpos)
# Internal -- scan past <!ENTITY declarations
_parse_doctype_notation(self, i, declstartpos)
# Internal -- scan past <!NOTATION declarations
_parse_doctype_subset(self, i, declstartpos)
# Internal -- scan past the internal subset in a <!DOCTYPE declaration,
# returning the index just past any whitespace following the trailing ']'.
_scan_name(self, i, declstartpos)
# Internal -- scan a name token and the new position and the token, or
# return -1 if we've reached the end of the buffer.
getpos(self)
Return current line number and offset.
parse_declaration(self, i)
# Internal -- parse declaration (for use by subclasses).
unknown_decl(self, data)
# To be overridden -- handlers for unknown objects
updatepos(self, i, j)
# Internal -- update line number and offset.  This should be
# called for each piece of data exactly once, in order -- in other
# words the concatenation of all the input strings to this
# function should be exactly the entire input.
 
Functions
            
test(args=None)
 
Data
             __all__ = ['SGMLParser']
__file__ = '/usr/lib/python2.2/sgmllib.pyc'
__name__ = 'sgmllib'
attrfind = <_sre.SRE_Pattern object>
charref = <_sre.SRE_Pattern object>
commentclose = <_sre.SRE_Pattern object>
endbracket = <_sre.SRE_Pattern object>
entityref = <_sre.SRE_Pattern object>
incomplete = <_sre.SRE_Pattern object>
interesting = <_sre.SRE_Pattern object>
piclose = <_sre.SRE_Pattern object>
shorttag = <_sre.SRE_Pattern object>
shorttagopen = <_sre.SRE_Pattern object>
starttagopen = <_sre.SRE_Pattern object>
tagfind = <_sre.SRE_Pattern object>