~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weave.py

  • Committer: Aaron Bentley
  • Date: 2005-10-04 04:32:32 UTC
  • mfrom: (1185.12.6)
  • mto: (1185.12.13)
  • mto: This revision was merged to the branch mainline in revision 1419.
  • Revision ID: aaron.bentley@utoronto.ca-20051004043231-40302a149769263b
merged my own changes

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?
24
55
 
25
56
# XXX: If we do weaves this way, will a merge still behave the same
26
57
# way if it's done in a different order?  That's a pretty desirable
43
74
 
44
75
# TODO: Parallel-extract that passes back each line along with a
45
76
# description of which revisions include it.  Nice for checking all
46
 
# shas or calculating stats in parallel.
 
77
# shas in parallel.
47
78
 
48
79
# TODO: Using a single _extract routine and then processing the output
49
80
# is probably inefficient.  It's simple enough that we can afford to
50
81
# have slight specializations for different ways its used: annotate,
51
82
# basis for add, get, etc.
52
83
 
53
 
# TODO: Probably the API should work only in names to hide the integer
54
 
# indexes from the user.
 
84
# TODO: Perhaps the API should work only in names to hide the integer
 
85
# indexes from the user?
55
86
 
56
87
# TODO: Is there any potential performance win by having an add()
57
88
# variant that is passed a pre-cooked version of the single basis
58
89
# version?
59
90
 
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.
68
91
 
69
92
 
70
93
import sha
71
94
from difflib import SequenceMatcher
72
95
 
73
 
from bzrlib.trace import mutter
74
 
from bzrlib.errors import WeaveError, WeaveFormatError, WeaveParentMismatch, \
75
 
        WeaveRevisionNotPresent, WeaveRevisionAlreadyPresent
76
 
from bzrlib.tsort import topo_sort
77
 
 
 
96
 
 
97
 
 
98
 
 
99
class WeaveError(Exception):
 
100
    """Exception in processing weave"""
 
101
 
 
102
 
 
103
class WeaveFormatError(WeaveError):
 
104
    """Weave invariant violated"""
 
105
    
78
106
 
79
107
class Weave(object):
80
108
    """weave - versioned text file storage.
177
205
        self._weave_name = weave_name
178
206
 
179
207
 
180
 
    def copy(self):
181
 
        """Return a deep copy of self.
182
 
        
183
 
        The copy can be modified without affecting the original weave."""
184
 
        other = Weave()
185
 
        other._weave = self._weave[:]
186
 
        other._parents = self._parents[:]
187
 
        other._sha1s = self._sha1s[:]
188
 
        other._names = self._names[:]
189
 
        other._name_map = self._name_map.copy()
190
 
        other._weave_name = self._weave_name
191
 
        return other
192
 
 
193
208
    def __eq__(self, other):
194
209
        if not isinstance(other, Weave):
195
210
            return False
201
216
    def __ne__(self, other):
202
217
        return not self.__eq__(other)
203
218
 
204
 
    def __contains__(self, name):
205
 
        return self._name_map.has_key(name)
206
219
 
207
220
    def maybe_lookup(self, name_or_index):
208
221
        """Convert possible symbolic name to index, or pass through indexes."""
217
230
        try:
218
231
            return self._name_map[name]
219
232
        except KeyError:
220
 
            raise WeaveRevisionNotPresent(name, self)
221
 
 
222
 
    def names(self):
223
 
        return self._names[:]
224
 
 
225
 
    def iter_names(self):
226
 
        """Yield a list of all names in this weave."""
227
 
        return iter(self._names)
 
233
            raise WeaveError("name %r not present in weave %r" %
 
234
                             (name, self._weave_name))
 
235
 
228
236
 
229
237
    def idx_to_name(self, version):
230
238
        return self._names[version]
231
239
 
 
240
 
232
241
    def _check_repeated_add(self, name, parents, text, sha1):
233
242
        """Check that a duplicated add is OK.
234
243
 
235
244
        If it is, return the (old) index; otherwise raise an exception.
236
245
        """
237
246
        idx = self.lookup(name)
238
 
        if sorted(self._parents[idx]) != sorted(parents) \
239
 
            or sha1 != self._sha1s[idx]:
240
 
            raise WeaveRevisionAlreadyPresent(name, self)
 
247
        if sorted(self._parents[idx]) != sorted(parents):
 
248
            raise WeaveError("name \"%s\" already present in weave "
 
249
                             "with different parents" % name)
 
250
        if sha1 != self._sha1s[idx]:
 
251
            raise WeaveError("name \"%s\" already present in weave "
 
252
                             "with different text" % name)            
241
253
        return idx
242
254
        
 
255
 
 
256
        
243
257
    def add(self, name, parents, text, sha1=None):
244
258
        """Add a single text on top of the weave.
245
259
  
386
400
        return self._parents[version]
387
401
 
388
402
 
389
 
    def parent_names(self, version):
390
 
        """Return version names for parents of a version."""
391
 
        return map(self.idx_to_name, self._parents[self.lookup(version)])
392
 
 
393
 
 
394
403
    def minimal_parents(self, version):
395
404
        """Find the minimal set of parents for the version."""
396
405
        included = self._parents[version]
446
455
        for origin, lineno, text in self._extract(incls):
447
456
            yield origin, text
448
457
 
 
458
 
449
459
    def _walk(self):
450
460
        """Walk the weave.
451
461
 
473
483
                elif c == ']':
474
484
                    dset.remove(v)
475
485
                else:
476
 
                    raise WeaveFormatError('unexpected instruction %r' % v)
 
486
                    raise WeaveFormatError('unexpected instruction %r'
 
487
                                           % v)
477
488
            else:
478
489
                assert isinstance(l, basestring)
479
490
                assert istack
533
544
                if isactive:
534
545
                    result.append((istack[-1], lineno, l))
535
546
            lineno += 1
 
547
 
536
548
        if istack:
537
 
            raise WeaveFormatError("unclosed insertion blocks "
538
 
                    "at end of weave: %s" % istack)
 
549
            raise WFE("unclosed insertion blocks at end of weave",
 
550
                                   istack)
539
551
        if dset:
540
 
            raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
541
 
                                   % dset)
 
552
            raise WFE("unclosed deletion blocks at end of weave",
 
553
                                   dset)
 
554
 
542
555
        return result
 
556
    
543
557
 
544
558
 
545
559
    def get_iter(self, name_or_index):
629
643
        If there is a chunk of the file where there's no diagreement,
630
644
        only one alternative is given.
631
645
        """
 
646
 
632
647
        # approach: find the included versions common to all the
633
648
        # merged versions
634
649
        raise NotImplementedError()
654
669
        If line1=line2, this is a pure insert; if newlines=[] this is a
655
670
        pure delete.  (Similar to difflib.)
656
671
        """
657
 
        raise NotImplementedError()
 
672
 
658
673
 
659
674
            
660
675
    def plan_merge(self, ver_a, ver_b):
723
738
                elif lines_a == lines_b:
724
739
                    for l in lines_a: yield l
725
740
                else:
726
 
                    yield '<<<<<<<\n'
 
741
                    yield '<<<<\n'
727
742
                    for l in lines_a: yield l
728
 
                    yield '=======\n'
 
743
                    yield '====\n'
729
744
                    for l in lines_b: yield l
730
 
                    yield '>>>>>>>\n'
 
745
                    yield '>>>>\n'
731
746
 
732
747
                del lines_a[:]
733
748
                del lines_b[:]
754
769
                       state
755
770
 
756
771
                
757
 
    def join(self, other):
758
 
        """Integrate versions from other into this weave.
759
 
 
760
 
        The resulting weave contains all the history of both weaves; 
761
 
        any version you could retrieve from either self or other can be 
762
 
        retrieved from self after this call.
763
 
 
764
 
        It is illegal for the two weaves to contain different values 
765
 
        or different parents for any version.  See also reweave().
766
 
        """
767
 
        if other.numversions() == 0:
768
 
            return          # nothing to update, easy
769
 
        # two loops so that we do not change ourselves before verifying it
770
 
        # will be ok
771
 
        # work through in index order to make sure we get all dependencies
772
 
        for other_idx, name in enumerate(other._names):
773
 
            if self._check_version_consistent(other, other_idx, name):
774
 
                continue
775
 
        for other_idx, name in enumerate(other._names):
776
 
            # TODO: If all the parents of the other version are already 
777
 
            # present then we can avoid some work by just taking the delta
778
 
            # and adjusting the offsets.
779
 
            new_parents = self._imported_parents(other, other_idx)
780
 
            lines = other.get_lines(other_idx)
781
 
            sha1 = other._sha1s[other_idx]
782
 
            self.add(name, new_parents, lines, sha1)
783
 
 
784
 
 
785
 
    def _imported_parents(self, other, other_idx):
786
 
        """Return list of parents in self corresponding to indexes in other."""
787
 
        new_parents = []
788
 
        for parent_idx in other._parents[other_idx]:
789
 
            parent_name = other._names[parent_idx]
790
 
            if parent_name not in self._names:
791
 
                # should not be possible
792
 
                raise WeaveError("missing parent {%s} of {%s} in %r" 
793
 
                                 % (parent_name, other._name_map[other_idx], self))
794
 
            new_parents.append(self._name_map[parent_name])
795
 
        return new_parents
796
 
 
797
 
    def _check_version_consistent(self, other, other_idx, name):
798
 
        """Check if a version in consistent in this and other.
799
 
 
800
 
        To be consistent it must have:
801
 
 
802
 
         * the same text
803
 
         * the same direct parents (by name, not index, and disregarding
804
 
           order)
805
 
        
806
 
        If present & correct return True;
807
 
        if not present in self return False; 
808
 
        if inconsistent raise error."""
809
 
        this_idx = self._name_map.get(name, -1)
810
 
        if this_idx != -1:
811
 
            if self._sha1s[this_idx] != other._sha1s[other_idx]:
812
 
                raise WeaveError("inconsistent texts for version {%s} "
813
 
                                 "when joining weaves"
814
 
                                 % (name))
815
 
            self_parents = self._parents[this_idx]
816
 
            other_parents = other._parents[other_idx]
817
 
            n1 = [self._names[i] for i in self_parents]
818
 
            n2 = [other._names[i] for i in other_parents]
819
 
            n1.sort()
820
 
            n2.sort()
821
 
            if n1 != n2:
822
 
                raise WeaveParentMismatch("inconsistent parents "
823
 
                    "for version {%s}: %s vs %s" % (name, n1, n2))
824
 
            else:
825
 
                return True         # ok!
826
 
        else:
827
 
            return False
828
 
 
829
 
    def reweave(self, other):
830
 
        """Reweave self with other."""
831
 
        new_weave = reweave(self, other)
832
 
        for attr in self.__slots__:
833
 
            setattr(self, attr, getattr(new_weave, attr))
834
 
 
835
 
 
836
 
def reweave(wa, wb):
837
 
    """Combine two weaves and return the result.
838
 
 
839
 
    This works even if a revision R has different parents in 
840
 
    wa and wb.  In the resulting weave all the parents are given.
841
 
 
842
 
    This is done by just building up a new weave, maintaining ordering 
843
 
    of the versions in the two inputs.  More efficient approaches
844
 
    might be possible but it should only be necessary to do 
845
 
    this operation rarely, when a new previously ghost version is 
846
 
    inserted.
847
 
    """
848
 
    wr = Weave()
849
 
    ia = ib = 0
850
 
    queue_a = range(wa.numversions())
851
 
    queue_b = range(wb.numversions())
852
 
    # first determine combined parents of all versions
853
 
    # map from version name -> all parent names
854
 
    combined_parents = _reweave_parent_graphs(wa, wb)
855
 
    mutter("combined parents: %r", combined_parents)
856
 
    order = topo_sort(combined_parents.iteritems())
857
 
    mutter("order to reweave: %r", order)
858
 
    for name in order:
859
 
        if name in wa._name_map:
860
 
            lines = wa.get_lines(name)
861
 
            if name in wb._name_map:
862
 
                assert lines == wb.get_lines(name)
863
 
        else:
864
 
            lines = wb.get_lines(name)
865
 
        wr.add(name, combined_parents[name], lines)
866
 
    return wr
867
 
 
868
 
 
869
 
def _reweave_parent_graphs(wa, wb):
870
 
    """Return combined parent ancestry for two weaves.
871
 
    
872
 
    Returned as a list of (version_name, set(parent_names))"""
873
 
    combined = {}
874
 
    for weave in [wa, wb]:
875
 
        for idx, name in enumerate(weave._names):
876
 
            p = combined.setdefault(name, set())
877
 
            p.update(map(weave.idx_to_name, weave._parents[idx]))
878
 
    return combined
 
772
 
 
773
 
 
774
 
879
775
 
880
776
 
881
777
def weave_toc(w):
904
800
    vers = len(w)
905
801
    for i in range(vers):
906
802
        pb.update('checking sizes', i, vers)
907
 
        for origin, lineno, line in w._extract([i]):
 
803
        for line in w.get_iter(i):
908
804
            total += len(line)
909
805
 
910
806
    pb.clear()