1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>CedarBackup2.cli._ActionSet</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="CedarBackup2-module.html">Package CedarBackup2</a> ::
<a href="CedarBackup2.cli-module.html">Module cli</a> ::
Class _ActionSet
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="CedarBackup2.cli._ActionSet-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class _ActionSet</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">_ActionSet</strong>
</pre>
<hr />
<p>Class representing a set of local actions to be executed.</p>
<p>This class does four different things. First, it ensures that the
actions specified on the command-line are sensible. The command-line can
only list either built-in actions or extended actions specified in
configuration. Also, certain actions (in <a
href="CedarBackup2.cli-module.html#NONCOMBINE_ACTIONS"
class="link">NONCOMBINE_ACTIONS</a>) cannot be combined with other
actions.</p>
<p>Second, the class enforces an execution order on the specified
actions. Any time actions are combined on the command line (either
built-in actions or extended actions), we must make sure they get
executed in a sensible order.</p>
<p>Third, the class ensures that any pre-action or post-action hooks are
scheduled and executed appropriately. Hooks are configured by building a
dictionary mapping between hook action name and command. Pre-action
hooks are executed immediately before their associated action, and
post-action hooks are executed immediately after their associated
action.</p>
<p>Finally, the class properly interleaves local and managed actions so
that the same action gets executed first locally and then on managed
peers.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">actions</span>,
<span class="summary-sig-arg">extensions</span>,
<span class="summary-sig-arg">options</span>,
<span class="summary-sig-arg">peers</span>,
<span class="summary-sig-arg">managed</span>,
<span class="summary-sig-arg">local</span>)</span><br />
Constructor for the <code>_ActionSet</code> class.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#executeActions" class="summary-sig-name">executeActions</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">configPath</span>,
<span class="summary-sig-arg">options</span>,
<span class="summary-sig-arg">config</span>)</span><br />
Executes all actions and extended actions, in the proper order.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet.executeActions">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__str__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Static Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-StaticMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_deriveExtensionNames" class="summary-sig-name" onclick="show_private();">_deriveExtensionNames</a>(<span class="summary-sig-arg">extensions</span>)</span><br />
Builds a list of extended actions that are available in
configuration.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._deriveExtensionNames">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_buildHookMaps" class="summary-sig-name" onclick="show_private();">_buildHookMaps</a>(<span class="summary-sig-arg">hooks</span>)</span><br />
Build two mappings from action name to configured
<code>ActionHook</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildHookMaps">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_buildFunctionMap" class="summary-sig-name" onclick="show_private();">_buildFunctionMap</a>(<span class="summary-sig-arg">extensions</span>)</span><br />
Builds a mapping from named action to action function.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildFunctionMap">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_buildIndexMap" class="summary-sig-name" onclick="show_private();">_buildIndexMap</a>(<span class="summary-sig-arg">extensions</span>)</span><br />
Builds a mapping from action name to proper execution index.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildIndexMap">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_buildActionMap" class="summary-sig-name" onclick="show_private();">_buildActionMap</a>(<span class="summary-sig-arg">managed</span>,
<span class="summary-sig-arg">local</span>,
<span class="summary-sig-arg">extensionNames</span>,
<span class="summary-sig-arg">functionMap</span>,
<span class="summary-sig-arg">indexMap</span>,
<span class="summary-sig-arg">preHookMap</span>,
<span class="summary-sig-arg">postHookMap</span>,
<span class="summary-sig-arg">peerMap</span>)</span><br />
Builds a mapping from action name to list of action items.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildActionMap">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_buildPeerMap" class="summary-sig-name" onclick="show_private();">_buildPeerMap</a>(<span class="summary-sig-arg">options</span>,
<span class="summary-sig-arg">peers</span>)</span><br />
Build a mapping from action name to list of remote peers.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildPeerMap">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_deriveHooks" class="summary-sig-name" onclick="show_private();">_deriveHooks</a>(<span class="summary-sig-arg">action</span>,
<span class="summary-sig-arg">preHookDict</span>,
<span class="summary-sig-arg">postHookDict</span>)</span><br />
Derive pre- and post-action hooks, if any, associated with named
action.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._deriveHooks">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_validateActions" class="summary-sig-name" onclick="show_private();">_validateActions</a>(<span class="summary-sig-arg">actions</span>,
<span class="summary-sig-arg">extensionNames</span>)</span><br />
Validate that the set of specified actions is sensible.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._validateActions">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_buildActionSet" class="summary-sig-name" onclick="show_private();">_buildActionSet</a>(<span class="summary-sig-arg">actions</span>,
<span class="summary-sig-arg">actionMap</span>)</span><br />
Build set of actions to be executed.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildActionSet">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_getRemoteUser" class="summary-sig-name" onclick="show_private();">_getRemoteUser</a>(<span class="summary-sig-arg">options</span>,
<span class="summary-sig-arg">remotePeer</span>)</span><br />
Gets the remote user associated with a remote peer.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._getRemoteUser">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_getRshCommand" class="summary-sig-name" onclick="show_private();">_getRshCommand</a>(<span class="summary-sig-arg">options</span>,
<span class="summary-sig-arg">remotePeer</span>)</span><br />
Gets the RSH command associated with a remote peer.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._getRshCommand">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_getCbackCommand" class="summary-sig-name" onclick="show_private();">_getCbackCommand</a>(<span class="summary-sig-arg">options</span>,
<span class="summary-sig-arg">remotePeer</span>)</span><br />
Gets the cback command associated with a remote peer.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._getCbackCommand">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="CedarBackup2.cli._ActionSet-class.html#_getManagedActions" class="summary-sig-name" onclick="show_private();">_getManagedActions</a>(<span class="summary-sig-arg">options</span>,
<span class="summary-sig-arg">remotePeer</span>)</span><br />
Gets the managed actions list associated with a remote peer.</td>
<td align="right" valign="top">
<span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._getManagedActions">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">actions</span>,
<span class="sig-arg">extensions</span>,
<span class="sig-arg">options</span>,
<span class="sig-arg">peers</span>,
<span class="sig-arg">managed</span>,
<span class="sig-arg">local</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet.__init__">source code</a></span>
</td>
</tr></table>
<p>Constructor for the <code>_ActionSet</code> class.</p>
<p>This is kind of ugly, because the constructor has to set up a lot of
data before being able to do anything useful. The following data
structures are initialized based on the input:</p>
<ul>
<li>
<code>extensionNames</code>: List of extensions available in
configuration
</li>
<li>
<code>preHookMap</code>: Mapping from action name to pre
<code>ActionHook</code>
</li>
<li>
<code>preHookMap</code>: Mapping from action name to post
<code>ActionHook</code>
</li>
<li>
<code>functionMap</code>: Mapping from action name to Python function
</li>
<li>
<code>indexMap</code>: Mapping from action name to execution index
</li>
<li>
<code>peerMap</code>: Mapping from action name to set of
<code>RemotePeer</code>
</li>
<li>
<code>actionMap</code>: Mapping from action name to
<code>_ActionItem</code>
</li>
</ul>
<p>Once these data structures are set up, the command line is validated
to make sure only valid actions have been requested, and in a sensible
combination. Then, all of the data is used to build
<code>self.actionSet</code>, the set action items to be executed by
<code>executeActions()</code>. This list might contain either
<code>_ActionItem</code> or <code>_ManagedActionItem</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>actions</code></strong> - Names of actions specified on the command-line.</li>
<li><strong class="pname"><code>extensions</code></strong> - Extended action configuration (i.e. config.extensions)</li>
<li><strong class="pname"><code>options</code></strong> - Options configuration (i.e. config.options)</li>
<li><strong class="pname"><code>peers</code></strong> - Peers configuration (i.e. config.peers)</li>
<li><strong class="pname"><code>managed</code></strong> - Whether to include managed actions in the set</li>
<li><strong class="pname"><code>local</code></strong> - Whether to include local actions in the set</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If one of the specified actions is invalid.</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="executeActions"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">executeActions</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">configPath</span>,
<span class="sig-arg">options</span>,
<span class="sig-arg">config</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet.executeActions">source code</a></span>
</td>
</tr></table>
<p>Executes all actions and extended actions, in the proper order.</p>
<p>Each action (whether built-in or extension) is executed in an
identical manner. The built-in actions will use only the options and
config values. We also pass in the config path so that extension modules
can re-parse configuration if they want to, to add in extra
information.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>configPath</code></strong> - Path to configuration file on disk.</li>
<li><strong class="pname"><code>options</code></strong> - Command-line options to be passed to action functions.</li>
<li><strong class="pname"><code>config</code></strong> - Parsed configuration to be passed to action functions.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>Exception</strong></code> - If there is a problem executing the actions.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_deriveExtensionNames"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_deriveExtensionNames</span>(<span class="sig-arg">extensions</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._deriveExtensionNames">source code</a></span>
</td>
</tr></table>
<p>Builds a list of extended actions that are available in
configuration.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>extensions</code></strong> - Extended action configuration (i.e. config.extensions)</li>
</ul></dd>
<dt>Returns:</dt>
<dd>List of extended action names.</dd>
</dl>
</td></tr></table>
</div>
<a name="_buildHookMaps"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildHookMaps</span>(<span class="sig-arg">hooks</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildHookMaps">source code</a></span>
</td>
</tr></table>
<p>Build two mappings from action name to configured
<code>ActionHook</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>hooks</code></strong> - List of pre- and post-action hooks (i.e. config.options.hooks)</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Tuple of (pre hook dictionary, post hook dictionary).</dd>
</dl>
</td></tr></table>
</div>
<a name="_buildFunctionMap"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildFunctionMap</span>(<span class="sig-arg">extensions</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildFunctionMap">source code</a></span>
</td>
</tr></table>
<p>Builds a mapping from named action to action function.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>extensions</code></strong> - Extended action configuration (i.e. config.extensions)</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Dictionary mapping action to function.</dd>
</dl>
</td></tr></table>
</div>
<a name="_buildIndexMap"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildIndexMap</span>(<span class="sig-arg">extensions</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildIndexMap">source code</a></span>
</td>
</tr></table>
<p>Builds a mapping from action name to proper execution index.</p>
<p>If extensions configuration is <code>None</code>, or there are no
configured extended actions, the ordering dictionary will only include
the built-in actions and their standard indices.</p>
<p>Otherwise, if the extensions order mode is <code>None</code> or
<code>"index"</code>, actions will scheduled by explicit index;
and if the extensions order mode is <code>"dependency"</code>,
actions will be scheduled using a dependency graph.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>extensions</code></strong> - Extended action configuration (i.e. config.extensions)</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Dictionary mapping action name to integer execution index.</dd>
</dl>
</td></tr></table>
</div>
<a name="_buildActionMap"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildActionMap</span>(<span class="sig-arg">managed</span>,
<span class="sig-arg">local</span>,
<span class="sig-arg">extensionNames</span>,
<span class="sig-arg">functionMap</span>,
<span class="sig-arg">indexMap</span>,
<span class="sig-arg">preHookMap</span>,
<span class="sig-arg">postHookMap</span>,
<span class="sig-arg">peerMap</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildActionMap">source code</a></span>
</td>
</tr></table>
<p>Builds a mapping from action name to list of action items.</p>
<p>We build either <code>_ActionItem</code> or
<code>_ManagedActionItem</code> objects here.</p>
<p>In most cases, the mapping from action name to
<code>_ActionItem</code> is 1:1. The exception is the "all"
action, which is a special case. However, a list is returned in all
cases, just for consistency later. Each <code>_ActionItem</code> will be
created with a proper function reference and index value for execution
ordering.</p>
<p>The mapping from action name to <code>_ManagedActionItem</code> is
always 1:1. Each managed action item contains a list of peers which the
action should be executed.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>managed</code></strong> - Whether to include managed actions in the set</li>
<li><strong class="pname"><code>local</code></strong> - Whether to include local actions in the set</li>
<li><strong class="pname"><code>extensionNames</code></strong> - List of valid extended action names</li>
<li><strong class="pname"><code>functionMap</code></strong> - Dictionary mapping action name to Python function</li>
<li><strong class="pname"><code>indexMap</code></strong> - Dictionary mapping action name to integer execution index</li>
<li><strong class="pname"><code>preHookMap</code></strong> - Dictionary mapping action name to pre hooks (if any) for the
action</li>
<li><strong class="pname"><code>postHookMap</code></strong> - Dictionary mapping action name to post hooks (if any) for the
action</li>
<li><strong class="pname"><code>peerMap</code></strong> - Dictionary mapping action name to list of remote peers on which
to execute the action</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Dictionary mapping action name to list of
<code>_ActionItem</code> objects.</dd>
</dl>
</td></tr></table>
</div>
<a name="_buildPeerMap"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildPeerMap</span>(<span class="sig-arg">options</span>,
<span class="sig-arg">peers</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildPeerMap">source code</a></span>
</td>
</tr></table>
<p>Build a mapping from action name to list of remote peers.</p>
<p>There will be one entry in the mapping for each managed action. If
there are no managed peers, the mapping will be empty. Only managed
actions will be listed in the mapping.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>options</code></strong> - Option configuration (i.e. config.options)</li>
<li><strong class="pname"><code>peers</code></strong> - Peers configuration (i.e. config.peers)</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_deriveHooks"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_deriveHooks</span>(<span class="sig-arg">action</span>,
<span class="sig-arg">preHookDict</span>,
<span class="sig-arg">postHookDict</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._deriveHooks">source code</a></span>
</td>
</tr></table>
<p>Derive pre- and post-action hooks, if any, associated with named
action.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>action</code></strong> - Name of action to look up</li>
<li><strong class="pname"><code>preHookDict</code></strong> - Dictionary mapping pre-action hooks to action name</li>
<li><strong class="pname"><code>postHookDict</code></strong> - Dictionary mapping post-action hooks to action name @return Tuple
(preHook, postHook) per mapping, with None values if there is no
hook.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_validateActions"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_validateActions</span>(<span class="sig-arg">actions</span>,
<span class="sig-arg">extensionNames</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._validateActions">source code</a></span>
</td>
</tr></table>
<p>Validate that the set of specified actions is sensible.</p>
<p>Any specified action must either be a built-in action or must be among
the extended actions defined in configuration. The actions from within
<a href="CedarBackup2.cli-module.html#NONCOMBINE_ACTIONS"
class="link">NONCOMBINE_ACTIONS</a> may not be combined with other
actions.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>actions</code></strong> - Names of actions specified on the command-line.</li>
<li><strong class="pname"><code>extensionNames</code></strong> - Names of extensions specified in configuration.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - If one or more configured actions are not valid.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_buildActionSet"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_buildActionSet</span>(<span class="sig-arg">actions</span>,
<span class="sig-arg">actionMap</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._buildActionSet">source code</a></span>
</td>
</tr></table>
<p>Build set of actions to be executed.</p>
<p>The set of actions is built in the proper order, so
<code>executeActions</code> can spin through the set without thinking
about it. Since we've already validated that the set of actions is
sensible, we don't take any precautions here to make sure things are
combined properly. If the action is listed, it will be
"scheduled" for execution.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>actions</code></strong> - Names of actions specified on the command-line.</li>
<li><strong class="pname"><code>actionMap</code></strong> - Dictionary mapping action name to <code>_ActionItem</code>
object.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Set of action items in proper order.</dd>
</dl>
</td></tr></table>
</div>
<a name="_getRemoteUser"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getRemoteUser</span>(<span class="sig-arg">options</span>,
<span class="sig-arg">remotePeer</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._getRemoteUser">source code</a></span>
</td>
</tr></table>
<p>Gets the remote user associated with a remote peer. Use peer's if
possible, otherwise take from options section.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>options</code></strong> - OptionsConfig object, as from config.options</li>
<li><strong class="pname"><code>remotePeer</code></strong> - Configuration-style remote peer object.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Name of remote user associated with remote peer.</dd>
</dl>
</td></tr></table>
</div>
<a name="_getRshCommand"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getRshCommand</span>(<span class="sig-arg">options</span>,
<span class="sig-arg">remotePeer</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._getRshCommand">source code</a></span>
</td>
</tr></table>
<p>Gets the RSH command associated with a remote peer. Use peer's if
possible, otherwise take from options section.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>options</code></strong> - OptionsConfig object, as from config.options</li>
<li><strong class="pname"><code>remotePeer</code></strong> - Configuration-style remote peer object.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>RSH command associated with remote peer.</dd>
</dl>
</td></tr></table>
</div>
<a name="_getCbackCommand"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getCbackCommand</span>(<span class="sig-arg">options</span>,
<span class="sig-arg">remotePeer</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._getCbackCommand">source code</a></span>
</td>
</tr></table>
<p>Gets the cback command associated with a remote peer. Use peer's if
possible, otherwise take from options section.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>options</code></strong> - OptionsConfig object, as from config.options</li>
<li><strong class="pname"><code>remotePeer</code></strong> - Configuration-style remote peer object.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>cback command associated with remote peer.</dd>
</dl>
</td></tr></table>
</div>
<a name="_getManagedActions"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_getManagedActions</span>(<span class="sig-arg">options</span>,
<span class="sig-arg">remotePeer</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionSet._getManagedActions">source code</a></span>
</td>
</tr></table>
<p>Gets the managed actions list associated with a remote peer. Use
peer's if possible, otherwise take from options section.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>options</code></strong> - OptionsConfig object, as from config.options</li>
<li><strong class="pname"><code>remotePeer</code></strong> - Configuration-style remote peer object.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>Set of managed actions associated with remote peer.</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="CedarBackup2-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://cedar-backup.sourceforge.net/">CedarBackup2</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Tue Oct 19 20:56:42 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
