doc/api/python/symbian.log.Parser-class.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     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>symbian.log.Parser</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 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         <a href="symbian-module.html">Package&nbsp;symbian</a> ::
       
    38         <a href="symbian.log-module.html">Module&nbsp;log</a> ::
       
    39         Class&nbsp;Parser
       
    40       </span>
       
    41     </td>
       
    42     <td>
       
    43       <table cellpadding="0" cellspacing="0">
       
    44         <!-- hide/show private -->
       
    45         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    46     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    47         <tr><td align="right"><span class="options"
       
    48             >[<a href="frames.html" target="_top">frames</a
       
    49             >]&nbsp;|&nbsp;<a href="symbian.log.Parser-class.html"
       
    50             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    51       </table>
       
    52     </td>
       
    53   </tr>
       
    54 </table>
       
    55 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    56 <h1 class="epydoc">Class Parser</h1><span class="codelink"><a href="symbian.log-pysrc.html#Parser">source&nbsp;code</a></span><br /><br />
       
    57 <pre class="base-tree">
       
    58 object --+
       
    59          |
       
    60         <strong class="uidshort">Parser</strong>
       
    61 </pre>
       
    62 
       
    63 <hr />
       
    64 Generic Symbian log parser. You just need to derive that class an override few methods
       
    65 from the interface to implement your own functionnalities.<br /><br />
       
    66 
       
    67 <!-- ==================== INSTANCE METHODS ==================== -->
       
    68 <a name="section-InstanceMethods"></a>
       
    69 <table class="summary" border="1" cellpadding="3"
       
    70        cellspacing="0" width="100%" bgcolor="white">
       
    71 <tr bgcolor="#70b0f0" class="table-header">
       
    72   <td colspan="2" class="table-header">
       
    73     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    74       <tr valign="top">
       
    75         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    76         <td align="right" valign="top"
       
    77          ><span class="options">[<a href="#section-InstanceMethods"
       
    78          class="privatelink" onclick="toggle_private();"
       
    79          >hide private</a>]</span></td>
       
    80       </tr>
       
    81     </table>
       
    82   </td>
       
    83 </tr>
       
    84 <tr>
       
    85     <td width="15%" align="right" valign="top" class="summary">
       
    86       <span class="summary-type">&nbsp;</span>
       
    87     </td><td class="summary">
       
    88       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    89         <tr>
       
    90           <td><span class="summary-sig"><a href="symbian.log.Parser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    91         <span class="summary-sig-arg">fileobject</span>)</span><br />
       
    92       The constructor, it accepts a file object:
       
    93 parser = Parser(open('output.log', 'r'))</td>
       
    94           <td align="right" valign="top">
       
    95             <span class="codelink"><a href="symbian.log-pysrc.html#Parser.__init__">source&nbsp;code</a></span>
       
    96             
       
    97           </td>
       
    98         </tr>
       
    99       </table>
       
   100       
       
   101     </td>
       
   102   </tr>
       
   103 <tr>
       
   104     <td width="15%" align="right" valign="top" class="summary">
       
   105       <span class="summary-type">&nbsp;</span>
       
   106     </td><td class="summary">
       
   107       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   108         <tr>
       
   109           <td><span class="summary-sig"><a name="parse"></a><span class="summary-sig-name">parse</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   110       Function that run the parsing of the log.</td>
       
   111           <td align="right" valign="top">
       
   112             <span class="codelink"><a href="symbian.log-pysrc.html#Parser.parse">source&nbsp;code</a></span>
       
   113             
       
   114           </td>
       
   115         </tr>
       
   116       </table>
       
   117       
       
   118     </td>
       
   119   </tr>
       
   120 <tr>
       
   121     <td width="15%" align="right" valign="top" class="summary">
       
   122       <span class="summary-type">&nbsp;</span>
       
   123     </td><td class="summary">
       
   124       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   125         <tr>
       
   126           <td><span class="summary-sig"><a name="start_stage"></a><span class="summary-sig-name">start_stage</span>(<span class="summary-sig-arg">self</span>,
       
   127         <span class="summary-sig-arg">name</span>,
       
   128         <span class="summary-sig-arg">date</span>)</span><br />
       
   129       Method to override to catch the start stage event.</td>
       
   130           <td align="right" valign="top">
       
   131             <span class="codelink"><a href="symbian.log-pysrc.html#Parser.start_stage">source&nbsp;code</a></span>
       
   132             
       
   133           </td>
       
   134         </tr>
       
   135       </table>
       
   136       
       
   137     </td>
       
   138   </tr>
       
   139 <tr>
       
   140     <td width="15%" align="right" valign="top" class="summary">
       
   141       <span class="summary-type">&nbsp;</span>
       
   142     </td><td class="summary">
       
   143       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   144         <tr>
       
   145           <td><span class="summary-sig"><a name="end_stage"></a><span class="summary-sig-name">end_stage</span>(<span class="summary-sig-arg">self</span>,
       
   146         <span class="summary-sig-arg">name</span>,
       
   147         <span class="summary-sig-arg">date</span>)</span><br />
       
   148       Method to override to catch the end stage event.</td>
       
   149           <td align="right" valign="top">
       
   150             <span class="codelink"><a href="symbian.log-pysrc.html#Parser.end_stage">source&nbsp;code</a></span>
       
   151             
       
   152           </td>
       
   153         </tr>
       
   154       </table>
       
   155       
       
   156     </td>
       
   157   </tr>
       
   158 <tr>
       
   159     <td width="15%" align="right" valign="top" class="summary">
       
   160       <span class="summary-type">&nbsp;</span>
       
   161     </td><td class="summary">
       
   162       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   163         <tr>
       
   164           <td><span class="summary-sig"><a name="task"></a><span class="summary-sig-name">task</span>(<span class="summary-sig-arg">self</span>,
       
   165         <span class="summary-sig-arg">name</span>,
       
   166         <span class="summary-sig-arg">cmdline</span>,
       
   167         <span class="summary-sig-arg">dir</span>,
       
   168         <span class="summary-sig-arg">output</span>)</span><br />
       
   169       Method to override to catch the task event.</td>
       
   170           <td align="right" valign="top">
       
   171             <span class="codelink"><a href="symbian.log-pysrc.html#Parser.task">source&nbsp;code</a></span>
       
   172             
       
   173           </td>
       
   174         </tr>
       
   175       </table>
       
   176       
       
   177     </td>
       
   178   </tr>
       
   179   <tr>
       
   180     <td colspan="2" class="summary">
       
   181     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   182       <code>__delattr__</code>,
       
   183       <code>__getattribute__</code>,
       
   184       <code>__hash__</code>,
       
   185       <code>__new__</code>,
       
   186       <code>__reduce__</code>,
       
   187       <code>__reduce_ex__</code>,
       
   188       <code>__repr__</code>,
       
   189       <code>__setattr__</code>,
       
   190       <code>__str__</code>
       
   191       </p>
       
   192     </td>
       
   193   </tr>
       
   194 </table>
       
   195 <!-- ==================== PROPERTIES ==================== -->
       
   196 <a name="section-Properties"></a>
       
   197 <table class="summary" border="1" cellpadding="3"
       
   198        cellspacing="0" width="100%" bgcolor="white">
       
   199 <tr bgcolor="#70b0f0" class="table-header">
       
   200   <td colspan="2" class="table-header">
       
   201     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   202       <tr valign="top">
       
   203         <td align="left"><span class="table-header">Properties</span></td>
       
   204         <td align="right" valign="top"
       
   205          ><span class="options">[<a href="#section-Properties"
       
   206          class="privatelink" onclick="toggle_private();"
       
   207          >hide private</a>]</span></td>
       
   208       </tr>
       
   209     </table>
       
   210   </td>
       
   211 </tr>
       
   212   <tr>
       
   213     <td colspan="2" class="summary">
       
   214     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   215       <code>__class__</code>
       
   216       </p>
       
   217     </td>
       
   218   </tr>
       
   219 </table>
       
   220 <!-- ==================== METHOD DETAILS ==================== -->
       
   221 <a name="section-MethodDetails"></a>
       
   222 <table class="details" border="1" cellpadding="3"
       
   223        cellspacing="0" width="100%" bgcolor="white">
       
   224 <tr bgcolor="#70b0f0" class="table-header">
       
   225   <td colspan="2" class="table-header">
       
   226     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   227       <tr valign="top">
       
   228         <td align="left"><span class="table-header">Method Details</span></td>
       
   229         <td align="right" valign="top"
       
   230          ><span class="options">[<a href="#section-MethodDetails"
       
   231          class="privatelink" onclick="toggle_private();"
       
   232          >hide private</a>]</span></td>
       
   233       </tr>
       
   234     </table>
       
   235   </td>
       
   236 </tr>
       
   237 </table>
       
   238 <a name="__init__"></a>
       
   239 <div>
       
   240 <table class="details" border="1" cellpadding="3"
       
   241        cellspacing="0" width="100%" bgcolor="white">
       
   242 <tr><td>
       
   243   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   244   <tr valign="top"><td>
       
   245   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   246         <span class="sig-arg">fileobject</span>)</span>
       
   247     <br /><em class="fname">(Constructor)</em>
       
   248   </h3>
       
   249   </td><td align="right" valign="top"
       
   250     ><span class="codelink"><a href="symbian.log-pysrc.html#Parser.__init__">source&nbsp;code</a></span>&nbsp;
       
   251     </td>
       
   252   </table>
       
   253   
       
   254   The constructor, it accepts a file object:
       
   255 parser = Parser(open('output.log', 'r'))
       
   256   <dl class="fields">
       
   257     <dt>Overrides:
       
   258       object.__init__
       
   259     </dt>
       
   260   </dl>
       
   261 </td></tr></table>
       
   262 </div>
       
   263 <br />
       
   264 <!-- ==================== NAVIGATION BAR ==================== -->
       
   265 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   266        bgcolor="#a0c0ff" cellspacing="0">
       
   267   <tr valign="middle">
       
   268 
       
   269   <!-- Tree link -->
       
   270       <th>&nbsp;&nbsp;&nbsp;<a
       
   271         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   272 
       
   273   <!-- Index link -->
       
   274       <th>&nbsp;&nbsp;&nbsp;<a
       
   275         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   276 
       
   277   <!-- Help link -->
       
   278       <th>&nbsp;&nbsp;&nbsp;<a
       
   279         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   280 
       
   281       <th class="navbar" width="100%"></th>
       
   282   </tr>
       
   283 </table>
       
   284 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   285   <tr>
       
   286     <td align="left" class="footer">
       
   287     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:19 2009
       
   288     </td>
       
   289     <td align="right" class="footer">
       
   290       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   291     </td>
       
   292   </tr>
       
   293 </table>
       
   294 
       
   295 <script type="text/javascript">
       
   296   <!--
       
   297   // Private objects are initially displayed (because if
       
   298   // javascript is turned off then we want them to be
       
   299   // visible); but by default, we want to hide them.  So hide
       
   300   // them unless we have a cookie that says to show them.
       
   301   checkCookie()
       
   302   // -->
       
   303 </script>
       
   304   
       
   305 </body>
       
   306 </html>