|
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>buildtools.Command</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="buildtools-module.html">Module buildtools</a> :: |
|
38 Class Command |
|
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="buildtools.Command-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 Command</h1><span class="codelink"><a href="buildtools-pysrc.html#Command">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 <a href="buildtools.Task-class.html">Task</a> --+ |
|
60 | |
|
61 <strong class="uidshort">Command</strong> |
|
62 </pre> |
|
63 |
|
64 <hr /> |
|
65 This class implements a command definition. |
|
66 It handles command id and stage. |
|
67 All command from one stage should be finished before starting the next stage.<br /><br /> |
|
68 |
|
69 <!-- ==================== INSTANCE METHODS ==================== --> |
|
70 <a name="section-InstanceMethods"></a> |
|
71 <table class="summary" border="1" cellpadding="3" |
|
72 cellspacing="0" width="100%" bgcolor="white"> |
|
73 <tr bgcolor="#70b0f0" class="table-header"> |
|
74 <td colspan="2" class="table-header"> |
|
75 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
76 <tr valign="top"> |
|
77 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
78 <td align="right" valign="top" |
|
79 ><span class="options">[<a href="#section-InstanceMethods" |
|
80 class="privatelink" onclick="toggle_private();" |
|
81 >hide private</a>]</span></td> |
|
82 </tr> |
|
83 </table> |
|
84 </td> |
|
85 </tr> |
|
86 <tr> |
|
87 <td width="15%" align="right" valign="top" class="summary"> |
|
88 <span class="summary-type"> </span> |
|
89 </td><td class="summary"> |
|
90 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
91 <tr> |
|
92 <td><span class="summary-sig"><a href="buildtools.Command-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
93 <span class="summary-sig-arg">executable</span>, |
|
94 <span class="summary-sig-arg">path</span>, |
|
95 <span class="summary-sig-arg">args</span>=<span class="summary-sig-default">None</span>, |
|
96 <span class="summary-sig-arg">name</span>=<span class="summary-sig-default">''</span>)</span><br /> |
|
97 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> |
|
98 <td align="right" valign="top"> |
|
99 <span class="codelink"><a href="buildtools-pysrc.html#Command.__init__">source code</a></span> |
|
100 |
|
101 </td> |
|
102 </tr> |
|
103 </table> |
|
104 |
|
105 </td> |
|
106 </tr> |
|
107 <tr> |
|
108 <td width="15%" align="right" valign="top" class="summary"> |
|
109 <span class="summary-type"> </span> |
|
110 </td><td class="summary"> |
|
111 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
112 <tr> |
|
113 <td><span class="summary-sig"><a name="setJobId"></a><span class="summary-sig-name">setJobId</span>(<span class="summary-sig-arg">self</span>, |
|
114 <span class="summary-sig-arg">idn</span>)</span><br /> |
|
115 Set the command id.</td> |
|
116 <td align="right" valign="top"> |
|
117 <span class="codelink"><a href="buildtools-pysrc.html#Command.setJobId">source code</a></span> |
|
118 |
|
119 </td> |
|
120 </tr> |
|
121 </table> |
|
122 |
|
123 </td> |
|
124 </tr> |
|
125 <tr> |
|
126 <td width="15%" align="right" valign="top" class="summary"> |
|
127 <span class="summary-type"> </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="setStage"></a><span class="summary-sig-name">setStage</span>(<span class="summary-sig-arg">self</span>, |
|
132 <span class="summary-sig-arg">stage</span>)</span><br /> |
|
133 Set the command stage.</td> |
|
134 <td align="right" valign="top"> |
|
135 <span class="codelink"><a href="buildtools-pysrc.html#Command.setStage">source code</a></span> |
|
136 |
|
137 </td> |
|
138 </tr> |
|
139 </table> |
|
140 |
|
141 </td> |
|
142 </tr> |
|
143 <tr> |
|
144 <td width="15%" align="right" valign="top" class="summary"> |
|
145 <span class="summary-type"> </span> |
|
146 </td><td class="summary"> |
|
147 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
148 <tr> |
|
149 <td><span class="summary-sig"><a name="jobId"></a><span class="summary-sig-name">jobId</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
150 Get the command id.</td> |
|
151 <td align="right" valign="top"> |
|
152 <span class="codelink"><a href="buildtools-pysrc.html#Command.jobId">source code</a></span> |
|
153 |
|
154 </td> |
|
155 </tr> |
|
156 </table> |
|
157 |
|
158 </td> |
|
159 </tr> |
|
160 <tr> |
|
161 <td width="15%" align="right" valign="top" class="summary"> |
|
162 <span class="summary-type"> </span> |
|
163 </td><td class="summary"> |
|
164 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
165 <tr> |
|
166 <td><span class="summary-sig"><a name="stage"></a><span class="summary-sig-name">stage</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
167 Get the command stage.</td> |
|
168 <td align="right" valign="top"> |
|
169 <span class="codelink"><a href="buildtools-pysrc.html#Command.stage">source code</a></span> |
|
170 |
|
171 </td> |
|
172 </tr> |
|
173 </table> |
|
174 |
|
175 </td> |
|
176 </tr> |
|
177 <tr> |
|
178 <td width="15%" align="right" valign="top" class="summary"> |
|
179 <span class="summary-type"> </span> |
|
180 </td><td class="summary"> |
|
181 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
182 <tr> |
|
183 <td><span class="summary-sig"><a name="name"></a><span class="summary-sig-name">name</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
184 Get the command name.</td> |
|
185 <td align="right" valign="top"> |
|
186 <span class="codelink"><a href="buildtools-pysrc.html#Command.name">source code</a></span> |
|
187 |
|
188 </td> |
|
189 </tr> |
|
190 </table> |
|
191 |
|
192 </td> |
|
193 </tr> |
|
194 <tr> |
|
195 <td width="15%" align="right" valign="top" class="summary"> |
|
196 <span class="summary-type"> </span> |
|
197 </td><td class="summary"> |
|
198 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
199 <tr> |
|
200 <td><span class="summary-sig"><a name="executable"></a><span class="summary-sig-name">executable</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
201 Get the command executable.</td> |
|
202 <td align="right" valign="top"> |
|
203 <span class="codelink"><a href="buildtools-pysrc.html#Command.executable">source code</a></span> |
|
204 |
|
205 </td> |
|
206 </tr> |
|
207 </table> |
|
208 |
|
209 </td> |
|
210 </tr> |
|
211 <tr> |
|
212 <td width="15%" align="right" valign="top" class="summary"> |
|
213 <span class="summary-type"> </span> |
|
214 </td><td class="summary"> |
|
215 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
216 <tr> |
|
217 <td><span class="summary-sig"><a name="path"></a><span class="summary-sig-name">path</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
218 Get the command path.</td> |
|
219 <td align="right" valign="top"> |
|
220 <span class="codelink"><a href="buildtools-pysrc.html#Command.path">source code</a></span> |
|
221 |
|
222 </td> |
|
223 </tr> |
|
224 </table> |
|
225 |
|
226 </td> |
|
227 </tr> |
|
228 <tr> |
|
229 <td width="15%" align="right" valign="top" class="summary"> |
|
230 <span class="summary-type"> </span> |
|
231 </td><td class="summary"> |
|
232 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
233 <tr> |
|
234 <td><span class="summary-sig"><a name="cmd"></a><span class="summary-sig-name">cmd</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
235 Get the command line.</td> |
|
236 <td align="right" valign="top"> |
|
237 <span class="codelink"><a href="buildtools-pysrc.html#Command.cmd">source code</a></span> |
|
238 |
|
239 </td> |
|
240 </tr> |
|
241 </table> |
|
242 |
|
243 </td> |
|
244 </tr> |
|
245 <tr> |
|
246 <td width="15%" align="right" valign="top" class="summary"> |
|
247 <span class="summary-type"> </span> |
|
248 </td><td class="summary"> |
|
249 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
250 <tr> |
|
251 <td><span class="summary-sig"><a name="addArg"></a><span class="summary-sig-name">addArg</span>(<span class="summary-sig-arg">self</span>, |
|
252 <span class="summary-sig-arg">arg</span>)</span><br /> |
|
253 Add a command line argument.</td> |
|
254 <td align="right" valign="top"> |
|
255 <span class="codelink"><a href="buildtools-pysrc.html#Command.addArg">source code</a></span> |
|
256 |
|
257 </td> |
|
258 </tr> |
|
259 </table> |
|
260 |
|
261 </td> |
|
262 </tr> |
|
263 <tr> |
|
264 <td width="15%" align="right" valign="top" class="summary"> |
|
265 <span class="summary-type"> </span> |
|
266 </td><td class="summary"> |
|
267 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
268 <tr> |
|
269 <td><span class="summary-sig"><a href="buildtools.Command-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
270 repr(x)</td> |
|
271 <td align="right" valign="top"> |
|
272 <span class="codelink"><a href="buildtools-pysrc.html#Command.__repr__">source code</a></span> |
|
273 |
|
274 </td> |
|
275 </tr> |
|
276 </table> |
|
277 |
|
278 </td> |
|
279 </tr> |
|
280 <tr> |
|
281 <td colspan="2" class="summary"> |
|
282 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
283 <code>__delattr__</code>, |
|
284 <code>__getattribute__</code>, |
|
285 <code>__hash__</code>, |
|
286 <code>__new__</code>, |
|
287 <code>__reduce__</code>, |
|
288 <code>__reduce_ex__</code>, |
|
289 <code>__setattr__</code>, |
|
290 <code>__str__</code> |
|
291 </p> |
|
292 </td> |
|
293 </tr> |
|
294 </table> |
|
295 <!-- ==================== PROPERTIES ==================== --> |
|
296 <a name="section-Properties"></a> |
|
297 <table class="summary" border="1" cellpadding="3" |
|
298 cellspacing="0" width="100%" bgcolor="white"> |
|
299 <tr bgcolor="#70b0f0" class="table-header"> |
|
300 <td colspan="2" class="table-header"> |
|
301 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
302 <tr valign="top"> |
|
303 <td align="left"><span class="table-header">Properties</span></td> |
|
304 <td align="right" valign="top" |
|
305 ><span class="options">[<a href="#section-Properties" |
|
306 class="privatelink" onclick="toggle_private();" |
|
307 >hide private</a>]</span></td> |
|
308 </tr> |
|
309 </table> |
|
310 </td> |
|
311 </tr> |
|
312 <tr> |
|
313 <td colspan="2" class="summary"> |
|
314 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
315 <code>__class__</code> |
|
316 </p> |
|
317 </td> |
|
318 </tr> |
|
319 </table> |
|
320 <!-- ==================== METHOD DETAILS ==================== --> |
|
321 <a name="section-MethodDetails"></a> |
|
322 <table class="details" border="1" cellpadding="3" |
|
323 cellspacing="0" width="100%" bgcolor="white"> |
|
324 <tr bgcolor="#70b0f0" class="table-header"> |
|
325 <td colspan="2" class="table-header"> |
|
326 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
327 <tr valign="top"> |
|
328 <td align="left"><span class="table-header">Method Details</span></td> |
|
329 <td align="right" valign="top" |
|
330 ><span class="options">[<a href="#section-MethodDetails" |
|
331 class="privatelink" onclick="toggle_private();" |
|
332 >hide private</a>]</span></td> |
|
333 </tr> |
|
334 </table> |
|
335 </td> |
|
336 </tr> |
|
337 </table> |
|
338 <a name="__init__"></a> |
|
339 <div> |
|
340 <table class="details" border="1" cellpadding="3" |
|
341 cellspacing="0" width="100%" bgcolor="white"> |
|
342 <tr><td> |
|
343 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
344 <tr valign="top"><td> |
|
345 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
346 <span class="sig-arg">executable</span>, |
|
347 <span class="sig-arg">path</span>, |
|
348 <span class="sig-arg">args</span>=<span class="sig-default">None</span>, |
|
349 <span class="sig-arg">name</span>=<span class="sig-default">''</span>)</span> |
|
350 <br /><em class="fname">(Constructor)</em> |
|
351 </h3> |
|
352 </td><td align="right" valign="top" |
|
353 ><span class="codelink"><a href="buildtools-pysrc.html#Command.__init__">source code</a></span> |
|
354 </td> |
|
355 </table> |
|
356 |
|
357 x.__init__(...) initializes x; see x.__class__.__doc__ for signature |
|
358 <dl class="fields"> |
|
359 <dt>Overrides: |
|
360 object.__init__ |
|
361 <dd><em class="note">(inherited documentation)</em></dd> |
|
362 </dt> |
|
363 </dl> |
|
364 </td></tr></table> |
|
365 </div> |
|
366 <a name="__repr__"></a> |
|
367 <div> |
|
368 <table class="details" border="1" cellpadding="3" |
|
369 cellspacing="0" width="100%" bgcolor="white"> |
|
370 <tr><td> |
|
371 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
372 <tr valign="top"><td> |
|
373 <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span> |
|
374 <br /><em class="fname">(Representation operator)</em> |
|
375 </h3> |
|
376 </td><td align="right" valign="top" |
|
377 ><span class="codelink"><a href="buildtools-pysrc.html#Command.__repr__">source code</a></span> |
|
378 </td> |
|
379 </table> |
|
380 |
|
381 repr(x) |
|
382 <dl class="fields"> |
|
383 <dt>Overrides: |
|
384 object.__repr__ |
|
385 <dd><em class="note">(inherited documentation)</em></dd> |
|
386 </dt> |
|
387 </dl> |
|
388 </td></tr></table> |
|
389 </div> |
|
390 <br /> |
|
391 <!-- ==================== NAVIGATION BAR ==================== --> |
|
392 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
393 bgcolor="#a0c0ff" cellspacing="0"> |
|
394 <tr valign="middle"> |
|
395 |
|
396 <!-- Tree link --> |
|
397 <th> <a |
|
398 href="module-tree.html">Trees</a> </th> |
|
399 |
|
400 <!-- Index link --> |
|
401 <th> <a |
|
402 href="identifier-index.html">Indices</a> </th> |
|
403 |
|
404 <!-- Help link --> |
|
405 <th> <a |
|
406 href="help.html">Help</a> </th> |
|
407 |
|
408 <th class="navbar" width="100%"></th> |
|
409 </tr> |
|
410 </table> |
|
411 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
412 <tr> |
|
413 <td align="left" class="footer"> |
|
414 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009 |
|
415 </td> |
|
416 <td align="right" class="footer"> |
|
417 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
418 </td> |
|
419 </tr> |
|
420 </table> |
|
421 |
|
422 <script type="text/javascript"> |
|
423 <!-- |
|
424 // Private objects are initially displayed (because if |
|
425 // javascript is turned off then we want them to be |
|
426 // visible); but by default, we want to hide them. So hide |
|
427 // them unless we have a cookie that says to show them. |
|
428 checkCookie() |
|
429 // --> |
|
430 </script> |
|
431 |
|
432 </body> |
|
433 </html> |