diff options
author | Fred Drake <fdrake@acm.org> | 2000-10-12 20:05:09 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2000-10-12 20:05:09 (GMT) |
commit | 014f0e33946c212e60604b4cf819cfec9fabb041 (patch) | |
tree | 515bc8be5ed1ecfa28d94e0d6036601eab1ecaca /Doc/lib/xmlsax.tex | |
parent | 110941a4ba037a3cab0224370aed71c465a2f865 (diff) | |
download | cpython-014f0e33946c212e60604b4cf819cfec9fabb041.zip cpython-014f0e33946c212e60604b4cf819cfec9fabb041.tar.gz cpython-014f0e33946c212e60604b4cf819cfec9fabb041.tar.bz2 |
Massive addition of SAX documentation from Martin von Loewis
<loewis@informatik.hu-berlin.de>.
Reorganized to be more like other parts of the documentation in its
arrangement, but with few content changes.
This closes SourceForge patch #101850.
Diffstat (limited to 'Doc/lib/xmlsax.tex')
-rw-r--r-- | Doc/lib/xmlsax.tex | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/Doc/lib/xmlsax.tex b/Doc/lib/xmlsax.tex index d09777f..c1b94da 100644 --- a/Doc/lib/xmlsax.tex +++ b/Doc/lib/xmlsax.tex @@ -6,6 +6,7 @@ functions.} \moduleauthor{Lars Marius Garshol}{larsga@garshol.priv.no} \sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org} +\sectionauthor{Martin v. L\"owis}{loewis@informatik.hu-berlin.de} \versionadded{2.0} @@ -41,8 +42,29 @@ The convenience functions are: received as a parameter. \end{funcdesc} - -The SAX exceptions are also provided here: +A typical SAX application uses three kinds of objects: readers, +handlers and input sources. ``Reader'' in this context is another term +for parser, ie. some piece of code that reads the bytes or characters +from the input source, and produces a sequence of events. The events +then get distributed to the handler objects, ie. the reader invokes a +method on the handler. A SAX application must therefore obtain a +handler object, create or open the input sources, create the handlers, +and connect these objects all together. As the final step, parsing is +invoked. During parsing + +For these objects, only the interfaces are relevant; they are normally +not instantiated by the application itself. Since Python does not have +an explicit notion of interface, they are formally introduced as +classes. The \class{InputSource}, \class{Locator}, +\class{AttributesImpl}, and \class{XMLReader} interfaces are defined +in the module \refmodule{xml.sax.xmlreader}. The handler interfaces +are defined in \refmodule{xml.sax.handler}. For convenience, +\class{InputSource} (which is often instantiated directly) and the +handler classes are also available from \module{xml.sax}. These +classes are described below. + +In addition to these classes, \module{xml.sax} provides the following +exception classes. \begin{excclassdesc}{SAXException}{msg\optional{, exception}} Encapsulate an XML error or warning. This class can contain basic @@ -94,7 +116,7 @@ The SAX exceptions are also provided here: \end{seealso} -\subsection{SAXException Objects \label{saxexception-objects}} +\subsection{SAXException Objects \label{sax-exception-objects}} The \class{SAXException} exception class supports the following methods: |