|
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>preparation.PreparationSnapshot</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="preparation-module.html">Module preparation</a> :: |
|
38 Class PreparationSnapshot |
|
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="preparation.PreparationSnapshot-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 PreparationSnapshot</h1><span class="codelink"><a href="preparation-pysrc.html#PreparationSnapshot">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 <a href="preparation.PreparationAction-class.html">PreparationAction</a> --+ |
|
60 | |
|
61 <strong class="uidshort">PreparationSnapshot</strong> |
|
62 </pre> |
|
63 |
|
64 <hr /> |
|
65 <p>Implements a Snapshot preparation function.</p> |
|
66 <p>Support the parallel snapshotter.</p><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="preparation.PreparationSnapshot-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
92 <span class="summary-sig-arg">config</span>, |
|
93 <span class="summary-sig-arg">builder</span>)</span><br /> |
|
94 Initialization.</td> |
|
95 <td align="right" valign="top"> |
|
96 <span class="codelink"><a href="preparation-pysrc.html#PreparationSnapshot.__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 href="preparation.PreparationSnapshot-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
111 Method that implements snapshoting of the project into a folder.</td> |
|
112 <td align="right" valign="top"> |
|
113 <span class="codelink"><a href="preparation-pysrc.html#PreparationSnapshot.execute">source code</a></span> |
|
114 |
|
115 </td> |
|
116 </tr> |
|
117 </table> |
|
118 |
|
119 </td> |
|
120 </tr> |
|
121 <tr class="private"> |
|
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 href="preparation.PreparationSnapshot-class.html#_check_version" class="summary-sig-name">_check_version</a>(<span class="summary-sig-arg">self</span>, |
|
128 <span class="summary-sig-arg">targetdir</span>)</span><br /> |
|
129 Check the version file for snaphot and identify if the project has to be snapshot or not.</td> |
|
130 <td align="right" valign="top"> |
|
131 <span class="codelink"><a href="preparation-pysrc.html#PreparationSnapshot._check_version">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><a href="preparation.PreparationAction-class.html">PreparationAction</a></code></b>: |
|
142 <code><a href="preparation.PreparationAction-class.html#check">check</a></code>, |
|
143 <code><a href="preparation.PreparationAction-class.html#get_session">get_session</a></code>, |
|
144 <code><a href="preparation.PreparationAction-class.html#get_threads">get_threads</a></code> |
|
145 </p> |
|
146 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="preparation.PreparationAction-class.html">PreparationAction</a></code></b> (private): |
|
147 <code><a href="preparation.PreparationAction-class.html#_check_object">_check_object</a></code> |
|
148 </p></div> |
|
149 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
150 <code>__delattr__</code>, |
|
151 <code>__getattribute__</code>, |
|
152 <code>__hash__</code>, |
|
153 <code>__new__</code>, |
|
154 <code>__reduce__</code>, |
|
155 <code>__reduce_ex__</code>, |
|
156 <code>__repr__</code>, |
|
157 <code>__setattr__</code>, |
|
158 <code>__str__</code> |
|
159 </p> |
|
160 </td> |
|
161 </tr> |
|
162 </table> |
|
163 <!-- ==================== PROPERTIES ==================== --> |
|
164 <a name="section-Properties"></a> |
|
165 <table class="summary" border="1" cellpadding="3" |
|
166 cellspacing="0" width="100%" bgcolor="white"> |
|
167 <tr bgcolor="#70b0f0" class="table-header"> |
|
168 <td colspan="2" class="table-header"> |
|
169 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
170 <tr valign="top"> |
|
171 <td align="left"><span class="table-header">Properties</span></td> |
|
172 <td align="right" valign="top" |
|
173 ><span class="options">[<a href="#section-Properties" |
|
174 class="privatelink" onclick="toggle_private();" |
|
175 >hide private</a>]</span></td> |
|
176 </tr> |
|
177 </table> |
|
178 </td> |
|
179 </tr> |
|
180 <tr> |
|
181 <td colspan="2" class="summary"> |
|
182 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
183 <code>__class__</code> |
|
184 </p> |
|
185 </td> |
|
186 </tr> |
|
187 </table> |
|
188 <!-- ==================== METHOD DETAILS ==================== --> |
|
189 <a name="section-MethodDetails"></a> |
|
190 <table class="details" border="1" cellpadding="3" |
|
191 cellspacing="0" width="100%" bgcolor="white"> |
|
192 <tr bgcolor="#70b0f0" class="table-header"> |
|
193 <td colspan="2" class="table-header"> |
|
194 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
195 <tr valign="top"> |
|
196 <td align="left"><span class="table-header">Method Details</span></td> |
|
197 <td align="right" valign="top" |
|
198 ><span class="options">[<a href="#section-MethodDetails" |
|
199 class="privatelink" onclick="toggle_private();" |
|
200 >hide private</a>]</span></td> |
|
201 </tr> |
|
202 </table> |
|
203 </td> |
|
204 </tr> |
|
205 </table> |
|
206 <a name="__init__"></a> |
|
207 <div> |
|
208 <table class="details" border="1" cellpadding="3" |
|
209 cellspacing="0" width="100%" bgcolor="white"> |
|
210 <tr><td> |
|
211 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
212 <tr valign="top"><td> |
|
213 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
214 <span class="sig-arg">config</span>, |
|
215 <span class="sig-arg">builder</span>)</span> |
|
216 <br /><em class="fname">(Constructor)</em> |
|
217 </h3> |
|
218 </td><td align="right" valign="top" |
|
219 ><span class="codelink"><a href="preparation-pysrc.html#PreparationSnapshot.__init__">source code</a></span> |
|
220 </td> |
|
221 </table> |
|
222 |
|
223 Initialization. |
|
224 <dl class="fields"> |
|
225 <dt>Overrides: |
|
226 <a href="preparation.PreparationAction-class.html#__init__">PreparationAction.__init__</a> |
|
227 </dt> |
|
228 </dl> |
|
229 </td></tr></table> |
|
230 </div> |
|
231 <a name="execute"></a> |
|
232 <div> |
|
233 <table class="details" border="1" cellpadding="3" |
|
234 cellspacing="0" width="100%" bgcolor="white"> |
|
235 <tr><td> |
|
236 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
237 <tr valign="top"><td> |
|
238 <h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>)</span> |
|
239 </h3> |
|
240 </td><td align="right" valign="top" |
|
241 ><span class="codelink"><a href="preparation-pysrc.html#PreparationSnapshot.execute">source code</a></span> |
|
242 </td> |
|
243 </table> |
|
244 |
|
245 Method that implements snapshoting of the project into a folder. |
|
246 <dl class="fields"> |
|
247 <dt>Overrides: |
|
248 <a href="preparation.PreparationAction-class.html#execute">PreparationAction.execute</a> |
|
249 </dt> |
|
250 </dl> |
|
251 </td></tr></table> |
|
252 </div> |
|
253 <a name="_check_version"></a> |
|
254 <div class="private"> |
|
255 <table class="details" border="1" cellpadding="3" |
|
256 cellspacing="0" width="100%" bgcolor="white"> |
|
257 <tr><td> |
|
258 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
259 <tr valign="top"><td> |
|
260 <h3 class="epydoc"><span class="sig"><span class="sig-name">_check_version</span>(<span class="sig-arg">self</span>, |
|
261 <span class="sig-arg">targetdir</span>)</span> |
|
262 </h3> |
|
263 </td><td align="right" valign="top" |
|
264 ><span class="codelink"><a href="preparation-pysrc.html#PreparationSnapshot._check_version">source code</a></span> |
|
265 </td> |
|
266 </table> |
|
267 |
|
268 Check the version file for snaphot and identify if the project has to be snapshot or not. |
|
269 Returns True if the content of the file matches the project to snapshot (nothing to do). |
|
270 Returns falls either if the file is missing, or the content is different. |
|
271 <dl class="fields"> |
|
272 </dl> |
|
273 </td></tr></table> |
|
274 </div> |
|
275 <br /> |
|
276 <!-- ==================== NAVIGATION BAR ==================== --> |
|
277 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
278 bgcolor="#a0c0ff" cellspacing="0"> |
|
279 <tr valign="middle"> |
|
280 |
|
281 <!-- Tree link --> |
|
282 <th> <a |
|
283 href="module-tree.html">Trees</a> </th> |
|
284 |
|
285 <!-- Index link --> |
|
286 <th> <a |
|
287 href="identifier-index.html">Indices</a> </th> |
|
288 |
|
289 <!-- Help link --> |
|
290 <th> <a |
|
291 href="help.html">Help</a> </th> |
|
292 |
|
293 <th class="navbar" width="100%"></th> |
|
294 </tr> |
|
295 </table> |
|
296 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
297 <tr> |
|
298 <td align="left" class="footer"> |
|
299 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:19 2009 |
|
300 </td> |
|
301 <td align="right" class="footer"> |
|
302 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
303 </td> |
|
304 </tr> |
|
305 </table> |
|
306 |
|
307 <script type="text/javascript"> |
|
308 <!-- |
|
309 // Private objects are initially displayed (because if |
|
310 // javascript is turned off then we want them to be |
|
311 // visible); but by default, we want to hide them. So hide |
|
312 // them unless we have a cookie that says to show them. |
|
313 checkCookie() |
|
314 // --> |
|
315 </script> |
|
316 |
|
317 </body> |
|
318 </html> |