new repository

1 files changed, 141 insertions, 0 deletions

diff --git a/devdocs/python~3.12/library%2Fxml.sax.reader.html b/devdocs/python~3.12/library%2Fxml.sax.reader.html
new file mode 100644
index 00000000..b5d0ec57
--- /dev/null
+++ b/devdocs/python~3.12/library%2Fxml.sax.reader.html
@@ -0,0 +1,141 @@
+ <span id="xml-sax-xmlreader-interface-for-xml-parsers"></span><h1>xml.sax.xmlreader — Interface for XML parsers</h1> <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/xml/sax/xmlreader.py">Lib/xml/sax/xmlreader.py</a></p>  <p>SAX parsers implement the <a class="reference internal" href="#xml.sax.xmlreader.XMLReader" title="xml.sax.xmlreader.XMLReader"><code>XMLReader</code></a> interface. They are implemented in a Python module, which must provide a function <code>create_parser()</code>. This function is invoked by <a class="reference internal" href="xml.sax#xml.sax.make_parser" title="xml.sax.make_parser"><code>xml.sax.make_parser()</code></a> with no arguments to create a new parser object.</p> <dl class="py class"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader">
+<code>class xml.sax.xmlreader.XMLReader</code> </dt> <dd>
+<p>Base class which can be inherited by SAX parsers.</p> </dd>
+</dl> <dl class="py class"> <dt class="sig sig-object py" id="xml.sax.xmlreader.IncrementalParser">
+<code>class xml.sax.xmlreader.IncrementalParser</code> </dt> <dd>
+<p>In some cases, it is desirable not to parse an input source at once, but to feed chunks of the document as they get available. Note that the reader will normally not read the entire file, but read it in chunks as well; still <code>parse()</code> won’t return until the entire document is processed. So these interfaces should be used if the blocking behaviour of <code>parse()</code> is not desirable.</p> <p>When the parser is instantiated it is ready to begin accepting data from the feed method immediately. After parsing has been finished with a call to close the reset method must be called to make the parser ready to accept new data, either from feed or using the parse method.</p> <p>Note that these methods must <em>not</em> be called during parsing, that is, after parse has been called and before it returns.</p> <p>By default, the class also implements the parse method of the XMLReader interface using the feed, close and reset methods of the IncrementalParser interface as a convenience to SAX 2.0 driver writers.</p> </dd>
+</dl> <dl class="py class"> <dt class="sig sig-object py" id="xml.sax.xmlreader.Locator">
+<code>class xml.sax.xmlreader.Locator</code> </dt> <dd>
+<p>Interface for associating a SAX event with a document location. A locator object will return valid results only during calls to DocumentHandler methods; at any other time, the results are unpredictable. If information is not available, methods may return <code>None</code>.</p> </dd>
+</dl> <dl class="py class"> <dt class="sig sig-object py" id="xml.sax.xmlreader.InputSource">
+<code>class xml.sax.xmlreader.InputSource(system_id=None)</code> </dt> <dd>
+<p>Encapsulation of the information needed by the <a class="reference internal" href="#xml.sax.xmlreader.XMLReader" title="xml.sax.xmlreader.XMLReader"><code>XMLReader</code></a> to read entities.</p> <p>This class may include information about the public identifier, system identifier, byte stream (possibly with character encoding information) and/or the character stream of an entity.</p> <p>Applications will create objects of this class for use in the <a class="reference internal" href="#xml.sax.xmlreader.XMLReader.parse" title="xml.sax.xmlreader.XMLReader.parse"><code>XMLReader.parse()</code></a> method and for returning from EntityResolver.resolveEntity.</p> <p>An <a class="reference internal" href="#xml.sax.xmlreader.InputSource" title="xml.sax.xmlreader.InputSource"><code>InputSource</code></a> belongs to the application, the <a class="reference internal" href="#xml.sax.xmlreader.XMLReader" title="xml.sax.xmlreader.XMLReader"><code>XMLReader</code></a> is not allowed to modify <a class="reference internal" href="#xml.sax.xmlreader.InputSource" title="xml.sax.xmlreader.InputSource"><code>InputSource</code></a> objects passed to it from the application, although it may make copies and modify those.</p> </dd>
+</dl> <dl class="py class"> <dt class="sig sig-object py" id="xml.sax.xmlreader.AttributesImpl">
+<code>class xml.sax.xmlreader.AttributesImpl(attrs)</code> </dt> <dd>
+<p>This is an implementation of the <code>Attributes</code> interface (see section <a class="reference internal" href="#attributes-objects"><span class="std std-ref">The Attributes Interface</span></a>). This is a dictionary-like object which represents the element attributes in a <code>startElement()</code> call. In addition to the most useful dictionary operations, it supports a number of other methods as described by the interface. Objects of this class should be instantiated by readers; <em>attrs</em> must be a dictionary-like object containing a mapping from attribute names to attribute values.</p> </dd>
+</dl> <dl class="py class"> <dt class="sig sig-object py" id="xml.sax.xmlreader.AttributesNSImpl">
+<code>class xml.sax.xmlreader.AttributesNSImpl(attrs, qnames)</code> </dt> <dd>
+<p>Namespace-aware variant of <a class="reference internal" href="#xml.sax.xmlreader.AttributesImpl" title="xml.sax.xmlreader.AttributesImpl"><code>AttributesImpl</code></a>, which will be passed to <code>startElementNS()</code>. It is derived from <a class="reference internal" href="#xml.sax.xmlreader.AttributesImpl" title="xml.sax.xmlreader.AttributesImpl"><code>AttributesImpl</code></a>, but understands attribute names as two-tuples of <em>namespaceURI</em> and <em>localname</em>. In addition, it provides a number of methods expecting qualified names as they appear in the original document. This class implements the <code>AttributesNS</code> interface (see section <a class="reference internal" href="#attributes-ns-objects"><span class="std std-ref">The AttributesNS Interface</span></a>).</p> </dd>
+</dl> <section id="xmlreader-objects"> <span id="id1"></span><h2>XMLReader Objects</h2> <p>The <a class="reference internal" href="#xml.sax.xmlreader.XMLReader" title="xml.sax.xmlreader.XMLReader"><code>XMLReader</code></a> interface supports the following methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.parse">
+<code>XMLReader.parse(source)</code> </dt> <dd>
+<p>Process an input source, producing SAX events. The <em>source</em> object can be a system identifier (a string identifying the input source – typically a file name or a URL), a <a class="reference internal" href="pathlib#pathlib.Path" title="pathlib.Path"><code>pathlib.Path</code></a> or <a class="reference internal" href="../glossary#term-path-like-object"><span class="xref std std-term">path-like</span></a> object, or an <a class="reference internal" href="#xml.sax.xmlreader.InputSource" title="xml.sax.xmlreader.InputSource"><code>InputSource</code></a> object. When <a class="reference internal" href="#xml.sax.xmlreader.XMLReader.parse" title="xml.sax.xmlreader.XMLReader.parse"><code>parse()</code></a> returns, the input is completely processed, and the parser object can be discarded or reset.</p> <div class="versionchanged"> <p><span class="versionmodified changed">Changed in version 3.5: </span>Added support of character streams.</p> </div> <div class="versionchanged"> <p><span class="versionmodified changed">Changed in version 3.8: </span>Added support of path-like objects.</p> </div> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.getContentHandler">
+<code>XMLReader.getContentHandler()</code> </dt> <dd>
+<p>Return the current <a class="reference internal" href="xml.sax.handler#xml.sax.handler.ContentHandler" title="xml.sax.handler.ContentHandler"><code>ContentHandler</code></a>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.setContentHandler">
+<code>XMLReader.setContentHandler(handler)</code> </dt> <dd>
+<p>Set the current <a class="reference internal" href="xml.sax.handler#xml.sax.handler.ContentHandler" title="xml.sax.handler.ContentHandler"><code>ContentHandler</code></a>. If no <a class="reference internal" href="xml.sax.handler#xml.sax.handler.ContentHandler" title="xml.sax.handler.ContentHandler"><code>ContentHandler</code></a> is set, content events will be discarded.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.getDTDHandler">
+<code>XMLReader.getDTDHandler()</code> </dt> <dd>
+<p>Return the current <a class="reference internal" href="xml.sax.handler#xml.sax.handler.DTDHandler" title="xml.sax.handler.DTDHandler"><code>DTDHandler</code></a>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.setDTDHandler">
+<code>XMLReader.setDTDHandler(handler)</code> </dt> <dd>
+<p>Set the current <a class="reference internal" href="xml.sax.handler#xml.sax.handler.DTDHandler" title="xml.sax.handler.DTDHandler"><code>DTDHandler</code></a>. If no <a class="reference internal" href="xml.sax.handler#xml.sax.handler.DTDHandler" title="xml.sax.handler.DTDHandler"><code>DTDHandler</code></a> is set, DTD events will be discarded.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.getEntityResolver">
+<code>XMLReader.getEntityResolver()</code> </dt> <dd>
+<p>Return the current <a class="reference internal" href="xml.sax.handler#xml.sax.handler.EntityResolver" title="xml.sax.handler.EntityResolver"><code>EntityResolver</code></a>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.setEntityResolver">
+<code>XMLReader.setEntityResolver(handler)</code> </dt> <dd>
+<p>Set the current <a class="reference internal" href="xml.sax.handler#xml.sax.handler.EntityResolver" title="xml.sax.handler.EntityResolver"><code>EntityResolver</code></a>. If no <a class="reference internal" href="xml.sax.handler#xml.sax.handler.EntityResolver" title="xml.sax.handler.EntityResolver"><code>EntityResolver</code></a> is set, attempts to resolve an external entity will result in opening the system identifier for the entity, and fail if it is not available.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.getErrorHandler">
+<code>XMLReader.getErrorHandler()</code> </dt> <dd>
+<p>Return the current <a class="reference internal" href="xml.sax.handler#xml.sax.handler.ErrorHandler" title="xml.sax.handler.ErrorHandler"><code>ErrorHandler</code></a>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.setErrorHandler">
+<code>XMLReader.setErrorHandler(handler)</code> </dt> <dd>
+<p>Set the current error handler. If no <a class="reference internal" href="xml.sax.handler#xml.sax.handler.ErrorHandler" title="xml.sax.handler.ErrorHandler"><code>ErrorHandler</code></a> is set, errors will be raised as exceptions, and warnings will be printed.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.setLocale">
+<code>XMLReader.setLocale(locale)</code> </dt> <dd>
+<p>Allow an application to set the locale for errors and warnings.</p> <p>SAX parsers are not required to provide localization for errors and warnings; if they cannot support the requested locale, however, they must raise a SAX exception. Applications may request a locale change in the middle of a parse.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.getFeature">
+<code>XMLReader.getFeature(featurename)</code> </dt> <dd>
+<p>Return the current setting for feature <em>featurename</em>. If the feature is not recognized, <code>SAXNotRecognizedException</code> is raised. The well-known featurenames are listed in the module <a class="reference internal" href="xml.sax.handler#module-xml.sax.handler" title="xml.sax.handler: Base classes for SAX event handlers."><code>xml.sax.handler</code></a>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.setFeature">
+<code>XMLReader.setFeature(featurename, value)</code> </dt> <dd>
+<p>Set the <em>featurename</em> to <em>value</em>. If the feature is not recognized, <code>SAXNotRecognizedException</code> is raised. If the feature or its setting is not supported by the parser, <em>SAXNotSupportedException</em> is raised.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.getProperty">
+<code>XMLReader.getProperty(propertyname)</code> </dt> <dd>
+<p>Return the current setting for property <em>propertyname</em>. If the property is not recognized, a <code>SAXNotRecognizedException</code> is raised. The well-known propertynames are listed in the module <a class="reference internal" href="xml.sax.handler#module-xml.sax.handler" title="xml.sax.handler: Base classes for SAX event handlers."><code>xml.sax.handler</code></a>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.XMLReader.setProperty">
+<code>XMLReader.setProperty(propertyname, value)</code> </dt> <dd>
+<p>Set the <em>propertyname</em> to <em>value</em>. If the property is not recognized, <code>SAXNotRecognizedException</code> is raised. If the property or its setting is not supported by the parser, <em>SAXNotSupportedException</em> is raised.</p> </dd>
+</dl> </section> <section id="incrementalparser-objects"> <span id="incremental-parser-objects"></span><h2>IncrementalParser Objects</h2> <p>Instances of <a class="reference internal" href="#xml.sax.xmlreader.IncrementalParser" title="xml.sax.xmlreader.IncrementalParser"><code>IncrementalParser</code></a> offer the following additional methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.IncrementalParser.feed">
+<code>IncrementalParser.feed(data)</code> </dt> <dd>
+<p>Process a chunk of <em>data</em>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.IncrementalParser.close">
+<code>IncrementalParser.close()</code> </dt> <dd>
+<p>Assume the end of the document. That will check well-formedness conditions that can be checked only at the end, invoke handlers, and may clean up resources allocated during parsing.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.IncrementalParser.reset">
+<code>IncrementalParser.reset()</code> </dt> <dd>
+<p>This method is called after close has been called to reset the parser so that it is ready to parse new documents. The results of calling parse or feed after close without calling reset are undefined.</p> </dd>
+</dl> </section> <section id="locator-objects"> <span id="id2"></span><h2>Locator Objects</h2> <p>Instances of <a class="reference internal" href="#xml.sax.xmlreader.Locator" title="xml.sax.xmlreader.Locator"><code>Locator</code></a> provide these methods:</p> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.Locator.getColumnNumber">
+<code>Locator.getColumnNumber()</code> </dt> <dd>
+<p>Return the column number where the current event begins.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.Locator.getLineNumber">
+<code>Locator.getLineNumber()</code> </dt> <dd>
+<p>Return the line number where the current event begins.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.Locator.getPublicId">
+<code>Locator.getPublicId()</code> </dt> <dd>
+<p>Return the public identifier for the current event.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.Locator.getSystemId">
+<code>Locator.getSystemId()</code> </dt> <dd>
+<p>Return the system identifier for the current event.</p> </dd>
+</dl> </section> <section id="inputsource-objects"> <span id="input-source-objects"></span><h2>InputSource Objects</h2> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.InputSource.setPublicId">
+<code>InputSource.setPublicId(id)</code> </dt> <dd>
+<p>Sets the public identifier of this <a class="reference internal" href="#xml.sax.xmlreader.InputSource" title="xml.sax.xmlreader.InputSource"><code>InputSource</code></a>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.InputSource.getPublicId">
+<code>InputSource.getPublicId()</code> </dt> <dd>
+<p>Returns the public identifier of this <a class="reference internal" href="#xml.sax.xmlreader.InputSource" title="xml.sax.xmlreader.InputSource"><code>InputSource</code></a>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.InputSource.setSystemId">
+<code>InputSource.setSystemId(id)</code> </dt> <dd>
+<p>Sets the system identifier of this <a class="reference internal" href="#xml.sax.xmlreader.InputSource" title="xml.sax.xmlreader.InputSource"><code>InputSource</code></a>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.InputSource.getSystemId">
+<code>InputSource.getSystemId()</code> </dt> <dd>
+<p>Returns the system identifier of this <a class="reference internal" href="#xml.sax.xmlreader.InputSource" title="xml.sax.xmlreader.InputSource"><code>InputSource</code></a>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.InputSource.setEncoding">
+<code>InputSource.setEncoding(encoding)</code> </dt> <dd>
+<p>Sets the character encoding of this <a class="reference internal" href="#xml.sax.xmlreader.InputSource" title="xml.sax.xmlreader.InputSource"><code>InputSource</code></a>.</p> <p>The encoding must be a string acceptable for an XML encoding declaration (see section 4.3.3 of the XML recommendation).</p> <p>The encoding attribute of the <a class="reference internal" href="#xml.sax.xmlreader.InputSource" title="xml.sax.xmlreader.InputSource"><code>InputSource</code></a> is ignored if the <a class="reference internal" href="#xml.sax.xmlreader.InputSource" title="xml.sax.xmlreader.InputSource"><code>InputSource</code></a> also contains a character stream.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.InputSource.getEncoding">
+<code>InputSource.getEncoding()</code> </dt> <dd>
+<p>Get the character encoding of this InputSource.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.InputSource.setByteStream">
+<code>InputSource.setByteStream(bytefile)</code> </dt> <dd>
+<p>Set the byte stream (a <a class="reference internal" href="../glossary#term-binary-file"><span class="xref std std-term">binary file</span></a>) for this input source.</p> <p>The SAX parser will ignore this if there is also a character stream specified, but it will use a byte stream in preference to opening a URI connection itself.</p> <p>If the application knows the character encoding of the byte stream, it should set it with the setEncoding method.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.InputSource.getByteStream">
+<code>InputSource.getByteStream()</code> </dt> <dd>
+<p>Get the byte stream for this input source.</p> <p>The getEncoding method will return the character encoding for this byte stream, or <code>None</code> if unknown.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.InputSource.setCharacterStream">
+<code>InputSource.setCharacterStream(charfile)</code> </dt> <dd>
+<p>Set the character stream (a <a class="reference internal" href="../glossary#term-text-file"><span class="xref std std-term">text file</span></a>) for this input source.</p> <p>If there is a character stream specified, the SAX parser will ignore any byte stream and will not attempt to open a URI connection to the system identifier.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.InputSource.getCharacterStream">
+<code>InputSource.getCharacterStream()</code> </dt> <dd>
+<p>Get the character stream for this input source.</p> </dd>
+</dl> </section> <section id="the-attributes-interface"> <span id="attributes-objects"></span><h2>The <code>Attributes</code> Interface</h2> <p><code>Attributes</code> objects implement a portion of the <a class="reference internal" href="../glossary#term-mapping"><span class="xref std std-term">mapping protocol</span></a>, including the methods <code>copy()</code>, <code>get()</code>, <a class="reference internal" href="../reference/datamodel#object.__contains__" title="object.__contains__"><code>__contains__()</code></a>, <code>items()</code>, <code>keys()</code>, and <code>values()</code>. The following methods are also provided:</p> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.Attributes.getLength">
+<code>Attributes.getLength()</code> </dt> <dd>
+<p>Return the number of attributes.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.Attributes.getNames">
+<code>Attributes.getNames()</code> </dt> <dd>
+<p>Return the names of the attributes.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.Attributes.getType">
+<code>Attributes.getType(name)</code> </dt> <dd>
+<p>Returns the type of the attribute <em>name</em>, which is normally <code>'CDATA'</code>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.Attributes.getValue">
+<code>Attributes.getValue(name)</code> </dt> <dd>
+<p>Return the value of attribute <em>name</em>.</p> </dd>
+</dl> </section> <section id="the-attributesns-interface"> <span id="attributes-ns-objects"></span><h2>The <code>AttributesNS</code> Interface</h2> <p>This interface is a subtype of the <code>Attributes</code> interface (see section <a class="reference internal" href="#attributes-objects"><span class="std std-ref">The Attributes Interface</span></a>). All methods supported by that interface are also available on <code>AttributesNS</code> objects.</p> <p>The following methods are also available:</p> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.AttributesNS.getValueByQName">
+<code>AttributesNS.getValueByQName(name)</code> </dt> <dd>
+<p>Return the value for a qualified name.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.AttributesNS.getNameByQName">
+<code>AttributesNS.getNameByQName(name)</code> </dt> <dd>
+<p>Return the <code>(namespace, localname)</code> pair for a qualified <em>name</em>.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.AttributesNS.getQNameByName">
+<code>AttributesNS.getQNameByName(name)</code> </dt> <dd>
+<p>Return the qualified name for a <code>(namespace, localname)</code> pair.</p> </dd>
+</dl> <dl class="py method"> <dt class="sig sig-object py" id="xml.sax.xmlreader.AttributesNS.getQNames">
+<code>AttributesNS.getQNames()</code> </dt> <dd>
+<p>Return the qualified names of all attributes.</p> </dd>
+</dl> </section> <div class="_attribution">
+  <p class="_attribution-p">
+    &copy; 2001&ndash;2023 Python Software Foundation<br>Licensed under the PSF License.<br>
+    <a href="https://docs.python.org/3.12/library/xml.sax.reader.html" class="_attribution-link">https://docs.python.org/3.12/library/xml.sax.reader.html</a>
+  </p>
+</div>