Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Watch 1
Star 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 0f75e31513
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/xml.sax.handler.html

809 lines
58KB
Raw Blame History 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="xml.sax.handler — Base classes for SAX handlers" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/xml.sax.handler.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/xml/sax/handler.py The SAX API defines five kinds of handlers: content handlers, DTD handlers, error handlers, entity resolvers and lexical handlers. Applications normally only nee..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/xml/sax/handler.py The SAX API defines five kinds of handlers: content handlers, DTD handlers, error handlers, entity resolvers and lexical handlers. Applications normally only nee..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>xml.sax.handler — Base classes for SAX handlers &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="xml.sax.saxutils — SAX Utilities" href="xml.sax.utils.html" />

  39.     <link rel="prev" title="xml.sax — Support for SAX2 parsers" href="xml.sax.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/xml.sax.handler.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xml.sax.handler</span></code> — Base classes for SAX handlers</a><ul>

  99. <li><a class="reference internal" href="#contenthandler-objects">ContentHandler Objects</a></li>

  100. <li><a class="reference internal" href="#dtdhandler-objects">DTDHandler Objects</a></li>

  101. <li><a class="reference internal" href="#entityresolver-objects">EntityResolver Objects</a></li>

  102. <li><a class="reference internal" href="#errorhandler-objects">ErrorHandler Objects</a></li>

  103. <li><a class="reference internal" href="#lexicalhandler-objects">LexicalHandler Objects</a></li>

  104. </ul>

  105. </li>

  106. </ul>

  107. 

  108.   </div>

  109.   <div>

  110.     <h4>Previous topic</h4>

  111.     <p class="topless"><a href="xml.sax.html"

  112.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xml.sax</span></code> — Support for SAX2 parsers</a></p>

  113.   </div>

  114.   <div>

  115.     <h4>Next topic</h4>

  116.     <p class="topless"><a href="xml.sax.utils.html"

  117.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xml.sax.saxutils</span></code> — SAX Utilities</a></p>

  118.   </div>

  119.   <div role="note" aria-label="source link">

  120.     <h3>This Page</h3>

  121.     <ul class="this-page-menu">

  122.       <li><a href="../bugs.html">Report a Bug</a></li>

  123.       <li>

  124.         <a href="https://github.com/python/cpython/blob/main/Doc/library/xml.sax.handler.rst"

  125.             rel="nofollow">Show Source

  126.         </a>

  127.       </li>

  128.     </ul>

  129.   </div>

  130.         </nav>

  131.     </div>

  132. </div>

  133. 

  134.   

  135.     <div class="related" role="navigation" aria-label="related navigation">

  136.       <h3>Navigation</h3>

  137.       <ul>

  138.         <li class="right" style="margin-right: 10px">

  139.           <a href="../genindex.html" title="General Index"

  140.              accesskey="I">index</a></li>

  141.         <li class="right" >

  142.           <a href="../py-modindex.html" title="Python Module Index"

  143.              >modules</a> |</li>

  144.         <li class="right" >

  145.           <a href="xml.sax.utils.html" title="xml.sax.saxutils — SAX Utilities"

  146.              accesskey="N">next</a> |</li>

  147.         <li class="right" >

  148.           <a href="xml.sax.html" title="xml.sax — Support for SAX2 parsers"

  149.              accesskey="P">previous</a> |</li>

  150. 

  151.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  152.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  153.           <li class="switchers">

  154.             <div class="language_switcher_placeholder"></div>

  155.             <div class="version_switcher_placeholder"></div>

  156.           </li>

  157.           <li>

  158.               

  159.           </li>

  160.     <li id="cpython-language-and-version">

  161.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  162.     </li>

  163. 

  164.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  165.           <li class="nav-item nav-item-2"><a href="markup.html" accesskey="U">Structured Markup Processing Tools</a> &#187;</li>

  166.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">xml.sax.handler</span></code> — Base classes for SAX handlers</a></li>

  167.                 <li class="right">

  168.                     

  169. 

  170.     <div class="inline-search" role="search">

  171.         <form class="inline-search" action="../search.html" method="get">

  172.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  173.           <input type="submit" value="Go" />

  174.         </form>

  175.     </div>

  176.                      |

  177.                 </li>

  178.             <li class="right">

  179. <label class="theme-selector-label">

  180.     Theme

  181.     <select class="theme-selector" oninput="activateTheme(this.value)">

  182.         <option value="auto" selected>Auto</option>

  183.         <option value="light">Light</option>

  184.         <option value="dark">Dark</option>

  185.     </select>

  186. </label> |</li>

  187.             

  188.       </ul>

  189.     </div>    

  190. 

  191.     <div class="document">

  192.       <div class="documentwrapper">

  193.         <div class="bodywrapper">

  194.           <div class="body" role="main">

  195.             

  196.   <section id="module-xml.sax.handler">

  197. <span id="xml-sax-handler-base-classes-for-sax-handlers"></span><h1><a class="reference internal" href="#module-xml.sax.handler" title="xml.sax.handler: Base classes for SAX event handlers."><code class="xref py py-mod docutils literal notranslate"><span class="pre">xml.sax.handler</span></code></a> — Base classes for SAX handlers<a class="headerlink" href="#module-xml.sax.handler" title="Link to this heading">¶</a></h1>

  198. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/xml/sax/handler.py">Lib/xml/sax/handler.py</a></p>

  199. <hr class="docutils" />

  200. <p>The SAX API defines five kinds of handlers: content handlers, DTD handlers,

  201. error handlers, entity resolvers and lexical handlers. Applications normally

  202. only need to implement those interfaces whose events they are interested in;

  203. they can implement the interfaces in a single object or in multiple objects.

  204. Handler implementations should inherit from the base classes provided in the

  205. module <a class="reference internal" href="#module-xml.sax.handler" title="xml.sax.handler: Base classes for SAX event handlers."><code class="xref py py-mod docutils literal notranslate"><span class="pre">xml.sax.handler</span></code></a>, so that all methods get default implementations.</p>

  206. <dl class="py class">

  207. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler">

  208. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">ContentHandler</span></span><a class="headerlink" href="#xml.sax.handler.ContentHandler" title="Link to this definition">¶</a></dt>

  209. <dd><p>This is the main callback interface in SAX, and the one most important to

  210. applications. The order of events in this interface mirrors the order of the

  211. information in the document.</p>

  212. </dd></dl>

  213. 

  214. <dl class="py class">

  215. <dt class="sig sig-object py" id="xml.sax.handler.DTDHandler">

  216. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">DTDHandler</span></span><a class="headerlink" href="#xml.sax.handler.DTDHandler" title="Link to this definition">¶</a></dt>

  217. <dd><p>Handle DTD events.</p>

  218. <p>This interface specifies only those DTD events required for basic parsing

  219. (unparsed entities and attributes).</p>

  220. </dd></dl>

  221. 

  222. <dl class="py class">

  223. <dt class="sig sig-object py" id="xml.sax.handler.EntityResolver">

  224. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">EntityResolver</span></span><a class="headerlink" href="#xml.sax.handler.EntityResolver" title="Link to this definition">¶</a></dt>

  225. <dd><p>Basic interface for resolving entities. If you create an object implementing

  226. this interface, then register the object with your Parser, the parser will call

  227. the method in your object to resolve all external entities.</p>

  228. </dd></dl>

  229. 

  230. <dl class="py class">

  231. <dt class="sig sig-object py" id="xml.sax.handler.ErrorHandler">

  232. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">ErrorHandler</span></span><a class="headerlink" href="#xml.sax.handler.ErrorHandler" title="Link to this definition">¶</a></dt>

  233. <dd><p>Interface used by the parser to present error and warning messages to the

  234. application.  The methods of this object control whether errors are immediately

  235. converted to exceptions or are handled in some other way.</p>

  236. </dd></dl>

  237. 

  238. <dl class="py class">

  239. <dt class="sig sig-object py" id="xml.sax.handler.LexicalHandler">

  240. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">LexicalHandler</span></span><a class="headerlink" href="#xml.sax.handler.LexicalHandler" title="Link to this definition">¶</a></dt>

  241. <dd><p>Interface used by the parser to represent low frequency events which may not

  242. be of interest to many applications.</p>

  243. </dd></dl>

  244. 

  245. <p>In addition to these classes, <a class="reference internal" href="#module-xml.sax.handler" title="xml.sax.handler: Base classes for SAX event handlers."><code class="xref py py-mod docutils literal notranslate"><span class="pre">xml.sax.handler</span></code></a> provides symbolic constants

  246. for the feature and property names.</p>

  247. <dl class="py data">

  248. <dt class="sig sig-object py" id="xml.sax.handler.feature_namespaces">

  249. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">feature_namespaces</span></span><a class="headerlink" href="#xml.sax.handler.feature_namespaces" title="Link to this definition">¶</a></dt>

  250. <dd><div class="line-block">

  251. <div class="line">value: <code class="docutils literal notranslate"><span class="pre">&quot;http://xml.org/sax/features/namespaces&quot;</span></code></div>

  252. <div class="line">true: Perform Namespace processing.</div>

  253. <div class="line">false: Optionally do not perform Namespace processing (implies

  254. namespace-prefixes; default).</div>

  255. <div class="line">access: (parsing) read-only; (not parsing) read/write</div>

  256. </div>

  257. </dd></dl>

  258. 

  259. <dl class="py data">

  260. <dt class="sig sig-object py" id="xml.sax.handler.feature_namespace_prefixes">

  261. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">feature_namespace_prefixes</span></span><a class="headerlink" href="#xml.sax.handler.feature_namespace_prefixes" title="Link to this definition">¶</a></dt>

  262. <dd><div class="line-block">

  263. <div class="line">value: <code class="docutils literal notranslate"><span class="pre">&quot;http://xml.org/sax/features/namespace-prefixes&quot;</span></code></div>

  264. <div class="line">true: Report the original prefixed names and attributes used for Namespace

  265. declarations.</div>

  266. <div class="line">false: Do not report attributes used for Namespace declarations, and

  267. optionally do not report original prefixed names (default).</div>

  268. <div class="line">access: (parsing) read-only; (not parsing) read/write</div>

  269. </div>

  270. </dd></dl>

  271. 

  272. <dl class="py data">

  273. <dt class="sig sig-object py" id="xml.sax.handler.feature_string_interning">

  274. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">feature_string_interning</span></span><a class="headerlink" href="#xml.sax.handler.feature_string_interning" title="Link to this definition">¶</a></dt>

  275. <dd><div class="line-block">

  276. <div class="line">value: <code class="docutils literal notranslate"><span class="pre">&quot;http://xml.org/sax/features/string-interning&quot;</span></code></div>

  277. <div class="line">true: All element names, prefixes, attribute names, Namespace URIs, and

  278. local names are interned using the built-in intern function.</div>

  279. <div class="line">false: Names are not necessarily interned, although they may be (default).</div>

  280. <div class="line">access: (parsing) read-only; (not parsing) read/write</div>

  281. </div>

  282. </dd></dl>

  283. 

  284. <dl class="py data">

  285. <dt class="sig sig-object py" id="xml.sax.handler.feature_validation">

  286. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">feature_validation</span></span><a class="headerlink" href="#xml.sax.handler.feature_validation" title="Link to this definition">¶</a></dt>

  287. <dd><div class="line-block">

  288. <div class="line">value: <code class="docutils literal notranslate"><span class="pre">&quot;http://xml.org/sax/features/validation&quot;</span></code></div>

  289. <div class="line">true: Report all validation errors (implies external-general-entities and

  290. external-parameter-entities).</div>

  291. <div class="line">false: Do not report validation errors.</div>

  292. <div class="line">access: (parsing) read-only; (not parsing) read/write</div>

  293. </div>

  294. </dd></dl>

  295. 

  296. <dl class="py data">

  297. <dt class="sig sig-object py" id="xml.sax.handler.feature_external_ges">

  298. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">feature_external_ges</span></span><a class="headerlink" href="#xml.sax.handler.feature_external_ges" title="Link to this definition">¶</a></dt>

  299. <dd><div class="line-block">

  300. <div class="line">value: <code class="docutils literal notranslate"><span class="pre">&quot;http://xml.org/sax/features/external-general-entities&quot;</span></code></div>

  301. <div class="line">true: Include all external general (text) entities.</div>

  302. <div class="line">false: Do not include external general entities.</div>

  303. <div class="line">access: (parsing) read-only; (not parsing) read/write</div>

  304. </div>

  305. </dd></dl>

  306. 

  307. <dl class="py data">

  308. <dt class="sig sig-object py" id="xml.sax.handler.feature_external_pes">

  309. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">feature_external_pes</span></span><a class="headerlink" href="#xml.sax.handler.feature_external_pes" title="Link to this definition">¶</a></dt>

  310. <dd><div class="line-block">

  311. <div class="line">value: <code class="docutils literal notranslate"><span class="pre">&quot;http://xml.org/sax/features/external-parameter-entities&quot;</span></code></div>

  312. <div class="line">true: Include all external parameter entities, including the external DTD

  313. subset.</div>

  314. <div class="line">false: Do not include any external parameter entities, even the external

  315. DTD subset.</div>

  316. <div class="line">access: (parsing) read-only; (not parsing) read/write</div>

  317. </div>

  318. </dd></dl>

  319. 

  320. <dl class="py data">

  321. <dt class="sig sig-object py" id="xml.sax.handler.all_features">

  322. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">all_features</span></span><a class="headerlink" href="#xml.sax.handler.all_features" title="Link to this definition">¶</a></dt>

  323. <dd><p>List of all features.</p>

  324. </dd></dl>

  325. 

  326. <dl class="py data">

  327. <dt class="sig sig-object py" id="xml.sax.handler.property_lexical_handler">

  328. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">property_lexical_handler</span></span><a class="headerlink" href="#xml.sax.handler.property_lexical_handler" title="Link to this definition">¶</a></dt>

  329. <dd><div class="line-block">

  330. <div class="line">value: <code class="docutils literal notranslate"><span class="pre">&quot;http://xml.org/sax/properties/lexical-handler&quot;</span></code></div>

  331. <div class="line">data type: xml.sax.handler.LexicalHandler (not supported in Python 2)</div>

  332. <div class="line">description: An optional extension handler for lexical events like

  333. comments.</div>

  334. <div class="line">access: read/write</div>

  335. </div>

  336. </dd></dl>

  337. 

  338. <dl class="py data">

  339. <dt class="sig sig-object py" id="xml.sax.handler.property_declaration_handler">

  340. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">property_declaration_handler</span></span><a class="headerlink" href="#xml.sax.handler.property_declaration_handler" title="Link to this definition">¶</a></dt>

  341. <dd><div class="line-block">

  342. <div class="line">value: <code class="docutils literal notranslate"><span class="pre">&quot;http://xml.org/sax/properties/declaration-handler&quot;</span></code></div>

  343. <div class="line">data type: xml.sax.sax2lib.DeclHandler (not supported in Python 2)</div>

  344. <div class="line">description: An optional extension handler for DTD-related events other

  345. than notations and unparsed entities.</div>

  346. <div class="line">access: read/write</div>

  347. </div>

  348. </dd></dl>

  349. 

  350. <dl class="py data">

  351. <dt class="sig sig-object py" id="xml.sax.handler.property_dom_node">

  352. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">property_dom_node</span></span><a class="headerlink" href="#xml.sax.handler.property_dom_node" title="Link to this definition">¶</a></dt>

  353. <dd><div class="line-block">

  354. <div class="line">value: <code class="docutils literal notranslate"><span class="pre">&quot;http://xml.org/sax/properties/dom-node&quot;</span></code></div>

  355. <div class="line">data type: org.w3c.dom.Node (not supported in Python 2)</div>

  356. <div class="line">description: When parsing, the current DOM node being visited if this is

  357. a DOM iterator; when not parsing, the root DOM node for iteration.</div>

  358. <div class="line">access: (parsing) read-only; (not parsing) read/write</div>

  359. </div>

  360. </dd></dl>

  361. 

  362. <dl class="py data">

  363. <dt class="sig sig-object py" id="xml.sax.handler.property_xml_string">

  364. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">property_xml_string</span></span><a class="headerlink" href="#xml.sax.handler.property_xml_string" title="Link to this definition">¶</a></dt>

  365. <dd><div class="line-block">

  366. <div class="line">value: <code class="docutils literal notranslate"><span class="pre">&quot;http://xml.org/sax/properties/xml-string&quot;</span></code></div>

  367. <div class="line">data type: Bytes</div>

  368. <div class="line">description: The literal string of characters that was the source for the

  369. current event.</div>

  370. <div class="line">access: read-only</div>

  371. </div>

  372. </dd></dl>

  373. 

  374. <dl class="py data">

  375. <dt class="sig sig-object py" id="xml.sax.handler.all_properties">

  376. <span class="sig-prename descclassname"><span class="pre">xml.sax.handler.</span></span><span class="sig-name descname"><span class="pre">all_properties</span></span><a class="headerlink" href="#xml.sax.handler.all_properties" title="Link to this definition">¶</a></dt>

  377. <dd><p>List of all known property names.</p>

  378. </dd></dl>

  379. 

  380. <section id="contenthandler-objects">

  381. <span id="content-handler-objects"></span><h2>ContentHandler Objects<a class="headerlink" href="#contenthandler-objects" title="Link to this heading">¶</a></h2>

  382. <p>Users are expected to subclass <a class="reference internal" href="#xml.sax.handler.ContentHandler" title="xml.sax.handler.ContentHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContentHandler</span></code></a> to support their

  383. application.  The following methods are called by the parser on the appropriate

  384. events in the input document:</p>

  385. <dl class="py method">

  386. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.setDocumentLocator">

  387. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">setDocumentLocator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">locator</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.setDocumentLocator" title="Link to this definition">¶</a></dt>

  388. <dd><p>Called by the parser to give the application a locator for locating the origin

  389. of document events.</p>

  390. <p>SAX parsers are strongly encouraged (though not absolutely required) to supply a

  391. locator: if it does so, it must supply the locator to the application by

  392. invoking this method before invoking any of the other methods in the

  393. DocumentHandler interface.</p>

  394. <p>The locator allows the application to determine the end position of any

  395. document-related event, even if the parser is not reporting an error. Typically,

  396. the application will use this information for reporting its own errors (such as

  397. character content that does not match an application’s business rules). The

  398. information returned by the locator is probably not sufficient for use with a

  399. search engine.</p>

  400. <p>Note that the locator will return correct information only during the invocation

  401. of the events in this interface. The application should not attempt to use it at

  402. any other time.</p>

  403. </dd></dl>

  404. 

  405. <dl class="py method">

  406. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.startDocument">

  407. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">startDocument</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.startDocument" title="Link to this definition">¶</a></dt>

  408. <dd><p>Receive notification of the beginning of a document.</p>

  409. <p>The SAX parser will invoke this method only once, before any other methods in

  410. this interface or in DTDHandler (except for <a class="reference internal" href="#xml.sax.handler.ContentHandler.setDocumentLocator" title="xml.sax.handler.ContentHandler.setDocumentLocator"><code class="xref py py-meth docutils literal notranslate"><span class="pre">setDocumentLocator()</span></code></a>).</p>

  411. </dd></dl>

  412. 

  413. <dl class="py method">

  414. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.endDocument">

  415. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">endDocument</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.endDocument" title="Link to this definition">¶</a></dt>

  416. <dd><p>Receive notification of the end of a document.</p>

  417. <p>The SAX parser will invoke this method only once, and it will be the last method

  418. invoked during the parse. The parser shall not invoke this method until it has

  419. either abandoned parsing (because of an unrecoverable error) or reached the end

  420. of input.</p>

  421. </dd></dl>

  422. 

  423. <dl class="py method">

  424. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.startPrefixMapping">

  425. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">startPrefixMapping</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uri</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.startPrefixMapping" title="Link to this definition">¶</a></dt>

  426. <dd><p>Begin the scope of a prefix-URI Namespace mapping.</p>

  427. <p>The information from this event is not necessary for normal Namespace

  428. processing: the SAX XML reader will automatically replace prefixes for element

  429. and attribute names when the <code class="docutils literal notranslate"><span class="pre">feature_namespaces</span></code> feature is enabled (the

  430. default).</p>

  431. <p>There are cases, however, when applications need to use prefixes in character

  432. data or in attribute values, where they cannot safely be expanded automatically;

  433. the <a class="reference internal" href="#xml.sax.handler.ContentHandler.startPrefixMapping" title="xml.sax.handler.ContentHandler.startPrefixMapping"><code class="xref py py-meth docutils literal notranslate"><span class="pre">startPrefixMapping()</span></code></a> and <a class="reference internal" href="#xml.sax.handler.ContentHandler.endPrefixMapping" title="xml.sax.handler.ContentHandler.endPrefixMapping"><code class="xref py py-meth docutils literal notranslate"><span class="pre">endPrefixMapping()</span></code></a> events supply the

  434. information to the application to expand prefixes in those contexts itself, if

  435. necessary.</p>

  436. <p>Note that <a class="reference internal" href="#xml.sax.handler.ContentHandler.startPrefixMapping" title="xml.sax.handler.ContentHandler.startPrefixMapping"><code class="xref py py-meth docutils literal notranslate"><span class="pre">startPrefixMapping()</span></code></a> and <a class="reference internal" href="#xml.sax.handler.ContentHandler.endPrefixMapping" title="xml.sax.handler.ContentHandler.endPrefixMapping"><code class="xref py py-meth docutils literal notranslate"><span class="pre">endPrefixMapping()</span></code></a> events are not

  437. guaranteed to be properly nested relative to each-other: all

  438. <a class="reference internal" href="#xml.sax.handler.ContentHandler.startPrefixMapping" title="xml.sax.handler.ContentHandler.startPrefixMapping"><code class="xref py py-meth docutils literal notranslate"><span class="pre">startPrefixMapping()</span></code></a> events will occur before the corresponding

  439. <a class="reference internal" href="#xml.sax.handler.ContentHandler.startElement" title="xml.sax.handler.ContentHandler.startElement"><code class="xref py py-meth docutils literal notranslate"><span class="pre">startElement()</span></code></a> event, and all <a class="reference internal" href="#xml.sax.handler.ContentHandler.endPrefixMapping" title="xml.sax.handler.ContentHandler.endPrefixMapping"><code class="xref py py-meth docutils literal notranslate"><span class="pre">endPrefixMapping()</span></code></a> events will occur

  440. after the corresponding <a class="reference internal" href="#xml.sax.handler.ContentHandler.endElement" title="xml.sax.handler.ContentHandler.endElement"><code class="xref py py-meth docutils literal notranslate"><span class="pre">endElement()</span></code></a> event, but their order is not

  441. guaranteed.</p>

  442. </dd></dl>

  443. 

  444. <dl class="py method">

  445. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.endPrefixMapping">

  446. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">endPrefixMapping</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.endPrefixMapping" title="Link to this definition">¶</a></dt>

  447. <dd><p>End the scope of a prefix-URI mapping.</p>

  448. <p>See <a class="reference internal" href="#xml.sax.handler.ContentHandler.startPrefixMapping" title="xml.sax.handler.ContentHandler.startPrefixMapping"><code class="xref py py-meth docutils literal notranslate"><span class="pre">startPrefixMapping()</span></code></a> for details. This event will always occur after

  449. the corresponding <a class="reference internal" href="#xml.sax.handler.ContentHandler.endElement" title="xml.sax.handler.ContentHandler.endElement"><code class="xref py py-meth docutils literal notranslate"><span class="pre">endElement()</span></code></a> event, but the order of

  450. <a class="reference internal" href="#xml.sax.handler.ContentHandler.endPrefixMapping" title="xml.sax.handler.ContentHandler.endPrefixMapping"><code class="xref py py-meth docutils literal notranslate"><span class="pre">endPrefixMapping()</span></code></a> events is not otherwise guaranteed.</p>

  451. </dd></dl>

  452. 

  453. <dl class="py method">

  454. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.startElement">

  455. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">startElement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.startElement" title="Link to this definition">¶</a></dt>

  456. <dd><p>Signals the start of an element in non-namespace mode.</p>

  457. <p>The <em>name</em> parameter contains the raw XML 1.0 name of the element type as a

  458. string and the <em>attrs</em> parameter holds an object of the

  459. <code class="xref py py-class docutils literal notranslate"><span class="pre">Attributes</span></code>

  460. interface (see <a class="reference internal" href="xml.sax.reader.html#attributes-objects"><span class="std std-ref">The Attributes Interface</span></a>) containing the attributes of

  461. the element.  The object passed as <em>attrs</em> may be re-used by the parser; holding

  462. on to a reference to it is not a reliable way to keep a copy of the attributes.

  463. To keep a copy of the attributes, use the <a class="reference internal" href="copy.html#module-copy" title="copy: Shallow and deep copy operations."><code class="xref py py-meth docutils literal notranslate"><span class="pre">copy()</span></code></a> method of the <em>attrs</em>

  464. object.</p>

  465. </dd></dl>

  466. 

  467. <dl class="py method">

  468. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.endElement">

  469. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">endElement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.endElement" title="Link to this definition">¶</a></dt>

  470. <dd><p>Signals the end of an element in non-namespace mode.</p>

  471. <p>The <em>name</em> parameter contains the name of the element type, just as with the

  472. <a class="reference internal" href="#xml.sax.handler.ContentHandler.startElement" title="xml.sax.handler.ContentHandler.startElement"><code class="xref py py-meth docutils literal notranslate"><span class="pre">startElement()</span></code></a> event.</p>

  473. </dd></dl>

  474. 

  475. <dl class="py method">

  476. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.startElementNS">

  477. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">startElementNS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.startElementNS" title="Link to this definition">¶</a></dt>

  478. <dd><p>Signals the start of an element in namespace mode.</p>

  479. <p>The <em>name</em> parameter contains the name of the element type as a <code class="docutils literal notranslate"><span class="pre">(uri,</span>

  480. <span class="pre">localname)</span></code> tuple, the <em>qname</em> parameter contains the raw XML 1.0 name used in

  481. the source document, and the <em>attrs</em> parameter holds an instance of the

  482. <code class="xref py py-class docutils literal notranslate"><span class="pre">AttributesNS</span></code> interface (see

  483. <a class="reference internal" href="xml.sax.reader.html#attributes-ns-objects"><span class="std std-ref">The AttributesNS Interface</span></a>)

  484. containing the attributes of the element.  If no namespace is associated with

  485. the element, the <em>uri</em> component of <em>name</em> will be <code class="docutils literal notranslate"><span class="pre">None</span></code>.  The object passed

  486. as <em>attrs</em> may be re-used by the parser; holding on to a reference to it is not

  487. a reliable way to keep a copy of the attributes.  To keep a copy of the

  488. attributes, use the <a class="reference internal" href="copy.html#module-copy" title="copy: Shallow and deep copy operations."><code class="xref py py-meth docutils literal notranslate"><span class="pre">copy()</span></code></a> method of the <em>attrs</em> object.</p>

  489. <p>Parsers may set the <em>qname</em> parameter to <code class="docutils literal notranslate"><span class="pre">None</span></code>, unless the

  490. <code class="docutils literal notranslate"><span class="pre">feature_namespace_prefixes</span></code> feature is activated.</p>

  491. </dd></dl>

  492. 

  493. <dl class="py method">

  494. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.endElementNS">

  495. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">endElementNS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qname</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.endElementNS" title="Link to this definition">¶</a></dt>

  496. <dd><p>Signals the end of an element in namespace mode.</p>

  497. <p>The <em>name</em> parameter contains the name of the element type, just as with the

  498. <a class="reference internal" href="#xml.sax.handler.ContentHandler.startElementNS" title="xml.sax.handler.ContentHandler.startElementNS"><code class="xref py py-meth docutils literal notranslate"><span class="pre">startElementNS()</span></code></a> method, likewise the <em>qname</em> parameter.</p>

  499. </dd></dl>

  500. 

  501. <dl class="py method">

  502. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.characters">

  503. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">characters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.characters" title="Link to this definition">¶</a></dt>

  504. <dd><p>Receive notification of character data.</p>

  505. <p>The Parser will call this method to report each chunk of character data. SAX

  506. parsers may return all contiguous character data in a single chunk, or they may

  507. split it into several chunks; however, all of the characters in any single event

  508. must come from the same external entity so that the Locator provides useful

  509. information.</p>

  510. <p><em>content</em> may be a string or bytes instance; the <code class="docutils literal notranslate"><span class="pre">expat</span></code> reader module

  511. always produces strings.</p>

  512. <div class="admonition note">

  513. <p class="admonition-title">Note</p>

  514. <p>The earlier SAX 1 interface provided by the Python XML Special Interest Group

  515. used a more Java-like interface for this method.  Since most parsers used from

  516. Python did not take advantage of the older interface, the simpler signature was

  517. chosen to replace it.  To convert old code to the new interface, use <em>content</em>

  518. instead of slicing content with the old <em>offset</em> and <em>length</em> parameters.</p>

  519. </div>

  520. </dd></dl>

  521. 

  522. <dl class="py method">

  523. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.ignorableWhitespace">

  524. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">ignorableWhitespace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">whitespace</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.ignorableWhitespace" title="Link to this definition">¶</a></dt>

  525. <dd><p>Receive notification of ignorable whitespace in element content.</p>

  526. <p>Validating Parsers must use this method to report each chunk of ignorable

  527. whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating

  528. parsers may also use this method if they are capable of parsing and using

  529. content models.</p>

  530. <p>SAX parsers may return all contiguous whitespace in a single chunk, or they may

  531. split it into several chunks; however, all of the characters in any single event

  532. must come from the same external entity, so that the Locator provides useful

  533. information.</p>

  534. </dd></dl>

  535. 

  536. <dl class="py method">

  537. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.processingInstruction">

  538. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">processingInstruction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.processingInstruction" title="Link to this definition">¶</a></dt>

  539. <dd><p>Receive notification of a processing instruction.</p>

  540. <p>The Parser will invoke this method once for each processing instruction found:

  541. note that processing instructions may occur before or after the main document

  542. element.</p>

  543. <p>A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a

  544. text declaration (XML 1.0, section 4.3.1) using this method.</p>

  545. </dd></dl>

  546. 

  547. <dl class="py method">

  548. <dt class="sig sig-object py" id="xml.sax.handler.ContentHandler.skippedEntity">

  549. <span class="sig-prename descclassname"><span class="pre">ContentHandler.</span></span><span class="sig-name descname"><span class="pre">skippedEntity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ContentHandler.skippedEntity" title="Link to this definition">¶</a></dt>

  550. <dd><p>Receive notification of a skipped entity.</p>

  551. <p>The Parser will invoke this method once for each entity skipped. Non-validating

  552. processors may skip entities if they have not seen the declarations (because,

  553. for example, the entity was declared in an external DTD subset). All processors

  554. may skip external entities, depending on the values of the

  555. <code class="docutils literal notranslate"><span class="pre">feature_external_ges</span></code> and the <code class="docutils literal notranslate"><span class="pre">feature_external_pes</span></code> properties.</p>

  556. </dd></dl>

  557. 

  558. </section>

  559. <section id="dtdhandler-objects">

  560. <span id="dtd-handler-objects"></span><h2>DTDHandler Objects<a class="headerlink" href="#dtdhandler-objects" title="Link to this heading">¶</a></h2>

  561. <p><a class="reference internal" href="#xml.sax.handler.DTDHandler" title="xml.sax.handler.DTDHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">DTDHandler</span></code></a> instances provide the following methods:</p>

  562. <dl class="py method">

  563. <dt class="sig sig-object py" id="xml.sax.handler.DTDHandler.notationDecl">

  564. <span class="sig-prename descclassname"><span class="pre">DTDHandler.</span></span><span class="sig-name descname"><span class="pre">notationDecl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">publicId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">systemId</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.DTDHandler.notationDecl" title="Link to this definition">¶</a></dt>

  565. <dd><p>Handle a notation declaration event.</p>

  566. </dd></dl>

  567. 

  568. <dl class="py method">

  569. <dt class="sig sig-object py" id="xml.sax.handler.DTDHandler.unparsedEntityDecl">

  570. <span class="sig-prename descclassname"><span class="pre">DTDHandler.</span></span><span class="sig-name descname"><span class="pre">unparsedEntityDecl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">publicId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">systemId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ndata</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.DTDHandler.unparsedEntityDecl" title="Link to this definition">¶</a></dt>

  571. <dd><p>Handle an unparsed entity declaration event.</p>

  572. </dd></dl>

  573. 

  574. </section>

  575. <section id="entityresolver-objects">

  576. <span id="entity-resolver-objects"></span><h2>EntityResolver Objects<a class="headerlink" href="#entityresolver-objects" title="Link to this heading">¶</a></h2>

  577. <dl class="py method">

  578. <dt class="sig sig-object py" id="xml.sax.handler.EntityResolver.resolveEntity">

  579. <span class="sig-prename descclassname"><span class="pre">EntityResolver.</span></span><span class="sig-name descname"><span class="pre">resolveEntity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">publicId</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">systemId</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.EntityResolver.resolveEntity" title="Link to this definition">¶</a></dt>

  580. <dd><p>Resolve the system identifier of an entity and return either the system

  581. identifier to read from as a string, or an InputSource to read from. The default

  582. implementation returns <em>systemId</em>.</p>

  583. </dd></dl>

  584. 

  585. </section>

  586. <section id="errorhandler-objects">

  587. <span id="sax-error-handler"></span><h2>ErrorHandler Objects<a class="headerlink" href="#errorhandler-objects" title="Link to this heading">¶</a></h2>

  588. <p>Objects with this interface are used to receive error and warning information

  589. from the <a class="reference internal" href="xml.sax.reader.html#xml.sax.xmlreader.XMLReader" title="xml.sax.xmlreader.XMLReader"><code class="xref py py-class docutils literal notranslate"><span class="pre">XMLReader</span></code></a>.  If you create an object that

  590. implements this interface, then register the object with your

  591. <a class="reference internal" href="xml.sax.reader.html#xml.sax.xmlreader.XMLReader" title="xml.sax.xmlreader.XMLReader"><code class="xref py py-class docutils literal notranslate"><span class="pre">XMLReader</span></code></a>, the parser

  592. will call the methods in your object to report all warnings and errors. There

  593. are three levels of errors available: warnings, (possibly) recoverable errors,

  594. and unrecoverable errors.  All methods take a <a class="reference internal" href="xml.sax.html#xml.sax.SAXParseException" title="xml.sax.SAXParseException"><code class="xref py py-exc docutils literal notranslate"><span class="pre">SAXParseException</span></code></a> as the

  595. only parameter.  Errors and warnings may be converted to an exception by raising

  596. the passed-in exception object.</p>

  597. <dl class="py method">

  598. <dt class="sig sig-object py" id="xml.sax.handler.ErrorHandler.error">

  599. <span class="sig-prename descclassname"><span class="pre">ErrorHandler.</span></span><span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exception</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ErrorHandler.error" title="Link to this definition">¶</a></dt>

  600. <dd><p>Called when the parser encounters a recoverable error.  If this method does not

  601. raise an exception, parsing may continue, but further document information

  602. should not be expected by the application.  Allowing the parser to continue may

  603. allow additional errors to be discovered in the input document.</p>

  604. </dd></dl>

  605. 

  606. <dl class="py method">

  607. <dt class="sig sig-object py" id="xml.sax.handler.ErrorHandler.fatalError">

  608. <span class="sig-prename descclassname"><span class="pre">ErrorHandler.</span></span><span class="sig-name descname"><span class="pre">fatalError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exception</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ErrorHandler.fatalError" title="Link to this definition">¶</a></dt>

  609. <dd><p>Called when the parser encounters an error it cannot recover from; parsing is

  610. expected to terminate when this method returns.</p>

  611. </dd></dl>

  612. 

  613. <dl class="py method">

  614. <dt class="sig sig-object py" id="xml.sax.handler.ErrorHandler.warning">

  615. <span class="sig-prename descclassname"><span class="pre">ErrorHandler.</span></span><span class="sig-name descname"><span class="pre">warning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exception</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.ErrorHandler.warning" title="Link to this definition">¶</a></dt>

  616. <dd><p>Called when the parser presents minor warning information to the application.

  617. Parsing is expected to continue when this method returns, and document

  618. information will continue to be passed to the application. Raising an exception

  619. in this method will cause parsing to end.</p>

  620. </dd></dl>

  621. 

  622. </section>

  623. <section id="lexicalhandler-objects">

  624. <span id="lexical-handler-objects"></span><h2>LexicalHandler Objects<a class="headerlink" href="#lexicalhandler-objects" title="Link to this heading">¶</a></h2>

  625. <p>Optional SAX2 handler for lexical events.</p>

  626. <p>This handler is used to obtain lexical information about an XML

  627. document. Lexical information includes information describing the

  628. document encoding used and XML comments embedded in the document, as

  629. well as section boundaries for the DTD and for any CDATA sections.

  630. The lexical handlers are used in the same manner as content handlers.</p>

  631. <p>Set the LexicalHandler of an XMLReader by using the setProperty method

  632. with the property identifier

  633. <code class="docutils literal notranslate"><span class="pre">'http://xml.org/sax/properties/lexical-handler'</span></code>.</p>

  634. <dl class="py method">

  635. <dt class="sig sig-object py" id="xml.sax.handler.LexicalHandler.comment">

  636. <span class="sig-prename descclassname"><span class="pre">LexicalHandler.</span></span><span class="sig-name descname"><span class="pre">comment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.LexicalHandler.comment" title="Link to this definition">¶</a></dt>

  637. <dd><p>Reports a comment anywhere in the document (including the DTD and

  638. outside the document element).</p>

  639. </dd></dl>

  640. 

  641. <dl class="py method">

  642. <dt class="sig sig-object py" id="xml.sax.handler.LexicalHandler.startDTD">

  643. <span class="sig-prename descclassname"><span class="pre">LexicalHandler.</span></span><span class="sig-name descname"><span class="pre">startDTD</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">system_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.LexicalHandler.startDTD" title="Link to this definition">¶</a></dt>

  644. <dd><p>Reports the start of the DTD declarations if the document has an

  645. associated DTD.</p>

  646. </dd></dl>

  647. 

  648. <dl class="py method">

  649. <dt class="sig sig-object py" id="xml.sax.handler.LexicalHandler.endDTD">

  650. <span class="sig-prename descclassname"><span class="pre">LexicalHandler.</span></span><span class="sig-name descname"><span class="pre">endDTD</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.LexicalHandler.endDTD" title="Link to this definition">¶</a></dt>

  651. <dd><p>Reports the end of DTD declaration.</p>

  652. </dd></dl>

  653. 

  654. <dl class="py method">

  655. <dt class="sig sig-object py" id="xml.sax.handler.LexicalHandler.startCDATA">

  656. <span class="sig-prename descclassname"><span class="pre">LexicalHandler.</span></span><span class="sig-name descname"><span class="pre">startCDATA</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.LexicalHandler.startCDATA" title="Link to this definition">¶</a></dt>

  657. <dd><p>Reports the start of a CDATA marked section.</p>

  658. <p>The contents of the CDATA marked section will be reported through

  659. the characters handler.</p>

  660. </dd></dl>

  661. 

  662. <dl class="py method">

  663. <dt class="sig sig-object py" id="xml.sax.handler.LexicalHandler.endCDATA">

  664. <span class="sig-prename descclassname"><span class="pre">LexicalHandler.</span></span><span class="sig-name descname"><span class="pre">endCDATA</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#xml.sax.handler.LexicalHandler.endCDATA" title="Link to this definition">¶</a></dt>

  665. <dd><p>Reports the end of a CDATA marked section.</p>

  666. </dd></dl>

  667. 

  668. </section>

  669. </section>

  670. 

  671. 

  672.             <div class="clearer"></div>

  673.           </div>

  674.         </div>

  675.       </div>

  676.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  677.         <div class="sphinxsidebarwrapper">

  678.   <div>

  679.     <h3><a href="../contents.html">Table of Contents</a></h3>

  680.     <ul>

  681. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xml.sax.handler</span></code> — Base classes for SAX handlers</a><ul>

  682. <li><a class="reference internal" href="#contenthandler-objects">ContentHandler Objects</a></li>

  683. <li><a class="reference internal" href="#dtdhandler-objects">DTDHandler Objects</a></li>

  684. <li><a class="reference internal" href="#entityresolver-objects">EntityResolver Objects</a></li>

  685. <li><a class="reference internal" href="#errorhandler-objects">ErrorHandler Objects</a></li>

  686. <li><a class="reference internal" href="#lexicalhandler-objects">LexicalHandler Objects</a></li>

  687. </ul>

  688. </li>

  689. </ul>

  690. 

  691.   </div>

  692.   <div>

  693.     <h4>Previous topic</h4>

  694.     <p class="topless"><a href="xml.sax.html"

  695.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xml.sax</span></code> — Support for SAX2 parsers</a></p>

  696.   </div>

  697.   <div>

  698.     <h4>Next topic</h4>

  699.     <p class="topless"><a href="xml.sax.utils.html"

  700.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xml.sax.saxutils</span></code> — SAX Utilities</a></p>

  701.   </div>

  702.   <div role="note" aria-label="source link">

  703.     <h3>This Page</h3>

  704.     <ul class="this-page-menu">

  705.       <li><a href="../bugs.html">Report a Bug</a></li>

  706.       <li>

  707.         <a href="https://github.com/python/cpython/blob/main/Doc/library/xml.sax.handler.rst"

  708.             rel="nofollow">Show Source

  709.         </a>

  710.       </li>

  711.     </ul>

  712.   </div>

  713.         </div>

  714. <div id="sidebarbutton" title="Collapse sidebar">

  715. <span>«</span>

  716. </div>

  717. 

  718.       </div>

  719.       <div class="clearer"></div>

  720.     </div>  

  721.     <div class="related" role="navigation" aria-label="related navigation">

  722.       <h3>Navigation</h3>

  723.       <ul>

  724.         <li class="right" style="margin-right: 10px">

  725.           <a href="../genindex.html" title="General Index"

  726.              >index</a></li>

  727.         <li class="right" >

  728.           <a href="../py-modindex.html" title="Python Module Index"

  729.              >modules</a> |</li>

  730.         <li class="right" >

  731.           <a href="xml.sax.utils.html" title="xml.sax.saxutils — SAX Utilities"

  732.              >next</a> |</li>

  733.         <li class="right" >

  734.           <a href="xml.sax.html" title="xml.sax — Support for SAX2 parsers"

  735.              >previous</a> |</li>

  736. 

  737.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  738.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  739.           <li class="switchers">

  740.             <div class="language_switcher_placeholder"></div>

  741.             <div class="version_switcher_placeholder"></div>

  742.           </li>

  743.           <li>

  744.               

  745.           </li>

  746.     <li id="cpython-language-and-version">

  747.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  748.     </li>

  749. 

  750.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  751.           <li class="nav-item nav-item-2"><a href="markup.html" >Structured Markup Processing Tools</a> &#187;</li>

  752.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">xml.sax.handler</span></code> — Base classes for SAX handlers</a></li>

  753.                 <li class="right">

  754.                     

  755. 

  756.     <div class="inline-search" role="search">

  757.         <form class="inline-search" action="../search.html" method="get">

  758.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  759.           <input type="submit" value="Go" />

  760.         </form>

  761.     </div>

  762.                      |

  763.                 </li>

  764.             <li class="right">

  765. <label class="theme-selector-label">

  766.     Theme

  767.     <select class="theme-selector" oninput="activateTheme(this.value)">

  768.         <option value="auto" selected>Auto</option>

  769.         <option value="light">Light</option>

  770.         <option value="dark">Dark</option>

  771.     </select>

  772. </label> |</li>

  773.             

  774.       </ul>

  775.     </div>  

  776.     <div class="footer">

  777.     &copy; 

  778.       <a href="../copyright.html">

  779.     

  780.     Copyright

  781.     

  782.       </a>

  783.      2001-2024, Python Software Foundation.

  784.     <br />

  785.     This page is licensed under the Python Software Foundation License Version 2.

  786.     <br />

  787.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  788.     <br />

  789.     

  790.       See <a href="/license.html">History and License</a> for more information.<br />

  791.     

  792.     

  793.     <br />

  794. 

  795.     The Python Software Foundation is a non-profit corporation.

  796. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  797. <br />

  798.     <br />

  799.       Last updated on Apr 09, 2024 (13:47 UTC).

  800.     

  801.       <a href="/bugs.html">Found a bug</a>?

  802.     

  803.     <br />

  804. 

  805.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  806.     </div>

  807. 

  808.   </body>

  809. </html>
上海开阖软件有限公司 沪ICP备12045867号-1