summaryrefslogtreecommitdiffstats
path: root/Doc/library/xml.sax.utils.rst
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2013-08-29 07:28:44 (GMT)
committerSerhiy Storchaka <storchaka@gmail.com>2013-08-29 07:28:44 (GMT)
commit15e6590774956a5bbb3a901bf5328869eb44ad49 (patch)
tree19ab1592f8fa1aefeab9c2cff2418ad10c1bf212 /Doc/library/xml.sax.utils.rst
parent3b44a409de0ac3ab2558e77716b8f0c821db6cde (diff)
downloadcpython-15e6590774956a5bbb3a901bf5328869eb44ad49.zip
cpython-15e6590774956a5bbb3a901bf5328869eb44ad49.tar.gz
cpython-15e6590774956a5bbb3a901bf5328869eb44ad49.tar.bz2
Issue #18760: Improved cross-references in the xml package.
Diffstat (limited to 'Doc/library/xml.sax.utils.rst')
-rw-r--r--Doc/library/xml.sax.utils.rst17
1 files changed, 10 insertions, 7 deletions
diff --git a/Doc/library/xml.sax.utils.rst b/Doc/library/xml.sax.utils.rst
index 0a4038c..14cf078 100644
--- a/Doc/library/xml.sax.utils.rst
+++ b/Doc/library/xml.sax.utils.rst
@@ -52,7 +52,8 @@ or as base classes.
.. class:: XMLGenerator(out=None, encoding='iso-8859-1', short_empty_elements=False)
- This class implements the :class:`ContentHandler` interface by writing SAX
+ This class implements the :class:`~xml.sax.handler.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
@@ -67,7 +68,8 @@ or as base classes.
.. class:: XMLFilterBase(base)
- This class is designed to sit between an :class:`XMLReader` and the client
+ This class is designed to sit between an
+ :class:`~xml.sax.xmlreader.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
@@ -76,9 +78,10 @@ or as base classes.
.. 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.
+ This function takes an input source and an optional base URL and returns a
+ fully resolved :class:`~xml.sax.xmlreader.InputSource` object ready for
+ reading. The input source can be given as a string, a file-like object, or
+ an :class:`~xml.sax.xmlreader.InputSource` object; parsers will use this
+ function to implement the polymorphic *source* argument to their
+ :meth:`parse` method.