]> granicus.if.org Git - python/commitdiff
added missing documentation for UseForeignDTD() (new in 2.3)
authorFred Drake <fdrake@acm.org>
Tue, 10 Aug 2004 17:18:32 +0000 (17:18 +0000)
committerFred Drake <fdrake@acm.org>
Tue, 10 Aug 2004 17:18:32 +0000 (17:18 +0000)
someone should backport to the release23-maint branch

Doc/lib/libpyexpat.tex

index 4fc103d02ee3d62a3c4d0c246403ed6bf51f0e50..5b1c7372a3eab58b14146f30ed10f708ab1876e2 100644 (file)
@@ -156,6 +156,27 @@ The child parser is created with the \member{ordered_attributes},
 values of this parser.
 \end{methoddesc}
 
+\begin{methoddesc}[xmlparser]{UseForeignDTD}{\optional{flag}}
+Calling this with a true value for \var{flag} (the default) will cause
+Expat to call the \member{ExternalEntityRefHandler} with
+\constant{None} for all arguments to allow an alternate DTD to be
+loaded.  If the document does not contain a document type declaration,
+the \member{ExternalEntityRefHandler} will still be called, but the
+\member{StartDoctypeDeclHandler} and \member{EndDoctypeDeclHandler}
+will not be called.
+
+Passing a false value for \var{flag} will cancel a previous call that
+passed a true value, but otherwise has no effect.
+
+This method can only be called before the \method{Parse()} or
+\method{ParseFile()} methods are called; calling it after either of
+those have been called causes \exception{ExpatError} to be raised with
+the \member{code} attribute set to
+\constant{errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING}.
+
+\versionadded{2.3}
+\end{methoddesc}
+
 
 \class{xmlparser} objects have the following attributes: