~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

Merge in format-5 work - release bzr 0.1rc1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
21
21
 
22
22
"""Weave - storage of related text file versions"""
23
23
 
24
 
# before intset (r923) 2000 versions in 41.5s
25
 
# with intset (r926) 2000 versions in 93s !!!
26
 
# better to just use plain sets.
27
 
 
28
 
# making _extract build and return a list, rather than being a generator
29
 
# takes 37.94s
30
 
 
31
 
# with python -O, r923 does 2000 versions in 36.87s
32
 
 
33
 
# with optimizations to avoid mutating lists - 35.75!  I guess copying
34
 
# all the elements every time costs more than the small manipulations.
35
 
# a surprisingly small change.
36
 
 
37
 
# r931, which avoids using a generator for extract, does 36.98s
38
 
 
39
 
# with memoized inclusions, takes 41.49s; not very good
40
 
 
41
 
# with slots, takes 37.35s; without takes 39.16, a bit surprising
42
 
 
43
 
# with the delta calculation mixed in with the add method, rather than
44
 
# separated, takes 36.78s
45
 
 
46
 
# with delta folded in and mutation of the list, 36.13s
47
 
 
48
 
# with all this and simplification of add code, 33s
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
# TODO: Perhaps have copy method for Weave instances?
55
24
 
56
25
# XXX: If we do weaves this way, will a merge still behave the same
57
26
# way if it's done in a different order?  That's a pretty desirable
74
43
 
75
44
# TODO: Parallel-extract that passes back each line along with a
76
45
# description of which revisions include it.  Nice for checking all
77
 
# shas in parallel.
 
46
# shas or calculating stats in parallel.
78
47
 
79
48
# TODO: Using a single _extract routine and then processing the output
80
49
# is probably inefficient.  It's simple enough that we can afford to
84
53
# TODO: Perhaps the API should work only in names to hide the integer
85
54
# indexes from the user?
86
55
 
 
56
# TODO: Is there any potential performance win by having an add()
 
57
# variant that is passed a pre-cooked version of the single basis
 
58
# version?
 
59
 
 
60
# TODO: Have a way to go back and insert a revision V1 that is a parent 
 
61
# of an already-stored revision V2.  This means some lines previously 
 
62
# counted as new in V2 will be discovered to have actually come from V1.  
 
63
# It is probably necessary to insert V1, then compute a whole new diff 
 
64
# from the mashed ancestors to V2.  This must be repeated for every 
 
65
# direct child of V1.  The deltas from V2 to its descendents won't change,
 
66
# although their location within the weave may change.  It may be possible
 
67
# to just adjust the location of those instructions rather than 
 
68
# re-weaving the whole thing.  This is expected to be a fairly rare
 
69
# operation, only used when inserting data that was previously a ghost.
 
70
 
 
71
 
87
72
 
88
73
 
89
74
import sha
 
75
from difflib import SequenceMatcher
 
76
 
90
77
 
91
78
 
92
79
 
113
100
 
114
101
    * a nonnegative index number.
115
102
 
116
 
    * a version-id string. (not implemented yet)
 
103
    * a version-id string.
117
104
 
118
105
    Typically the index number will be valid only inside this weave and
119
106
    the version-id is used to reference it in the larger world.
181
168
 
182
169
    _name_map
183
170
        For each name, the version number.
 
171
 
 
172
    _weave_name
 
173
        Descriptive name of this weave; typically the filename if known.
 
174
        Set by read_weave.
184
175
    """
185
176
 
186
 
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map']
 
177
    __slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
 
178
                 '_weave_name']
187
179
    
188
 
    def __init__(self):
 
180
    def __init__(self, weave_name=None):
189
181
        self._weave = []
190
182
        self._parents = []
191
183
        self._sha1s = []
192
184
        self._names = []
193
185
        self._name_map = {}
194
 
 
 
186
        self._weave_name = weave_name
 
187
 
 
188
 
 
189
    def copy(self):
 
190
        """Return a deep copy of self.
 
191
        
 
192
        The copy can be modified without affecting the original weave."""
 
193
        other = Weave()
 
194
        other._weave = self._weave[:]
 
195
        other._parents = self._parents[:]
 
196
        other._sha1s = self._sha1s[:]
 
197
        other._names = self._names[:]
 
198
        other._name_map = self._name_map.copy()
 
199
        other._weave_name = self._weave_name
 
200
        return other
195
201
 
196
202
    def __eq__(self, other):
197
203
        if not isinstance(other, Weave):
205
211
        return not self.__eq__(other)
206
212
 
207
213
 
 
214
    def maybe_lookup(self, name_or_index):
 
215
        """Convert possible symbolic name to index, or pass through indexes."""
 
216
        if isinstance(name_or_index, (int, long)):
 
217
            return name_or_index
 
218
        else:
 
219
            return self.lookup(name_or_index)
 
220
 
 
221
        
208
222
    def lookup(self, name):
 
223
        """Convert symbolic version name to index."""
209
224
        try:
210
225
            return self._name_map[name]
211
226
        except KeyError:
212
 
            raise WeaveError("name %s not present in weave" % name)
213
 
 
214
 
        
215
 
    def add(self, name, parents, text):
 
227
            raise WeaveError("name %r not present in weave %r" %
 
228
                             (name, self._weave_name))
 
229
 
 
230
 
 
231
    def iter_names(self):
 
232
        """Yield a list of all names in this weave."""
 
233
        return iter(self._names)
 
234
 
 
235
    def idx_to_name(self, version):
 
236
        return self._names[version]
 
237
 
 
238
 
 
239
    def _check_repeated_add(self, name, parents, text, sha1):
 
240
        """Check that a duplicated add is OK.
 
241
 
 
242
        If it is, return the (old) index; otherwise raise an exception.
 
243
        """
 
244
        idx = self.lookup(name)
 
245
        if sorted(self._parents[idx]) != sorted(parents):
 
246
            raise WeaveError("name \"%s\" already present in weave "
 
247
                             "with different parents" % name)
 
248
        if sha1 != self._sha1s[idx]:
 
249
            raise WeaveError("name \"%s\" already present in weave "
 
250
                             "with different text" % name)            
 
251
        return idx
 
252
        
 
253
 
 
254
        
 
255
    def add(self, name, parents, text, sha1=None):
216
256
        """Add a single text on top of the weave.
217
257
  
218
258
        Returns the index number of the newly added version.
225
265
            List or set of direct parent version numbers.
226
266
            
227
267
        text
228
 
            Sequence of lines to be added in the new version."""
 
268
            Sequence of lines to be added in the new version.
 
269
 
 
270
        sha -- SHA-1 of the file, if known.  This is trusted to be
 
271
            correct if supplied.
 
272
        """
 
273
        from bzrlib.osutils import sha_strings
229
274
 
230
275
        assert isinstance(name, basestring)
 
276
        if sha1 is None:
 
277
            sha1 = sha_strings(text)
231
278
        if name in self._name_map:
232
 
            raise WeaveError("name %r already present in weave" % name)
233
 
        
 
279
            return self._check_repeated_add(name, parents, text, sha1)
 
280
 
 
281
        parents = map(self.maybe_lookup, parents)
234
282
        self._check_versions(parents)
235
283
        ## self._check_lines(text)
236
284
        new_version = len(self._parents)
237
285
 
238
 
        s = sha.new()
239
 
        map(s.update, text)
240
 
        sha1 = s.hexdigest()
241
 
        del s
242
286
 
243
287
        # if we abort after here the (in-memory) weave will be corrupt because only
244
288
        # some fields are updated
293
337
        #print 'basis_lines:', basis_lines
294
338
        #print 'new_lines:  ', lines
295
339
 
296
 
        from difflib import SequenceMatcher
297
340
        s = SequenceMatcher(None, basis_lines, text)
298
341
 
299
342
        # offset gives the number of lines that have been inserted
334
377
 
335
378
        return new_version
336
379
 
 
380
    def add_identical(self, old_rev_id, new_rev_id, parents):
 
381
        """Add an identical text to old_rev_id as new_rev_id."""
 
382
        old_lines = self.get(self.lookup(old_rev_id))
 
383
        self.add(new_rev_id, parents, old_lines)
337
384
 
338
385
    def inclusions(self, versions):
339
386
        """Return set of all ancestors of given version(s)."""
340
387
        i = set(versions)
341
 
        v = max(versions)
342
 
        try:
343
 
            while v >= 0:
344
 
                if v in i:
345
 
                    # include all its parents
346
 
                    i.update(self._parents[v])
347
 
                v -= 1
348
 
            return i
349
 
        except IndexError:
350
 
            raise ValueError("version %d not present in weave" % v)
 
388
        for v in xrange(max(versions), 0, -1):
 
389
            if v in i:
 
390
                # include all its parents
 
391
                i.update(self._parents[v])
 
392
        return i
 
393
        ## except IndexError:
 
394
        ##     raise ValueError("version %d not present in weave" % v)
 
395
 
 
396
 
 
397
    def parents(self, version):
 
398
        return self._parents[version]
351
399
 
352
400
 
353
401
    def minimal_parents(self, version):
393
441
                raise IndexError("invalid version number %r" % i)
394
442
 
395
443
    
396
 
    def annotate(self, index):
397
 
        return list(self.annotate_iter(index))
398
 
 
399
 
 
400
 
    def annotate_iter(self, version):
 
444
    def annotate(self, name_or_index):
 
445
        return list(self.annotate_iter(name_or_index))
 
446
 
 
447
 
 
448
    def annotate_iter(self, name_or_index):
401
449
        """Yield list of (index-id, line) pairs for the specified version.
402
450
 
403
451
        The index indicates when the line originated in the weave."""
404
 
        for origin, lineno, text in self._extract([version]):
 
452
        incls = [self.maybe_lookup(name_or_index)]
 
453
        for origin, lineno, text in self._extract(incls):
405
454
            yield origin, text
406
455
 
407
456
 
451
500
 
452
501
        The set typically but not necessarily corresponds to a version.
453
502
        """
 
503
        for i in versions:
 
504
            if not isinstance(i, int):
 
505
                raise ValueError(i)
 
506
            
454
507
        included = self.inclusions(versions)
455
508
 
456
509
        istack = []
501
554
    
502
555
 
503
556
 
504
 
    def get_iter(self, version):
 
557
    def get_iter(self, name_or_index):
505
558
        """Yield lines for the specified version."""
506
 
        for origin, lineno, line in self._extract([version]):
 
559
        incls = [self.maybe_lookup(name_or_index)]
 
560
        for origin, lineno, line in self._extract(incls):
507
561
            yield line
508
562
 
509
563
 
510
 
    def get(self, index):
511
 
        return list(self.get_iter(index))
 
564
    def get_text(self, name_or_index):
 
565
        return ''.join(self.get_iter(name_or_index))
 
566
        assert isinstance(version, int)
 
567
 
 
568
 
 
569
    def get_lines(self, name_or_index):
 
570
        return list(self.get_iter(name_or_index))
 
571
 
 
572
 
 
573
    get = get_lines
512
574
 
513
575
 
514
576
    def mash_iter(self, included):
515
577
        """Return composed version of multiple included versions."""
 
578
        included = map(self.maybe_lookup, included)
516
579
        for origin, lineno, text in self._extract(included):
517
580
            yield text
518
581
 
578
641
        If there is a chunk of the file where there's no diagreement,
579
642
        only one alternative is given.
580
643
        """
581
 
 
582
644
        # approach: find the included versions common to all the
583
645
        # merged versions
584
646
        raise NotImplementedError()
604
666
        If line1=line2, this is a pure insert; if newlines=[] this is a
605
667
        pure delete.  (Similar to difflib.)
606
668
        """
607
 
 
 
669
        raise NotImplementedError()
608
670
 
609
671
            
610
672
    def plan_merge(self, ver_a, ver_b):
704
766
                       state
705
767
 
706
768
                
707
 
 
708
 
 
709
 
 
 
769
    def join(self, other):
 
770
        """Integrate versions from other into this weave.
 
771
 
 
772
        The resulting weave contains all the history of both weaves; 
 
773
        any version you could retrieve from either self or other can be 
 
774
        retrieved from self after this call.
 
775
 
 
776
        It is illegal for the two weaves to contain different values 
 
777
        for any version.
 
778
        """
 
779
        if other.numversions() == 0:
 
780
            return          # nothing to update, easy
 
781
        # work through in index order to make sure we get all dependencies
 
782
        for other_idx, name in enumerate(other._names):
 
783
            # TODO: If all the parents of the other version are already 
 
784
            # present then we can avoid some work by just taking the delta
 
785
            # and adjusting the offsets.
 
786
            if self._check_version_consistent(other, other_idx, name):
 
787
                continue
 
788
            new_parents = self._imported_parents(other, other_idx)
 
789
            lines = other.get_lines(other_idx)
 
790
            sha1 = other._sha1s[other_idx]
 
791
            self.add(name, new_parents, lines, sha1)
 
792
 
 
793
 
 
794
    def _imported_parents(self, other, other_idx):
 
795
        """Return list of parents in self corresponding to indexes in other."""
 
796
        new_parents = []
 
797
        for parent_idx in other._parents[other_idx]:
 
798
            parent_name = other._names[parent_idx]
 
799
            if parent_name not in self._names:
 
800
                # should not be possible
 
801
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
802
                                 % (parent_name, other._name_map[other_idx], self))
 
803
            new_parents.append(self._name_map[parent_name])
 
804
        return new_parents
 
805
 
 
806
    def _check_version_consistent(self, other, other_idx, name):
 
807
        """Check if a version in consistent in this and other.
 
808
 
 
809
        To be consistent it must have:
 
810
 
 
811
         * the same text
 
812
         * the same direct parents (by name, not index, and disregarding
 
813
           order)
 
814
        
 
815
        If present & correct return True;
 
816
        if not present in self return False; 
 
817
        if inconsistent raise error."""
 
818
        this_idx = self._name_map.get(name, -1)
 
819
        if this_idx != -1:
 
820
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
821
                raise WeaveError("inconsistent texts for version {%s} "
 
822
                                 "when joining weaves"
 
823
                                 % (name))
 
824
            self_parents = self._parents[this_idx]
 
825
            other_parents = other._parents[other_idx]
 
826
            n1 = [self._names[i] for i in self_parents]
 
827
            n2 = [other._names[i] for i in other_parents]
 
828
            n1.sort()
 
829
            n2.sort()
 
830
            if n1 != n2:
 
831
                raise WeaveError("inconsistent parents for version {%s}: "
 
832
                                 "%s vs %s"
 
833
                                 % (name, n1, n2))
 
834
            else:
 
835
                return True         # ok!
 
836
        else:
 
837
            return False
710
838
 
711
839
 
712
840
def weave_toc(w):
723
851
 
724
852
 
725
853
 
726
 
def weave_stats(weave_file):
727
 
    from bzrlib.progress import ProgressBar
 
854
def weave_stats(weave_file, pb):
728
855
    from bzrlib.weavefile import read_weave
729
856
 
730
 
    pb = ProgressBar()
731
 
 
732
857
    wf = file(weave_file, 'rb')
733
858
    w = read_weave(wf)
734
859
    # FIXME: doesn't work on pipes
738
863
    vers = len(w)
739
864
    for i in range(vers):
740
865
        pb.update('checking sizes', i, vers)
741
 
        for line in w.get_iter(i):
 
866
        for origin, lineno, line in w._extract([i]):
742
867
            total += len(line)
743
868
 
744
869
    pb.clear()
775
900
        Display composite of all selected versions.
776
901
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
777
902
        Auto-merge two versions and display conflicts.
 
903
    weave diff WEAVEFILE VERSION1 VERSION2 
 
904
        Show differences between two versions.
778
905
 
779
906
example:
780
907
 
805
932
def main(argv):
806
933
    import sys
807
934
    import os
808
 
    from weavefile import write_weave, read_weave
 
935
    try:
 
936
        import bzrlib
 
937
    except ImportError:
 
938
        # in case we're run directly from the subdirectory
 
939
        sys.path.append('..')
 
940
        import bzrlib
 
941
    from bzrlib.weavefile import write_weave, read_weave
809
942
    from bzrlib.progress import ProgressBar
810
943
 
811
944
    try:
848
981
        w = readit()
849
982
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
850
983
 
 
984
    elif cmd == 'diff':
 
985
        from difflib import unified_diff
 
986
        w = readit()
 
987
        fn = argv[2]
 
988
        v1, v2 = map(int, argv[3:5])
 
989
        lines1 = w.get(v1)
 
990
        lines2 = w.get(v2)
 
991
        diff_gen = unified_diff(lines1, lines2,
 
992
                                '%s version %d' % (fn, v1),
 
993
                                '%s version %d' % (fn, v2))
 
994
        sys.stdout.writelines(diff_gen)
 
995
            
851
996
    elif cmd == 'annotate':
852
997
        w = readit()
853
998
        # newline is added to all lines regardless; too hard to get
865
1010
        weave_toc(readit())
866
1011
 
867
1012
    elif cmd == 'stats':
868
 
        weave_stats(argv[2])
 
1013
        weave_stats(argv[2], ProgressBar())
869
1014
        
870
1015
    elif cmd == 'check':
871
1016
        w = readit()