~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: abentley
  • Date: 2005-10-16 23:56:25 UTC
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1460.
  • Revision ID: abentley@lappy-20051016235625-f2e4f5d4ff1e889c
Cleanups for pull

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
81
50
# have slight specializations for different ways its used: annotate,
82
51
# basis for add, get, etc.
83
52
 
84
 
# TODO: Perhaps the API should work only in names to hide the integer
85
 
# indexes from the user?
86
 
 
 
53
# TODO: Probably the API should work only in names to hide the integer
 
54
# indexes from the user.
 
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: Reweave can possibly be made faster by remembering diffs
 
61
# where the basis and destination are unchanged.
 
62
 
 
63
# FIXME: Sometimes we will be given a parents list for a revision
 
64
# that includes some redundant parents (i.e. already a parent of 
 
65
# something in the list.)  We should eliminate them.  This can 
 
66
# be done fairly efficiently because the sequence numbers constrain
 
67
# the possible relationships.
87
68
 
88
69
 
89
70
import sha
90
 
from cStringIO import StringIO
 
71
from difflib import SequenceMatcher
 
72
 
 
73
from bzrlib.trace import mutter
91
74
 
92
75
 
93
76
class WeaveError(Exception):
96
79
 
97
80
class WeaveFormatError(WeaveError):
98
81
    """Weave invariant violated"""
 
82
 
 
83
 
 
84
class WeaveParentMismatch(WeaveError):
 
85
    """Parents are mismatched between two revisions."""
99
86
    
100
87
 
101
88
class Weave(object):
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.
199
186
        self._weave_name = weave_name
200
187
 
201
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
 
201
 
202
202
    def __eq__(self, other):
203
203
        if not isinstance(other, Weave):
204
204
            return False
211
211
        return not self.__eq__(other)
212
212
 
213
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
        
214
222
    def lookup(self, name):
 
223
        """Convert symbolic version name to index."""
215
224
        try:
216
225
            return self._name_map[name]
217
226
        except KeyError:
218
 
            raise WeaveError("name %s not present in weave %s" %
 
227
            raise WeaveError("name %r not present in weave %r" %
219
228
                             (name, self._weave_name))
220
229
 
221
 
        
222
 
    def add(self, name, parents, text):
 
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):
223
256
        """Add a single text on top of the weave.
224
257
  
225
258
        Returns the index number of the newly added version.
232
265
            List or set of direct parent version numbers.
233
266
            
234
267
        text
235
 
            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
236
274
 
237
275
        assert isinstance(name, basestring)
 
276
        if sha1 is None:
 
277
            sha1 = sha_strings(text)
238
278
        if name in self._name_map:
239
 
            raise WeaveError("name %r already present in weave" % name)
240
 
        
 
279
            return self._check_repeated_add(name, parents, text, sha1)
 
280
 
 
281
        parents = map(self.maybe_lookup, parents)
241
282
        self._check_versions(parents)
242
283
        ## self._check_lines(text)
243
284
        new_version = len(self._parents)
244
285
 
245
 
        s = sha.new()
246
 
        map(s.update, text)
247
 
        sha1 = s.hexdigest()
248
 
        del s
249
286
 
250
287
        # if we abort after here the (in-memory) weave will be corrupt because only
251
288
        # some fields are updated
300
337
        #print 'basis_lines:', basis_lines
301
338
        #print 'new_lines:  ', lines
302
339
 
303
 
        from difflib import SequenceMatcher
304
340
        s = SequenceMatcher(None, basis_lines, text)
305
341
 
306
342
        # offset gives the number of lines that have been inserted
341
377
 
342
378
        return new_version
343
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)
344
384
 
345
385
    def inclusions(self, versions):
346
386
        """Return set of all ancestors of given version(s)."""
347
387
        i = set(versions)
348
 
        v = max(versions)
349
 
        try:
350
 
            while v >= 0:
351
 
                if v in i:
352
 
                    # include all its parents
353
 
                    i.update(self._parents[v])
354
 
                v -= 1
355
 
            return i
356
 
        except IndexError:
357
 
            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]
 
399
 
 
400
 
 
401
    def parent_names(self, version):
 
402
        """Return version names for parents of a version."""
 
403
        return map(self.idx_to_name, self._parents[self.lookup(version)])
358
404
 
359
405
 
360
406
    def minimal_parents(self, version):
400
446
                raise IndexError("invalid version number %r" % i)
401
447
 
402
448
    
403
 
    def annotate(self, index):
404
 
        return list(self.annotate_iter(index))
405
 
 
406
 
 
407
 
    def annotate_iter(self, version):
 
449
    def annotate(self, name_or_index):
 
450
        return list(self.annotate_iter(name_or_index))
 
451
 
 
452
 
 
453
    def annotate_iter(self, name_or_index):
408
454
        """Yield list of (index-id, line) pairs for the specified version.
409
455
 
410
456
        The index indicates when the line originated in the weave."""
411
 
        for origin, lineno, text in self._extract([version]):
 
457
        incls = [self.maybe_lookup(name_or_index)]
 
458
        for origin, lineno, text in self._extract(incls):
412
459
            yield origin, text
413
460
 
414
461
 
512
559
    
513
560
 
514
561
 
515
 
    def get_iter(self, version):
 
562
    def get_iter(self, name_or_index):
516
563
        """Yield lines for the specified version."""
517
 
        for origin, lineno, line in self._extract([version]):
 
564
        incls = [self.maybe_lookup(name_or_index)]
 
565
        for origin, lineno, line in self._extract(incls):
518
566
            yield line
519
567
 
520
568
 
521
 
    def get_text(self, version):
 
569
    def get_text(self, name_or_index):
 
570
        return ''.join(self.get_iter(name_or_index))
522
571
        assert isinstance(version, int)
523
 
        s = StringIO()
524
 
        s.writelines(self.get_iter(version))
525
 
        return s.getvalue()
526
 
 
527
 
 
528
 
    def get(self, index):
529
 
        return list(self.get_iter(index))
 
572
 
 
573
 
 
574
    def get_lines(self, name_or_index):
 
575
        return list(self.get_iter(name_or_index))
 
576
 
 
577
 
 
578
    get = get_lines
530
579
 
531
580
 
532
581
    def mash_iter(self, included):
533
582
        """Return composed version of multiple included versions."""
 
583
        included = map(self.maybe_lookup, included)
534
584
        for origin, lineno, text in self._extract(included):
535
585
            yield text
536
586
 
596
646
        If there is a chunk of the file where there's no diagreement,
597
647
        only one alternative is given.
598
648
        """
599
 
 
600
649
        # approach: find the included versions common to all the
601
650
        # merged versions
602
651
        raise NotImplementedError()
622
671
        If line1=line2, this is a pure insert; if newlines=[] this is a
623
672
        pure delete.  (Similar to difflib.)
624
673
        """
625
 
 
 
674
        raise NotImplementedError()
626
675
 
627
676
            
628
677
    def plan_merge(self, ver_a, ver_b):
722
771
                       state
723
772
 
724
773
                
725
 
 
726
 
 
727
 
 
 
774
    def join(self, other):
 
775
        """Integrate versions from other into this weave.
 
776
 
 
777
        The resulting weave contains all the history of both weaves; 
 
778
        any version you could retrieve from either self or other can be 
 
779
        retrieved from self after this call.
 
780
 
 
781
        It is illegal for the two weaves to contain different values 
 
782
        or different parents for any version.  See also reweave().
 
783
        """
 
784
        if other.numversions() == 0:
 
785
            return          # nothing to update, easy
 
786
        # two loops so that we do not change ourselves before verifying it
 
787
        # will be ok
 
788
        # work through in index order to make sure we get all dependencies
 
789
        for other_idx, name in enumerate(other._names):
 
790
            if self._check_version_consistent(other, other_idx, name):
 
791
                continue
 
792
        for other_idx, name in enumerate(other._names):
 
793
            # TODO: If all the parents of the other version are already 
 
794
            # present then we can avoid some work by just taking the delta
 
795
            # and adjusting the offsets.
 
796
            new_parents = self._imported_parents(other, other_idx)
 
797
            lines = other.get_lines(other_idx)
 
798
            sha1 = other._sha1s[other_idx]
 
799
            self.add(name, new_parents, lines, sha1)
 
800
 
 
801
 
 
802
    def _imported_parents(self, other, other_idx):
 
803
        """Return list of parents in self corresponding to indexes in other."""
 
804
        new_parents = []
 
805
        for parent_idx in other._parents[other_idx]:
 
806
            parent_name = other._names[parent_idx]
 
807
            if parent_name not in self._names:
 
808
                # should not be possible
 
809
                raise WeaveError("missing parent {%s} of {%s} in %r" 
 
810
                                 % (parent_name, other._name_map[other_idx], self))
 
811
            new_parents.append(self._name_map[parent_name])
 
812
        return new_parents
 
813
 
 
814
    def _check_version_consistent(self, other, other_idx, name):
 
815
        """Check if a version in consistent in this and other.
 
816
 
 
817
        To be consistent it must have:
 
818
 
 
819
         * the same text
 
820
         * the same direct parents (by name, not index, and disregarding
 
821
           order)
 
822
        
 
823
        If present & correct return True;
 
824
        if not present in self return False; 
 
825
        if inconsistent raise error."""
 
826
        this_idx = self._name_map.get(name, -1)
 
827
        if this_idx != -1:
 
828
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
 
829
                raise WeaveError("inconsistent texts for version {%s} "
 
830
                                 "when joining weaves"
 
831
                                 % (name))
 
832
            self_parents = self._parents[this_idx]
 
833
            other_parents = other._parents[other_idx]
 
834
            n1 = [self._names[i] for i in self_parents]
 
835
            n2 = [other._names[i] for i in other_parents]
 
836
            n1.sort()
 
837
            n2.sort()
 
838
            if n1 != n2:
 
839
                raise WeaveParentMismatch("inconsistent parents "
 
840
                    "for version {%s}: %s vs %s" % (name, n1, n2))
 
841
            else:
 
842
                return True         # ok!
 
843
        else:
 
844
            return False
 
845
 
 
846
    def reweave(self, other):
 
847
        """Reweave self with other."""
 
848
        new_weave = reweave(self, other)
 
849
        for attr in self.__slots__:
 
850
            setattr(self, attr, getattr(new_weave, attr))
 
851
 
 
852
 
 
853
def reweave(wa, wb):
 
854
    """Combine two weaves and return the result.
 
855
 
 
856
    This works even if a revision R has different parents in 
 
857
    wa and wb.  In the resulting weave all the parents are given.
 
858
 
 
859
    This is done by just building up a new weave, maintaining ordering 
 
860
    of the versions in the two inputs.  More efficient approaches
 
861
    might be possible but it should only be necessary to do 
 
862
    this operation rarely, when a new previously ghost version is 
 
863
    inserted.
 
864
    """
 
865
    wr = Weave()
 
866
    ia = ib = 0
 
867
    queue_a = range(wa.numversions())
 
868
    queue_b = range(wb.numversions())
 
869
    # first determine combined parents of all versions
 
870
    # map from version name -> all parent names
 
871
    combined_parents = _reweave_parent_graphs(wa, wb)
 
872
    mutter("combined parents: %r", combined_parents)
 
873
    order = _make_reweave_order(wa._names, wb._names, combined_parents)
 
874
    mutter("order to reweave: %r", order)
 
875
    for name in order:
 
876
        if name in wa._name_map:
 
877
            lines = wa.get_lines(name)
 
878
            if name in wb._name_map:
 
879
                assert lines == wb.get_lines(name)
 
880
        else:
 
881
            lines = wb.get_lines(name)
 
882
        wr.add(name, combined_parents[name], lines)
 
883
    return wr
 
884
 
 
885
 
 
886
def _reweave_parent_graphs(wa, wb):
 
887
    """Return combined parent ancestry for two weaves.
 
888
    
 
889
    Returned as a list of (version_name, set(parent_names))"""
 
890
    combined = {}
 
891
    for weave in [wa, wb]:
 
892
        for idx, name in enumerate(weave._names):
 
893
            p = combined.setdefault(name, set())
 
894
            p.update(map(weave.idx_to_name, weave._parents[idx]))
 
895
    return combined
 
896
 
 
897
 
 
898
def _make_reweave_order(wa_order, wb_order, combined_parents):
 
899
    """Return an order to reweave versions respecting parents."""
 
900
    done = set()
 
901
    result = []
 
902
    ia = ib = 0
 
903
    next_a = next_b = None
 
904
    len_a = len(wa_order)
 
905
    len_b = len(wb_order)
 
906
    while ia < len(wa_order) or ib < len(wb_order):
 
907
        if ia < len_a:
 
908
            next_a = wa_order[ia]
 
909
            if next_a in done:
 
910
                ia += 1
 
911
                continue
 
912
            if combined_parents[next_a].issubset(done):
 
913
                ia += 1
 
914
                result.append(next_a)
 
915
                done.add(next_a)
 
916
                continue
 
917
        if ib < len_b:
 
918
            next_b = wb_order[ib]
 
919
            if next_b in done:
 
920
                ib += 1
 
921
                continue
 
922
            elif combined_parents[next_b].issubset(done):
 
923
                ib += 1
 
924
                result.append(next_b)
 
925
                done.add(next_b)
 
926
                continue
 
927
        raise WeaveError("don't know how to reweave at {%s} and {%s}"
 
928
                         % (next_a, next_b))
 
929
    return result
728
930
 
729
931
 
730
932
def weave_toc(w):
741
943
 
742
944
 
743
945
 
744
 
def weave_stats(weave_file):
745
 
    from bzrlib.progress import ProgressBar
 
946
def weave_stats(weave_file, pb):
746
947
    from bzrlib.weavefile import read_weave
747
948
 
748
 
    pb = ProgressBar()
749
 
 
750
949
    wf = file(weave_file, 'rb')
751
950
    w = read_weave(wf)
752
951
    # FIXME: doesn't work on pipes
756
955
    vers = len(w)
757
956
    for i in range(vers):
758
957
        pb.update('checking sizes', i, vers)
759
 
        for line in w.get_iter(i):
 
958
        for origin, lineno, line in w._extract([i]):
760
959
            total += len(line)
761
960
 
762
961
    pb.clear()
793
992
        Display composite of all selected versions.
794
993
    weave merge WEAVEFILE VERSION1 VERSION2 > OUT
795
994
        Auto-merge two versions and display conflicts.
 
995
    weave diff WEAVEFILE VERSION1 VERSION2 
 
996
        Show differences between two versions.
796
997
 
797
998
example:
798
999
 
823
1024
def main(argv):
824
1025
    import sys
825
1026
    import os
826
 
    from weavefile import write_weave, read_weave
 
1027
    try:
 
1028
        import bzrlib
 
1029
    except ImportError:
 
1030
        # in case we're run directly from the subdirectory
 
1031
        sys.path.append('..')
 
1032
        import bzrlib
 
1033
    from bzrlib.weavefile import write_weave, read_weave
827
1034
    from bzrlib.progress import ProgressBar
828
1035
 
829
1036
    try:
866
1073
        w = readit()
867
1074
        sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
868
1075
 
 
1076
    elif cmd == 'diff':
 
1077
        from difflib import unified_diff
 
1078
        w = readit()
 
1079
        fn = argv[2]
 
1080
        v1, v2 = map(int, argv[3:5])
 
1081
        lines1 = w.get(v1)
 
1082
        lines2 = w.get(v2)
 
1083
        diff_gen = unified_diff(lines1, lines2,
 
1084
                                '%s version %d' % (fn, v1),
 
1085
                                '%s version %d' % (fn, v2))
 
1086
        sys.stdout.writelines(diff_gen)
 
1087
            
869
1088
    elif cmd == 'annotate':
870
1089
        w = readit()
871
1090
        # newline is added to all lines regardless; too hard to get
883
1102
        weave_toc(readit())
884
1103
 
885
1104
    elif cmd == 'stats':
886
 
        weave_stats(argv[2])
 
1105
        weave_stats(argv[2], ProgressBar())
887
1106
        
888
1107
    elif cmd == 'check':
889
1108
        w = readit()