xml.sax.xmlreader
index
/usr/local/lib/python2.3/xml/sax/xmlreader.py

An XML Reader is the SAX 2 name for an XML parser. XML Parsers
should be based on this code.

 
Modules
       
xml.sax.handler

 
Classes
       
AttributesImpl
AttributesNSImpl
InputSource
Locator
XMLReader
IncrementalParser

 
class AttributesImpl
     Methods defined here:
__contains__(self, name)
__getitem__(self, name)
__init__(self, attrs)
Non-NS-aware implementation.
 
attrs should be of the form {name : value}.
__len__(self)
copy(self)
get(self, name, alternative=None)
getLength(self)
getNameByQName(self, name)
getNames(self)
getQNameByName(self, name)
getQNames(self)
getType(self, name)
getValue(self, name)
getValueByQName(self, name)
has_key(self, name)
items(self)
keys(self)
values(self)

 
class AttributesNSImpl(AttributesImpl)
     Methods defined here:
__init__(self, attrs, qnames)
NS-aware implementation.
 
attrs should be of the form {(ns_uri, lname): value, ...}.
qnames of the form {(ns_uri, lname): qname, ...}.
copy(self)
getNameByQName(self, name)
getQNameByName(self, name)
getQNames(self)
getValueByQName(self, name)

Methods inherited from AttributesImpl:
__contains__(self, name)
__getitem__(self, name)
__len__(self)
get(self, name, alternative=None)
getLength(self)
getNames(self)
getType(self, name)
getValue(self, name)
has_key(self, name)
items(self)
keys(self)
values(self)

 
class IncrementalParser(XMLReader)
    This interface adds three extra methods to the XMLReader
interface that allow XML parsers to support incremental
parsing. Support for this interface is optional, since not all
underlying XML parsers support this functionality.
 
When the parser is instantiated it is ready to begin accepting
data from the feed method immediately. After parsing has been
finished with a call to close the reset method must be called to
make the parser ready to accept new data, either from feed or
using the parse method.
 
Note that these methods must _not_ be called during parsing, that
is, after parse has been called and before it returns.
 
By default, the class also implements the parse method of the XMLReader
interface using the feed, close and reset methods of the
IncrementalParser interface as a convenience to SAX 2.0 driver
writers.
 
  Methods defined here:
__init__(self, bufsize=65536)
close(self)
This method is called when the entire XML document has been
passed to the parser through the feed method, to notify the
parser that there are no more data. This allows the parser to
do the final checks on the document and empty the internal
data buffer.
 
The parser will not be ready to parse another document until
the reset method has been called.
 
close may raise SAXException.
feed(self, data)
This method gives the raw XML data in the data parameter to
the parser and makes it parse the data, emitting the
corresponding events. It is allowed for XML constructs to be
split across several calls to feed.
 
feed may raise SAXException.
parse(self, source)
prepareParser(self, source)
This method is called by the parse implementation to allow
the SAX 2.0 driver to prepare itself for parsing.
reset(self)
This method is called after close has been called to reset
the parser so that it is ready to parse new documents. The
results of calling parse or feed after close without calling
reset are undefined.

Methods inherited from XMLReader:
getContentHandler(self)
Returns the current ContentHandler.
getDTDHandler(self)
Returns the current DTD handler.
getEntityResolver(self)
Returns the current EntityResolver.
getErrorHandler(self)
Returns the current ErrorHandler.
getFeature(self, name)
Looks up and returns the state of a SAX2 feature.
getProperty(self, name)
Looks up and returns the value of a SAX2 property.
setContentHandler(self, handler)
Registers a new object to receive document content events.
setDTDHandler(self, handler)
Register an object to receive basic DTD-related events.
setEntityResolver(self, resolver)
Register an object to resolve external entities.
setErrorHandler(self, handler)
Register an object to receive error-message events.
setFeature(self, name, state)
Sets the state of a SAX2 feature.
setLocale(self, locale)
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.
setProperty(self, name, value)
Sets the value of a SAX2 property.

 
class InputSource
    Encapsulation of the information needed by the XMLReader to
read entities.
 
This class may include information about the public identifier,
system identifier, byte stream (possibly with character encoding
information) and/or the character stream of an entity.
 
Applications will create objects of this class for use in the
XMLReader.parse method and for returning from
EntityResolver.resolveEntity.
 
An InputSource belongs to the application, the XMLReader is not
allowed to modify InputSource objects passed to it from the
application, although it may make copies and modify those.
 
  Methods defined here:
__init__(self, system_id=None)
getByteStream(self)
Get the byte stream for this input source.
 
The getEncoding method will return the character encoding for
this byte stream, or None if unknown.
getCharacterStream(self)
Get the character stream for this input source.
getEncoding(self)
Get the character encoding of this InputSource.
getPublicId(self)
Returns the public identifier of this InputSource.
getSystemId(self)
Returns the system identifier of this InputSource.
setByteStream(self, bytefile)
Set the byte stream (a Python file-like object which does
not perform byte-to-character conversion) for this input
source.
 
The SAX parser will ignore this if there is also a character
stream specified, but it will use a byte stream in preference
to opening a URI connection itself.
 
If the application knows the character encoding of the byte
stream, it should set it with the setEncoding method.
setCharacterStream(self, charfile)
Set the character stream for this input source. (The stream
must be a Python 2.0 Unicode-wrapped file-like that performs
conversion to Unicode strings.)
 
If there is a character stream specified, the SAX parser will
ignore any byte stream and will not attempt to open a URI
connection to the system identifier.
setEncoding(self, encoding)
Sets the character encoding of this InputSource.
 
The encoding must be a string acceptable for an XML encoding
declaration (see section 4.3.3 of the XML recommendation).
 
The encoding attribute of the InputSource is ignored if the
InputSource also contains a character stream.
setPublicId(self, public_id)
Sets the public identifier of this InputSource.
setSystemId(self, system_id)
Sets the system identifier of this InputSource.

 
class Locator
    Interface for associating a SAX event with a document
location. A locator object will return valid results only during
calls to DocumentHandler methods; at any other time, the
results are unpredictable.
 
  Methods defined here:
getColumnNumber(self)
Return the column number where the current event ends.
getLineNumber(self)
Return the line number where the current event ends.
getPublicId(self)
Return the public identifier for the current event.
getSystemId(self)
Return the system identifier for the current event.

 
class XMLReader
    Interface for reading an XML document using callbacks.
 
XMLReader is the interface that an XML parser's SAX2 driver must
implement. This interface allows an application to set and query
features and properties in the parser, to register event handlers
for document processing, and to initiate a document parse.
 
All SAX interfaces are assumed to be synchronous: the parse
methods must not return until parsing is complete, and readers
must wait for an event-handler callback to return before reporting
the next event.
 
  Methods defined here:
__init__(self)
getContentHandler(self)
Returns the current ContentHandler.
getDTDHandler(self)
Returns the current DTD handler.
getEntityResolver(self)
Returns the current EntityResolver.
getErrorHandler(self)
Returns the current ErrorHandler.
getFeature(self, name)
Looks up and returns the state of a SAX2 feature.
getProperty(self, name)
Looks up and returns the value of a SAX2 property.
parse(self, source)
Parse an XML document from a system identifier or an InputSource.
setContentHandler(self, handler)
Registers a new object to receive document content events.
setDTDHandler(self, handler)
Register an object to receive basic DTD-related events.
setEntityResolver(self, resolver)
Register an object to resolve external entities.
setErrorHandler(self, handler)
Register an object to receive error-message events.
setFeature(self, name, state)
Sets the state of a SAX2 feature.
setLocale(self, locale)
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.
setProperty(self, name, value)
Sets the value of a SAX2 property.