doc/html/api/lxml.etree.PyErrorLog-class.html

   1 <?xml version="1.0" encoding="ascii"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3           "DTD/xhtml1-transitional.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6   <title>lxml.etree.PyErrorLog</title>
   7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
   8   <script type="text/javascript" src="epydoc.js"></script>
   9 </head>
  10
  11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
  12       alink="#204080">
  13 <!-- ==================== NAVIGATION BAR ==================== -->
  14 <table class="navbar" border="0" width="100%" cellpadding="0"
  15        bgcolor="#a0c0ff" cellspacing="0">
  16   <tr valign="middle">
  17   <!-- Home link -->
  18       <th>&nbsp;&nbsp;&nbsp;<a
  19         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
  20
  21   <!-- Tree link -->
  22       <th>&nbsp;&nbsp;&nbsp;<a
  23         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  24
  25   <!-- Index link -->
  26       <th>&nbsp;&nbsp;&nbsp;<a
  27         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  28
  29   <!-- Help link -->
  30       <th>&nbsp;&nbsp;&nbsp;<a
  31         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  32
  33   <!-- Project homepage -->
  34       <th class="navbar" align="right" width="100%">
  35         <table border="0" cellpadding="0" cellspacing="0">
  36           <tr><th class="navbar" align="center"
  37             ><a class="navbar" target="_top" href="http://codespeak.net/lxml/">lxml API</a></th>
  38           </tr></table></th>
  39   </tr>
  40 </table>
  41 <table width="100%" cellpadding="0" cellspacing="0">
  42   <tr valign="top">
  43     <td width="100%">
  44       <span class="breadcrumbs">
  45         <a href="lxml-module.html">Package&nbsp;lxml</a> ::
  46         <a href="lxml.etree-module.html">Module&nbsp;etree</a> ::
  47         Class&nbsp;PyErrorLog
  48       </span>
  49     </td>
  50     <td>
  51       <table cellpadding="0" cellspacing="0">
  52         <!-- hide/show private -->
  53         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  54     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  55         <tr><td align="right"><span class="options"
  56             >[<a href="frames.html" target="_top">frames</a
  57             >]&nbsp;|&nbsp;<a href="lxml.etree.PyErrorLog-class.html"
  58             target="_top">no&nbsp;frames</a>]</span></td></tr>
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <!-- ==================== CLASS DESCRIPTION ==================== -->
  64 <h1 class="epydoc">Class PyErrorLog</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66    object --+
  67             |
  68 <a href="lxml.etree._BaseErrorLog-class.html" onclick="show_private();">_BaseErrorLog</a> --+
  69                 |
  70                <strong class="uidshort">PyErrorLog</strong>
  71 </pre>
  72
  73 <hr />
  74 <p>PyErrorLog(self, logger_name=None)
  75 A global error log that connects to the Python stdlib logging package.</p>
  76 <p>The constructor accepts an optional logger name.</p>
  77 <p>If you want to change the mapping between libxml2's ErrorLevels and Python
  78 logging levels, you can modify the level_map dictionary from a subclass.</p>
  79 <p>The default mapping is:</p>
  80 <pre class="rst-literal-block">
  81 ErrorLevels.WARNING = logging.WARNING
  82 ErrorLevels.ERROR   = logging.ERROR
  83 ErrorLevels.FATAL   = logging.CRITICAL
  84 </pre>
  85 <p>You can also override the method <tt class="rst-docutils literal"><span class="pre">receive()</span></tt> that takes a LogEntry
  86 object and calls <tt class="rst-docutils literal"><span class="pre">self.log(log_entry,</span> <span class="pre">format_string,</span> <span class="pre">arg1,</span> <span class="pre">arg2,</span> <span class="pre">...)</span></tt>
  87 with appropriate data.</p>
  88
  89 <!-- ==================== INSTANCE METHODS ==================== -->
  90 <a name="section-InstanceMethods"></a>
  91 <table class="summary" border="1" cellpadding="3"
  92        cellspacing="0" width="100%" bgcolor="white">
  93 <tr bgcolor="#70b0f0" class="table-header">
  94   <td colspan="2" class="table-header">
  95     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  96       <tr valign="top">
  97         <td align="left"><span class="table-header">Instance Methods</span></td>
  98         <td align="right" valign="top"
  99          ><span class="options">[<a href="#section-InstanceMethods"
 100          class="privatelink" onclick="toggle_private();"
 101          >hide private</a>]</span></td>
 102       </tr>
 103     </table>
 104   </td>
 105 </tr>
 106 <tr>
 107     <td width="15%" align="right" valign="top" class="summary">
 108       <span class="summary-type">&nbsp;</span>
 109     </td><td class="summary">
 110       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 111         <tr>
 112           <td><span class="summary-sig"><a href="lxml.etree.PyErrorLog-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 113         <span class="summary-sig-arg">logger_name</span>=<span class="summary-sig-default">None</span>)</span><br />
 114       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
 115           <td align="right" valign="top">
 116
 117
 118           </td>
 119         </tr>
 120       </table>
 121
 122     </td>
 123   </tr>
 124 <tr>
 125     <td width="15%" align="right" valign="top" class="summary">
 126       <span class="summary-type">a new object with type S, a subtype of T</span>
 127     </td><td class="summary">
 128       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 129         <tr>
 130           <td><span class="summary-sig"><a href="lxml.etree.PyErrorLog-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 131         <span class="summary-sig-arg">S</span>,
 132         <span class="summary-sig-arg">...</span>)</span></td>
 133           <td align="right" valign="top">
 134
 135
 136           </td>
 137         </tr>
 138       </table>
 139
 140     </td>
 141   </tr>
 142 <tr>
 143     <td width="15%" align="right" valign="top" class="summary">
 144       <span class="summary-type">&nbsp;</span>
 145     </td><td class="summary">
 146       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 147         <tr>
 148           <td><span class="summary-sig"><a href="lxml.etree.PyErrorLog-class.html#copy" class="summary-sig-name">copy</a>(<span class="summary-sig-arg">...</span>)</span><br />
 149       Dummy method that returns an empty error log.</td>
 150           <td align="right" valign="top">
 151
 152
 153           </td>
 154         </tr>
 155       </table>
 156
 157     </td>
 158   </tr>
 159 <tr>
 160     <td width="15%" align="right" valign="top" class="summary">
 161       <span class="summary-type">&nbsp;</span>
 162     </td><td class="summary">
 163       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 164         <tr>
 165           <td><span class="summary-sig"><a href="lxml.etree.PyErrorLog-class.html#log" class="summary-sig-name">log</a>(<span class="summary-sig-arg">self</span>,
 166         <span class="summary-sig-arg">log_entry</span>,
 167         <span class="summary-sig-arg">message</span>,
 168         <span class="summary-sig-arg">*args</span>)</span><br />
 169       Called by the .receive() method to log a _LogEntry instance to
 170 the Python logging system.</td>
 171           <td align="right" valign="top">
 172
 173
 174           </td>
 175         </tr>
 176       </table>
 177
 178     </td>
 179   </tr>
 180 <tr>
 181     <td width="15%" align="right" valign="top" class="summary">
 182       <span class="summary-type">&nbsp;</span>
 183     </td><td class="summary">
 184       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 185         <tr>
 186           <td><span class="summary-sig"><a href="lxml.etree.PyErrorLog-class.html#receive" class="summary-sig-name">receive</a>(<span class="summary-sig-arg">self</span>,
 187         <span class="summary-sig-arg">log_entry</span>)</span><br />
 188       Receive a _LogEntry instance from the logging system.</td>
 189           <td align="right" valign="top">
 190
 191
 192           </td>
 193         </tr>
 194       </table>
 195
 196     </td>
 197   </tr>
 198   <tr>
 199     <td colspan="2" class="summary">
 200     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._BaseErrorLog-class.html" onclick="show_private();">_BaseErrorLog</a></code></b>:
 201       <code><a href="lxml.etree._BaseErrorLog-class.html#__repr__">__repr__</a></code>
 202       </p>
 203     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 204       <code>__delattr__</code>,
 205       <code>__getattribute__</code>,
 206       <code>__hash__</code>,
 207       <code>__reduce__</code>,
 208       <code>__reduce_ex__</code>,
 209       <code>__setattr__</code>,
 210       <code>__str__</code>
 211       </p>
 212     </td>
 213   </tr>
 214 </table>
 215 <!-- ==================== PROPERTIES ==================== -->
 216 <a name="section-Properties"></a>
 217 <table class="summary" border="1" cellpadding="3"
 218        cellspacing="0" width="100%" bgcolor="white">
 219 <tr bgcolor="#70b0f0" class="table-header">
 220   <td colspan="2" class="table-header">
 221     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 222       <tr valign="top">
 223         <td align="left"><span class="table-header">Properties</span></td>
 224         <td align="right" valign="top"
 225          ><span class="options">[<a href="#section-Properties"
 226          class="privatelink" onclick="toggle_private();"
 227          >hide private</a>]</span></td>
 228       </tr>
 229     </table>
 230   </td>
 231 </tr>
 232 <tr>
 233     <td width="15%" align="right" valign="top" class="summary">
 234       <span class="summary-type">&nbsp;</span>
 235     </td><td class="summary">
 236         <a name="level_map"></a><span class="summary-name">level_map</span>
 237     </td>
 238   </tr>
 239   <tr>
 240     <td colspan="2" class="summary">
 241     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._BaseErrorLog-class.html" onclick="show_private();">_BaseErrorLog</a></code></b>:
 242       <code><a href="lxml.etree._BaseErrorLog-class.html#last_error">last_error</a></code>
 243       </p>
 244     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 245       <code>__class__</code>
 246       </p>
 247     </td>
 248   </tr>
 249 </table>
 250 <!-- ==================== METHOD DETAILS ==================== -->
 251 <a name="section-MethodDetails"></a>
 252 <table class="details" border="1" cellpadding="3"
 253        cellspacing="0" width="100%" bgcolor="white">
 254 <tr bgcolor="#70b0f0" class="table-header">
 255   <td colspan="2" class="table-header">
 256     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 257       <tr valign="top">
 258         <td align="left"><span class="table-header">Method Details</span></td>
 259         <td align="right" valign="top"
 260          ><span class="options">[<a href="#section-MethodDetails"
 261          class="privatelink" onclick="toggle_private();"
 262          >hide private</a>]</span></td>
 263       </tr>
 264     </table>
 265   </td>
 266 </tr>
 267 </table>
 268 <a name="__init__"></a>
 269 <div>
 270 <table class="details" border="1" cellpadding="3"
 271        cellspacing="0" width="100%" bgcolor="white">
 272 <tr><td>
 273   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 274   <tr valign="top"><td>
 275   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 276         <span class="sig-arg">logger_name</span>=<span class="sig-default">None</span>)</span>
 277     <br /><em class="fname">(Constructor)</em>
 278   </h3>
 279   </td><td align="right" valign="top"
 280     >&nbsp;
 281     </td>
 282   </tr></table>
 283
 284   x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 285   <dl class="fields">
 286     <dt>Overrides:
 287         object.__init__
 288     </dt>
 289   </dl>
 290 </td></tr></table>
 291 </div>
 292 <a name="__new__"></a>
 293 <div>
 294 <table class="details" border="1" cellpadding="3"
 295        cellspacing="0" width="100%" bgcolor="white">
 296 <tr><td>
 297   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 298   <tr valign="top"><td>
 299   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 300         <span class="sig-arg">S</span>,
 301         <span class="sig-arg">...</span>)</span>
 302   </h3>
 303   </td><td align="right" valign="top"
 304     >&nbsp;
 305     </td>
 306   </tr></table>
 307
 308
 309   <dl class="fields">
 310     <dt>Returns: a new object with type S, a subtype of T</dt>
 311     <dt>Overrides:
 312         object.__new__
 313     </dt>
 314   </dl>
 315 </td></tr></table>
 316 </div>
 317 <a name="copy"></a>
 318 <div>
 319 <table class="details" border="1" cellpadding="3"
 320        cellspacing="0" width="100%" bgcolor="white">
 321 <tr><td>
 322   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 323   <tr valign="top"><td>
 324   <h3 class="epydoc"><span class="sig"><span class="sig-name">copy</span>(<span class="sig-arg">...</span>)</span>
 325   </h3>
 326   </td><td align="right" valign="top"
 327     >&nbsp;
 328     </td>
 329   </tr></table>
 330
 331   Dummy method that returns an empty error log.
 332   <dl class="fields">
 333     <dt>Overrides:
 334         <a href="lxml.etree._BaseErrorLog-class.html#copy">_BaseErrorLog.copy</a>
 335     </dt>
 336   </dl>
 337 </td></tr></table>
 338 </div>
 339 <a name="log"></a>
 340 <div>
 341 <table class="details" border="1" cellpadding="3"
 342        cellspacing="0" width="100%" bgcolor="white">
 343 <tr><td>
 344   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 345   <tr valign="top"><td>
 346   <h3 class="epydoc"><span class="sig"><span class="sig-name">log</span>(<span class="sig-arg">self</span>,
 347         <span class="sig-arg">log_entry</span>,
 348         <span class="sig-arg">message</span>,
 349         <span class="sig-arg">*args</span>)</span>
 350   </h3>
 351   </td><td align="right" valign="top"
 352     >&nbsp;
 353     </td>
 354   </tr></table>
 355
 356   <p>Called by the .receive() method to log a _LogEntry instance to
 357 the Python logging system.  This handles the error level
 358 mapping.</p>
 359 <p>In the default implementation, the <tt class="rst-docutils literal"><span class="pre">message</span></tt> argument
 360 receives a complete log line, and there are no further
 361 <tt class="rst-docutils literal"><span class="pre">args</span></tt>.  To change the message format, it is best to
 362 override the .receive() method instead of this one.</p>
 363   <dl class="fields">
 364   </dl>
 365 </td></tr></table>
 366 </div>
 367 <a name="receive"></a>
 368 <div>
 369 <table class="details" border="1" cellpadding="3"
 370        cellspacing="0" width="100%" bgcolor="white">
 371 <tr><td>
 372   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 373   <tr valign="top"><td>
 374   <h3 class="epydoc"><span class="sig"><span class="sig-name">receive</span>(<span class="sig-arg">self</span>,
 375         <span class="sig-arg">log_entry</span>)</span>
 376   </h3>
 377   </td><td align="right" valign="top"
 378     >&nbsp;
 379     </td>
 380   </tr></table>
 381
 382   <p>Receive a _LogEntry instance from the logging system.  Calls
 383 the .log() method with appropriate parameters:</p>
 384 <pre class="rst-literal-block">
 385 self.log(log_entry, repr(log_entry))
 386 </pre>
 387 <p>You can override this method to provide your own log output
 388 format.</p>
 389   <dl class="fields">
 390   </dl>
 391 </td></tr></table>
 392 </div>
 393 <br />
 394 <!-- ==================== NAVIGATION BAR ==================== -->
 395 <table class="navbar" border="0" width="100%" cellpadding="0"
 396        bgcolor="#a0c0ff" cellspacing="0">
 397   <tr valign="middle">
 398   <!-- Home link -->
 399       <th>&nbsp;&nbsp;&nbsp;<a
 400         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 401
 402   <!-- Tree link -->
 403       <th>&nbsp;&nbsp;&nbsp;<a
 404         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 405
 406   <!-- Index link -->
 407       <th>&nbsp;&nbsp;&nbsp;<a
 408         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 409
 410   <!-- Help link -->
 411       <th>&nbsp;&nbsp;&nbsp;<a
 412         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 413
 414   <!-- Project homepage -->
 415       <th class="navbar" align="right" width="100%">
 416         <table border="0" cellpadding="0" cellspacing="0">
 417           <tr><th class="navbar" align="center"
 418             ><a class="navbar" target="_top" href="http://codespeak.net/lxml/">lxml API</a></th>
 419           </tr></table></th>
 420   </tr>
 421 </table>
 422 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 423   <tr>
 424     <td align="left" class="footer">
 425     Generated by Epydoc 3.0 on Fri Oct 30 14:51:45 2009
 426     </td>
 427     <td align="right" class="footer">
 428       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 429         >http://epydoc.sourceforge.net</a>
 430     </td>
 431   </tr>
 432 </table>
 433
 434 <script type="text/javascript">
 435   <!--
 436   // Private objects are initially displayed (because if
 437   // javascript is turned off then we want them to be
 438   // visible); but by default, we want to hide them.  So hide
 439   // them unless we have a cookie that says to show them.
 440   checkCookie();
 441   // -->
 442 </script>
 443 </body>
 444 </html>