doc/api/python/archive.tools-module.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.tools</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         Module&nbsp;tools
       
    39       </span>
       
    40     </td>
       
    41     <td>
       
    42       <table cellpadding="0" cellspacing="0">
       
    43         <!-- hide/show private -->
       
    44         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    45     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    46         <tr><td align="right"><span class="options"
       
    47             >[<a href="frames.html" target="_top">frames</a
       
    48             >]&nbsp;|&nbsp;<a href="archive.tools-module.html"
       
    49             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    50       </table>
       
    51     </td>
       
    52   </tr>
       
    53 </table>
       
    54 <!-- ==================== MODULE DESCRIPTION ==================== -->
       
    55 <h1 class="epydoc">Module tools</h1><span class="codelink"><a href="archive.tools-pysrc.html">source&nbsp;code</a></span><br /><br />
       
    56 Archiving operations.<br /><br />
       
    57 
       
    58 <!-- ==================== CLASSES ==================== -->
       
    59 <a name="section-Classes"></a>
       
    60 <table class="summary" border="1" cellpadding="3"
       
    61        cellspacing="0" width="100%" bgcolor="white">
       
    62 <tr bgcolor="#70b0f0" class="table-header">
       
    63   <td colspan="2" class="table-header">
       
    64     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    65       <tr valign="top">
       
    66         <td align="left"><span class="table-header">Classes</span></td>
       
    67         <td align="right" valign="top"
       
    68          ><span class="options">[<a href="#section-Classes"
       
    69          class="privatelink" onclick="toggle_private();"
       
    70          >hide private</a>]</span></td>
       
    71       </tr>
       
    72     </table>
       
    73   </td>
       
    74 </tr>
       
    75 <tr>
       
    76     <td width="15%" align="right" valign="top" class="summary">
       
    77       <span class="summary-type">&nbsp;</span>
       
    78     </td><td class="summary">
       
    79         <a href="archive.tools.Tool-class.html" class="summary-name">Tool</a><br />
       
    80       Tool abstract class.
       
    81     </td>
       
    82   </tr>
       
    83 <tr>
       
    84     <td width="15%" align="right" valign="top" class="summary">
       
    85       <span class="summary-type">&nbsp;</span>
       
    86     </td><td class="summary">
       
    87         <a href="archive.tools.SevenZipArchiver-class.html" class="summary-name">SevenZipArchiver</a><br />
       
    88       Creates task definitions for executing 7zip archive operations.
       
    89     </td>
       
    90   </tr>
       
    91 <tr>
       
    92     <td width="15%" align="right" valign="top" class="summary">
       
    93       <span class="summary-type">&nbsp;</span>
       
    94     </td><td class="summary">
       
    95         <a href="archive.tools.ZipArchiver-class.html" class="summary-name">ZipArchiver</a><br />
       
    96       Creates task definitions for executing zip archive operations.
       
    97     </td>
       
    98   </tr>
       
    99 <tr>
       
   100     <td width="15%" align="right" valign="top" class="summary">
       
   101       <span class="summary-type">&nbsp;</span>
       
   102     </td><td class="summary">
       
   103         <a href="archive.tools.Remover-class.html" class="summary-name">Remover</a><br />
       
   104       Creates task definitions for executing zip archive operations.
       
   105     </td>
       
   106   </tr>
       
   107 </table>
       
   108 <!-- ==================== FUNCTIONS ==================== -->
       
   109 <a name="section-Functions"></a>
       
   110 <table class="summary" border="1" cellpadding="3"
       
   111        cellspacing="0" width="100%" bgcolor="white">
       
   112 <tr bgcolor="#70b0f0" class="table-header">
       
   113   <td colspan="2" class="table-header">
       
   114     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   115       <tr valign="top">
       
   116         <td align="left"><span class="table-header">Functions</span></td>
       
   117         <td align="right" valign="top"
       
   118          ><span class="options">[<a href="#section-Functions"
       
   119          class="privatelink" onclick="toggle_private();"
       
   120          >hide private</a>]</span></td>
       
   121       </tr>
       
   122     </table>
       
   123   </td>
       
   124 </tr>
       
   125 <tr>
       
   126     <td width="15%" align="right" valign="top" class="summary">
       
   127       <span class="summary-type">&nbsp;</span>
       
   128     </td><td class="summary">
       
   129       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   130         <tr>
       
   131           <td><span class="summary-sig"><a name="get_tool"></a><span class="summary-sig-name">get_tool</span>(<span class="summary-sig-arg">name</span>)</span><br />
       
   132       Return a tool using its id name.</td>
       
   133           <td align="right" valign="top">
       
   134             <span class="codelink"><a href="archive.tools-pysrc.html#get_tool">source&nbsp;code</a></span>
       
   135             
       
   136           </td>
       
   137         </tr>
       
   138       </table>
       
   139       
       
   140     </td>
       
   141   </tr>
       
   142 </table>
       
   143 <!-- ==================== VARIABLES ==================== -->
       
   144 <a name="section-Variables"></a>
       
   145 <table class="summary" border="1" cellpadding="3"
       
   146        cellspacing="0" width="100%" bgcolor="white">
       
   147 <tr bgcolor="#70b0f0" class="table-header">
       
   148   <td colspan="2" class="table-header">
       
   149     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   150       <tr valign="top">
       
   151         <td align="left"><span class="table-header">Variables</span></td>
       
   152         <td align="right" valign="top"
       
   153          ><span class="options">[<a href="#section-Variables"
       
   154          class="privatelink" onclick="toggle_private();"
       
   155          >hide private</a>]</span></td>
       
   156       </tr>
       
   157     </table>
       
   158   </td>
       
   159 </tr>
       
   160 <tr class="private">
       
   161     <td width="15%" align="right" valign="top" class="summary">
       
   162       <span class="summary-type">&nbsp;</span>
       
   163     </td><td class="summary">
       
   164         <a name="_logger"></a><span class="summary-name">_logger</span> = <code title="logging.getLogger('archive')">logging.getLogger('archive')</code>
       
   165     </td>
       
   166   </tr>
       
   167 <tr>
       
   168     <td width="15%" align="right" valign="top" class="summary">
       
   169       <span class="summary-type">&nbsp;</span>
       
   170     </td><td class="summary">
       
   171         <a href="archive.tools-module.html#TOOL_CONSTRUCTORS" class="summary-name">TOOL_CONSTRUCTORS</a> = <code title="{'zip': ZipArchiver, '7za': SevenZipArchiver, 'remover': Remover}">{'zip': ZipArchiver, '7za': SevenZipArchiv<code class="variable-ellipsis">...</code></code>
       
   172     </td>
       
   173   </tr>
       
   174 </table>
       
   175 <!-- ==================== VARIABLES DETAILS ==================== -->
       
   176 <a name="section-VariablesDetails"></a>
       
   177 <table class="details" border="1" cellpadding="3"
       
   178        cellspacing="0" width="100%" bgcolor="white">
       
   179 <tr bgcolor="#70b0f0" class="table-header">
       
   180   <td colspan="2" class="table-header">
       
   181     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   182       <tr valign="top">
       
   183         <td align="left"><span class="table-header">Variables Details</span></td>
       
   184         <td align="right" valign="top"
       
   185          ><span class="options">[<a href="#section-VariablesDetails"
       
   186          class="privatelink" onclick="toggle_private();"
       
   187          >hide private</a>]</span></td>
       
   188       </tr>
       
   189     </table>
       
   190   </td>
       
   191 </tr>
       
   192 </table>
       
   193 <a name="TOOL_CONSTRUCTORS"></a>
       
   194 <div>
       
   195 <table class="details" border="1" cellpadding="3"
       
   196        cellspacing="0" width="100%" bgcolor="white">
       
   197 <tr><td>
       
   198   <h3 class="epydoc">TOOL_CONSTRUCTORS</h3>
       
   199   
       
   200   <dl class="fields">
       
   201   </dl>
       
   202   <dl class="fields">
       
   203     <dt>Value:</dt>
       
   204       <dd><table><tr><td><pre class="variable">
       
   205 {'zip': ZipArchiver, '7za': SevenZipArchiver, 'remover': Remover}
       
   206 </pre></td></tr></table>
       
   207 </dd>
       
   208   </dl>
       
   209 </td></tr></table>
       
   210 </div>
       
   211 <br />
       
   212 <!-- ==================== NAVIGATION BAR ==================== -->
       
   213 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   214        bgcolor="#a0c0ff" cellspacing="0">
       
   215   <tr valign="middle">
       
   216 
       
   217   <!-- Tree link -->
       
   218       <th>&nbsp;&nbsp;&nbsp;<a
       
   219         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   220 
       
   221   <!-- Index link -->
       
   222       <th>&nbsp;&nbsp;&nbsp;<a
       
   223         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   224 
       
   225   <!-- Help link -->
       
   226       <th>&nbsp;&nbsp;&nbsp;<a
       
   227         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   228 
       
   229       <th class="navbar" width="100%"></th>
       
   230   </tr>
       
   231 </table>
       
   232 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   233   <tr>
       
   234     <td align="left" class="footer">
       
   235     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:15 2009
       
   236     </td>
       
   237     <td align="right" class="footer">
       
   238       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   239     </td>
       
   240   </tr>
       
   241 </table>
       
   242 
       
   243 <script type="text/javascript">
       
   244   <!--
       
   245   // Private objects are initially displayed (because if
       
   246   // javascript is turned off then we want them to be
       
   247   // visible); but by default, we want to hide them.  So hide
       
   248   // them unless we have a cookie that says to show them.
       
   249   checkCookie()
       
   250   // -->
       
   251 </script>
       
   252   
       
   253 </body>
       
   254 </html>