doc/api/python/archive.scanners.Scanner-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>archive.scanners.Scanner</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="archive-module.html">Package&nbsp;archive</a> ::
       
    38         <a href="archive.scanners-module.html">Module&nbsp;scanners</a> ::
       
    39         Class&nbsp;Scanner
       
    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="archive.scanners.Scanner-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 Scanner</h1><span class="codelink"><a href="archive.scanners-pysrc.html#Scanner">source&nbsp;code</a></span><br /><br />
       
    57 <pre class="base-tree">
       
    58                object --+    
       
    59                         |    
       
    60 <a href="fileutils.AbstractScanner-class.html">fileutils.AbstractScanner</a> --+
       
    61                             |
       
    62                            <strong class="uidshort">Scanner</strong>
       
    63 </pre>
       
    64 
       
    65 <hr />
       
    66 Abstract class that represent and input source.<br /><br />
       
    67 
       
    68 <!-- ==================== INSTANCE METHODS ==================== -->
       
    69 <a name="section-InstanceMethods"></a>
       
    70 <table class="summary" border="1" cellpadding="3"
       
    71        cellspacing="0" width="100%" bgcolor="white">
       
    72 <tr bgcolor="#70b0f0" class="table-header">
       
    73   <td colspan="2" class="table-header">
       
    74     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    75       <tr valign="top">
       
    76         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    77         <td align="right" valign="top"
       
    78          ><span class="options">[<a href="#section-InstanceMethods"
       
    79          class="privatelink" onclick="toggle_private();"
       
    80          >hide private</a>]</span></td>
       
    81       </tr>
       
    82     </table>
       
    83   </td>
       
    84 </tr>
       
    85 <tr>
       
    86     <td width="15%" align="right" valign="top" class="summary">
       
    87       <span class="summary-type">&nbsp;</span>
       
    88     </td><td class="summary">
       
    89       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    90         <tr>
       
    91           <td><span class="summary-sig"><a href="archive.scanners.Scanner-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    92         <span class="summary-sig-arg">config</span>)</span><br />
       
    93       Initialization.</td>
       
    94           <td align="right" valign="top">
       
    95             <span class="codelink"><a href="archive.scanners-pysrc.html#Scanner.__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="setup"></a><span class="summary-sig-name">setup</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   110       Setting up the scanner.</td>
       
   111           <td align="right" valign="top">
       
   112             <span class="codelink"><a href="archive.scanners-pysrc.html#Scanner.setup">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="add_exclude_lst"></a><span class="summary-sig-name">add_exclude_lst</span>(<span class="summary-sig-arg">self</span>,
       
   127         <span class="summary-sig-arg">filename</span>)</span><br />
       
   128       Adding excludes from exclude list.</td>
       
   129           <td align="right" valign="top">
       
   130             <span class="codelink"><a href="archive.scanners-pysrc.html#Scanner.add_exclude_lst">source&nbsp;code</a></span>
       
   131             
       
   132           </td>
       
   133         </tr>
       
   134       </table>
       
   135       
       
   136     </td>
       
   137   </tr>
       
   138 <tr>
       
   139     <td width="15%" align="right" valign="top" class="summary">
       
   140       <span class="summary-type">&nbsp;</span>
       
   141     </td><td class="summary">
       
   142       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   143         <tr>
       
   144           <td><span class="summary-sig"><a href="archive.scanners.Scanner-class.html#scan" class="summary-sig-name">scan</a>(<span class="summary-sig-arg">self</span>)</span><br />
       
   145       Generator method that scan the relevant input source.</td>
       
   146           <td align="right" valign="top">
       
   147             <span class="codelink"><a href="archive.scanners-pysrc.html#Scanner.scan">source&nbsp;code</a></span>
       
   148             
       
   149           </td>
       
   150         </tr>
       
   151       </table>
       
   152       
       
   153     </td>
       
   154   </tr>
       
   155   <tr>
       
   156     <td colspan="2" class="summary">
       
   157     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="fileutils.AbstractScanner-class.html">fileutils.AbstractScanner</a></code></b>:
       
   158       <code><a href="fileutils.AbstractScanner-class.html#__repr__">__repr__</a></code>,
       
   159       <code><a href="fileutils.AbstractScanner-class.html#__str__">__str__</a></code>,
       
   160       <code><a href="fileutils.AbstractScanner-class.html#add_exclude">add_exclude</a></code>,
       
   161       <code><a href="fileutils.AbstractScanner-class.html#add_exclude_file">add_exclude_file</a></code>,
       
   162       <code><a href="fileutils.AbstractScanner-class.html#add_filetype">add_filetype</a></code>,
       
   163       <code><a href="fileutils.AbstractScanner-class.html#add_include">add_include</a></code>,
       
   164       <code><a href="fileutils.AbstractScanner-class.html#add_selector">add_selector</a></code>,
       
   165       <code><a href="fileutils.AbstractScanner-class.html#is_excluded">is_excluded</a></code>,
       
   166       <code><a href="fileutils.AbstractScanner-class.html#is_filetype">is_filetype</a></code>,
       
   167       <code><a href="fileutils.AbstractScanner-class.html#is_included">is_included</a></code>,
       
   168       <code><a href="fileutils.AbstractScanner-class.html#is_selected">is_selected</a></code>,
       
   169       <code><a href="fileutils.AbstractScanner-class.html#match">match</a></code>,
       
   170       <code><a href="fileutils.AbstractScanner-class.html#test_path">test_path</a></code>
       
   171       </p>
       
   172     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   173       <code>__delattr__</code>,
       
   174       <code>__getattribute__</code>,
       
   175       <code>__hash__</code>,
       
   176       <code>__new__</code>,
       
   177       <code>__reduce__</code>,
       
   178       <code>__reduce_ex__</code>,
       
   179       <code>__setattr__</code>
       
   180       </p>
       
   181     </td>
       
   182   </tr>
       
   183 </table>
       
   184 <!-- ==================== PROPERTIES ==================== -->
       
   185 <a name="section-Properties"></a>
       
   186 <table class="summary" border="1" cellpadding="3"
       
   187        cellspacing="0" width="100%" bgcolor="white">
       
   188 <tr bgcolor="#70b0f0" class="table-header">
       
   189   <td colspan="2" class="table-header">
       
   190     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   191       <tr valign="top">
       
   192         <td align="left"><span class="table-header">Properties</span></td>
       
   193         <td align="right" valign="top"
       
   194          ><span class="options">[<a href="#section-Properties"
       
   195          class="privatelink" onclick="toggle_private();"
       
   196          >hide private</a>]</span></td>
       
   197       </tr>
       
   198     </table>
       
   199   </td>
       
   200 </tr>
       
   201   <tr>
       
   202     <td colspan="2" class="summary">
       
   203     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   204       <code>__class__</code>
       
   205       </p>
       
   206     </td>
       
   207   </tr>
       
   208 </table>
       
   209 <!-- ==================== METHOD DETAILS ==================== -->
       
   210 <a name="section-MethodDetails"></a>
       
   211 <table class="details" border="1" cellpadding="3"
       
   212        cellspacing="0" width="100%" bgcolor="white">
       
   213 <tr bgcolor="#70b0f0" class="table-header">
       
   214   <td colspan="2" class="table-header">
       
   215     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   216       <tr valign="top">
       
   217         <td align="left"><span class="table-header">Method Details</span></td>
       
   218         <td align="right" valign="top"
       
   219          ><span class="options">[<a href="#section-MethodDetails"
       
   220          class="privatelink" onclick="toggle_private();"
       
   221          >hide private</a>]</span></td>
       
   222       </tr>
       
   223     </table>
       
   224   </td>
       
   225 </tr>
       
   226 </table>
       
   227 <a name="__init__"></a>
       
   228 <div>
       
   229 <table class="details" border="1" cellpadding="3"
       
   230        cellspacing="0" width="100%" bgcolor="white">
       
   231 <tr><td>
       
   232   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   233   <tr valign="top"><td>
       
   234   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   235         <span class="sig-arg">config</span>)</span>
       
   236     <br /><em class="fname">(Constructor)</em>
       
   237   </h3>
       
   238   </td><td align="right" valign="top"
       
   239     ><span class="codelink"><a href="archive.scanners-pysrc.html#Scanner.__init__">source&nbsp;code</a></span>&nbsp;
       
   240     </td>
       
   241   </table>
       
   242   
       
   243   Initialization.
       
   244   <dl class="fields">
       
   245     <dt>Overrides:
       
   246       <a href="fileutils.AbstractScanner-class.html#__init__">fileutils.AbstractScanner.__init__</a>
       
   247         <dd><em class="note">(inherited documentation)</em></dd>
       
   248     </dt>
       
   249   </dl>
       
   250 </td></tr></table>
       
   251 </div>
       
   252 <a name="scan"></a>
       
   253 <div>
       
   254 <table class="details" border="1" cellpadding="3"
       
   255        cellspacing="0" width="100%" bgcolor="white">
       
   256 <tr><td>
       
   257   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   258   <tr valign="top"><td>
       
   259   <h3 class="epydoc"><span class="sig"><span class="sig-name">scan</span>(<span class="sig-arg">self</span>)</span>
       
   260   </h3>
       
   261   </td><td align="right" valign="top"
       
   262     ><span class="codelink"><a href="archive.scanners-pysrc.html#Scanner.scan">source&nbsp;code</a></span>&nbsp;
       
   263     </td>
       
   264   </table>
       
   265   
       
   266   Generator method that scan the relevant input source.
       
   267 This method need to be overloaded by the specialized class.
       
   268 return fullpath name
       
   269   <dl class="fields">
       
   270     <dt>Overrides:
       
   271       <a href="fileutils.AbstractScanner-class.html#scan">fileutils.AbstractScanner.scan</a>
       
   272     </dt>
       
   273   </dl>
       
   274 </td></tr></table>
       
   275 </div>
       
   276 <br />
       
   277 <!-- ==================== NAVIGATION BAR ==================== -->
       
   278 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   279        bgcolor="#a0c0ff" cellspacing="0">
       
   280   <tr valign="middle">
       
   281 
       
   282   <!-- Tree link -->
       
   283       <th>&nbsp;&nbsp;&nbsp;<a
       
   284         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   285 
       
   286   <!-- Index link -->
       
   287       <th>&nbsp;&nbsp;&nbsp;<a
       
   288         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   289 
       
   290   <!-- Help link -->
       
   291       <th>&nbsp;&nbsp;&nbsp;<a
       
   292         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   293 
       
   294       <th class="navbar" width="100%"></th>
       
   295   </tr>
       
   296 </table>
       
   297 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   298   <tr>
       
   299     <td align="left" class="footer">
       
   300     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009
       
   301     </td>
       
   302     <td align="right" class="footer">
       
   303       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   304     </td>
       
   305   </tr>
       
   306 </table>
       
   307 
       
   308 <script type="text/javascript">
       
   309   <!--
       
   310   // Private objects are initially displayed (because if
       
   311   // javascript is turned off then we want them to be
       
   312   // visible); but by default, we want to hide them.  So hide
       
   313   // them unless we have a cookie that says to show them.
       
   314   checkCookie()
       
   315   // -->
       
   316 </script>
       
   317   
       
   318 </body>
       
   319 </html>