Doc/lib/xmlsaxutils.tex

   1 \section{\module{xml.sax.saxutils} ---
   2          SAX Utilities}
   3
   4 \declaremodule{standard}{xml.sax.saxutils}
   5 \modulesynopsis{Convenience functions and classes for use with SAX.}
   6 \sectionauthor{Martin v. L\"owis}{loewis@informatik.hu-berlin.de}
   7 \moduleauthor{Lars Marius Garshol}{larsga@garshol.priv.no}
   8
   9 \versionadded{2.0}
  10
  11
  12 The module \module{xml.sax.saxutils} contains a number of classes and
  13 functions that are commonly useful when creating SAX applications,
  14 either in direct use, or as base classes.
  15
  16 \begin{funcdesc}{escape}{data\optional{, entities}}
  17   Escape \character{\&}, \character{<}, and \character{>} in a string
  18   of data.
  19
  20   You can escape other strings of data by passing a dictionary as the
  21   optional \var{entities} parameter.  The keys and values must all be
  22   strings; each key will be replaced with its corresponding value.
  23 \end{funcdesc}
  24
  25 \begin{funcdesc}{quoteattr}{data\optional{, entities}}
  26   Similar to \function{escape()}, but also prepares \var{data} to be
  27   used as an attribute value.  The return value is a quoted version of
  28   \var{data} with any additional required replacements.
  29   \function{quoteattr()} will select a quote character based on the
  30   content of \var{data}, attempting to avoid encoding any quote
  31   characters in the string.  If both single- and double-quote
  32   characters are already in \var{data}, the double-quote characters
  33   will be encoded and \var{data} will be wrapped in doule-quotes.  The
  34   resulting string can be used directly as an attribute value:
  35
  36 \begin{verbatim}
  37 >>> print "<element attr=%s>" % quoteattr("ab ' cd \" ef")
  38 <element attr="ab ' cd &quot; ef">
  39 \end{verbatim}
  40
  41   This function is useful when generating attribute values for HTML or
  42   any SGML using the reference concrete syntax.
  43   \versionadded{2.2}
  44 \end{funcdesc}
  45
  46 \begin{classdesc}{XMLGenerator}{\optional{out\optional{, encoding}}}
  47   This class implements the \class{ContentHandler} interface by
  48   writing SAX events back into an XML document. In other words, using
  49   an \class{XMLGenerator} as the content handler will reproduce the
  50   original document being parsed. \var{out} should be a file-like
  51   object which will default to \var{sys.stdout}. \var{encoding} is the
  52   encoding of the output stream which defaults to \code{'iso-8859-1'}.
  53 \end{classdesc}
  54
  55 \begin{classdesc}{XMLFilterBase}{base}
  56   This class is designed to sit between an \class{XMLReader} and the
  57   client application's event handlers.  By default, it does nothing
  58   but pass requests up to the reader and events on to the handlers
  59   unmodified, but subclasses can override specific methods to modify
  60   the event stream or the configuration requests as they pass through.
  61 \end{classdesc}
  62
  63 \begin{funcdesc}{prepare_input_source}{source\optional{, base}}
  64   This function takes an input source and an optional base URL and
  65   returns a fully resolved \class{InputSource} object ready for
  66   reading.  The input source can be given as a string, a file-like
  67   object, or an \class{InputSource} object; parsers will use this
  68   function to implement the polymorphic \var{source} argument to their
  69   \method{parse()} method.
  70 \end{funcdesc}