|
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>ccm</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 Package ccm |
|
38 </span> |
|
39 </td> |
|
40 <td> |
|
41 <table cellpadding="0" cellspacing="0"> |
|
42 <!-- hide/show private --> |
|
43 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
44 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
45 <tr><td align="right"><span class="options" |
|
46 >[<a href="frames.html" target="_top">frames</a |
|
47 >] | <a href="ccm-module.html" |
|
48 target="_top">no frames</a>]</span></td></tr> |
|
49 </table> |
|
50 </td> |
|
51 </tr> |
|
52 </table> |
|
53 <!-- ==================== PACKAGE DESCRIPTION ==================== --> |
|
54 <h1 class="epydoc">Package ccm</h1><span class="codelink"><a href="ccm-pysrc.html">source code</a></span><br /><br /> |
|
55 CM/Synergy Python toolkit.<br /><br /> |
|
56 |
|
57 <!-- ==================== SUBMODULES ==================== --> |
|
58 <a name="section-Submodules"></a> |
|
59 <table class="summary" border="1" cellpadding="3" |
|
60 cellspacing="0" width="100%" bgcolor="white"> |
|
61 <tr bgcolor="#70b0f0" class="table-header"> |
|
62 <td colspan="2" class="table-header"> |
|
63 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
64 <tr valign="top"> |
|
65 <td align="left"><span class="table-header">Submodules</span></td> |
|
66 <td align="right" valign="top" |
|
67 ><span class="options">[<a href="#section-Submodules" |
|
68 class="privatelink" onclick="toggle_private();" |
|
69 >hide private</a>]</span></td> |
|
70 </tr> |
|
71 </table> |
|
72 </td> |
|
73 </tr> |
|
74 <tr><td class="summary"> |
|
75 <ul class="nomargin"> |
|
76 <li> <strong class="uidlink"><a href="ccm.conflict-module.html">ccm.conflict</a></strong>: <em class="summary">CCM conflict detection module.</em> </li> |
|
77 <li> <strong class="uidlink"><a href="ccm.extra-module.html">ccm.extra</a></strong>: <em class="summary">Library that contains custom Synergy functionnlities: e.g |
|
78 * Snapshotter that can snapshot unfrozen baselines |
|
79 * Threaded snapshotter.</em> </li> |
|
80 </ul></td></tr> |
|
81 </table> |
|
82 |
|
83 <br /> |
|
84 <!-- ==================== CLASSES ==================== --> |
|
85 <a name="section-Classes"></a> |
|
86 <table class="summary" border="1" cellpadding="3" |
|
87 cellspacing="0" width="100%" bgcolor="white"> |
|
88 <tr bgcolor="#70b0f0" class="table-header"> |
|
89 <td colspan="2" class="table-header"> |
|
90 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
91 <tr valign="top"> |
|
92 <td align="left"><span class="table-header">Classes</span></td> |
|
93 <td align="right" valign="top" |
|
94 ><span class="options">[<a href="#section-Classes" |
|
95 class="privatelink" onclick="toggle_private();" |
|
96 >hide private</a>]</span></td> |
|
97 </tr> |
|
98 </table> |
|
99 </td> |
|
100 </tr> |
|
101 <tr> |
|
102 <td width="15%" align="right" valign="top" class="summary"> |
|
103 <span class="summary-type"> </span> |
|
104 </td><td class="summary"> |
|
105 <a href="ccm.CCMException-class.html" class="summary-name">CCMException</a><br /> |
|
106 Base exception that should be raised by methods of this framework. |
|
107 </td> |
|
108 </tr> |
|
109 <tr> |
|
110 <td width="15%" align="right" valign="top" class="summary"> |
|
111 <span class="summary-type"> </span> |
|
112 </td><td class="summary"> |
|
113 <a href="ccm.Result-class.html" class="summary-name">Result</a><br /> |
|
114 Class that abstracts ccm call result handling. |
|
115 </td> |
|
116 </tr> |
|
117 <tr> |
|
118 <td width="15%" align="right" valign="top" class="summary"> |
|
119 <span class="summary-type"> </span> |
|
120 </td><td class="summary"> |
|
121 <a href="ccm.ProjectCheckoutResult-class.html" class="summary-name">ProjectCheckoutResult</a><br /> |
|
122 Project checkout output parser. |
|
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 <a href="ccm.ProjectPurposeResult-class.html" class="summary-name">ProjectPurposeResult</a><br /> |
|
130 Parses purpose query output. |
|
131 </td> |
|
132 </tr> |
|
133 <tr> |
|
134 <td width="15%" align="right" valign="top" class="summary"> |
|
135 <span class="summary-type"> </span> |
|
136 </td><td class="summary"> |
|
137 <a href="ccm.ConflictsResult-class.html" class="summary-name">ConflictsResult</a><br /> |
|
138 Parses purpose query output. |
|
139 </td> |
|
140 </tr> |
|
141 <tr> |
|
142 <td width="15%" align="right" valign="top" class="summary"> |
|
143 <span class="summary-type"> </span> |
|
144 </td><td class="summary"> |
|
145 <a href="ccm.FinduseResult-class.html" class="summary-name">FinduseResult</a><br /> |
|
146 Parses finduse query output. |
|
147 </td> |
|
148 </tr> |
|
149 <tr> |
|
150 <td width="15%" align="right" valign="top" class="summary"> |
|
151 <span class="summary-type"> </span> |
|
152 </td><td class="summary"> |
|
153 <a href="ccm.UpdateTemplateInformation-class.html" class="summary-name">UpdateTemplateInformation</a><br /> |
|
154 Parse update template information output. |
|
155 </td> |
|
156 </tr> |
|
157 <tr> |
|
158 <td width="15%" align="right" valign="top" class="summary"> |
|
159 <span class="summary-type"> </span> |
|
160 </td><td class="summary"> |
|
161 <a href="ccm.UpdatePropertiesRefreshResult-class.html" class="summary-name">UpdatePropertiesRefreshResult</a><br /> |
|
162 Parse update template refresh output. |
|
163 </td> |
|
164 </tr> |
|
165 <tr> |
|
166 <td width="15%" align="right" valign="top" class="summary"> |
|
167 <span class="summary-type"> </span> |
|
168 </td><td class="summary"> |
|
169 <a href="ccm.UpdateResultSimple-class.html" class="summary-name">UpdateResultSimple</a><br /> |
|
170 Parse update output. |
|
171 </td> |
|
172 </tr> |
|
173 <tr> |
|
174 <td width="15%" align="right" valign="top" class="summary"> |
|
175 <span class="summary-type"> </span> |
|
176 </td><td class="summary"> |
|
177 <a href="ccm.UpdateResult-class.html" class="summary-name">UpdateResult</a><br /> |
|
178 Parse update output. |
|
179 </td> |
|
180 </tr> |
|
181 <tr> |
|
182 <td width="15%" align="right" valign="top" class="summary"> |
|
183 <span class="summary-type"> </span> |
|
184 </td><td class="summary"> |
|
185 <a href="ccm.WorkAreaInfoResult-class.html" class="summary-name">WorkAreaInfoResult</a><br /> |
|
186 Parse work area info output. |
|
187 </td> |
|
188 </tr> |
|
189 <tr> |
|
190 <td width="15%" align="right" valign="top" class="summary"> |
|
191 <span class="summary-type"> </span> |
|
192 </td><td class="summary"> |
|
193 <a href="ccm.CreateNewTaskResult-class.html" class="summary-name">CreateNewTaskResult</a> |
|
194 </td> |
|
195 </tr> |
|
196 <tr> |
|
197 <td width="15%" align="right" valign="top" class="summary"> |
|
198 <span class="summary-type"> </span> |
|
199 </td><td class="summary"> |
|
200 <a href="ccm.AttributeNameListResult-class.html" class="summary-name">AttributeNameListResult</a><br /> |
|
201 Class that abstract ccm call result handling. |
|
202 </td> |
|
203 </tr> |
|
204 <tr> |
|
205 <td width="15%" align="right" valign="top" class="summary"> |
|
206 <span class="summary-type"> </span> |
|
207 </td><td class="summary"> |
|
208 <a href="ccm.ObjectListResult-class.html" class="summary-name">ObjectListResult</a><br /> |
|
209 Parses an object list Synergy output. |
|
210 </td> |
|
211 </tr> |
|
212 <tr> |
|
213 <td width="15%" align="right" valign="top" class="summary"> |
|
214 <span class="summary-type"> </span> |
|
215 </td><td class="summary"> |
|
216 <a href="ccm.DataMapperListResult-class.html" class="summary-name">DataMapperListResult</a><br /> |
|
217 Parses an object list Synergy output. |
|
218 </td> |
|
219 </tr> |
|
220 <tr> |
|
221 <td width="15%" align="right" valign="top" class="summary"> |
|
222 <span class="summary-type"> </span> |
|
223 </td><td class="summary"> |
|
224 <a href="ccm.FolderCopyResult-class.html" class="summary-name">FolderCopyResult</a><br /> |
|
225 Parses a folder copy result |
|
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 <a href="ccm.AbstractSession-class.html" class="summary-name">AbstractSession</a><br /> |
|
233 An abstract Synergy session. |
|
234 </td> |
|
235 </tr> |
|
236 <tr> |
|
237 <td width="15%" align="right" valign="top" class="summary"> |
|
238 <span class="summary-type"> </span> |
|
239 </td><td class="summary"> |
|
240 <a href="ccm.Session-class.html" class="summary-name">Session</a><br /> |
|
241 A Synergy session. |
|
242 </td> |
|
243 </tr> |
|
244 <tr> |
|
245 <td width="15%" align="right" valign="top" class="summary"> |
|
246 <span class="summary-type"> </span> |
|
247 </td><td class="summary"> |
|
248 <a href="ccm.SessionPool-class.html" class="summary-name">SessionPool</a><br /> |
|
249 Session that transparently handled several subsession, to easily enable |
|
250 multithreaded application. |
|
251 </td> |
|
252 </tr> |
|
253 <tr> |
|
254 <td width="15%" align="right" valign="top" class="summary"> |
|
255 <span class="summary-type"> </span> |
|
256 </td><td class="summary"> |
|
257 <a href="ccm.Query-class.html" class="summary-name">Query</a><br /> |
|
258 This object wrap a synergy query, it takes a query as input as well as the |
|
259 attribute you want as output, and get them translated using the model configuration. |
|
260 </td> |
|
261 </tr> |
|
262 <tr> |
|
263 <td width="15%" align="right" valign="top" class="summary"> |
|
264 <span class="summary-type"> </span> |
|
265 </td><td class="summary"> |
|
266 <a href="ccm.InvalidFourPartNameException-class.html" class="summary-name">InvalidFourPartNameException</a><br /> |
|
267 Badly formed Synergy four-part name. |
|
268 </td> |
|
269 </tr> |
|
270 <tr> |
|
271 <td width="15%" align="right" valign="top" class="summary"> |
|
272 <span class="summary-type"> </span> |
|
273 </td><td class="summary"> |
|
274 <a href="ccm.FourPartName-class.html" class="summary-name">FourPartName</a><br /> |
|
275 This class handle four part name parsing and validation. |
|
276 </td> |
|
277 </tr> |
|
278 <tr> |
|
279 <td width="15%" align="right" valign="top" class="summary"> |
|
280 <span class="summary-type"> </span> |
|
281 </td><td class="summary"> |
|
282 <a href="ccm.CCMObject-class.html" class="summary-name">CCMObject</a><br /> |
|
283 Base class for any Synergy object. |
|
284 </td> |
|
285 </tr> |
|
286 <tr> |
|
287 <td width="15%" align="right" valign="top" class="summary"> |
|
288 <span class="summary-type"> </span> |
|
289 </td><td class="summary"> |
|
290 <a href="ccm.File-class.html" class="summary-name">File</a><br /> |
|
291 Wrapper for any Synergy file object |
|
292 </td> |
|
293 </tr> |
|
294 <tr> |
|
295 <td width="15%" align="right" valign="top" class="summary"> |
|
296 <span class="summary-type"> </span> |
|
297 </td><td class="summary"> |
|
298 <a href="ccm.Project-class.html" class="summary-name">Project</a><br /> |
|
299 Wrapper class for Synergy project object. |
|
300 </td> |
|
301 </tr> |
|
302 <tr> |
|
303 <td width="15%" align="right" valign="top" class="summary"> |
|
304 <span class="summary-type"> </span> |
|
305 </td><td class="summary"> |
|
306 <a href="ccm.Dir-class.html" class="summary-name">Dir</a><br /> |
|
307 Wrapper class for Synergy dir object |
|
308 </td> |
|
309 </tr> |
|
310 <tr> |
|
311 <td width="15%" align="right" valign="top" class="summary"> |
|
312 <span class="summary-type"> </span> |
|
313 </td><td class="summary"> |
|
314 <a href="ccm.Releasedef-class.html" class="summary-name">Releasedef</a><br /> |
|
315 Wrapper class for Synergy releasedef object |
|
316 </td> |
|
317 </tr> |
|
318 <tr> |
|
319 <td width="15%" align="right" valign="top" class="summary"> |
|
320 <span class="summary-type"> </span> |
|
321 </td><td class="summary"> |
|
322 <a href="ccm.Folder-class.html" class="summary-name">Folder</a><br /> |
|
323 Wrapper class for Synergy folder object |
|
324 </td> |
|
325 </tr> |
|
326 <tr> |
|
327 <td width="15%" align="right" valign="top" class="summary"> |
|
328 <span class="summary-type"> </span> |
|
329 </td><td class="summary"> |
|
330 <a href="ccm.Task-class.html" class="summary-name">Task</a><br /> |
|
331 Wrapper class for Synergy task object |
|
332 </td> |
|
333 </tr> |
|
334 <tr> |
|
335 <td width="15%" align="right" valign="top" class="summary"> |
|
336 <span class="summary-type"> </span> |
|
337 </td><td class="summary"> |
|
338 <a href="ccm.UpdateTemplate-class.html" class="summary-name">UpdateTemplate</a><br /> |
|
339 Allow to access Update Template property using Release and Purpose. |
|
340 </td> |
|
341 </tr> |
|
342 </table> |
|
343 <!-- ==================== FUNCTIONS ==================== --> |
|
344 <a name="section-Functions"></a> |
|
345 <table class="summary" border="1" cellpadding="3" |
|
346 cellspacing="0" width="100%" bgcolor="white"> |
|
347 <tr bgcolor="#70b0f0" class="table-header"> |
|
348 <td colspan="2" class="table-header"> |
|
349 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
350 <tr valign="top"> |
|
351 <td align="left"><span class="table-header">Functions</span></td> |
|
352 <td align="right" valign="top" |
|
353 ><span class="options">[<a href="#section-Functions" |
|
354 class="privatelink" onclick="toggle_private();" |
|
355 >hide private</a>]</span></td> |
|
356 </tr> |
|
357 </table> |
|
358 </td> |
|
359 </tr> |
|
360 <tr class="private"> |
|
361 <td width="15%" align="right" valign="top" class="summary"> |
|
362 <span class="summary-type"> </span> |
|
363 </td><td class="summary"> |
|
364 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
365 <tr> |
|
366 <td><span class="summary-sig"><a name="_execute"></a><span class="summary-sig-name">_execute</span>(<span class="summary-sig-arg">command</span>, |
|
367 <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
368 Runs a command and returns the result data.</td> |
|
369 <td align="right" valign="top"> |
|
370 <span class="codelink"><a href="ccm-pysrc.html#_execute">source code</a></span> |
|
371 |
|
372 </td> |
|
373 </tr> |
|
374 </table> |
|
375 |
|
376 </td> |
|
377 </tr> |
|
378 <tr> |
|
379 <td width="15%" align="right" valign="top" class="summary"> |
|
380 <span class="summary-type"> </span> |
|
381 </td><td class="summary"> |
|
382 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
383 <tr> |
|
384 <td><span class="summary-sig"><a name="log_result"></a><span class="summary-sig-name">log_result</span>(<span class="summary-sig-arg">result</span>, |
|
385 <span class="summary-sig-arg">rules</span>, |
|
386 <span class="summary-sig-arg">logger</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
387 Rules it a list of tuple defining a regular expression and an log level.</td> |
|
388 <td align="right" valign="top"> |
|
389 <span class="codelink"><a href="ccm-pysrc.html#log_result">source code</a></span> |
|
390 |
|
391 </td> |
|
392 </tr> |
|
393 </table> |
|
394 |
|
395 </td> |
|
396 </tr> |
|
397 <tr> |
|
398 <td width="15%" align="right" valign="top" class="summary"> |
|
399 <span class="summary-type"> </span> |
|
400 </td><td class="summary"> |
|
401 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
402 <tr> |
|
403 <td><span class="summary-sig"><a href="ccm-module.html#read_ccmwaid_info" class="summary-sig-name">read_ccmwaid_info</a>(<span class="summary-sig-arg">filename</span>)</span><br /> |
|
404 Read data from a ccmwaid file.</td> |
|
405 <td align="right" valign="top"> |
|
406 <span class="codelink"><a href="ccm-pysrc.html#read_ccmwaid_info">source code</a></span> |
|
407 |
|
408 </td> |
|
409 </tr> |
|
410 </table> |
|
411 |
|
412 </td> |
|
413 </tr> |
|
414 <tr> |
|
415 <td width="15%" align="right" valign="top" class="summary"> |
|
416 <span class="summary-type"> </span> |
|
417 </td><td class="summary"> |
|
418 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
419 <tr> |
|
420 <td><span class="summary-sig"><a name="create_project_from_path"></a><span class="summary-sig-name">create_project_from_path</span>(<span class="summary-sig-arg">session</span>, |
|
421 <span class="summary-sig-arg">path</span>)</span><br /> |
|
422 Uses the (_|.)ccmwaid.inf file to create a Project object.</td> |
|
423 <td align="right" valign="top"> |
|
424 <span class="codelink"><a href="ccm-pysrc.html#create_project_from_path">source code</a></span> |
|
425 |
|
426 </td> |
|
427 </tr> |
|
428 </table> |
|
429 |
|
430 </td> |
|
431 </tr> |
|
432 <tr> |
|
433 <td width="15%" align="right" valign="top" class="summary"> |
|
434 <span class="summary-type"> </span> |
|
435 </td><td class="summary"> |
|
436 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
437 <tr> |
|
438 <td><span class="summary-sig"><a href="ccm-module.html#open_session" class="summary-sig-name">open_session</a>(<span class="summary-sig-arg">username</span>=<span class="summary-sig-default">None</span>, |
|
439 <span class="summary-sig-arg">password</span>=<span class="summary-sig-default">None</span>, |
|
440 <span class="summary-sig-arg">engine</span>=<span class="summary-sig-default">None</span>, |
|
441 <span class="summary-sig-arg">dbpath</span>=<span class="summary-sig-default">None</span>, |
|
442 <span class="summary-sig-arg">database</span>=<span class="summary-sig-default">None</span>, |
|
443 <span class="summary-sig-arg">reuse</span>=<span class="summary-sig-default">True</span>)</span><br /> |
|
444 Provides a Session object.</td> |
|
445 <td align="right" valign="top"> |
|
446 <span class="codelink"><a href="ccm-pysrc.html#open_session">source code</a></span> |
|
447 |
|
448 </td> |
|
449 </tr> |
|
450 </table> |
|
451 |
|
452 </td> |
|
453 </tr> |
|
454 <tr> |
|
455 <td width="15%" align="right" valign="top" class="summary"> |
|
456 <span class="summary-type"> </span> |
|
457 </td><td class="summary"> |
|
458 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
459 <tr> |
|
460 <td><span class="summary-sig"><a name="get_role_for_purpose"></a><span class="summary-sig-name">get_role_for_purpose</span>(<span class="summary-sig-arg">session</span>, |
|
461 <span class="summary-sig-arg">purpose</span>)</span><br /> |
|
462 return role needed to modify project with checkout for purpose.</td> |
|
463 <td align="right" valign="top"> |
|
464 <span class="codelink"><a href="ccm-pysrc.html#get_role_for_purpose">source code</a></span> |
|
465 |
|
466 </td> |
|
467 </tr> |
|
468 </table> |
|
469 |
|
470 </td> |
|
471 </tr> |
|
472 <tr> |
|
473 <td width="15%" align="right" valign="top" class="summary"> |
|
474 <span class="summary-type"> </span> |
|
475 </td><td class="summary"> |
|
476 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
477 <tr> |
|
478 <td><span class="summary-sig"><a name="get_role_for_status"></a><span class="summary-sig-name">get_role_for_status</span>(<span class="summary-sig-arg">session</span>, |
|
479 <span class="summary-sig-arg">status</span>)</span><br /> |
|
480 return role needed to modify project with a specific status.</td> |
|
481 <td align="right" valign="top"> |
|
482 <span class="codelink"><a href="ccm-pysrc.html#get_role_for_status">source code</a></span> |
|
483 |
|
484 </td> |
|
485 </tr> |
|
486 </table> |
|
487 |
|
488 </td> |
|
489 </tr> |
|
490 <tr> |
|
491 <td width="15%" align="right" valign="top" class="summary"> |
|
492 <span class="summary-type"> </span> |
|
493 </td><td class="summary"> |
|
494 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
495 <tr> |
|
496 <td><span class="summary-sig"><a href="ccm-module.html#running_sessions" class="summary-sig-name">running_sessions</a>(<span class="summary-sig-arg">database</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
497 Return the list of synergy session currently available on the local machine.</td> |
|
498 <td align="right" valign="top"> |
|
499 <span class="codelink"><a href="ccm-pysrc.html#running_sessions">source code</a></span> |
|
500 |
|
501 </td> |
|
502 </tr> |
|
503 </table> |
|
504 |
|
505 </td> |
|
506 </tr> |
|
507 <tr> |
|
508 <td width="15%" align="right" valign="top" class="summary"> |
|
509 <span class="summary-type"> </span> |
|
510 </td><td class="summary"> |
|
511 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
512 <tr> |
|
513 <td><span class="summary-sig"><a name="session_exists"></a><span class="summary-sig-name">session_exists</span>(<span class="summary-sig-arg">sessionid</span>, |
|
514 <span class="summary-sig-arg">database</span>=<span class="summary-sig-default">None</span>)</span></td> |
|
515 <td align="right" valign="top"> |
|
516 <span class="codelink"><a href="ccm-pysrc.html#session_exists">source code</a></span> |
|
517 |
|
518 </td> |
|
519 </tr> |
|
520 </table> |
|
521 |
|
522 </td> |
|
523 </tr> |
|
524 </table> |
|
525 <!-- ==================== VARIABLES ==================== --> |
|
526 <a name="section-Variables"></a> |
|
527 <table class="summary" border="1" cellpadding="3" |
|
528 cellspacing="0" width="100%" bgcolor="white"> |
|
529 <tr bgcolor="#70b0f0" class="table-header"> |
|
530 <td colspan="2" class="table-header"> |
|
531 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
532 <tr valign="top"> |
|
533 <td align="left"><span class="table-header">Variables</span></td> |
|
534 <td align="right" valign="top" |
|
535 ><span class="options">[<a href="#section-Variables" |
|
536 class="privatelink" onclick="toggle_private();" |
|
537 >hide private</a>]</span></td> |
|
538 </tr> |
|
539 </table> |
|
540 </td> |
|
541 </tr> |
|
542 <tr class="private"> |
|
543 <td width="15%" align="right" valign="top" class="summary"> |
|
544 <span class="summary-type"> </span> |
|
545 </td><td class="summary"> |
|
546 <a name="_logger"></a><span class="summary-name">_logger</span> = <code title="logging.getLogger("ccm")">logging.getLogger("ccm")</code> |
|
547 </td> |
|
548 </tr> |
|
549 <tr> |
|
550 <td width="15%" align="right" valign="top" class="summary"> |
|
551 <span class="summary-type"> </span> |
|
552 </td><td class="summary"> |
|
553 <a href="ccm-module.html#VALID_OBJECT_STATES" class="summary-name">VALID_OBJECT_STATES</a> = <code title="'working', 'checkpoint', 'public', 'prep', 'integrate', 'sqa', 'test',\ |
|
554 'released'">'working', 'checkpoint', 'public', 'prep<code class="variable-ellipsis">...</code></code> |
|
555 </td> |
|
556 </tr> |
|
557 <tr> |
|
558 <td width="15%" align="right" valign="top" class="summary"> |
|
559 <span class="summary-type"> </span> |
|
560 </td><td class="summary"> |
|
561 <a name="STATIC_OBJECT_STATES"></a><span class="summary-name">STATIC_OBJECT_STATES</span> = <code title="'integrate', 'sqa', 'test', 'released'">'integrate', 'sqa', 'test', 'released'</code> |
|
562 </td> |
|
563 </tr> |
|
564 <tr> |
|
565 <td width="15%" align="right" valign="top" class="summary"> |
|
566 <span class="summary-type"> </span> |
|
567 </td><td class="summary"> |
|
568 <a href="ccm-module.html#CCM_SESSION_LOCK" class="summary-name">CCM_SESSION_LOCK</a> = <code title="os.path.join(os.environ ['TEMP'], "ccm_session.lock")">os.path.join(os.environ ['TEMP'], "ccm_sess<code class="variable-ellipsis">...</code></code> |
|
569 </td> |
|
570 </tr> |
|
571 <tr> |
|
572 <td width="15%" align="right" valign="top" class="summary"> |
|
573 <span class="summary-type"> </span> |
|
574 </td><td class="summary"> |
|
575 <a href="ccm-module.html#CHECKOUT_LOG_RULES" class="summary-name">CHECKOUT_LOG_RULES</a> = <code title="[[r'^Derive failed for', logging.ERROR], [r'^Serious:', logging.ERROR]\ |
|
576 , [r'^Warning: .* failed.', logging.ERROR], [r'^Warning:', logging.WAR\ |
|
577 NING],]">[[r'^Derive failed for', logging.ERROR], <code class="variable-ellipsis">...</code></code> |
|
578 </td> |
|
579 </tr> |
|
580 <tr> |
|
581 <td width="15%" align="right" valign="top" class="summary"> |
|
582 <span class="summary-type"> </span> |
|
583 </td><td class="summary"> |
|
584 <a href="ccm-module.html#UPDATE_LOG_RULES" class="summary-name">UPDATE_LOG_RULES</a> = <code title="[[r'^Update failed.', logging.ERROR], [r'^Serious:', logging.ERROR], [\ |
|
585 r'^\s+Failed to', logging.ERROR], [r'^\d+ failures to', logging.ERROR]\ |
|
586 , [r"^Warning: This work area '.+' cannot be reused", logging.ERROR], \ |
|
587 [r'^Rebind of .* failed', logging.ERROR], [r'^Warning: .* failed.', lo\ |
|
588 gging.ERROR], [r'^Skipping \'.*\'\. You do not have permission to mod\ |
|
589 ify this project.', logging.ERROR], [r'^Work area conflict exists for \ |
|
590 file', logging.ERROR], [r'^Warning: No candidates found for directory\ |
|
591 entry', logging.ERROR], [r'^Warning:', logging.WARNING],]">[[r'^Update failed.', logging.ERROR], [r'^S<code class="variable-ellipsis">...</code></code> |
|
592 </td> |
|
593 </tr> |
|
594 <tr> |
|
595 <td width="15%" align="right" valign="top" class="summary"> |
|
596 <span class="summary-type"> </span> |
|
597 </td><td class="summary"> |
|
598 <a href="ccm-module.html#CONFLICTS_LOG_RULES" class="summary-name">CONFLICTS_LOG_RULES</a> = <code title="[[r'^\w+#\d+\s+Implicit', logging.WARNING], [r'^(.*)\s+(\w+#\d+)\s+(.+\ |
|
599 )', logging.ERROR],]">[[r'^\w+#\d+\s+Implicit', logging.WARNIN<code class="variable-ellipsis">...</code></code> |
|
600 </td> |
|
601 </tr> |
|
602 <tr> |
|
603 <td width="15%" align="right" valign="top" class="summary"> |
|
604 <span class="summary-type"> </span> |
|
605 </td><td class="summary"> |
|
606 <a href="ccm-module.html#SYNC_LOG_RULES" class="summary-name">SYNC_LOG_RULES</a> = <code title="[[r'^\s+0\s+Conflict\(s\) for project', logging.INFO], [r'^\s+\d+\s+Co\ |
|
607 nflict\(s\) for project', logging.ERROR], [r'^Project \'.*\' does not \ |
|
608 maintain a workarea.', logging.ERROR], [r'^Work area conflict exists f\ |
|
609 or file', logging.ERROR], [r'^Warning: Conflicts detected during synch\ |
|
610 ronization. Check your logs.', logging.ERROR], [r'^Warning:', logging.\ |
|
611 WARNING],]">[[r'^\s+0\s+Conflict\(s\) for project', loggi<code class="variable-ellipsis">...</code></code> |
|
612 </td> |
|
613 </tr> |
|
614 <tr> |
|
615 <td width="15%" align="right" valign="top" class="summary"> |
|
616 <span class="summary-type"> </span> |
|
617 </td><td class="summary"> |
|
618 <a name="CCM_BIN"></a><span class="summary-name">CCM_BIN</span> = <code title="fileutils.which("ccm.exe")">fileutils.which("ccm.exe")</code> |
|
619 </td> |
|
620 </tr> |
|
621 </table> |
|
622 <!-- ==================== FUNCTION DETAILS ==================== --> |
|
623 <a name="section-FunctionDetails"></a> |
|
624 <table class="details" border="1" cellpadding="3" |
|
625 cellspacing="0" width="100%" bgcolor="white"> |
|
626 <tr bgcolor="#70b0f0" class="table-header"> |
|
627 <td colspan="2" class="table-header"> |
|
628 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
629 <tr valign="top"> |
|
630 <td align="left"><span class="table-header">Function Details</span></td> |
|
631 <td align="right" valign="top" |
|
632 ><span class="options">[<a href="#section-FunctionDetails" |
|
633 class="privatelink" onclick="toggle_private();" |
|
634 >hide private</a>]</span></td> |
|
635 </tr> |
|
636 </table> |
|
637 </td> |
|
638 </tr> |
|
639 </table> |
|
640 <a name="read_ccmwaid_info"></a> |
|
641 <div> |
|
642 <table class="details" border="1" cellpadding="3" |
|
643 cellspacing="0" width="100%" bgcolor="white"> |
|
644 <tr><td> |
|
645 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
646 <tr valign="top"><td> |
|
647 <h3 class="epydoc"><span class="sig"><span class="sig-name">read_ccmwaid_info</span>(<span class="sig-arg">filename</span>)</span> |
|
648 </h3> |
|
649 </td><td align="right" valign="top" |
|
650 ><span class="codelink"><a href="ccm-pysrc.html#read_ccmwaid_info">source code</a></span> |
|
651 </td> |
|
652 </table> |
|
653 |
|
654 Read data from a ccmwaid file. This method is an helper to retreive a project from a physical location. |
|
655 <dl class="fields"> |
|
656 </dl> |
|
657 </td></tr></table> |
|
658 </div> |
|
659 <a name="open_session"></a> |
|
660 <div> |
|
661 <table class="details" border="1" cellpadding="3" |
|
662 cellspacing="0" width="100%" bgcolor="white"> |
|
663 <tr><td> |
|
664 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
665 <tr valign="top"><td> |
|
666 <h3 class="epydoc"><span class="sig"><span class="sig-name">open_session</span>(<span class="sig-arg">username</span>=<span class="sig-default">None</span>, |
|
667 <span class="sig-arg">password</span>=<span class="sig-default">None</span>, |
|
668 <span class="sig-arg">engine</span>=<span class="sig-default">None</span>, |
|
669 <span class="sig-arg">dbpath</span>=<span class="sig-default">None</span>, |
|
670 <span class="sig-arg">database</span>=<span class="sig-default">None</span>, |
|
671 <span class="sig-arg">reuse</span>=<span class="sig-default">True</span>)</span> |
|
672 </h3> |
|
673 </td><td align="right" valign="top" |
|
674 ><span class="codelink"><a href="ccm-pysrc.html#open_session">source code</a></span> |
|
675 </td> |
|
676 </table> |
|
677 |
|
678 <p>Provides a Session object.</p> |
|
679 <p>Attempts to return a Session, based either on existing Synergy |
|
680 sessions or by creating a new one.</p> |
|
681 <ul> |
|
682 <li><p class="rst-first">If a .netrc file can be found on the user's personal drive, |
|
683 that will be read to obtain Synergy login information if it |
|
684 is defined there. This will be used to fill in any missing |
|
685 parameters not passed in the call to open_session().</p> |
|
686 <p>The format of the .netrc file entries should be:</p> |
|
687 <p>machine synergy login USERNAME password foobar account <a class="rst-reference external" href="mailto:DATABASE_PATH@SERVER" target="_top">DATABASE_PATH@SERVER</a></p> |
|
688 <p>If the details refer to a specific database, the machine can be the database name, |
|
689 instead of "synergy".</p> |
|
690 </li> |
|
691 <li><p class="rst-first">If an existing session is running that matches the supplied |
|
692 parameters, it will reuse that.</p> |
|
693 </li> |
|
694 </ul> |
|
695 <dl class="fields"> |
|
696 </dl> |
|
697 </td></tr></table> |
|
698 </div> |
|
699 <a name="running_sessions"></a> |
|
700 <div> |
|
701 <table class="details" border="1" cellpadding="3" |
|
702 cellspacing="0" width="100%" bgcolor="white"> |
|
703 <tr><td> |
|
704 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
705 <tr valign="top"><td> |
|
706 <h3 class="epydoc"><span class="sig"><span class="sig-name">running_sessions</span>(<span class="sig-arg">database</span>=<span class="sig-default">None</span>)</span> |
|
707 </h3> |
|
708 </td><td align="right" valign="top" |
|
709 ><span class="codelink"><a href="ccm-pysrc.html#running_sessions">source code</a></span> |
|
710 </td> |
|
711 </table> |
|
712 |
|
713 Return the list of synergy session currently available on the local machine. |
|
714 If database is given then it tries to update the router address. |
|
715 <dl class="fields"> |
|
716 </dl> |
|
717 </td></tr></table> |
|
718 </div> |
|
719 <br /> |
|
720 <!-- ==================== VARIABLES DETAILS ==================== --> |
|
721 <a name="section-VariablesDetails"></a> |
|
722 <table class="details" border="1" cellpadding="3" |
|
723 cellspacing="0" width="100%" bgcolor="white"> |
|
724 <tr bgcolor="#70b0f0" class="table-header"> |
|
725 <td colspan="2" class="table-header"> |
|
726 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
727 <tr valign="top"> |
|
728 <td align="left"><span class="table-header">Variables Details</span></td> |
|
729 <td align="right" valign="top" |
|
730 ><span class="options">[<a href="#section-VariablesDetails" |
|
731 class="privatelink" onclick="toggle_private();" |
|
732 >hide private</a>]</span></td> |
|
733 </tr> |
|
734 </table> |
|
735 </td> |
|
736 </tr> |
|
737 </table> |
|
738 <a name="VALID_OBJECT_STATES"></a> |
|
739 <div> |
|
740 <table class="details" border="1" cellpadding="3" |
|
741 cellspacing="0" width="100%" bgcolor="white"> |
|
742 <tr><td> |
|
743 <h3 class="epydoc">VALID_OBJECT_STATES</h3> |
|
744 |
|
745 <dl class="fields"> |
|
746 </dl> |
|
747 <dl class="fields"> |
|
748 <dt>Value:</dt> |
|
749 <dd><table><tr><td><pre class="variable"> |
|
750 'working', 'checkpoint', 'public', 'prep', 'integrate', 'sqa', 'test',<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
751 'released' |
|
752 </pre></td></tr></table> |
|
753 </dd> |
|
754 </dl> |
|
755 </td></tr></table> |
|
756 </div> |
|
757 <a name="CCM_SESSION_LOCK"></a> |
|
758 <div> |
|
759 <table class="details" border="1" cellpadding="3" |
|
760 cellspacing="0" width="100%" bgcolor="white"> |
|
761 <tr><td> |
|
762 <h3 class="epydoc">CCM_SESSION_LOCK</h3> |
|
763 |
|
764 <dl class="fields"> |
|
765 </dl> |
|
766 <dl class="fields"> |
|
767 <dt>Value:</dt> |
|
768 <dd><table><tr><td><pre class="variable"> |
|
769 os.path.join(os.environ ['TEMP'], "ccm_session.lock") |
|
770 </pre></td></tr></table> |
|
771 </dd> |
|
772 </dl> |
|
773 </td></tr></table> |
|
774 </div> |
|
775 <a name="CHECKOUT_LOG_RULES"></a> |
|
776 <div> |
|
777 <table class="details" border="1" cellpadding="3" |
|
778 cellspacing="0" width="100%" bgcolor="white"> |
|
779 <tr><td> |
|
780 <h3 class="epydoc">CHECKOUT_LOG_RULES</h3> |
|
781 |
|
782 <dl class="fields"> |
|
783 </dl> |
|
784 <dl class="fields"> |
|
785 <dt>Value:</dt> |
|
786 <dd><table><tr><td><pre class="variable"> |
|
787 [[r'^Derive failed for', logging.ERROR], [r'^Serious:', logging.ERROR]<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
788 , [r'^Warning: .* failed.', logging.ERROR], [r'^Warning:', logging.WAR<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
789 NING],] |
|
790 </pre></td></tr></table> |
|
791 </dd> |
|
792 </dl> |
|
793 </td></tr></table> |
|
794 </div> |
|
795 <a name="UPDATE_LOG_RULES"></a> |
|
796 <div> |
|
797 <table class="details" border="1" cellpadding="3" |
|
798 cellspacing="0" width="100%" bgcolor="white"> |
|
799 <tr><td> |
|
800 <h3 class="epydoc">UPDATE_LOG_RULES</h3> |
|
801 |
|
802 <dl class="fields"> |
|
803 </dl> |
|
804 <dl class="fields"> |
|
805 <dt>Value:</dt> |
|
806 <dd><table><tr><td><pre class="variable"> |
|
807 [[r'^Update failed.', logging.ERROR], [r'^Serious:', logging.ERROR], [<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
808 r'^\s+Failed to', logging.ERROR], [r'^\d+ failures to', logging.ERROR]<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
809 , [r"^Warning: This work area '.+' cannot be reused", logging.ERROR], <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
810 [r'^Rebind of .* failed', logging.ERROR], [r'^Warning: .* failed.', lo<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
811 gging.ERROR], [r'^Skipping \'.*\'\. You do not have permission to mod<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
812 ify this project.', logging.ERROR], [r'^Work area conflict exists for <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
813 file', logging.ERROR], [r'^Warning: No candidates found for directory<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
814 entry', logging.ERROR], [r'^Warning:', logging.WARNING],] |
|
815 </pre></td></tr></table> |
|
816 </dd> |
|
817 </dl> |
|
818 </td></tr></table> |
|
819 </div> |
|
820 <a name="CONFLICTS_LOG_RULES"></a> |
|
821 <div> |
|
822 <table class="details" border="1" cellpadding="3" |
|
823 cellspacing="0" width="100%" bgcolor="white"> |
|
824 <tr><td> |
|
825 <h3 class="epydoc">CONFLICTS_LOG_RULES</h3> |
|
826 |
|
827 <dl class="fields"> |
|
828 </dl> |
|
829 <dl class="fields"> |
|
830 <dt>Value:</dt> |
|
831 <dd><table><tr><td><pre class="variable"> |
|
832 [[r'^\w+#\d+\s+Implicit', logging.WARNING], [r'^(.*)\s+(\w+#\d+)\s+(.+<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
833 )', logging.ERROR],] |
|
834 </pre></td></tr></table> |
|
835 </dd> |
|
836 </dl> |
|
837 </td></tr></table> |
|
838 </div> |
|
839 <a name="SYNC_LOG_RULES"></a> |
|
840 <div> |
|
841 <table class="details" border="1" cellpadding="3" |
|
842 cellspacing="0" width="100%" bgcolor="white"> |
|
843 <tr><td> |
|
844 <h3 class="epydoc">SYNC_LOG_RULES</h3> |
|
845 |
|
846 <dl class="fields"> |
|
847 </dl> |
|
848 <dl class="fields"> |
|
849 <dt>Value:</dt> |
|
850 <dd><table><tr><td><pre class="variable"> |
|
851 [[r'^\s+0\s+Conflict\(s\) for project', logging.INFO], [r'^\s+\d+\s+Co<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
852 nflict\(s\) for project', logging.ERROR], [r'^Project \'.*\' does not <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
853 maintain a workarea.', logging.ERROR], [r'^Work area conflict exists f<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
854 or file', logging.ERROR], [r'^Warning: Conflicts detected during synch<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
855 ronization. Check your logs.', logging.ERROR], [r'^Warning:', logging.<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> |
|
856 WARNING],] |
|
857 </pre></td></tr></table> |
|
858 </dd> |
|
859 </dl> |
|
860 </td></tr></table> |
|
861 </div> |
|
862 <br /> |
|
863 <!-- ==================== NAVIGATION BAR ==================== --> |
|
864 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
865 bgcolor="#a0c0ff" cellspacing="0"> |
|
866 <tr valign="middle"> |
|
867 |
|
868 <!-- Tree link --> |
|
869 <th> <a |
|
870 href="module-tree.html">Trees</a> </th> |
|
871 |
|
872 <!-- Index link --> |
|
873 <th> <a |
|
874 href="identifier-index.html">Indices</a> </th> |
|
875 |
|
876 <!-- Help link --> |
|
877 <th> <a |
|
878 href="help.html">Help</a> </th> |
|
879 |
|
880 <th class="navbar" width="100%"></th> |
|
881 </tr> |
|
882 </table> |
|
883 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
884 <tr> |
|
885 <td align="left" class="footer"> |
|
886 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009 |
|
887 </td> |
|
888 <td align="right" class="footer"> |
|
889 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
890 </td> |
|
891 </tr> |
|
892 </table> |
|
893 |
|
894 <script type="text/javascript"> |
|
895 <!-- |
|
896 // Private objects are initially displayed (because if |
|
897 // javascript is turned off then we want them to be |
|
898 // visible); but by default, we want to hide them. So hide |
|
899 // them unless we have a cookie that says to show them. |
|
900 checkCookie() |
|
901 // --> |
|
902 </script> |
|
903 |
|
904 </body> |
|
905 </html> |