Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html

Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html

changeset 3673
e26d7d0c1088
child 5606
da305d172769
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues</h1>
23 <p>
24 Module implementing the queues extension interface.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#Queues">Queues</a></td>
34 <td>Class implementing the queues extension interface.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="Queues" ID="Queues"></a>
43 <h2>Queues</h2>
44 <p>
45 Class implementing the queues extension interface.
46 </p>
47 <h3>Derived from</h3>
48 HgExtension
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>APPLIED_LIST</td></tr><tr><td>GOTO</td></tr><tr><td>POP</td></tr><tr><td>PUSH</td></tr><tr><td>QUEUE_ACTIVATE</td></tr><tr><td>QUEUE_DELETE</td></tr><tr><td>QUEUE_PURGE</td></tr><tr><td>SERIES_LIST</td></tr><tr><td>UNAPPLIED_LIST</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#Queues.__init__">Queues</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#Queues.__getCommitMessage">__getCommitMessage</a></td>
64 <td>Private method to get the commit message of the current patch.</td>
65 </tr><tr>
66 <td><a href="#Queues.__getCurrentPatch">__getCurrentPatch</a></td>
67 <td>Private method to get the name of the current patch.</td>
68 </tr><tr>
69 <td><a href="#Queues.__getPatchesList">__getPatchesList</a></td>
70 <td>Private method to get a list of patches of a given type.</td>
71 </tr><tr>
72 <td><a href="#Queues.getGuardsList">getGuardsList</a></td>
73 <td>Public method to get a list of all guards defined.</td>
74 </tr><tr>
75 <td><a href="#Queues.hgQueueCreateRenameQueue">hgQueueCreateRenameQueue</a></td>
76 <td>Public method to create a new queue or rename the active queue.</td>
77 </tr><tr>
78 <td><a href="#Queues.hgQueueDeletePatch">hgQueueDeletePatch</a></td>
79 <td>Public method to delete a selected unapplied patch.</td>
80 </tr><tr>
81 <td><a href="#Queues.hgQueueDeletePurgeActivateQueue">hgQueueDeletePurgeActivateQueue</a></td>
82 <td>Public method to delete the reference to a queue and optionally remove the patch directory or set the active queue.</td>
83 </tr><tr>
84 <td><a href="#Queues.hgQueueFinishAppliedPatches">hgQueueFinishAppliedPatches</a></td>
85 <td>Public method to finish all applied patches.</td>
86 </tr><tr>
87 <td><a href="#Queues.hgQueueFoldUnappliedPatches">hgQueueFoldUnappliedPatches</a></td>
88 <td>Public method to fold patches into the current patch.</td>
89 </tr><tr>
90 <td><a href="#Queues.hgQueueGuardsDeactivate">hgQueueGuardsDeactivate</a></td>
91 <td>Public method to deactivate all active guards.</td>
92 </tr><tr>
93 <td><a href="#Queues.hgQueueGuardsDefine">hgQueueGuardsDefine</a></td>
94 <td>Public method to define guards for the current or a named patch.</td>
95 </tr><tr>
96 <td><a href="#Queues.hgQueueGuardsDropAll">hgQueueGuardsDropAll</a></td>
97 <td>Public method to drop all guards of the current or a named patch.</td>
98 </tr><tr>
99 <td><a href="#Queues.hgQueueGuardsIdentifyActive">hgQueueGuardsIdentifyActive</a></td>
100 <td>Public method to list all active guards.</td>
101 </tr><tr>
102 <td><a href="#Queues.hgQueueGuardsList">hgQueueGuardsList</a></td>
103 <td>Public method to list the guards for the current or a named patch.</td>
104 </tr><tr>
105 <td><a href="#Queues.hgQueueGuardsListAll">hgQueueGuardsListAll</a></td>
106 <td>Public method to list all guards of all patches.</td>
107 </tr><tr>
108 <td><a href="#Queues.hgQueueGuardsSetActive">hgQueueGuardsSetActive</a></td>
109 <td>Public method to set the active guards.</td>
110 </tr><tr>
111 <td><a href="#Queues.hgQueueInit">hgQueueInit</a></td>
112 <td>Public method to initialize a new queue repository.</td>
113 </tr><tr>
114 <td><a href="#Queues.hgQueueListPatches">hgQueueListPatches</a></td>
115 <td>Public method to show a list of all patches.</td>
116 </tr><tr>
117 <td><a href="#Queues.hgQueueListQueues">hgQueueListQueues</a></td>
118 <td>Public method to list available queues.</td>
119 </tr><tr>
120 <td><a href="#Queues.hgQueueNewPatch">hgQueueNewPatch</a></td>
121 <td>Public method to create a new named patch.</td>
122 </tr><tr>
123 <td><a href="#Queues.hgQueuePushPopPatches">hgQueuePushPopPatches</a></td>
124 <td>Public method to push patches onto the stack or pop patches off the stack.</td>
125 </tr><tr>
126 <td><a href="#Queues.hgQueueRefreshPatch">hgQueueRefreshPatch</a></td>
127 <td>Public method to refresh the current patch.</td>
128 </tr><tr>
129 <td><a href="#Queues.hgQueueRenamePatch">hgQueueRenamePatch</a></td>
130 <td>Public method to rename the current or a selected patch.</td>
131 </tr><tr>
132 <td><a href="#Queues.hgQueueShowHeader">hgQueueShowHeader</a></td>
133 <td>Public method to show the commit message of the current patch.</td>
134 </tr><tr>
135 <td><a href="#Queues.hgQueueShowPatch">hgQueueShowPatch</a></td>
136 <td>Public method to show the contents of the current patch.</td>
137 </tr><tr>
138 <td><a href="#Queues.hgQueueStatus">hgQueueStatus</a></td>
139 <td>Public method used to view the status of a queue repository.</td>
140 </tr><tr>
141 <td><a href="#Queues.shutdown">shutdown</a></td>
142 <td>Public method used to shutdown the queues interface.</td>
143 </tr>
144 </table>
145 <h3>Static Methods</h3>
146 <table>
147 <tr><td>None</td></tr>
148 </table>
149 <a NAME="Queues.__init__" ID="Queues.__init__"></a>
150 <h4>Queues (Constructor)</h4>
151 <b>Queues</b>(<i>vcs</i>)
152 <p>
153 Constructor
154 </p><dl>
155 <dt><i>vcs</i></dt>
156 <dd>
157 reference to the Mercurial vcs object
158 </dd>
159 </dl><a NAME="Queues.__getCommitMessage" ID="Queues.__getCommitMessage"></a>
160 <h4>Queues.__getCommitMessage</h4>
161 <b>__getCommitMessage</b>(<i>repodir</i>)
162 <p>
163 Private method to get the commit message of the current patch.
164 </p><dl>
165 <dt><i>repodir</i></dt>
166 <dd>
167 directory name of the repository (string)
168 </dd>
169 </dl><dl>
170 <dt>Returns:</dt>
171 <dd>
172 name of the current patch (string)
173 </dd>
174 </dl><a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a>
175 <h4>Queues.__getCurrentPatch</h4>
176 <b>__getCurrentPatch</b>(<i>repodir</i>)
177 <p>
178 Private method to get the name of the current patch.
179 </p><dl>
180 <dt><i>repodir</i></dt>
181 <dd>
182 directory name of the repository (string)
183 </dd>
184 </dl><dl>
185 <dt>Returns:</dt>
186 <dd>
187 name of the current patch (string)
188 </dd>
189 </dl><a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a>
190 <h4>Queues.__getPatchesList</h4>
191 <b>__getPatchesList</b>(<i>repodir, listType, withSummary=False</i>)
192 <p>
193 Private method to get a list of patches of a given type.
194 </p><dl>
195 <dt><i>repodir</i></dt>
196 <dd>
197 directory name of the repository (string)
198 </dd><dt><i>listType</i></dt>
199 <dd>
200 type of patches list to get
201 (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST)
202 </dd><dt><i>withSummary</i></dt>
203 <dd>
204 flag indicating to get a summary as well (boolean)
205 </dd>
206 </dl><dl>
207 <dt>Returns:</dt>
208 <dd>
209 list of patches (list of string)
210 </dd>
211 </dl><dl>
212 <dt>Raises <b>ValueError</b>:</dt>
213 <dd>
214 raised to indicate an invalid patch list type
215 </dd>
216 </dl><a NAME="Queues.getGuardsList" ID="Queues.getGuardsList"></a>
217 <h4>Queues.getGuardsList</h4>
218 <b>getGuardsList</b>(<i>repodir, all=True</i>)
219 <p>
220 Public method to get a list of all guards defined.
221 </p><dl>
222 <dt><i>repodir</i></dt>
223 <dd>
224 directory name of the repository (string)
225 </dd><dt><i>all</i></dt>
226 <dd>
227 flag indicating to get all guards (boolean)
228 </dd>
229 </dl><dl>
230 <dt>Returns:</dt>
231 <dd>
232 sorted list of guards (list of strings)
233 </dd>
234 </dl><a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a>
235 <h4>Queues.hgQueueCreateRenameQueue</h4>
236 <b>hgQueueCreateRenameQueue</b>(<i>name, isCreate</i>)
237 <p>
238 Public method to create a new queue or rename the active queue.
239 </p><dl>
240 <dt><i>name</i></dt>
241 <dd>
242 file/directory name (string)
243 </dd><dt><i>isCreate</i></dt>
244 <dd>
245 flag indicating to create a new queue (boolean)
246 </dd>
247 </dl><a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a>
248 <h4>Queues.hgQueueDeletePatch</h4>
249 <b>hgQueueDeletePatch</b>(<i>name</i>)
250 <p>
251 Public method to delete a selected unapplied patch.
252 </p><dl>
253 <dt><i>name</i></dt>
254 <dd>
255 file/directory name (string)
256 </dd>
257 </dl><a NAME="Queues.hgQueueDeletePurgeActivateQueue" ID="Queues.hgQueueDeletePurgeActivateQueue"></a>
258 <h4>Queues.hgQueueDeletePurgeActivateQueue</h4>
259 <b>hgQueueDeletePurgeActivateQueue</b>(<i>name, operation</i>)
260 <p>
261 Public method to delete the reference to a queue and optionally
262 remove the patch directory or set the active queue.
263 </p><dl>
264 <dt><i>name</i></dt>
265 <dd>
266 file/directory name (string)
267 </dd><dt><i>operation</i></dt>
268 <dd>
269 operation to be performed (Queues.QUEUE_DELETE,
270 Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE)
271 </dd>
272 </dl><dl>
273 <dt>Raises <b>ValueError</b>:</dt>
274 <dd>
275 raised to indicate an invalid operation
276 </dd>
277 </dl><a NAME="Queues.hgQueueFinishAppliedPatches" ID="Queues.hgQueueFinishAppliedPatches"></a>
278 <h4>Queues.hgQueueFinishAppliedPatches</h4>
279 <b>hgQueueFinishAppliedPatches</b>(<i>name</i>)
280 <p>
281 Public method to finish all applied patches.
282 </p><dl>
283 <dt><i>name</i></dt>
284 <dd>
285 file/directory name (string)
286 </dd>
287 </dl><a NAME="Queues.hgQueueFoldUnappliedPatches" ID="Queues.hgQueueFoldUnappliedPatches"></a>
288 <h4>Queues.hgQueueFoldUnappliedPatches</h4>
289 <b>hgQueueFoldUnappliedPatches</b>(<i>name</i>)
290 <p>
291 Public method to fold patches into the current patch.
292 </p><dl>
293 <dt><i>name</i></dt>
294 <dd>
295 file/directory name (string)
296 </dd>
297 </dl><a NAME="Queues.hgQueueGuardsDeactivate" ID="Queues.hgQueueGuardsDeactivate"></a>
298 <h4>Queues.hgQueueGuardsDeactivate</h4>
299 <b>hgQueueGuardsDeactivate</b>(<i>name</i>)
300 <p>
301 Public method to deactivate all active guards.
302 </p><dl>
303 <dt><i>name</i></dt>
304 <dd>
305 file/directory name (string)
306 </dd>
307 </dl><a NAME="Queues.hgQueueGuardsDefine" ID="Queues.hgQueueGuardsDefine"></a>
308 <h4>Queues.hgQueueGuardsDefine</h4>
309 <b>hgQueueGuardsDefine</b>(<i>name</i>)
310 <p>
311 Public method to define guards for the current or a named patch.
312 </p><dl>
313 <dt><i>name</i></dt>
314 <dd>
315 file/directory name (string)
316 </dd>
317 </dl><a NAME="Queues.hgQueueGuardsDropAll" ID="Queues.hgQueueGuardsDropAll"></a>
318 <h4>Queues.hgQueueGuardsDropAll</h4>
319 <b>hgQueueGuardsDropAll</b>(<i>name</i>)
320 <p>
321 Public method to drop all guards of the current or a named patch.
322 </p><dl>
323 <dt><i>name</i></dt>
324 <dd>
325 file/directory name (string)
326 </dd>
327 </dl><a NAME="Queues.hgQueueGuardsIdentifyActive" ID="Queues.hgQueueGuardsIdentifyActive"></a>
328 <h4>Queues.hgQueueGuardsIdentifyActive</h4>
329 <b>hgQueueGuardsIdentifyActive</b>(<i>name</i>)
330 <p>
331 Public method to list all active guards.
332 </p><dl>
333 <dt><i>name</i></dt>
334 <dd>
335 file/directory name (string)
336 </dd>
337 </dl><a NAME="Queues.hgQueueGuardsList" ID="Queues.hgQueueGuardsList"></a>
338 <h4>Queues.hgQueueGuardsList</h4>
339 <b>hgQueueGuardsList</b>(<i>name</i>)
340 <p>
341 Public method to list the guards for the current or a named patch.
342 </p><dl>
343 <dt><i>name</i></dt>
344 <dd>
345 file/directory name (string)
346 </dd>
347 </dl><a NAME="Queues.hgQueueGuardsListAll" ID="Queues.hgQueueGuardsListAll"></a>
348 <h4>Queues.hgQueueGuardsListAll</h4>
349 <b>hgQueueGuardsListAll</b>(<i>name</i>)
350 <p>
351 Public method to list all guards of all patches.
352 </p><dl>
353 <dt><i>name</i></dt>
354 <dd>
355 file/directory name (string)
356 </dd>
357 </dl><a NAME="Queues.hgQueueGuardsSetActive" ID="Queues.hgQueueGuardsSetActive"></a>
358 <h4>Queues.hgQueueGuardsSetActive</h4>
359 <b>hgQueueGuardsSetActive</b>(<i>name</i>)
360 <p>
361 Public method to set the active guards.
362 </p><dl>
363 <dt><i>name</i></dt>
364 <dd>
365 file/directory name (string)
366 </dd>
367 </dl><a NAME="Queues.hgQueueInit" ID="Queues.hgQueueInit"></a>
368 <h4>Queues.hgQueueInit</h4>
369 <b>hgQueueInit</b>(<i>name</i>)
370 <p>
371 Public method to initialize a new queue repository.
372 </p><dl>
373 <dt><i>name</i></dt>
374 <dd>
375 directory name (string)
376 </dd>
377 </dl><a NAME="Queues.hgQueueListPatches" ID="Queues.hgQueueListPatches"></a>
378 <h4>Queues.hgQueueListPatches</h4>
379 <b>hgQueueListPatches</b>(<i>name</i>)
380 <p>
381 Public method to show a list of all patches.
382 </p><dl>
383 <dt><i>name</i></dt>
384 <dd>
385 file/directory name (string)
386 </dd>
387 </dl><a NAME="Queues.hgQueueListQueues" ID="Queues.hgQueueListQueues"></a>
388 <h4>Queues.hgQueueListQueues</h4>
389 <b>hgQueueListQueues</b>(<i>name</i>)
390 <p>
391 Public method to list available queues.
392 </p><dl>
393 <dt><i>name</i></dt>
394 <dd>
395 file/directory name (string)
396 </dd>
397 </dl><a NAME="Queues.hgQueueNewPatch" ID="Queues.hgQueueNewPatch"></a>
398 <h4>Queues.hgQueueNewPatch</h4>
399 <b>hgQueueNewPatch</b>(<i>name</i>)
400 <p>
401 Public method to create a new named patch.
402 </p><dl>
403 <dt><i>name</i></dt>
404 <dd>
405 file/directory name (string)
406 </dd>
407 </dl><a NAME="Queues.hgQueuePushPopPatches" ID="Queues.hgQueuePushPopPatches"></a>
408 <h4>Queues.hgQueuePushPopPatches</h4>
409 <b>hgQueuePushPopPatches</b>(<i>name, operation, all=False, named=False, force=False</i>)
410 <p>
411 Public method to push patches onto the stack or pop patches off the
412 stack.
413 </p><dl>
414 <dt><i>name</i></dt>
415 <dd>
416 file/directory name (string)
417 </dd><dt><i>operation</i></dt>
418 <dd>
419 operation type to be performed (Queues.POP,
420 Queues.PUSH, Queues.GOTO)
421 </dd><dt><i>all=</i></dt>
422 <dd>
423 flag indicating to push/pop all (boolean)
424 </dd><dt><i>named=</i></dt>
425 <dd>
426 flag indicating to push/pop until a named patch
427 is at the top of the stack (boolean)
428 </dd><dt><i>force=</i></dt>
429 <dd>
430 flag indicating a forceful pop (boolean)
431 </dd>
432 </dl><dl>
433 <dt>Returns:</dt>
434 <dd>
435 flag indicating that the project should be reread (boolean)
436 </dd>
437 </dl><dl>
438 <dt>Raises <b>ValueError</b>:</dt>
439 <dd>
440 raised to indicate an invalid operation
441 </dd>
442 </dl><a NAME="Queues.hgQueueRefreshPatch" ID="Queues.hgQueueRefreshPatch"></a>
443 <h4>Queues.hgQueueRefreshPatch</h4>
444 <b>hgQueueRefreshPatch</b>(<i>name, editMessage=False</i>)
445 <p>
446 Public method to refresh the current patch.
447 </p><dl>
448 <dt><i>name</i></dt>
449 <dd>
450 file/directory name (string)
451 </dd><dt><i>editMessage</i></dt>
452 <dd>
453 flag indicating to edit the current
454 commit message (boolean)
455 </dd>
456 </dl><a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a>
457 <h4>Queues.hgQueueRenamePatch</h4>
458 <b>hgQueueRenamePatch</b>(<i>name</i>)
459 <p>
460 Public method to rename the current or a selected patch.
461 </p><dl>
462 <dt><i>name</i></dt>
463 <dd>
464 file/directory name (string)
465 </dd>
466 </dl><a NAME="Queues.hgQueueShowHeader" ID="Queues.hgQueueShowHeader"></a>
467 <h4>Queues.hgQueueShowHeader</h4>
468 <b>hgQueueShowHeader</b>(<i>name</i>)
469 <p>
470 Public method to show the commit message of the current patch.
471 </p><dl>
472 <dt><i>name</i></dt>
473 <dd>
474 file/directory name (string)
475 </dd>
476 </dl><a NAME="Queues.hgQueueShowPatch" ID="Queues.hgQueueShowPatch"></a>
477 <h4>Queues.hgQueueShowPatch</h4>
478 <b>hgQueueShowPatch</b>(<i>name</i>)
479 <p>
480 Public method to show the contents of the current patch.
481 </p><dl>
482 <dt><i>name</i></dt>
483 <dd>
484 file/directory name (string)
485 </dd>
486 </dl><a NAME="Queues.hgQueueStatus" ID="Queues.hgQueueStatus"></a>
487 <h4>Queues.hgQueueStatus</h4>
488 <b>hgQueueStatus</b>(<i>name</i>)
489 <p>
490 Public method used to view the status of a queue repository.
491 </p><dl>
492 <dt><i>name</i></dt>
493 <dd>
494 directory name (string)
495 </dd>
496 </dl><a NAME="Queues.shutdown" ID="Queues.shutdown"></a>
497 <h4>Queues.shutdown</h4>
498 <b>shutdown</b>(<i></i>)
499 <p>
500 Public method used to shutdown the queues interface.
501 </p>
502 <div align="right"><a href="#top">Up</a></div>
503 <hr />
504 </body></html>

Mercurial Repository: eric

eric ide

mercurial