/Doc/library/xml.sax.utils.rst
http://unladen-swallow.googlecode.com/ · ReStructuredText · 85 lines · 55 code · 30 blank · 0 comment · 0 complexity · 283f1f48c29e94f646cef92f0d73b0d9 MD5 · raw file
- :mod:`xml.sax.saxutils` --- SAX Utilities
- =========================================
- .. module:: xml.sax.saxutils
- :synopsis: Convenience functions and classes for use with SAX.
- .. moduleauthor:: Lars Marius Garshol <larsga@garshol.priv.no>
- .. sectionauthor:: Martin v. Lรถwis <martin@v.loewis.de>
- .. versionadded:: 2.0
- The module :mod:`xml.sax.saxutils` contains a number of classes and functions
- that are commonly useful when creating SAX applications, either in direct use,
- or as base classes.
- .. function:: escape(data[, entities])
- Escape ``'&'``, ``'<'``, and ``'>'`` in a string of data.
- You can escape other strings of data by passing a dictionary as the optional
- *entities* parameter. The keys and values must all be strings; each key will be
- replaced with its corresponding value. The characters ``'&'``, ``'<'`` and
- ``'>'`` are always escaped, even if *entities* is provided.
- .. function:: unescape(data[, entities])
- Unescape ``'&'``, ``'<'``, and ``'>'`` in a string of data.
- You can unescape other strings of data by passing a dictionary as the optional
- *entities* parameter. The keys and values must all be strings; each key will be
- replaced with its corresponding value. ``'&'``, ``'<'``, and ``'>'``
- are always unescaped, even if *entities* is provided.
- .. versionadded:: 2.3
- .. function:: quoteattr(data[, entities])
- Similar to :func:`escape`, but also prepares *data* to be used as an
- attribute value. The return value is a quoted version of *data* with any
- additional required replacements. :func:`quoteattr` will select a quote
- character based on the content of *data*, attempting to avoid encoding any
- quote characters in the string. If both single- and double-quote characters
- are already in *data*, the double-quote characters will be encoded and *data*
- will be wrapped in double-quotes. The resulting string can be used directly
- as an attribute value::
- >>> print "<element attr=%s>" % quoteattr("ab ' cd \" ef")
- <element attr="ab ' cd " ef">
- This function is useful when generating attribute values for HTML or any SGML
- using the reference concrete syntax.
- .. versionadded:: 2.2
- .. class:: XMLGenerator([out[, encoding]])
- This class implements the :class:`ContentHandler` interface by writing SAX
- events back into an XML document. In other words, using an :class:`XMLGenerator`
- as the content handler will reproduce the original document being parsed. *out*
- should be a file-like object which will default to *sys.stdout*. *encoding* is
- the encoding of the output stream which defaults to ``'iso-8859-1'``.
- .. class:: XMLFilterBase(base)
- This class is designed to sit between an :class:`XMLReader` and the client
- application's event handlers. By default, it does nothing but pass requests up
- to the reader and events on to the handlers unmodified, but subclasses can
- override specific methods to modify the event stream or the configuration
- requests as they pass through.
- .. function:: prepare_input_source(source[, base])
- This function takes an input source and an optional base URL and returns a fully
- resolved :class:`InputSource` object ready for reading. The input source can be
- given as a string, a file-like object, or an :class:`InputSource` object;
- parsers will use this function to implement the polymorphic *source* argument to
- their :meth:`parse` method.