|
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.ZipArchiver</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> <a |
|
20 href="module-tree.html">Trees</a> </th> |
|
21 |
|
22 <!-- Index link --> |
|
23 <th> <a |
|
24 href="identifier-index.html">Indices</a> </th> |
|
25 |
|
26 <!-- Help link --> |
|
27 <th> <a |
|
28 href="help.html">Help</a> </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 archive</a> :: |
|
38 <a href="archive.tools-module.html">Module tools</a> :: |
|
39 Class ZipArchiver |
|
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 private</a>]</span></td></tr> |
|
47 <tr><td align="right"><span class="options" |
|
48 >[<a href="frames.html" target="_top">frames</a |
|
49 >] | <a href="archive.tools.ZipArchiver-class.html" |
|
50 target="_top">no frames</a>]</span></td></tr> |
|
51 </table> |
|
52 </td> |
|
53 </tr> |
|
54 </table> |
|
55 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
56 <h1 class="epydoc">Class ZipArchiver</h1><span class="codelink"><a href="archive.tools-pysrc.html#ZipArchiver">source code</a></span><br /><br /> |
|
57 <pre class="base-tree"> |
|
58 object --+ |
|
59 | |
|
60 <a href="archive.tools.Tool-class.html">Tool</a> --+ |
|
61 | |
|
62 <strong class="uidshort">ZipArchiver</strong> |
|
63 </pre> |
|
64 |
|
65 <hr /> |
|
66 Creates task definitions for executing zip archive operations.<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"> </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.tools.ZipArchiver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
92 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> |
|
93 <td align="right" valign="top"> |
|
94 <span class="codelink"><a href="archive.tools-pysrc.html#ZipArchiver.__init__">source code</a></span> |
|
95 |
|
96 </td> |
|
97 </tr> |
|
98 </table> |
|
99 |
|
100 </td> |
|
101 </tr> |
|
102 <tr> |
|
103 <td width="15%" align="right" valign="top" class="summary"> |
|
104 <span class="summary-type"> </span> |
|
105 </td><td class="summary"> |
|
106 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
107 <tr> |
|
108 <td><span class="summary-sig"><a href="archive.tools.ZipArchiver-class.html#extension" class="summary-sig-name">extension</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
109 Always return '.zip'.</td> |
|
110 <td align="right" valign="top"> |
|
111 <span class="codelink"><a href="archive.tools-pysrc.html#ZipArchiver.extension">source code</a></span> |
|
112 |
|
113 </td> |
|
114 </tr> |
|
115 </table> |
|
116 |
|
117 </td> |
|
118 </tr> |
|
119 <tr> |
|
120 <td width="15%" align="right" valign="top" class="summary"> |
|
121 <span class="summary-type"> </span> |
|
122 </td><td class="summary"> |
|
123 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
124 <tr> |
|
125 <td><span class="summary-sig"><a href="archive.tools.ZipArchiver-class.html#create_command" class="summary-sig-name">create_command</a>(<span class="summary-sig-arg">self</span>, |
|
126 <span class="summary-sig-arg">path</span>, |
|
127 <span class="summary-sig-arg">name</span>, |
|
128 <span class="summary-sig-arg">manifests</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
129 Returns a list of one command that will use zip to archive the content.</td> |
|
130 <td align="right" valign="top"> |
|
131 <span class="codelink"><a href="archive.tools-pysrc.html#ZipArchiver.create_command">source code</a></span> |
|
132 |
|
133 </td> |
|
134 </tr> |
|
135 </table> |
|
136 |
|
137 </td> |
|
138 </tr> |
|
139 <tr> |
|
140 <td colspan="2" class="summary"> |
|
141 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
142 <code>__delattr__</code>, |
|
143 <code>__getattribute__</code>, |
|
144 <code>__hash__</code>, |
|
145 <code>__new__</code>, |
|
146 <code>__reduce__</code>, |
|
147 <code>__reduce_ex__</code>, |
|
148 <code>__repr__</code>, |
|
149 <code>__setattr__</code>, |
|
150 <code>__str__</code> |
|
151 </p> |
|
152 </td> |
|
153 </tr> |
|
154 </table> |
|
155 <!-- ==================== PROPERTIES ==================== --> |
|
156 <a name="section-Properties"></a> |
|
157 <table class="summary" border="1" cellpadding="3" |
|
158 cellspacing="0" width="100%" bgcolor="white"> |
|
159 <tr bgcolor="#70b0f0" class="table-header"> |
|
160 <td colspan="2" class="table-header"> |
|
161 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
162 <tr valign="top"> |
|
163 <td align="left"><span class="table-header">Properties</span></td> |
|
164 <td align="right" valign="top" |
|
165 ><span class="options">[<a href="#section-Properties" |
|
166 class="privatelink" onclick="toggle_private();" |
|
167 >hide private</a>]</span></td> |
|
168 </tr> |
|
169 </table> |
|
170 </td> |
|
171 </tr> |
|
172 <tr> |
|
173 <td colspan="2" class="summary"> |
|
174 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
175 <code>__class__</code> |
|
176 </p> |
|
177 </td> |
|
178 </tr> |
|
179 </table> |
|
180 <!-- ==================== METHOD DETAILS ==================== --> |
|
181 <a name="section-MethodDetails"></a> |
|
182 <table class="details" border="1" cellpadding="3" |
|
183 cellspacing="0" width="100%" bgcolor="white"> |
|
184 <tr bgcolor="#70b0f0" class="table-header"> |
|
185 <td colspan="2" class="table-header"> |
|
186 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
187 <tr valign="top"> |
|
188 <td align="left"><span class="table-header">Method Details</span></td> |
|
189 <td align="right" valign="top" |
|
190 ><span class="options">[<a href="#section-MethodDetails" |
|
191 class="privatelink" onclick="toggle_private();" |
|
192 >hide private</a>]</span></td> |
|
193 </tr> |
|
194 </table> |
|
195 </td> |
|
196 </tr> |
|
197 </table> |
|
198 <a name="__init__"></a> |
|
199 <div> |
|
200 <table class="details" border="1" cellpadding="3" |
|
201 cellspacing="0" width="100%" bgcolor="white"> |
|
202 <tr><td> |
|
203 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
204 <tr valign="top"><td> |
|
205 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span> |
|
206 <br /><em class="fname">(Constructor)</em> |
|
207 </h3> |
|
208 </td><td align="right" valign="top" |
|
209 ><span class="codelink"><a href="archive.tools-pysrc.html#ZipArchiver.__init__">source code</a></span> |
|
210 </td> |
|
211 </table> |
|
212 |
|
213 x.__init__(...) initializes x; see x.__class__.__doc__ for signature |
|
214 <dl class="fields"> |
|
215 <dt>Overrides: |
|
216 object.__init__ |
|
217 <dd><em class="note">(inherited documentation)</em></dd> |
|
218 </dt> |
|
219 </dl> |
|
220 </td></tr></table> |
|
221 </div> |
|
222 <a name="extension"></a> |
|
223 <div> |
|
224 <table class="details" border="1" cellpadding="3" |
|
225 cellspacing="0" width="100%" bgcolor="white"> |
|
226 <tr><td> |
|
227 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
228 <tr valign="top"><td> |
|
229 <h3 class="epydoc"><span class="sig"><span class="sig-name">extension</span>(<span class="sig-arg">self</span>)</span> |
|
230 </h3> |
|
231 </td><td align="right" valign="top" |
|
232 ><span class="codelink"><a href="archive.tools-pysrc.html#ZipArchiver.extension">source code</a></span> |
|
233 </td> |
|
234 </table> |
|
235 |
|
236 Always return '.zip'. |
|
237 <dl class="fields"> |
|
238 <dt>Overrides: |
|
239 <a href="archive.tools.Tool-class.html#extension">Tool.extension</a> |
|
240 </dt> |
|
241 </dl> |
|
242 </td></tr></table> |
|
243 </div> |
|
244 <a name="create_command"></a> |
|
245 <div> |
|
246 <table class="details" border="1" cellpadding="3" |
|
247 cellspacing="0" width="100%" bgcolor="white"> |
|
248 <tr><td> |
|
249 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
250 <tr valign="top"><td> |
|
251 <h3 class="epydoc"><span class="sig"><span class="sig-name">create_command</span>(<span class="sig-arg">self</span>, |
|
252 <span class="sig-arg">path</span>, |
|
253 <span class="sig-arg">name</span>, |
|
254 <span class="sig-arg">manifests</span>=<span class="sig-default">None</span>)</span> |
|
255 </h3> |
|
256 </td><td align="right" valign="top" |
|
257 ><span class="codelink"><a href="archive.tools-pysrc.html#ZipArchiver.create_command">source code</a></span> |
|
258 </td> |
|
259 </table> |
|
260 |
|
261 Returns a list of one command that will use zip to archive the content. |
|
262 <dl class="fields"> |
|
263 <dt>Overrides: |
|
264 <a href="archive.tools.Tool-class.html#create_command">Tool.create_command</a> |
|
265 </dt> |
|
266 </dl> |
|
267 </td></tr></table> |
|
268 </div> |
|
269 <br /> |
|
270 <!-- ==================== NAVIGATION BAR ==================== --> |
|
271 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
272 bgcolor="#a0c0ff" cellspacing="0"> |
|
273 <tr valign="middle"> |
|
274 |
|
275 <!-- Tree link --> |
|
276 <th> <a |
|
277 href="module-tree.html">Trees</a> </th> |
|
278 |
|
279 <!-- Index link --> |
|
280 <th> <a |
|
281 href="identifier-index.html">Indices</a> </th> |
|
282 |
|
283 <!-- Help link --> |
|
284 <th> <a |
|
285 href="help.html">Help</a> </th> |
|
286 |
|
287 <th class="navbar" width="100%"></th> |
|
288 </tr> |
|
289 </table> |
|
290 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
291 <tr> |
|
292 <td align="left" class="footer"> |
|
293 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009 |
|
294 </td> |
|
295 <td align="right" class="footer"> |
|
296 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
297 </td> |
|
298 </tr> |
|
299 </table> |
|
300 |
|
301 <script type="text/javascript"> |
|
302 <!-- |
|
303 // Private objects are initially displayed (because if |
|
304 // javascript is turned off then we want them to be |
|
305 // visible); but by default, we want to hide them. So hide |
|
306 // them unless we have a cookie that says to show them. |
|
307 checkCookie() |
|
308 // --> |
|
309 </script> |
|
310 |
|
311 </body> |
|
312 </html> |