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
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!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>pybaz</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th bgcolor="#70b0f0" class="navselect"> Home </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
Package pybaz
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="pybaz-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF PACKAGE DESCRIPTION =========== -->
<h2 class="package">Package pybaz</h2>
<p>High level bindings for the Arch revision control system</p>
<div class="section">
<h1 class="heading"><a id="archive-namespace-class-hierarchy" name="archive-namespace-class-hierarchy">Archive Namespace Class Hierarchy</a></h1>
<p>The <a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a>, <a href="pybaz.Category-class.html" class="link"><code>Category</code></a>, <a href="pybaz.Branch-class.html" class="link"><code>Branch</code></a>, <a href="pybaz.Version-class.html" class="link"><code>Version</code></a> and <a href="pybaz.Revision-class.html" class="link"><code>Revision</code></a> classes
model the Arch namespace. Namespace objects can be created without the
corresponding archive structure being available.</p>
<p>Since they form a hierarchy of containers with shared methods and
properties in both directions, but do not have any subclass
relationship, they are defined using a collection of mixin classes.</p>
<p>The <a href="pybaz.RevisionIterable-class.html" class="link"><code>RevisionIterable</code></a>, <a href="pybaz.VersionIterable-class.html" class="link"><code>VersionIterable</code></a>, <a href="pybaz.BranchIterable-class.html" class="link"><code>BranchIterable</code></a> and
<a href="pybaz.CategoryIterable-class.html" class="link"><code>CategoryIterable</code></a> classes define the features which are inherited by
enclosing archive containers. Many methods in that hierarchy are
defined abstract (they raise UnimplementedError). They are always
overriden and are required to prevent legitimate PyChecker warnings.</p>
<p>The <a href="pybaz.ArchiveItem-class.html" class="link"><code>ArchiveItem</code></a>, <a href="pybaz.CategoryItem-class.html" class="link"><code>CategoryItem</code></a>, <a href="pybaz.BranchItem-class.html" class="link"><code>BranchItem</code></a> and <a href="pybaz.VersionItem-class.html" class="link"><code>VersionItem</code></a>
classes provides features which are inherited by enclosed archive
items. The <a href="pybaz.NamespaceObject-class.html" class="link"><code>NamespaceObject</code></a>, <a href="pybaz.Setupable-class.html" class="link"><code>Setupable</code></a> and <a href="pybaz.Package-class.html" class="link"><code>Package</code></a> classes
provide miscellaneous features and define aspects which do not fit
within the rest of the hierarchy.</p>
</div>
<hr/>
<!-- =========== START OF SUBMODULES =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Submodules</th></tr>
<tr><td><ul>
<li> <b><a href="pybaz.backends-module.html"><code>backends</code></a></b>: <i>Backend control.</i>
<ul>
<li> <b><a href="pybaz.backends.baz-module.html"><code>baz</code></a></b>: <i>Construction of tla commands</i>
<li> <b><a href="pybaz.backends.commandline-module.html"><code>commandline</code></a></b>: <i>Command-line back-end glue.</i>
<li> <b><a href="pybaz.backends.forkexec-module.html"><code>forkexec</code></a></b>: <i>PyArch specific process spawning</i>
<li> <b><a href="pybaz.backends.logger-module.html"><code>logger</code></a></b>: <i>Command line logging</i>
</ul>
<li> <b><a href="pybaz.compat-module.html"><code>compat</code></a></b>: <i>Utilities for handling compatibility with multiple versions.</i>
<li> <b><a href="pybaz.errors-module.html"><code>errors</code></a></b>: <i>PyArch exceptions</i>
<li> <b><a href="pybaz.pathname-module.html"><code>pathname</code></a></b>: <i>File name manipulation.</i>
<li> <b><a href="pybaz.util-module.html"><code>util</code></a></b>: <i>Obsolete utility module</i>
</ul></td></tr>
</table><br />
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="pybaz.ArchiveLocationParams-class.html"><code>ArchiveLocationParams</code></a></b></td>
<td>Parameter Object used for creating archives masters and mirrors.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.Factory-class.html"><code>Factory</code></a></b></td>
<td>Abstract factory for objects created by the public interface.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Namespace Classes</th></tr>
<tr><td width="15%">
<b><a href="pybaz.ArchiveLocation-class.html"><code>ArchiveLocation</code></a></b></td>
<td>A location identified by an url and containing a Bazaar archive.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.Archive-class.html"><code>Archive</code></a></b></td>
<td>Arch archive namespace object.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.Category-class.html"><code>Category</code></a></b></td>
<td>Arch category namespace object.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.Branch-class.html"><code>Branch</code></a></b></td>
<td>Arch branch namespace object.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.Version-class.html"><code>Version</code></a></b></td>
<td>Arch version namespace object.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.Revision-class.html"><code>Revision</code></a></b></td>
<td>Arch revision namespace object.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Abstract Namespace Classes</th></tr>
<tr><td width="15%">
<b><a href="pybaz.NamespaceObject-class.html"><code>NamespaceObject</code></a></b></td>
<td>Base class for all archive objects.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.Setupable-class.html"><code>Setupable</code></a></b></td>
<td>Base class for container archive objects.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.Package-class.html"><code>Package</code></a></b></td>
<td>Base class for ordered container archive objects.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.CategoryIterable-class.html"><code>CategoryIterable</code></a></b></td>
<td>Base class for Archive.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.BranchIterable-class.html"><code>BranchIterable</code></a></b></td>
<td>Base class for archive classes above Branch.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.VersionIterable-class.html"><code>VersionIterable</code></a></b></td>
<td>Abstract class for archive classes above Version.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.RevisionIterable-class.html"><code>RevisionIterable</code></a></b></td>
<td>Abstract class for namespace classes above Revision.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.ArchiveItem-class.html"><code>ArchiveItem</code></a></b></td>
<td>Base class for all archive components classes.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.CategoryItem-class.html"><code>CategoryItem</code></a></b></td>
<td>Base class for archive classes below Category.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.BranchItem-class.html"><code>BranchItem</code></a></b></td>
<td>Base class for archive classes Version and Revision.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.VersionItem-class.html"><code>VersionItem</code></a></b></td>
<td>Base class for Revision.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Archive-Related Classes</th></tr>
<tr><td width="15%">
<b><a href="pybaz.RevisionFile-class.html"><code>RevisionFile</code></a></b></td>
<td>File component of an archived revision.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.NameParser-class.html"><code>NameParser</code></a></b></td>
<td>Parser for names in Arch archive namespace.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Source Tree Classes</th></tr>
<tr><td width="15%">
<b><a href="pybaz.SourceTree-class.html"><code>SourceTree</code></a></b></td>
<td>Abstract base class for <a href="pybaz.ForeignTree-class.html" class="link"><code>ForeignTree</code></a> and <a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a>.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.ForeignTree-class.html"><code>ForeignTree</code></a></b></td>
<td>Generic source tree without Arch support.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.ArchSourceTree-class.html"><code>ArchSourceTree</code></a></b></td>
<td>Abstract base class for Arch source trees.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.LibraryTree-class.html"><code>LibraryTree</code></a></b></td>
<td>Read-only Arch source tree.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.WorkingTree-class.html"><code>WorkingTree</code></a></b></td>
<td>Working source tree, Arch source tree which can be modified.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Changeset and Log Classes</th></tr>
<tr><td width="15%">
<b><a href="pybaz.Changeset-class.html"><code>Changeset</code></a></b></td>
<td>Arch whole-tree changeset.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.Patchlog-class.html"><code>Patchlog</code></a></b></td>
<td>Log entry associated to a revision.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.LogMessage-class.html"><code>LogMessage</code></a></b></td>
<td>Log message for use with commit, import or tag operations.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Incremental Ouput</th></tr>
<tr><td width="15%">
<b><a href="pybaz.ChangesetCreation-class.html"><code>ChangesetCreation</code></a></b></td>
<td>Incremental changeset generation process.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.ChangesetApplication-class.html"><code>ChangesetApplication</code></a></b></td>
<td>Incremental changeset application process.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.Chatter-class.html"><code>Chatter</code></a></b></td>
<td>Chatter lines in <tt class="docutils literal"><span class="pre">tla</span></tt> output.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.TreeChange-class.html"><code>TreeChange</code></a></b></td>
<td>Abstract base class for <tt class="docutils literal"><span class="pre">changes</span></tt> summary output lines.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.FileAddition-class.html"><code>FileAddition</code></a></b></td>
<td>Changeset summary line for a new file.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.FileDeletion-class.html"><code>FileDeletion</code></a></b></td>
<td>Changeset summary line for a deleted file.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.FileModification-class.html"><code>FileModification</code></a></b></td>
<td>Changeset summary line for file whose contents were modified.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.FilePermissionsChange-class.html"><code>FilePermissionsChange</code></a></b></td>
<td>Changeset summary line for a change in permissions.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.FileRename-class.html"><code>FileRename</code></a></b></td>
<td>Changeset summary line for a renaming.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.SymlinkModification-class.html"><code>SymlinkModification</code></a></b></td>
<td>Changeset summary line for a symlink modification.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.MergeOutcome-class.html"><code>MergeOutcome</code></a></b></td>
<td>Abstract base class for changeset application summary output lines.</td></tr>
<tr><td width="15%">
<b><a href="pybaz.PatchConflict-class.html"><code>PatchConflict</code></a></b></td>
<td>Changeset application summary line for a patch conflict.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Archive Functions</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>sequence of <a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#archives" class="summary-sig-name"><code>archives</code></a>()</span></code>
<br />
Deprecated.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>iterable of <a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#iter_archives" class="summary-sig-name"><code>iter_archives</code></a>()</span></code>
<br />
Iterate over registered archives.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#make_archive" class="summary-sig-name"><code>make_archive</code></a>(<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>location</span>,
<span class=summary-sig-arg>signed</span>,
<span class=summary-sig-arg>listing</span>,
<span class=summary-sig-arg>tla</span>)</span></code>
<br />
Deprecated.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a>.</p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#register_archive" class="summary-sig-name"><code>register_archive</code></a>(<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>location</span>)</span></code>
<br />
Deprecated.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.WorkingTree-class.html" class="link"><code>WorkingTree</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#get" class="summary-sig-name"><code>get</code></a>(<span class=summary-sig-arg>revision</span>,
<span class=summary-sig-arg>dir</span>,
<span class=summary-sig-arg>link</span>)</span></code>
<br />
Construct a project tree for a revision.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.Changeset-class.html" class="link"><code>Changeset</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#get_patch" class="summary-sig-name"><code>get_patch</code></a>(<span class=summary-sig-arg>revision</span>,
<span class=summary-sig-arg>dir</span>)</span></code>
<br />
Deprecated.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#make_continuation" class="summary-sig-name"><code>make_continuation</code></a>(<span class=summary-sig-arg>source_revision</span>,
<span class=summary-sig-arg>tag_version</span>)</span></code>
<br />
Deprecated.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Source Tree Functions</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.WorkingTree-class.html" class="link"><code>WorkingTree</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#init_tree" class="summary-sig-name"><code>init_tree</code></a>(<span class=summary-sig-arg>directory</span>,
<span class=summary-sig-arg>version</span>,
<span class=summary-sig-arg>nested</span>)</span></code>
<br />
Initialize a new project tree.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>bool</p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#in_source_tree" class="summary-sig-name"><code>in_source_tree</code></a>(<span class=summary-sig-arg>directory</span>)</span></code>
<br />
Is directory inside a Arch source tree?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#tree_root" class="summary-sig-name"><code>tree_root</code></a>(<span class=summary-sig-arg>directory</span>)</span></code>
<br />
SourceTree containing the given directory.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> User Functions</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a>, None</p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#default_archive" class="summary-sig-name"><code>default_archive</code></a>()</span></code>
<br />
Default Archive object or None.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>str</p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#my_id" class="summary-sig-name"><code>my_id</code></a>()</span></code>
<br />
The current registered user id</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#set_my_id" class="summary-sig-name"><code>set_my_id</code></a>(<span class=summary-sig-arg>new_id</span>)</span></code>
<br />
Set the current registered user id</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Changeset Generation Functions</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.Changeset-class.html" class="link"><code>Changeset</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#changeset" class="summary-sig-name"><code>changeset</code></a>(<span class=summary-sig-arg>orig</span>,
<span class=summary-sig-arg>mod</span>,
<span class=summary-sig-arg>dest</span>)</span></code>
<br />
Deprecated.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.Changeset-class.html" class="link"><code>Changeset</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#delta" class="summary-sig-name"><code>delta</code></a>(<span class=summary-sig-arg>orig</span>,
<span class=summary-sig-arg>mod</span>,
<span class=summary-sig-arg>dest</span>)</span></code>
<br />
Compute a whole-tree changeset.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.ChangesetCreation-class.html" class="link"><code>ChangesetCreation</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#iter_delta" class="summary-sig-name"><code>iter_delta</code></a>(<span class=summary-sig-arg>orig</span>,
<span class=summary-sig-arg>mod</span>,
<span class=summary-sig-arg>dest</span>)</span></code>
<br />
Compute a whole-tree changeset with incremental output.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Pika Escaping Functions</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>str</p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#name_escape" class="summary-sig-name"><code>name_escape</code></a>(<span class=summary-sig-arg>name</span>)</span></code>
<br />
Escape a file name using the Arch syntax.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>str</p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#name_unescape" class="summary-sig-name"><code>name_unescape</code></a>(<span class=summary-sig-arg>name</span>)</span></code>
<br />
Unescape a file name using the Arch syntax.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Revision Library Functions</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#register_revision_library" class="summary-sig-name"><code>register_revision_library</code></a>(<span class=summary-sig-arg>dirname</span>)</span></code>
<br />
Register an existing revision library directory.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#unregister_revision_library" class="summary-sig-name"><code>unregister_revision_library</code></a>(<span class=summary-sig-arg>dirname</span>)</span></code>
<br />
Unregister a revision library directory.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>iterable of str</p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#iter_revision_libraries" class="summary-sig-name"><code>iter_revision_libraries</code></a>()</span></code>
<br />
Iterate over registered revision library directories.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>sequence of <a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#library_archives" class="summary-sig-name"><code>library_archives</code></a>()</span></code>
<br />
Deprecated.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>iterable of <a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a></p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#iter_library_archives" class="summary-sig-name"><code>iter_library_archives</code></a>()</span></code>
<br />
Iterate over archives present in the revision library.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Incremental Output Functions</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>iterable of <a href="pybaz.Chatter-class.html" class="link"><code>Chatter</code></a> or str</p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#classify_chatter" class="summary-sig-name"><code>classify_chatter</code></a>(<span class=summary-sig-arg>iter</span>)</span></code>
<br />
Classify chatter in a sequence of strings.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>Iterable of <a href="pybaz.Chatter-class.html" class="link"><code>Chatter</code></a>, <a href="pybaz.TreeChange-class.html" class="link"><code>TreeChange</code></a>, str</p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#classify_changeset_creation" class="summary-sig-name"><code>classify_changeset_creation</code></a>(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>pad</span>)</span></code>
<br />
Classify the output of a changeset creation command.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>iterable of <a href="pybaz.Chatter-class.html" class="link"><code>Chatter</code></a>, <a href="pybaz.MergeOutcome-class.html" class="link"><code>MergeOutcome</code></a>, str</p>
</font></td>
<td><code><span class="summary-sig"><a href="pybaz-module.html#classify_changeset_application" class="summary-sig-name"><code>classify_changeset_application</code></a>(<span class=summary-sig-arg>lines</span>)</span></code>
<br />
Classify the output of a change-producing command.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Obsolete Utility Functions</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="filter_archive_logs"></a><span class="summary-sig"><span class="summary-sig-name">filter_archive_logs</span>(<span class=summary-sig-arg>limit</span>,
<span class=summary-sig-arg>pred</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="filter_revisions"></a><span class="summary-sig"><span class="summary-sig-name">filter_revisions</span>(<span class=summary-sig-arg>limit</span>,
<span class=summary-sig-arg>pred</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="grep_summary"></a><span class="summary-sig"><span class="summary-sig-name">grep_summary</span>(<span class=summary-sig-arg>limit</span>,
<span class=summary-sig-arg>rx</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="grep_summary_interactive"></a><span class="summary-sig"><span class="summary-sig-name">grep_summary_interactive</span>(<span class=summary-sig-arg>limit</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="last_revision"></a><span class="summary-sig"><span class="summary-sig-name">last_revision</span>(<span class=summary-sig-arg>tree</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="map_name_id"></a><span class="summary-sig"><span class="summary-sig-name">map_name_id</span>(<span class=summary-sig-arg>tree</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="revision_which_created"></a><span class="summary-sig"><span class="summary-sig-name">revision_which_created</span>(<span class=summary-sig-arg>file</span>,
<span class=summary-sig-arg>revision</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="revisions_merging"></a><span class="summary-sig"><span class="summary-sig-name">revisions_merging</span>(<span class=summary-sig-arg>limit</span>,
<span class=summary-sig-arg>rev</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="suspected_move"></a><span class="summary-sig"><span class="summary-sig-name">suspected_move</span>(<span class=summary-sig-arg>limit</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="temphack"></a><span class="summary-sig"><span class="summary-sig-name">temphack</span>(<span class=summary-sig-arg>revision</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.backends.commandline.CommandLineBackend-class.html" class="link"><code>backends.commandline.CommandLineBackend</code></a></p></font></td>
<td><b><a href="pybaz-module.html#backend"><code>backend</code></a></b>: Backend controller.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="archives"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">archives</span>()</span>
</h3>
<p>Deprecated.</p>
<p>List of registered archives.</p>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>sequence of <a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a></p>
</dd>
</dl>
<p><b>See Also:</b> <p><a href="pybaz-module.html#iter_archives" class="link"><code>iter_archives</code></a></p>
</p>
</dd></dl>
</td></tr></table>
<a name="iter_archives"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">iter_archives</span>()</span>
</h3>
<p>Iterate over registered archives.</p>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>all registered archives.</p>
<br /><i>
(type=<p>iterable of <a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a></p>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="make_archive"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">make_archive</span>(<span class=sig-arg>name</span>,
<span class=sig-arg>location</span>,
<span class=sig-arg>signed</span>=<span class=sig-default>False</span>,
<span class=sig-arg>listing</span>=<span class=sig-default>False</span>,
<span class=sig-arg>tla</span>=<span class=sig-default>False</span>)</span>
</h3>
<p>Deprecated.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
<p>archive name (e.g. "<a class="rst-reference" href="mailto:david@allouche.net--2003b">david@allouche.net--2003b</a>").</p>
<br /><i>
(type=<p><a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a> or str</p>)</i>
<dd><code><b>location</b></code> -
<p>URL of the archive</p>
<br /><i>
(type=<p>str</p>)</i>
<dd><code><b>signed</b></code> -
<p>create GPG signatures for the archive contents.</p>
<br /><i>
(type=<p>bool</p>)</i>
<dd><code><b>listing</b></code> -
<p>maintains ''.listing'' files to enable HTTP access.</p>
<br /><i>
(type=<p>bool</p>)</i>
<dd><code><b>tla</b></code> -
<p>create a tla archive instead of a baz archive.</p>
<br /><i>
(type=<p>bool</p>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>an <a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a> instance for the given name.</p>
<br /><i>
(type=<p><a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a></p>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>errors.NamespaceError</b></code> -
<p><tt class="docutils literal"><span class="pre">name</span></tt> is not a valid archive name.</p>
</dl>
<p><b>See Also:</b> <p><a href="pybaz.ArchiveLocation-class.html#create_master" class="link"><code>ArchiveLocation.create_master</code></a></p>
</p>
</dd></dl>
</td></tr></table>
<a name="register_archive"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">register_archive</span>(<span class=sig-arg>name</span>,
<span class=sig-arg>location</span>)</span>
</h3>
<p>Deprecated.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
<p>archive name, or None to use the official name stored in the
archive.</p>
<br /><i>
(type=<p>str, None</p>)</i>
<dd><code><b>location</b></code> -
<p>URL of the archive.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>newly registered archive.</p>
<br /><i>
(type=<p><a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a>.</p>)</i>
</dd>
</dl>
<p><b>See Also:</b> <p><a href="pybaz.ArchiveLocation-class.html#register" class="link"><code>ArchiveLocation.register</code></a></p>
</p>
</dd></dl>
</td></tr></table>
<a name="get"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get</span>(<span class=sig-arg>revision</span>,
<span class=sig-arg>dir</span>,
<span class=sig-arg>link</span>=<span class=sig-default>False</span>)</span>
</h3>
<p>Construct a project tree for a revision.</p>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<p><a href="pybaz.WorkingTree-class.html" class="link"><code>WorkingTree</code></a></p>
</dd>
</dl>
<p><b>See Also:</b> <p><a href="pybaz.Revision-class.html#get" class="link"><code>Revision.get</code></a></p>
</p>
</dd></dl>
</td></tr></table>
<a name="get_patch"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_patch</span>(<span class=sig-arg>revision</span>,
<span class=sig-arg>dir</span>)</span>
</h3>
<p>Deprecated.</p>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<p><a href="pybaz.Changeset-class.html" class="link"><code>Changeset</code></a></p>
</dd>
</dl>
<p><b>See Also:</b> <p><a href="pybaz.Revision-class.html#get_patch" class="link"><code>Revision.get_patch</code></a></p>
</p>
</dd></dl>
</td></tr></table>
<a name="make_continuation"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">make_continuation</span>(<span class=sig-arg>source_revision</span>,
<span class=sig-arg>tag_version</span>)</span>
</h3>
<p>Deprecated.</p>
<dl><dt></dt><dd>
<p><b>See Also:</b> <p><a href="pybaz.Revision-class.html#make_continuation" class="link"><code>Revision.make_continuation</code></a></p>
</p>
</dd></dl>
</td></tr></table>
<a name="init_tree"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">init_tree</span>(<span class=sig-arg>directory</span>,
<span class=sig-arg>version</span>=<span class=sig-default>None</span>,
<span class=sig-arg>nested</span>=<span class=sig-default>False</span>)</span>
</h3>
<p>Initialize a new project tree.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>directory</b></code> -
<p>directory to initialize as a source tree.</p>
<br /><i>
(type=<p>str</p>)</i>
<dd><code><b>version</b></code> -
<p>if given, set the the <tt class="docutils literal"><span class="pre">tree-version</span></tt> and create an empty
log version.</p>
<br /><i>
(type=<p><a href="pybaz.Version-class.html" class="link"><code>Version</code></a></p>)</i>
<dd><code><b>nested</b></code> -
<p>if true, the command will succeed even if 'directory'
is already within a source tree.</p>
<br /><i>
(type=<p>bool</p>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>source tree object for the given directory.</p>
<br /><i>
(type=<p><a href="pybaz.WorkingTree-class.html" class="link"><code>WorkingTree</code></a></p>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="in_source_tree"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">in_source_tree</span>(<span class=sig-arg>directory</span>=<span class=sig-default>None</span>)</span>
</h3>
<p>Is directory inside a Arch source tree?</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>directory</b></code> -
<p>test if that directory is in an Arch source tree.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>whether this directory is inside an Arch source tree.</p>
<br /><i>
(type=<p>bool</p>)</i>
</dd>
</dl>
<p><b>Warning:</b> <p>omitting the <tt class="docutils literal"><span class="pre">directory</span></tt> argument is deprecated.</p>
</p>
</dd></dl>
</td></tr></table>
<a name="tree_root"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tree_root</span>(<span class=sig-arg>directory</span>=<span class=sig-default>None</span>)</span>
</h3>
<p>SourceTree containing the given directory.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>directory</b></code> -
<p>give the <tt class="docutils literal"><span class="pre">tree-root</span></tt> of this directory. Specify "." to
get the <tt class="docutils literal"><span class="pre">tree-root</span></tt> of the current directory.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>source tree containing <tt class="docutils literal"><span class="pre">directory</span></tt>.</p>
<br /><i>
(type=<p><a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a></p>)</i>
</dd>
</dl>
<p><b>Warning:</b> <p>omitting the <tt class="docutils literal"><span class="pre">directory</span></tt> argument is deprecated.</p>
</p>
</dd></dl>
</td></tr></table>
<a name="default_archive"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">default_archive</span>()</span>
</h3>
<p>Default Archive object or None.</p>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>the default archive, or None.</p>
<br /><i>
(type=<p><a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a>, None</p>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="my_id"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">my_id</span>()</span>
</h3>
<p>The current registered user id</p>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>the user id, for example 'John Doe <<a class="rst-reference" href="mailto:jdoe@example.org">jdoe@example.org</a>>'.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="set_my_id"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">set_my_id</span>(<span class=sig-arg>new_id</span>)</span>
</h3>
<p>Set the current registered user id</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>new_id</b></code> -
<p>new value of the user id.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="changeset"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">changeset</span>(<span class=sig-arg>orig</span>,
<span class=sig-arg>mod</span>,
<span class=sig-arg>dest</span>)</span>
</h3>
<p>Deprecated.</p>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<p><a href="pybaz.Changeset-class.html" class="link"><code>Changeset</code></a></p>
</dd>
</dl>
<p><b>See Also:</b> <p><a href="pybaz-module.html#delta" class="link"><code>delta</code></a></p>
</p>
</dd></dl>
</td></tr></table>
<a name="delta"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">delta</span>(<span class=sig-arg>orig</span>,
<span class=sig-arg>mod</span>,
<span class=sig-arg>dest</span>)</span>
</h3>
<p>Compute a whole-tree changeset.</p>
<p>Create the output directory <tt class="docutils literal"><span class="pre">dest</span></tt> (it must not already exist).</p>
<p>Compare the source trees <tt class="docutils literal"><span class="pre">orig</span></tt> and <tt class="docutils literal"><span class="pre">mod</span></tt> (which may be source
arch source tree or revisions). Create a changeset in <tt class="docutils literal"><span class="pre">dest</span></tt>.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>orig</b></code> -
<p>the old revision or directory.</p>
<br /><i>
(type=<p><a href="pybaz.Revision-class.html" class="link"><code>Revision</code></a>, <a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a></p>)</i>
<dd><code><b>mod</b></code> -
<p>the new revision or directory.</p>
<br /><i>
(type=<p><a href="pybaz.Revision-class.html" class="link"><code>Revision</code></a>, <a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a></p>)</i>
<dd><code><b>dest</b></code> -
<p>path of the changeset to create.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>changeset from <tt class="docutils literal"><span class="pre">orig</span></tt> to <tt class="docutils literal"><span class="pre">mod</span></tt>.</p>
<br /><i>
(type=<p><a href="pybaz.Changeset-class.html" class="link"><code>Changeset</code></a></p>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="iter_delta"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">iter_delta</span>(<span class=sig-arg>orig</span>,
<span class=sig-arg>mod</span>,
<span class=sig-arg>dest</span>)</span>
</h3>
<p>Compute a whole-tree changeset with incremental output.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>orig</b></code> -
<p>old revision or directory.</p>
<br /><i>
(type=<p><a href="pybaz.Revision-class.html" class="link"><code>Revision</code></a>, <a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a></p>)</i>
<dd><code><b>mod</b></code> -
<p>new revision or directory,</p>
<br /><i>
(type=<p><a href="pybaz.Revision-class.html" class="link"><code>Revision</code></a>, <a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a></p>)</i>
<dd><code><b>dest</b></code> -
<p>path of the changeset to create.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p><a href="pybaz.ChangesetCreation-class.html" class="link"><code>ChangesetCreation</code></a></p>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="name_escape"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">name_escape</span>(<span class=sig-arg>name</span>)</span>
</h3>
<p>Escape a file name using the Arch syntax.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
<p>unescaped file name.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>escaped file name.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="name_unescape"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">name_unescape</span>(<span class=sig-arg>name</span>)</span>
</h3>
<p>Unescape a file name using the Arch syntax.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
<p>escaped file name.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>unescaped file name.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>errors.IllegalEscapeSequence</b></code> -
<p>the syntax of <tt class="docutils literal"><span class="pre">name</span></tt> is incorrect.</p>
</dl>
</dd></dl>
</td></tr></table>
<a name="register_revision_library"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">register_revision_library</span>(<span class=sig-arg>dirname</span>)</span>
</h3>
<p>Register an existing revision library directory.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>dirname</b></code> -
<p>absolute path name of existing user-writable directory.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
<p><b>Postcondition:</b> <p><tt class="docutils literal"><span class="pre">dirname</span></tt> is present in <a href="pybaz-module.html#iter_revision_libraries" class="link"><code>iter_revision_libraries</code></a> output.</p>
</p>
<p><b>To Do:</b> <p>create_revision_library which abstracts out revlib construction.</p>
</p>
</dd></dl>
</td></tr></table>
<a name="unregister_revision_library"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unregister_revision_library</span>(<span class=sig-arg>dirname</span>)</span>
</h3>
<p>Unregister a revision library directory.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>dirname</b></code> -
<p>registered revision library directory.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
<p><b>Precondition:</b> <p><tt class="docutils literal"><span class="pre">dirname</span></tt> is present in <a href="pybaz-module.html#iter_revision_libraries" class="link"><code>iter_revision_libraries</code></a> output.</p>
</p>
<p><b>Postcondition:</b> <p><tt class="docutils literal"><span class="pre">dirname</span></tt> is not listed by <a href="pybaz-module.html#iter_revision_libraries" class="link"><code>iter_revision_libraries</code></a>.</p>
</p>
<p><b>To Do:</b> <p>delete_revision_library which abstracts out revlib destruction.</p>
</p>
</dd></dl>
</td></tr></table>
<a name="iter_revision_libraries"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">iter_revision_libraries</span>()</span>
</h3>
<p>Iterate over registered revision library directories.</p>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>directory names of all registered revision libraries.</p>
<br /><i>
(type=<p>iterable of str</p>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="library_archives"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">library_archives</span>()</span>
</h3>
<p>Deprecated.</p>
<p>List of archives present in the revision library.</p>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>sequence of <a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a></p>
</dd>
</dl>
<p><b>See Also:</b> <p><a href="pybaz-module.html#iter_library_archives" class="link"><code>iter_library_archives</code></a></p>
</p>
</dd></dl>
</td></tr></table>
<a name="iter_library_archives"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">iter_library_archives</span>()</span>
</h3>
<p>Iterate over archives present in the revision library.</p>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>all archives which are present in the revision library.</p>
<br /><i>
(type=<p>iterable of <a href="pybaz.Archive-class.html" class="link"><code>Archive</code></a></p>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="classify_chatter"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">classify_chatter</span>(<span class=sig-arg>iter</span>)</span>
</h3>
<p>Classify chatter in a sequence of strings.</p>
<p>Generator that yields Chatter objects for chatter lines, and
yields other lines verbatim.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>iter</b></code> -
<p>iterable of str</p>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>iterable of <a href="pybaz.Chatter-class.html" class="link"><code>Chatter</code></a> or str</p>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="classify_changeset_creation"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">classify_changeset_creation</span>(<span class=sig-arg>lines</span>,
<span class=sig-arg>pad</span>=<span class=sig-default>' '</span>)</span>
</h3>
<p>Classify the output of a changeset creation command.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>lines</b></code> -
<p>incremental output from a changeset creation command.</p>
<br /><i>
(type=<p>iterator of str</p>)</i>
<dd><code><b>pad</b></code> -
<p>padding text between prefix and file name.</p>
<br /><i>
(type=<p>str</p>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>Iterable of <a href="pybaz.Chatter-class.html" class="link"><code>Chatter</code></a>, <a href="pybaz.TreeChange-class.html" class="link"><code>TreeChange</code></a>, str</p>
</dd>
</dl>
<p><b>Note:</b> <p>diff output (<em>e.g.</em> <tt class="docutils literal"><span class="pre">changes</span> <span class="pre">--diffs</span></tt>) is not supported.</p>
</p>
</dd></dl>
</td></tr></table>
<a name="classify_changeset_application"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">classify_changeset_application</span>(<span class=sig-arg>lines</span>)</span>
</h3>
<p>Classify the output of a change-producing command.</p>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>lines</b></code> -
<p>incremental output from a changeset application command.</p>
<br /><i>
(type=<p>iterable of str</p>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<p>iterable of <a href="pybaz.Chatter-class.html" class="link"><code>Chatter</code></a>, <a href="pybaz.MergeOutcome-class.html" class="link"><code>MergeOutcome</code></a>, str</p>
</dd>
</dl>
<p><b>Note:</b> <p>diff output (<em>e.g.</em> <tt class="docutils literal"><span class="pre">changes</span> <span class="pre">--diffs</span></tt>) is not supported.</p>
</p>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="backend"></a>
<h3>backend</h3>
<p>Backend controller.</p>
<p>This object is used to configure the backend system: name of the
executable, process handling strategy and command-line logging.</p>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<p><a href="pybaz.backends.commandline.CommandLineBackend-class.html" class="link"><code>backends.commandline.CommandLineBackend</code></a></p>
</dd>
<span title="<pybaz.backends.commandline.CommandLineBackend object at 0x3aea4d0c>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<pybaz.backends.commandline.CommandLineBackend object at 0x3aea4d0c> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th bgcolor="#70b0f0" class="navselect"> Home </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Fri Jul 7 10:56:28 2006</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
