File: pybaz.ArchSourceTree-class.html

package info (click to toggle)
pybaz 1.5pre1-3
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 8,644 kB
  • ctags: 3,289
  • sloc: python: 8,386; makefile: 89; sh: 15; lisp: 12
file content (808 lines) | stat: -rw-r--r-- 51,038 bytes parent folder | download
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
<?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.ArchSourceTree</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 class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="pybaz-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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">
        <a href="pybaz-module.html">Package&nbsp;pybaz</a> ::
        Class&nbsp;ArchSourceTree
      </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>&nbsp;|&nbsp;<a href="pybaz.ArchSourceTree-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type ArchSourceTree</h2>

<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+                    
         |                    
<a href="__builtin__.basestring-class.html"><code>basestring</code></a> --+                
             |                
           <a href="__builtin__.str-class.html"><code>str</code></a> --+            
                 |            
          <a href="pybaz.pathname.PathName-class.html"><code>PathName</code></a> --+        
                     |        
               <a href="pybaz.pathname.DirName-class.html"><code>DirName</code></a> --+    
                         |    
                <a href="pybaz.SourceTree-class.html"><code>SourceTree</code></a> --+
                             |
                            <b>ArchSourceTree</b>
</pre><br />

<dl><dt><b>Known Subclasses:</b></dt>
<dd>
    <a href="pybaz.LibraryTree-class.html"><code>LibraryTree</code></a>,
    <a href="pybaz.WorkingTree-class.html"><code>WorkingTree</code></a></dd></dl>

<hr/>

<p>Abstract base class for Arch source trees.</p>
<hr/>


<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="check_is_tree_root"></a><span class="summary-sig"><span class="summary-sig-name">check_is_tree_root</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p><a href="pybaz.pathname.PathName-class.html" class="link"><code>pathname.PathName</code></a></p>
</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.ArchSourceTree-class.html#file_find" class="summary-sig-name"><code>file_find</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>name</span>,
          <span class=summary-sig-arg>revision</span>)</span></code>
<br />
Find a pristine copy of a file for a given revision.</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.ArchSourceTree-class.html#get_tag" class="summary-sig-name"><code>get_tag</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>name</span>)</span></code>
<br />
Read a file id set by an explicit id tag or tagline.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="get_tagging_method"></a><span class="summary-sig"><span class="summary-sig-name">get_tagging_method</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="get_tree"></a><span class="summary-sig"><span class="summary-sig-name">get_tree</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.ArchSourceTree-class.html#get_tree_version" class="summary-sig-name"><code>get_tree_version</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Default version of the tree, also called tree-version.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.ArchSourceTree-class.html#inventory" class="summary-sig-name"><code>inventory</code></a>(<span class=summary-sig-arg>self</span>,
          <span class="summary-sig-vararg">*args</span>,
          <span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Deprecated.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>iterable of <a href="pybaz.pathname.FileName-class.html" class="link"><code>FileName</code></a>, <a href="pybaz.pathname.DirName-class.html" class="link"><code>DirName</code></a>, <a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a>
according to the arguments.</p>
</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.ArchSourceTree-class.html#iter_inventory" class="summary-sig-name"><code>iter_inventory</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>source</span>,
          <span class=summary-sig-arg>precious</span>,
          <span class=summary-sig-arg>backups</span>,
          <span class=summary-sig-arg>junk</span>,
          <span class=summary-sig-arg>unrecognized</span>,
          <span class=summary-sig-arg>trees</span>,
          <span class=summary-sig-arg>directories</span>,
          <span class=summary-sig-arg>files</span>,
          <span class=summary-sig-arg>both</span>,
          <span class=summary-sig-arg>names</span>,
          <span class=summary-sig-arg>limit</span>)</span></code>
<br />
Tree inventory.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>iterable of tuples <tt class="docutils literal"><span class="pre">(id,</span> <span class="pre">item)</span></tt>, where <tt class="docutils literal"><span class="pre">item</span></tt> is
<a href="pybaz.pathname.FileName-class.html" class="link"><code>FileName</code></a>, <a href="pybaz.pathname.DirName-class.html" class="link"><code>DirName</code></a>, <a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a> according to the
arguments and <tt class="docutils literal"><span class="pre">id</span></tt> is the associated inventory id.</p>
</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.ArchSourceTree-class.html#iter_inventory_ids" class="summary-sig-name"><code>iter_inventory_ids</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>source</span>,
          <span class=summary-sig-arg>precious</span>,
          <span class=summary-sig-arg>backups</span>,
          <span class=summary-sig-arg>junk</span>,
          <span class=summary-sig-arg>unrecognized</span>,
          <span class=summary-sig-arg>trees</span>,
          <span class=summary-sig-arg>directories</span>,
          <span class=summary-sig-arg>files</span>,
          <span class=summary-sig-arg>both</span>,
          <span class=summary-sig-arg>limit</span>)</span></code>
<br />
Tree inventory with file ids.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.ArchSourceTree-class.html#iter_log_versions" class="summary-sig-name"><code>iter_log_versions</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>limit</span>,
          <span class=summary-sig-arg>reverse</span>)</span></code>
<br />
Iterate over versions this tree has a log-version for.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><p>iterator of <a href="pybaz.Patchlog-class.html" class="link"><code>Patchlog</code></a>.</p>
</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.ArchSourceTree-class.html#iter_logs" class="summary-sig-name"><code>iter_logs</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>version</span>,
          <span class=summary-sig-arg>reverse</span>)</span></code>
<br />
Iterate over patchlogs present in this tree.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from SourceTree</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.SourceTree-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>cls</span>,
          <span class=summary-sig-arg>root</span>)</span></code>
<br />
Create a source tree object for the given root path.    <i>(Static method)</i>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from PathName</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.pathname.PathName-class.html#__div__" class="summary-sig-name"><code>__div__</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>path</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.pathname.PathName-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.pathname.PathName-class.html#abspath" class="summary-sig-name"><code>abspath</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.pathname.PathName-class.html#basename" class="summary-sig-name"><code>basename</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.pathname.PathName-class.html#dirname" class="summary-sig-name"><code>dirname</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.pathname.PathName-class.html#realpath" class="summary-sig-name"><code>realpath</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="pybaz.pathname.PathName-class.html#splitname" class="summary-sig-name"><code>splitname</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from str</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__add__" class="summary-sig-name"><code>__add__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>y</span>)</span></code>
<br />
x.__add__(y) &lt;==&gt; x+y</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__contains__" class="summary-sig-name"><code>__contains__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>y</span>)</span></code>
<br />
x.__contains__(y) &lt;==&gt; y in x</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__eq__" class="summary-sig-name"><code>__eq__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>y</span>)</span></code>
<br />
x.__eq__(y) &lt;==&gt; x==y</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__ge__" class="summary-sig-name"><code>__ge__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>y</span>)</span></code>
<br />
x.__ge__(y) &lt;==&gt; x&gt;=y</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__getattribute__('name') &lt;==&gt; x.name</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>y</span>)</span></code>
<br />
x.__getitem__(y) &lt;==&gt; x[y]</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__getnewargs__" class="summary-sig-name"><code>__getnewargs__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__getslice__" class="summary-sig-name"><code>__getslice__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>i</span>,
          <span class=summary-sig-arg>j</span>)</span></code>
<br />
Use of negative indices is not supported.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__gt__" class="summary-sig-name"><code>__gt__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>y</span>)</span></code>
<br />
x.__gt__(y) &lt;==&gt; x&gt;y</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
<br />
x.__hash__() &lt;==&gt; hash(x)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__le__" class="summary-sig-name"><code>__le__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>y</span>)</span></code>
<br />
x.__le__(y) &lt;==&gt; x&lt;=y</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__len__" class="summary-sig-name"><code>__len__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
<br />
x.__len__() &lt;==&gt; len(x)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__lt__" class="summary-sig-name"><code>__lt__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>y</span>)</span></code>
<br />
x.__lt__(y) &lt;==&gt; x&lt;y</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__mod__" class="summary-sig-name"><code>__mod__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>y</span>)</span></code>
<br />
x.__mod__(y) &lt;==&gt; x%y</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__mul__" class="summary-sig-name"><code>__mul__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>n</span>)</span></code>
<br />
x.__mul__(n) &lt;==&gt; x*n</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__ne__" class="summary-sig-name"><code>__ne__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>y</span>)</span></code>
<br />
x.__ne__(y) &lt;==&gt; x!=y</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__rmod__" class="summary-sig-name"><code>__rmod__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>y</span>)</span></code>
<br />
x.__rmod__(y) &lt;==&gt; y%x</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__rmul__" class="summary-sig-name"><code>__rmul__</code></a>(<span class=summary-sig-arg>x</span>,
          <span class=summary-sig-arg>n</span>)</span></code>
<br />
x.__rmul__(n) &lt;==&gt; n*x</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
<br />
x.__str__() &lt;==&gt; str(x)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#capitalize" class="summary-sig-name"><code>capitalize</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return a copy of the string S with only its first character
capitalized.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#center" class="summary-sig-name"><code>center</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>width</span>)</span></code>
<br />
Return S centered in a string of length width.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#count" class="summary-sig-name"><code>count</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>sub</span>,
          <span class=summary-sig-arg>start</span>,
          <span class=summary-sig-arg>end</span>)</span></code>
<br />
Return the number of occurrences of substring sub in string
S[start:end].</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#decode" class="summary-sig-name"><code>decode</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>encoding</span>,
          <span class=summary-sig-arg>errors</span>)</span></code>
<br />
Decodes S using the codec registered for encoding.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#encode" class="summary-sig-name"><code>encode</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>encoding</span>,
          <span class=summary-sig-arg>errors</span>)</span></code>
<br />
Encodes S using the codec registered for encoding.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#endswith" class="summary-sig-name"><code>endswith</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>suffix</span>,
          <span class=summary-sig-arg>start</span>,
          <span class=summary-sig-arg>end</span>)</span></code>
<br />
Return True if S ends with the specified suffix, False otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#expandtabs" class="summary-sig-name"><code>expandtabs</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>tabsize</span>)</span></code>
<br />
Return a copy of S where all tab characters are expanded using spaces.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#find" class="summary-sig-name"><code>find</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>sub</span>,
          <span class=summary-sig-arg>start</span>,
          <span class=summary-sig-arg>end</span>)</span></code>
<br />
Return the lowest index in S where substring sub is found,
such that sub is contained within s[start,end].</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#index" class="summary-sig-name"><code>index</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>sub</span>,
          <span class=summary-sig-arg>start</span>,
          <span class=summary-sig-arg>end</span>)</span></code>
<br />
Like S.find() but raise ValueError when the substring is not found.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#isalnum" class="summary-sig-name"><code>isalnum</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return True if all characters in S are alphanumeric
and there is at least one character in S, False otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#isalpha" class="summary-sig-name"><code>isalpha</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return True if all characters in S are alphabetic
and there is at least one character in S, False otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#isdigit" class="summary-sig-name"><code>isdigit</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return True if all characters in S are digits
and there is at least one character in S, False otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#islower" class="summary-sig-name"><code>islower</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return True if all cased characters in S are lowercase and there is
at least one cased character in S, False otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#isspace" class="summary-sig-name"><code>isspace</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return True if all characters in S are whitespace
and there is at least one character in S, False otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#istitle" class="summary-sig-name"><code>istitle</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return True if S is a titlecased string and there is at least one
character in S, i.e.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#isupper" class="summary-sig-name"><code>isupper</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return True if all cased characters in S are uppercase and there is
at least one cased character in S, False otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#join" class="summary-sig-name"><code>join</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>sequence</span>)</span></code>
<br />
Return a string which is the concatenation of the strings in the
sequence.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#ljust" class="summary-sig-name"><code>ljust</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>width</span>)</span></code>
<br />
Return S left justified in a string of length width.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#lower" class="summary-sig-name"><code>lower</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return a copy of the string S converted to lowercase.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#lstrip" class="summary-sig-name"><code>lstrip</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>chars</span>)</span></code>
<br />
Return a copy of the string S with leading whitespace removed.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#replace" class="summary-sig-name"><code>replace</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
S.replace (old, new[, count]) -&gt; string</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#rfind" class="summary-sig-name"><code>rfind</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>sub</span>,
          <span class=summary-sig-arg>start</span>,
          <span class=summary-sig-arg>end</span>)</span></code>
<br />
Return the highest index in S where substring sub is found,
such that sub is contained within s[start,end].</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#rindex" class="summary-sig-name"><code>rindex</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>sub</span>,
          <span class=summary-sig-arg>start</span>,
          <span class=summary-sig-arg>end</span>)</span></code>
<br />
Like S.rfind() but raise ValueError when the substring is not found.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#rjust" class="summary-sig-name"><code>rjust</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>width</span>)</span></code>
<br />
Return S right justified in a string of length width.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#rstrip" class="summary-sig-name"><code>rstrip</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>chars</span>)</span></code>
<br />
Return a copy of the string S with trailing whitespace removed.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#split" class="summary-sig-name"><code>split</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>sep</span>,
          <span class=summary-sig-arg>maxsplit</span>)</span></code>
<br />
Return a list of the words in the string S, using sep as the
delimiter string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#splitlines" class="summary-sig-name"><code>splitlines</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>keepends</span>)</span></code>
<br />
Return a list of the lines in S, breaking at line boundaries.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#startswith" class="summary-sig-name"><code>startswith</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>prefix</span>,
          <span class=summary-sig-arg>start</span>,
          <span class=summary-sig-arg>end</span>)</span></code>
<br />
Return True if S starts with the specified prefix, False otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#strip" class="summary-sig-name"><code>strip</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>chars</span>)</span></code>
<br />
Return a copy of the string S with leading and trailing
whitespace removed.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#swapcase" class="summary-sig-name"><code>swapcase</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return a copy of the string S with uppercase characters
converted to lowercase and vice versa.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#title" class="summary-sig-name"><code>title</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return a titlecased version of S, i.e.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#translate" class="summary-sig-name"><code>translate</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>table</span>,
          <span class=summary-sig-arg>deletechars</span>)</span></code>
<br />
Return a copy of the string S, where all characters occurring
in the optional argument deletechars are removed, and the
remaining characters have been mapped through the given
translation table, which must be a string of length 256.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#upper" class="summary-sig-name"><code>upper</code></a>(<span class=summary-sig-arg>S</span>)</span></code>
<br />
Return a copy of the string S converted to uppercase.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.str-class.html#zfill" class="summary-sig-name"><code>zfill</code></a>(<span class=summary-sig-arg>S</span>,
          <span class=summary-sig-arg>width</span>)</span></code>
<br />
Pad a numeric string S with zeros on the left, to fill a field
of the specified width.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__delattr__('name') &lt;==&gt; del x.name</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
helper for pickle</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
helper for pickle</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__setattr__('name', value) &lt;==&gt; x.name = value</td></tr>
</table><br />


<!-- =========== START OF PROPERTY SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Property Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><b><a href="pybaz.ArchSourceTree-class.html#tagging_method"><code>tagging_method</code></a></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><a name="tree_revision"></a><b><code>tree_revision</code></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><b><a href="pybaz.ArchSourceTree-class.html#tree_version"><code>tree_version</code></a></b></td></tr></table><br />


<!-- =========== START OF INSTANCE METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
  <th colspan="2">Instance Method Details</th></tr>
</table>

<a name="file_find"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">file_find</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>name</span>,
          <span class=sig-arg>revision</span>)</span>
  </h3>
<p>Find a pristine copy of a file for a given revision.</p>
<p>Will create the requested revision in the library or in the
current tree pristines if needed.</p>
  <dl><dt></dt><dd>
    <dl><dt><b>Parameters:</b></dt>
      <dd><code><b>name</b></code> -
 <p>name of the file.</p>
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<p>str</p>)</i>
      <dd><code><b>revision</b></code> -
 <p>revision to look for the file into.</p>
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<p><a href="pybaz.Revision-class.html" class="link"><code>Revision</code></a></p>)</i>
      </dd>
    </dl>
    <dl><dt><b>Returns:</b></dt>
      <dd>
<p>absolute path name of a pristine copy of the file.</p>
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<p><a href="pybaz.pathname.PathName-class.html" class="link"><code>pathname.PathName</code></a></p>)</i>
      </dd>
    </dl>
    <dl><dt><b>Raises:</b></dt>
      <dd><code><b>errors.MissingFileError</b></code> -
<p>file is not source or is not
present in the specified revision.</p>
    </dl>
  </dd></dl>
</td></tr></table>

<a name="get_tag"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">get_tag</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>name</span>)</span>
  </h3>
<p>Read a file id set by an explicit id tag or tagline.</p>
<p>FIXME: update docstring when support for pybaz&lt;1.3 is dropped, as this
release fixed &quot;baz id&quot; to report name-based ids correctly.</p>
  <dl><dt></dt><dd>
    <dl><dt><b>Parameters:</b></dt>
      <dd><code><b>name</b></code> -
 <p>name of a source file relative to the tree-root.</p>
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<p>str</p>)</i>
      </dd>
    </dl>
    <dl><dt><b>Returns:</b></dt>
      <dd>
<p>file id if the file has an explicit id or a tagline.</p>
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<p>str</p>)</i>
      </dd>
    </dl>
  </dd></dl>
</td></tr></table>

<a name="get_tree_version"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">get_tree_version</span>(<span class=sig-arg>self</span>)</span>
  </h3>
<p>Default version of the tree, also called tree-version.</p>
  <dl><dt></dt><dd>
    <dl><dt><b>Raises:</b></dt>
      <dd><code><b>errors.TreeVersionError</b></code> -
<p>no valid default version set.</p>
      <dd><code><b>IOError</b></code> -
<p>unable to read the ++default-version file.</p>
    </dl>
  </dd></dl>
</td></tr></table>

<a name="inventory"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">inventory</span>(<span class=sig-arg>self</span>,
          <span class="sig-vararg">*args</span>,
          <span class="sig-kwarg">**kw</span>)</span>
  </h3>
<p>Deprecated.</p>
<p>Inventory of the source tree as a list.</p>
  <dl><dt></dt><dd>
<p><b>See Also:</b> <p><a href="pybaz.ArchSourceTree-class.html#iter_inventory" class="link"><code>iter_inventory</code></a></p>
</p>

  </dd></dl>
</td></tr></table>

<a name="iter_inventory"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">iter_inventory</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>source</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>precious</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>backups</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>junk</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>unrecognized</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>trees</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>directories</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>files</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>both</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>names</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>limit</span>=<span class=sig-default>None</span>)</span>
  </h3>
<p>Tree inventory.</p>
<p>The kind of files looked for is specified by setting to
<tt class="docutils literal"><span class="pre">True</span></tt> exactly one of the following keyword arguments:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">source</span></tt>, <tt class="docutils literal"><span class="pre">precious</span></tt>, <tt class="docutils literal"><span class="pre">backups</span></tt>, <tt class="docutils literal"><span class="pre">junk</span></tt>,
<tt class="docutils literal"><span class="pre">unrecognized</span></tt>, <tt class="docutils literal"><span class="pre">trees</span></tt>.</blockquote>
<p>If the <tt class="docutils literal"><span class="pre">trees</span></tt> argument is not set, whether files, directory
or both should be listed is specified by setting to <tt class="docutils literal"><span class="pre">True</span></tt>
exactly one of the following keyword arguments:</p>
<blockquote>
<tt class="docutils literal"><span class="pre">directories</span></tt>, <tt class="docutils literal"><span class="pre">files</span></tt>, <tt class="docutils literal"><span class="pre">both</span></tt>.</blockquote>
  <dl><dt></dt><dd>
    <dl><dt><b>Keyword Parameters:</b></dt>
      <dd><code><b>source</b></code> -
 <p>list source files only.</p>
      <dd><code><b>precious</b></code> -
 <p>list precious files only.</p>
      <dd><code><b>backups</b></code> -
 <p>list backup files only.</p>
      <dd><code><b>junk</b></code> -
 <p>list junk files only.</p>
      <dd><code><b>unrecognized</b></code> -
 <p>list unrecognized files only.</p>
      <dd><code><b>trees</b></code> -
 <p>list nested trees only. If this is true, the
iterator wil only yield <a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a> objects.</p>
      <dd><code><b>directories</b></code> -
 <p>list directories only,
yield only <a href="pybaz.pathname.FileName-class.html" class="link"><code>FileName</code></a> objects.</p>
      <dd><code><b>files</b></code> -
 <p>list files only, yield only <a href="pybaz.pathname.DirName-class.html" class="link"><code>DirName</code></a> objects.</p>
      <dd><code><b>both</b></code> -
 <p>list both files and directories,
yield both FileName and <a href="pybaz.pathname.DirName-class.html" class="link"><code>DirName</code></a> objects.</p>
      <dd><code><b>name</b></code> -
 <p>do inventory as if the id-tagging-method was
set to <tt class="docutils literal"><span class="pre">names</span></tt>. That is useful to ignore
<tt class="docutils literal"><span class="pre">untagged-source</span></tt> classification.</p>
      <dd><code><b>limit</b></code> -
 <p>restrict the inventory to this directory. Must
be the name of a directory relative to the tree root.</p>
      </dd>
    </dl>
    <dl><dt><b>Returns:</b></dt>
      <dd>
<p>iterable of <a href="pybaz.pathname.FileName-class.html" class="link"><code>FileName</code></a>, <a href="pybaz.pathname.DirName-class.html" class="link"><code>DirName</code></a>, <a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a>
according to the arguments.</p>
      </dd>
    </dl>
  </dd></dl>
</td></tr></table>

<a name="iter_inventory_ids"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">iter_inventory_ids</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>source</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>precious</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>backups</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>junk</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>unrecognized</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>trees</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>directories</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>files</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>both</span>=<span class=sig-default>False</span>,
          <span class=sig-arg>limit</span>=<span class=sig-default>None</span>)</span>
  </h3>
<p>Tree inventory with file ids.</p>
  <dl><dt></dt><dd>
    <dl><dt><b>Returns:</b></dt>
      <dd>
<p>iterable of tuples <tt class="docutils literal docutils literal"><span class="pre">(id,</span> <span class="pre">item)</span></tt>, where <tt class="docutils literal docutils literal"><span class="pre">item</span></tt> is
<a href="pybaz.pathname.FileName-class.html" class="link"><code>FileName</code></a>, <a href="pybaz.pathname.DirName-class.html" class="link"><code>DirName</code></a>, <a href="pybaz.ArchSourceTree-class.html" class="link"><code>ArchSourceTree</code></a> according to the
arguments and <tt class="docutils literal docutils literal"><span class="pre">id</span></tt> is the associated inventory id.</p>
      </dd>
    </dl>
<p><b>See Also:</b> <p><a href="pybaz.ArchSourceTree-class.html#iter_inventory" class="link"><code>ArchSourceTree.iter_inventory</code></a></p>
</p>

  </dd></dl>
</td></tr></table>

<a name="iter_log_versions"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">iter_log_versions</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>limit</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>reverse</span>=<span class=sig-default>False</span>)</span>
  </h3>
<p>Iterate over versions this tree has a log-version for.</p>
  <dl><dt></dt><dd>
    <dl><dt><b>Parameters:</b></dt>
      <dd><code><b>limit</b></code> -
 <p>only iterate log-versions in this namespace.</p>
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<p><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></p>)</i>
      <dd><code><b>reverse</b></code> -
 <p>yield log-versions in reverse order.</p>
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<p>bool</p>)</i>
      </dd>
    </dl>
  </dd></dl>
</td></tr></table>

<a name="iter_logs"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">iter_logs</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>version</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>reverse</span>=<span class=sig-default>False</span>)</span>
  </h3>
<p>Iterate over patchlogs present in this tree.</p>
  <dl><dt></dt><dd>
    <dl><dt><b>Parameters:</b></dt>
      <dd><code><b>version</b></code> -
 <p>list patchlogs from this version. Defaults to
the tree-version.</p>
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<p><a href="pybaz.Version-class.html" class="link"><code>Version</code></a></p>)</i>
      <dd><code><b>reverse</b></code> -
 <p>iterate more recent logs first.</p>
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<p>bool</p>)</i>
      </dd>
    </dl>
    <dl><dt><b>Returns:</b></dt>
      <dd>
<p>patchlogs from <tt class="docutils literal"><span class="pre">version</span></tt>.</p>
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
        (type=<p>iterator of <a href="pybaz.Patchlog-class.html" class="link"><code>Patchlog</code></a>.</p>)</i>
      </dd>
    </dl>
    <dl><dt><b>Raises:</b></dt>
      <dd><code><b>errors.TreeVersionError</b></code> -
<p>no valid default version set.</p>
      <dd><code><b>IOError</b></code> -
<p>unable to read the ++default-version file.</p>
    </dl>
  </dd></dl>
</td></tr></table>
<br />


<!-- =========== START OF PROPERTY DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
  <th colspan="2">Property Details</th></tr>
</table>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>

<a name="tagging_method"></a>
<h3>tagging_method</h3>
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Get Method:</b></dt>
      <dd><span class="summary-sig"><a href="pybaz.ArchSourceTree-class.html#get_tagging_method" class="summary-sig-name"><code>get_tagging_method</code></a>(<span class=summary-sig-arg>self</span>)</span>
      </dd>
    </dl>
  </dd>
</dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>

<a name="tree_version"></a>
<h3>tree_version</h3>
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Get Method:</b></dt>
      <dd><span class="summary-sig"><a href="pybaz.ArchSourceTree-class.html#get_tree_version" class="summary-sig-name"><code>get_tree_version</code></a>(<span class=summary-sig-arg>self</span>)</span>
      </dd>
    </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 class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="pybaz-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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>