|
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>delta_zip.MD5SignatureBuilder</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="delta_zip-module.html">Module delta_zip</a> :: |
|
38 Class MD5SignatureBuilder |
|
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 private</a>]</span></td></tr> |
|
46 <tr><td align="right"><span class="options" |
|
47 >[<a href="frames.html" target="_top">frames</a |
|
48 >] | <a href="delta_zip.MD5SignatureBuilder-class.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Class MD5SignatureBuilder</h1><span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 <strong class="uidshort">MD5SignatureBuilder</strong> |
|
60 </pre> |
|
61 |
|
62 <hr /> |
|
63 MD5 CRC creation base class<br /><br /> |
|
64 |
|
65 <!-- ==================== INSTANCE METHODS ==================== --> |
|
66 <a name="section-InstanceMethods"></a> |
|
67 <table class="summary" border="1" cellpadding="3" |
|
68 cellspacing="0" width="100%" bgcolor="white"> |
|
69 <tr bgcolor="#70b0f0" class="table-header"> |
|
70 <td colspan="2" class="table-header"> |
|
71 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
72 <tr valign="top"> |
|
73 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
74 <td align="right" valign="top" |
|
75 ><span class="options">[<a href="#section-InstanceMethods" |
|
76 class="privatelink" onclick="toggle_private();" |
|
77 >hide private</a>]</span></td> |
|
78 </tr> |
|
79 </table> |
|
80 </td> |
|
81 </tr> |
|
82 <tr> |
|
83 <td width="15%" align="right" valign="top" class="summary"> |
|
84 <span class="summary-type"> </span> |
|
85 </td><td class="summary"> |
|
86 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
87 <tr> |
|
88 <td><span class="summary-sig"><a href="delta_zip.MD5SignatureBuilder-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
89 <span class="summary-sig-arg">build_area_root</span>, |
|
90 <span class="summary-sig-arg">nb_split</span>, |
|
91 <span class="summary-sig-arg">temp_dir</span>, |
|
92 <span class="summary-sig-arg">exclude_dirs</span>, |
|
93 <span class="summary-sig-arg">list_of_files</span>)</span><br /> |
|
94 constructor</td> |
|
95 <td align="right" valign="top"> |
|
96 <span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.__init__">source code</a></span> |
|
97 |
|
98 </td> |
|
99 </tr> |
|
100 </table> |
|
101 |
|
102 </td> |
|
103 </tr> |
|
104 <tr> |
|
105 <td width="15%" align="right" valign="top" class="summary"> |
|
106 <span class="summary-type"> </span> |
|
107 </td><td class="summary"> |
|
108 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
109 <tr> |
|
110 <td><span class="summary-sig"><a name="create_file_list"></a><span class="summary-sig-name">create_file_list</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
111 Create list of files (was list_files.pl)</td> |
|
112 <td align="right" valign="top"> |
|
113 <span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.create_file_list">source code</a></span> |
|
114 |
|
115 </td> |
|
116 </tr> |
|
117 </table> |
|
118 |
|
119 </td> |
|
120 </tr> |
|
121 <tr> |
|
122 <td width="15%" align="right" valign="top" class="summary"> |
|
123 <span class="summary-type"> </span> |
|
124 </td><td class="summary"> |
|
125 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
126 <tr> |
|
127 <td><span class="summary-sig"><a name="split_file_list"></a><span class="summary-sig-name">split_file_list</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
128 Split the list of files for parallelalisation</td> |
|
129 <td align="right" valign="top"> |
|
130 <span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.split_file_list">source 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"> </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 name="create_command_list"></a><span class="summary-sig-name">create_command_list</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
145 create the command to run evalid on each file in the list of files</td> |
|
146 <td align="right" valign="top"> |
|
147 <span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.create_command_list">source code</a></span> |
|
148 |
|
149 </td> |
|
150 </tr> |
|
151 </table> |
|
152 |
|
153 </td> |
|
154 </tr> |
|
155 <tr class="private"> |
|
156 <td width="15%" align="right" valign="top" class="summary"> |
|
157 <span class="summary-type"> </span> |
|
158 </td><td class="summary"> |
|
159 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
160 <tr> |
|
161 <td><span class="summary-sig"><a name="__get_partial_input_file_name"></a><span class="summary-sig-name">__get_partial_input_file_name</span>(<span class="summary-sig-arg">self</span>, |
|
162 <span class="summary-sig-arg">_nb</span>)</span><br /> |
|
163 get the input file name string as has been created so far and add .txt to it</td> |
|
164 <td align="right" valign="top"> |
|
165 <span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.__get_partial_input_file_name">source code</a></span> |
|
166 |
|
167 </td> |
|
168 </tr> |
|
169 </table> |
|
170 |
|
171 </td> |
|
172 </tr> |
|
173 <tr class="private"> |
|
174 <td width="15%" align="right" valign="top" class="summary"> |
|
175 <span class="summary-type"> </span> |
|
176 </td><td class="summary"> |
|
177 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
178 <tr> |
|
179 <td><span class="summary-sig"><a name="__get_partial_signature_file_name"></a><span class="summary-sig-name">__get_partial_signature_file_name</span>(<span class="summary-sig-arg">self</span>, |
|
180 <span class="summary-sig-arg">_nb</span>)</span><br /> |
|
181 get the signature file name string as has been created so far and add .md5 to it</td> |
|
182 <td align="right" valign="top"> |
|
183 <span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.__get_partial_signature_file_name">source code</a></span> |
|
184 |
|
185 </td> |
|
186 </tr> |
|
187 </table> |
|
188 |
|
189 </td> |
|
190 </tr> |
|
191 <tr> |
|
192 <td width="15%" align="right" valign="top" class="summary"> |
|
193 <span class="summary-type"> </span> |
|
194 </td><td class="summary"> |
|
195 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
196 <tr> |
|
197 <td><span class="summary-sig"><a name="concatenate_signature_files"></a><span class="summary-sig-name">concatenate_signature_files</span>(<span class="summary-sig-arg">self</span>, |
|
198 <span class="summary-sig-arg">signature_file</span>)</span><br /> |
|
199 concatenate all the files with the MD5 CRC in</td> |
|
200 <td align="right" valign="top"> |
|
201 <span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.concatenate_signature_files">source code</a></span> |
|
202 |
|
203 </td> |
|
204 </tr> |
|
205 </table> |
|
206 |
|
207 </td> |
|
208 </tr> |
|
209 <tr> |
|
210 <td width="15%" align="right" valign="top" class="summary"> |
|
211 <span class="summary-type"> </span> |
|
212 </td><td class="summary"> |
|
213 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
214 <tr> |
|
215 <td><span class="summary-sig"><a name="write_build_file"></a><span class="summary-sig-name">write_build_file</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
216 create the file of the list of files to have a CRC created</td> |
|
217 <td align="right" valign="top"> |
|
218 <span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.write_build_file">source code</a></span> |
|
219 |
|
220 </td> |
|
221 </tr> |
|
222 </table> |
|
223 |
|
224 </td> |
|
225 </tr> |
|
226 <tr> |
|
227 <td width="15%" align="right" valign="top" class="summary"> |
|
228 <span class="summary-type"> </span> |
|
229 </td><td class="summary"> |
|
230 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
231 <tr> |
|
232 <td><span class="summary-sig"><a name="create_build_file"></a><span class="summary-sig-name">create_build_file</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
233 there should always be an overloaded version of this method in sub-classes</td> |
|
234 <td align="right" valign="top"> |
|
235 <span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.create_build_file">source code</a></span> |
|
236 |
|
237 </td> |
|
238 </tr> |
|
239 </table> |
|
240 |
|
241 </td> |
|
242 </tr> |
|
243 <tr> |
|
244 <td width="15%" align="right" valign="top" class="summary"> |
|
245 <span class="summary-type"> </span> |
|
246 </td><td class="summary"> |
|
247 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
248 <tr> |
|
249 <td><span class="summary-sig"><a name="build"></a><span class="summary-sig-name">build</span>(<span class="summary-sig-arg">self</span>, |
|
250 <span class="summary-sig-arg">signature_file</span>)</span><br /> |
|
251 create the list of files generate the MD5 CRC and create the final file with CRCs in</td> |
|
252 <td align="right" valign="top"> |
|
253 <span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.build">source code</a></span> |
|
254 |
|
255 </td> |
|
256 </tr> |
|
257 </table> |
|
258 |
|
259 </td> |
|
260 </tr> |
|
261 <tr> |
|
262 <td width="15%" align="right" valign="top" class="summary"> |
|
263 <span class="summary-type"> </span> |
|
264 </td><td class="summary"> |
|
265 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
266 <tr> |
|
267 <td><span class="summary-sig"><a name="compute_evalid_MD5"></a><span class="summary-sig-name">compute_evalid_MD5</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
268 there should always be an overlaoded version in the methos sub-class</td> |
|
269 <td align="right" valign="top"> |
|
270 <span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.compute_evalid_MD5">source code</a></span> |
|
271 |
|
272 </td> |
|
273 </tr> |
|
274 </table> |
|
275 |
|
276 </td> |
|
277 </tr> |
|
278 <tr> |
|
279 <td colspan="2" class="summary"> |
|
280 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
281 <code>__delattr__</code>, |
|
282 <code>__getattribute__</code>, |
|
283 <code>__hash__</code>, |
|
284 <code>__new__</code>, |
|
285 <code>__reduce__</code>, |
|
286 <code>__reduce_ex__</code>, |
|
287 <code>__repr__</code>, |
|
288 <code>__setattr__</code>, |
|
289 <code>__str__</code> |
|
290 </p> |
|
291 </td> |
|
292 </tr> |
|
293 </table> |
|
294 <!-- ==================== PROPERTIES ==================== --> |
|
295 <a name="section-Properties"></a> |
|
296 <table class="summary" border="1" cellpadding="3" |
|
297 cellspacing="0" width="100%" bgcolor="white"> |
|
298 <tr bgcolor="#70b0f0" class="table-header"> |
|
299 <td colspan="2" class="table-header"> |
|
300 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
301 <tr valign="top"> |
|
302 <td align="left"><span class="table-header">Properties</span></td> |
|
303 <td align="right" valign="top" |
|
304 ><span class="options">[<a href="#section-Properties" |
|
305 class="privatelink" onclick="toggle_private();" |
|
306 >hide private</a>]</span></td> |
|
307 </tr> |
|
308 </table> |
|
309 </td> |
|
310 </tr> |
|
311 <tr> |
|
312 <td colspan="2" class="summary"> |
|
313 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
314 <code>__class__</code> |
|
315 </p> |
|
316 </td> |
|
317 </tr> |
|
318 </table> |
|
319 <!-- ==================== METHOD DETAILS ==================== --> |
|
320 <a name="section-MethodDetails"></a> |
|
321 <table class="details" border="1" cellpadding="3" |
|
322 cellspacing="0" width="100%" bgcolor="white"> |
|
323 <tr bgcolor="#70b0f0" class="table-header"> |
|
324 <td colspan="2" class="table-header"> |
|
325 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
326 <tr valign="top"> |
|
327 <td align="left"><span class="table-header">Method Details</span></td> |
|
328 <td align="right" valign="top" |
|
329 ><span class="options">[<a href="#section-MethodDetails" |
|
330 class="privatelink" onclick="toggle_private();" |
|
331 >hide private</a>]</span></td> |
|
332 </tr> |
|
333 </table> |
|
334 </td> |
|
335 </tr> |
|
336 </table> |
|
337 <a name="__init__"></a> |
|
338 <div> |
|
339 <table class="details" border="1" cellpadding="3" |
|
340 cellspacing="0" width="100%" bgcolor="white"> |
|
341 <tr><td> |
|
342 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
343 <tr valign="top"><td> |
|
344 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
345 <span class="sig-arg">build_area_root</span>, |
|
346 <span class="sig-arg">nb_split</span>, |
|
347 <span class="sig-arg">temp_dir</span>, |
|
348 <span class="sig-arg">exclude_dirs</span>, |
|
349 <span class="sig-arg">list_of_files</span>)</span> |
|
350 <br /><em class="fname">(Constructor)</em> |
|
351 </h3> |
|
352 </td><td align="right" valign="top" |
|
353 ><span class="codelink"><a href="delta_zip-pysrc.html#MD5SignatureBuilder.__init__">source code</a></span> |
|
354 </td> |
|
355 </table> |
|
356 |
|
357 constructor |
|
358 <dl class="fields"> |
|
359 <dt>Overrides: |
|
360 object.__init__ |
|
361 </dt> |
|
362 </dl> |
|
363 </td></tr></table> |
|
364 </div> |
|
365 <br /> |
|
366 <!-- ==================== NAVIGATION BAR ==================== --> |
|
367 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
368 bgcolor="#a0c0ff" cellspacing="0"> |
|
369 <tr valign="middle"> |
|
370 |
|
371 <!-- Tree link --> |
|
372 <th> <a |
|
373 href="module-tree.html">Trees</a> </th> |
|
374 |
|
375 <!-- Index link --> |
|
376 <th> <a |
|
377 href="identifier-index.html">Indices</a> </th> |
|
378 |
|
379 <!-- Help link --> |
|
380 <th> <a |
|
381 href="help.html">Help</a> </th> |
|
382 |
|
383 <th class="navbar" width="100%"></th> |
|
384 </tr> |
|
385 </table> |
|
386 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
387 <tr> |
|
388 <td align="left" class="footer"> |
|
389 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:18 2009 |
|
390 </td> |
|
391 <td align="right" class="footer"> |
|
392 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
393 </td> |
|
394 </tr> |
|
395 </table> |
|
396 |
|
397 <script type="text/javascript"> |
|
398 <!-- |
|
399 // Private objects are initially displayed (because if |
|
400 // javascript is turned off then we want them to be |
|
401 // visible); but by default, we want to hide them. So hide |
|
402 // them unless we have a cookie that says to show them. |
|
403 checkCookie() |
|
404 // --> |
|
405 </script> |
|
406 |
|
407 </body> |
|
408 </html> |