<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"incremental-parser-objects.html" />
<link rel=
"prev" href=
"module-xml.sax.xmlreader.html" />
<link rel=
"parent" href=
"module-xml.sax.xmlreader.html" />
<link rel=
"next" href=
"incremental-parser-objects.html" />
<meta name='aesop' content='information'
/>
<title>13.12.1 XMLReader Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"13.12 xml.sax.xmlreader "
href=
"module-xml.sax.xmlreader.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"13.12 xml.sax.xmlreader "
href=
"module-xml.sax.xmlreader.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"13.12.2 IncrementalParser Objects"
href=
"incremental-parser-objects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-xml.sax.xmlreader.html">13.12 xml.sax.xmlreader
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-xml.sax.xmlreader.html">13.12 xml.sax.xmlreader
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"incremental-parser-objects.html">13.12.2 IncrementalParser Objects
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION00151210000000000000000"></A><A NAME=
"xmlreader-objects"></A>
13.12.1 XMLReader Objects
The
<tt class=
"class">XMLReader
</tt> interface supports the following methods:
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4522' xml:id='l2h-
4522'
class=
"method">parse
</tt></b>(
</nobr></td>
<td><var>source
</var>)
</td></tr></table></dt>
Process an input source, producing SAX events. The
<var>source
</var>
object can be a system identifier (a string identifying the
input source - typically a file name or an URL), a file-like
object, or an
<tt class=
"class">InputSource
</tt> object. When
<tt class=
"method">parse()
</tt>
returns, the input is completely processed, and the parser object
can be discarded or reset. As a limitation, the current implementation
only accepts byte streams; processing of character streams is for
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4523' xml:id='l2h-
4523'
class=
"method">getContentHandler
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Return the current
<tt class=
"class">ContentHandler
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4524' xml:id='l2h-
4524'
class=
"method">setContentHandler
</tt></b>(
</nobr></td>
<td><var>handler
</var>)
</td></tr></table></dt>
Set the current
<tt class=
"class">ContentHandler
</tt>. If no
<tt class=
"class">ContentHandler
</tt> is set, content events will be discarded.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4525' xml:id='l2h-
4525'
class=
"method">getDTDHandler
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Return the current
<tt class=
"class">DTDHandler
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4526' xml:id='l2h-
4526'
class=
"method">setDTDHandler
</tt></b>(
</nobr></td>
<td><var>handler
</var>)
</td></tr></table></dt>
Set the current
<tt class=
"class">DTDHandler
</tt>. If no
<tt class=
"class">DTDHandler
</tt> is
set, DTD events will be discarded.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4527' xml:id='l2h-
4527'
class=
"method">getEntityResolver
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Return the current
<tt class=
"class">EntityResolver
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4528' xml:id='l2h-
4528'
class=
"method">setEntityResolver
</tt></b>(
</nobr></td>
<td><var>handler
</var>)
</td></tr></table></dt>
Set the current
<tt class=
"class">EntityResolver
</tt>. If no
<tt class=
"class">EntityResolver
</tt> is set, attempts to resolve an external
entity will result in opening the system identifier for the entity,
and fail if it is not available.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4529' xml:id='l2h-
4529'
class=
"method">getErrorHandler
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Return the current
<tt class=
"class">ErrorHandler
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4530' xml:id='l2h-
4530'
class=
"method">setErrorHandler
</tt></b>(
</nobr></td>
<td><var>handler
</var>)
</td></tr></table></dt>
Set the current error handler. If no
<tt class=
"class">ErrorHandler
</tt> is set,
errors will be raised as exceptions, and warnings will be printed.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4531' xml:id='l2h-
4531'
class=
"method">setLocale
</tt></b>(
</nobr></td>
<td><var>locale
</var>)
</td></tr></table></dt>
Allow an application to set the locale for errors and warnings.
SAX parsers are not required to provide localization for errors and
warnings; if they cannot support the requested locale, however, they
must throw a SAX exception. Applications may request a locale change
in the middle of a parse.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4532' xml:id='l2h-
4532'
class=
"method">getFeature
</tt></b>(
</nobr></td>
<td><var>featurename
</var>)
</td></tr></table></dt>
Return the current setting for feature
<var>featurename
</var>. If the
feature is not recognized,
<tt class=
"exception">SAXNotRecognizedException
</tt> is
raised. The well-known featurenames are listed in the module
<tt class=
"module">xml.sax.handler
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4533' xml:id='l2h-
4533'
class=
"method">setFeature
</tt></b>(
</nobr></td>
<td><var>featurename, value
</var>)
</td></tr></table></dt>
Set the
<var>featurename
</var> to
<var>value
</var>. If the feature is not
recognized,
<tt class=
"exception">SAXNotRecognizedException
</tt> is raised. If the
feature or its setting is not supported by the parser,
<var>SAXNotSupportedException
</var> is raised.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4534' xml:id='l2h-
4534'
class=
"method">getProperty
</tt></b>(
</nobr></td>
<td><var>propertyname
</var>)
</td></tr></table></dt>
Return the current setting for property
<var>propertyname
</var>. If the
property is not recognized, a
<tt class=
"exception">SAXNotRecognizedException
</tt>
is raised. The well-known propertynames are listed in the module
<tt class=
"module">xml.sax.handler
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4535' xml:id='l2h-
4535'
class=
"method">setProperty
</tt></b>(
</nobr></td>
<td><var>propertyname, value
</var>)
</td></tr></table></dt>
Set the
<var>propertyname
</var> to
<var>value
</var>. If the property is not
recognized,
<tt class=
"exception">SAXNotRecognizedException
</tt> is raised. If the
property or its setting is not supported by the parser,
<var>SAXNotSupportedException
</var> is raised.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"13.12 xml.sax.xmlreader "
href=
"module-xml.sax.xmlreader.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"13.12 xml.sax.xmlreader "
href=
"module-xml.sax.xmlreader.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"13.12.2 IncrementalParser Objects"
href=
"incremental-parser-objects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-xml.sax.xmlreader.html">13.12 xml.sax.xmlreader
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-xml.sax.xmlreader.html">13.12 xml.sax.xmlreader
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"incremental-parser-objects.html">13.12.2 IncrementalParser Objects
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.