Issue #5262: Improved fix.
[python.git] / Doc / library / xml.sax.reader.rst
blob75c7d5b53b2021ba1712fb55d8d8c3edc32e0da7
2 :mod:`xml.sax.xmlreader` --- Interface for XML parsers
3 ======================================================
5 .. module:: xml.sax.xmlreader
6    :synopsis: Interface which SAX-compliant XML parsers must implement.
7 .. moduleauthor:: Lars Marius Garshol <larsga@garshol.priv.no>
8 .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de>
11 .. versionadded:: 2.0
13 SAX parsers implement the :class:`XMLReader` interface. They are implemented in
14 a Python module, which must provide a function :func:`create_parser`. This
15 function is invoked by  :func:`xml.sax.make_parser` with no arguments to create
16 a new  parser object.
19 .. class:: XMLReader()
21    Base class which can be inherited by SAX parsers.
24 .. class:: IncrementalParser()
26    In some cases, it is desirable not to parse an input source at once, but to feed
27    chunks of the document as they get available. Note that the reader will normally
28    not read the entire file, but read it in chunks as well; still :meth:`parse`
29    won't return until the entire document is processed. So these interfaces should
30    be used if the blocking behaviour of :meth:`parse` is not desirable.
32    When the parser is instantiated it is ready to begin accepting data from the
33    feed method immediately. After parsing has been finished with a call to close
34    the reset method must be called to make the parser ready to accept new data,
35    either from feed or using the parse method.
37    Note that these methods must *not* be called during parsing, that is, after
38    parse has been called and before it returns.
40    By default, the class also implements the parse method of the XMLReader
41    interface using the feed, close and reset methods of the IncrementalParser
42    interface as a convenience to SAX 2.0 driver writers.
45 .. class:: Locator()
47    Interface for associating a SAX event with a document location. A locator object
48    will return valid results only during calls to DocumentHandler methods; at any
49    other time, the results are unpredictable. If information is not available,
50    methods may return ``None``.
53 .. class:: InputSource([systemId])
55    Encapsulation of the information needed by the :class:`XMLReader` to read
56    entities.
58    This class may include information about the public identifier, system
59    identifier, byte stream (possibly with character encoding information) and/or
60    the character stream of an entity.
62    Applications will create objects of this class for use in the
63    :meth:`XMLReader.parse` method and for returning from
64    EntityResolver.resolveEntity.
66    An :class:`InputSource` belongs to the application, the :class:`XMLReader` is
67    not allowed to modify :class:`InputSource` objects passed to it from the
68    application, although it may make copies and modify those.
71 .. class:: AttributesImpl(attrs)
73    This is an implementation of the :class:`Attributes` interface (see section
74    :ref:`attributes-objects`).  This is a dictionary-like object which
75    represents the element attributes in a :meth:`startElement` call. In addition
76    to the most useful dictionary operations, it supports a number of other
77    methods as described by the interface. Objects of this class should be
78    instantiated by readers; *attrs* must be a dictionary-like object containing
79    a mapping from attribute names to attribute values.
82 .. class:: AttributesNSImpl(attrs, qnames)
84    Namespace-aware variant of :class:`AttributesImpl`, which will be passed to
85    :meth:`startElementNS`. It is derived from :class:`AttributesImpl`, but
86    understands attribute names as two-tuples of *namespaceURI* and
87    *localname*. In addition, it provides a number of methods expecting qualified
88    names as they appear in the original document.  This class implements the
89    :class:`AttributesNS` interface (see section :ref:`attributes-ns-objects`).
92 .. _xmlreader-objects:
94 XMLReader Objects
95 -----------------
97 The :class:`XMLReader` interface supports the following methods:
100 .. method:: XMLReader.parse(source)
102    Process an input source, producing SAX events. The *source* object can be a
103    system identifier (a string identifying the input source -- typically a file
104    name or an URL), a file-like object, or an :class:`InputSource` object. When
105    :meth:`parse` returns, the input is completely processed, and the parser object
106    can be discarded or reset. As a limitation, the current implementation only
107    accepts byte streams; processing of character streams is for further study.
110 .. method:: XMLReader.getContentHandler()
112    Return the current :class:`ContentHandler`.
115 .. method:: XMLReader.setContentHandler(handler)
117    Set the current :class:`ContentHandler`.  If no :class:`ContentHandler` is set,
118    content events will be discarded.
121 .. method:: XMLReader.getDTDHandler()
123    Return the current :class:`DTDHandler`.
126 .. method:: XMLReader.setDTDHandler(handler)
128    Set the current :class:`DTDHandler`.  If no :class:`DTDHandler` is set, DTD
129    events will be discarded.
132 .. method:: XMLReader.getEntityResolver()
134    Return the current :class:`EntityResolver`.
137 .. method:: XMLReader.setEntityResolver(handler)
139    Set the current :class:`EntityResolver`.  If no :class:`EntityResolver` is set,
140    attempts to resolve an external entity will result in opening the system
141    identifier for the entity, and fail if it is not available.
144 .. method:: XMLReader.getErrorHandler()
146    Return the current :class:`ErrorHandler`.
149 .. method:: XMLReader.setErrorHandler(handler)
151    Set the current error handler.  If no :class:`ErrorHandler` is set, errors will
152    be raised as exceptions, and warnings will be printed.
155 .. method:: XMLReader.setLocale(locale)
157    Allow an application to set the locale for errors and warnings.
159    SAX parsers are not required to provide localization for errors and warnings; if
160    they cannot support the requested locale, however, they must throw a SAX
161    exception.  Applications may request a locale change in the middle of a parse.
164 .. method:: XMLReader.getFeature(featurename)
166    Return the current setting for feature *featurename*.  If the feature is not
167    recognized, :exc:`SAXNotRecognizedException` is raised. The well-known
168    featurenames are listed in the module :mod:`xml.sax.handler`.
171 .. method:: XMLReader.setFeature(featurename, value)
173    Set the *featurename* to *value*. If the feature is not recognized,
174    :exc:`SAXNotRecognizedException` is raised. If the feature or its setting is not
175    supported by the parser, *SAXNotSupportedException* is raised.
178 .. method:: XMLReader.getProperty(propertyname)
180    Return the current setting for property *propertyname*. If the property is not
181    recognized, a :exc:`SAXNotRecognizedException` is raised. The well-known
182    propertynames are listed in the module :mod:`xml.sax.handler`.
185 .. method:: XMLReader.setProperty(propertyname, value)
187    Set the *propertyname* to *value*. If the property is not recognized,
188    :exc:`SAXNotRecognizedException` is raised. If the property or its setting is
189    not supported by the parser, *SAXNotSupportedException* is raised.
192 .. _incremental-parser-objects:
194 IncrementalParser Objects
195 -------------------------
197 Instances of :class:`IncrementalParser` offer the following additional methods:
200 .. method:: IncrementalParser.feed(data)
202    Process a chunk of *data*.
205 .. method:: IncrementalParser.close()
207    Assume the end of the document. That will check well-formedness conditions that
208    can be checked only at the end, invoke handlers, and may clean up resources
209    allocated during parsing.
212 .. method:: IncrementalParser.reset()
214    This method is called after close has been called to reset the parser so that it
215    is ready to parse new documents. The results of calling parse or feed after
216    close without calling reset are undefined.
219 .. _locator-objects:
221 Locator Objects
222 ---------------
224 Instances of :class:`Locator` provide these methods:
227 .. method:: Locator.getColumnNumber()
229    Return the column number where the current event ends.
232 .. method:: Locator.getLineNumber()
234    Return the line number where the current event ends.
237 .. method:: Locator.getPublicId()
239    Return the public identifier for the current event.
242 .. method:: Locator.getSystemId()
244    Return the system identifier for the current event.
247 .. _input-source-objects:
249 InputSource Objects
250 -------------------
253 .. method:: InputSource.setPublicId(id)
255    Sets the public identifier of this :class:`InputSource`.
258 .. method:: InputSource.getPublicId()
260    Returns the public identifier of this :class:`InputSource`.
263 .. method:: InputSource.setSystemId(id)
265    Sets the system identifier of this :class:`InputSource`.
268 .. method:: InputSource.getSystemId()
270    Returns the system identifier of this :class:`InputSource`.
273 .. method:: InputSource.setEncoding(encoding)
275    Sets the character encoding of this :class:`InputSource`.
277    The encoding must be a string acceptable for an XML encoding declaration (see
278    section 4.3.3 of the XML recommendation).
280    The encoding attribute of the :class:`InputSource` is ignored if the
281    :class:`InputSource` also contains a character stream.
284 .. method:: InputSource.getEncoding()
286    Get the character encoding of this InputSource.
289 .. method:: InputSource.setByteStream(bytefile)
291    Set the byte stream (a Python file-like object which does not perform
292    byte-to-character conversion) for this input source.
294    The SAX parser will ignore this if there is also a character stream specified,
295    but it will use a byte stream in preference to opening a URI connection itself.
297    If the application knows the character encoding of the byte stream, it should
298    set it with the setEncoding method.
301 .. method:: InputSource.getByteStream()
303    Get the byte stream for this input source.
305    The getEncoding method will return the character encoding for this byte stream,
306    or None if unknown.
309 .. method:: InputSource.setCharacterStream(charfile)
311    Set the character stream for this input source. (The stream must be a Python 1.6
312    Unicode-wrapped file-like that performs conversion to Unicode strings.)
314    If there is a character stream specified, the SAX parser will ignore any byte
315    stream and will not attempt to open a URI connection to the system identifier.
318 .. method:: InputSource.getCharacterStream()
320    Get the character stream for this input source.
323 .. _attributes-objects:
325 The :class:`Attributes` Interface
326 ---------------------------------
328 :class:`Attributes` objects implement a portion of the mapping protocol,
329 including the methods :meth:`copy`, :meth:`get`, :meth:`has_key`, :meth:`items`,
330 :meth:`keys`, and :meth:`values`.  The following methods are also provided:
333 .. method:: Attributes.getLength()
335    Return the number of attributes.
338 .. method:: Attributes.getNames()
340    Return the names of the attributes.
343 .. method:: Attributes.getType(name)
345    Returns the type of the attribute *name*, which is normally ``'CDATA'``.
348 .. method:: Attributes.getValue(name)
350    Return the value of attribute *name*.
352 .. getValueByQName, getNameByQName, getQNameByName, getQNames available
353 .. here already, but documented only for derived class.
356 .. _attributes-ns-objects:
358 The :class:`AttributesNS` Interface
359 -----------------------------------
361 This interface is a subtype of the :class:`Attributes` interface (see section
362 :ref:`attributes-objects`).  All methods supported by that interface are also
363 available on :class:`AttributesNS` objects.
365 The following methods are also available:
368 .. method:: AttributesNS.getValueByQName(name)
370    Return the value for a qualified name.
373 .. method:: AttributesNS.getNameByQName(name)
375    Return the ``(namespace, localname)`` pair for a qualified *name*.
378 .. method:: AttributesNS.getQNameByName(name)
380    Return the qualified name for a ``(namespace, localname)`` pair.
383 .. method:: AttributesNS.getQNames()
385    Return the qualified names of all attributes.