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