22
22
"""Weave - storage of related text file versions"""
24
# before intset (r923) 2000 versions in 41.5s
25
# with intset (r926) 2000 versions in 93s !!!
26
# better to just use plain sets.
28
# making _extract build and return a list, rather than being a generator
31
# with python -O, r923 does 2000 versions in 36.87s
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.
37
# r931, which avoids using a generator for extract, does 36.98s
39
# with memoized inclusions, takes 41.49s; not very good
41
# with slots, takes 37.35s; without takes 39.16, a bit surprising
43
# with the delta calculation mixed in with the add method, rather than
44
# separated, takes 36.78s
46
# with delta folded in and mutation of the list, 36.13s
48
# with all this and simplification of add code, 33s
54
# TODO: Perhaps have copy method for Weave instances?
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
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.
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.
53
# TODO: Probably the API should work only in names to hide the integer
54
# indexes from the user.
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
60
# TODO: Reweave can possibly be made faster by remembering diffs
61
# where the basis and destination are unchanged.
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.
84
# TODO: Perhaps the API should work only in names to hide the integer
85
# indexes from the user?
71
from difflib import SequenceMatcher
73
from bzrlib.trace import mutter
74
from bzrlib.errors import WeaveError, WeaveFormatError, WeaveParentMismatch, \
75
WeaveRevisionNotPresent, WeaveRevisionAlreadyPresent
76
from bzrlib.tsort import topo_sort
93
class WeaveError(Exception):
94
"""Exception in processing weave"""
97
class WeaveFormatError(WeaveError):
98
"""Weave invariant violated"""
79
101
class Weave(object):
80
102
"""weave - versioned text file storage.
161
183
For each name, the version number.
164
Descriptive name of this weave; typically the filename if known.
168
__slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
186
__slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map']
171
def __init__(self, weave_name=None):
173
190
self._parents = []
176
193
self._name_map = {}
177
self._weave_name = weave_name
180
return "Weave(%r)" % self._weave_name
184
"""Return a deep copy of self.
186
The copy can be modified without affecting the original weave."""
188
other._weave = self._weave[:]
189
other._parents = self._parents[:]
190
other._sha1s = self._sha1s[:]
191
other._names = self._names[:]
192
other._name_map = self._name_map.copy()
193
other._weave_name = self._weave_name
196
196
def __eq__(self, other):
197
197
if not isinstance(other, Weave):
204
204
def __ne__(self, other):
205
205
return not self.__eq__(other)
207
def __contains__(self, name):
208
return self._name_map.has_key(name)
210
def maybe_lookup(self, name_or_index):
211
"""Convert possible symbolic name to index, or pass through indexes."""
212
if isinstance(name_or_index, (int, long)):
215
return self.lookup(name_or_index)
218
208
def lookup(self, name):
219
"""Convert symbolic version name to index."""
221
210
return self._name_map[name]
223
raise WeaveRevisionNotPresent(name, self)
226
return self._names[:]
228
def iter_names(self):
229
"""Yield a list of all names in this weave."""
230
return iter(self._names)
232
def idx_to_name(self, version):
233
return self._names[version]
235
def _check_repeated_add(self, name, parents, text, sha1):
236
"""Check that a duplicated add is OK.
238
If it is, return the (old) index; otherwise raise an exception.
240
idx = self.lookup(name)
241
if sorted(self._parents[idx]) != sorted(parents) \
242
or sha1 != self._sha1s[idx]:
243
raise WeaveRevisionAlreadyPresent(name, self)
212
raise WeaveError("name %s not present in weave" % name)
246
def add(self, name, parents, text, sha1=None):
215
def add(self, name, parents, text):
247
216
"""Add a single text on top of the weave.
249
218
Returns the index number of the newly added version.
256
225
List or set of direct parent version numbers.
259
Sequence of lines to be added in the new version.
261
sha -- SHA-1 of the file, if known. This is trusted to be
264
from bzrlib.osutils import sha_strings
228
Sequence of lines to be added in the new version."""
266
230
assert isinstance(name, basestring)
268
sha1 = sha_strings(text)
269
231
if name in self._name_map:
270
return self._check_repeated_add(name, parents, text, sha1)
272
parents = map(self.maybe_lookup, parents)
232
raise WeaveError("name %r already present in weave" % name)
273
234
self._check_versions(parents)
274
235
## self._check_lines(text)
275
236
new_version = len(self._parents)
278
243
# if we abort after here the (in-memory) weave will be corrupt because only
279
244
# some fields are updated
369
335
return new_version
371
def add_identical(self, old_rev_id, new_rev_id, parents):
372
"""Add an identical text to old_rev_id as new_rev_id."""
373
old_lines = self.get(self.lookup(old_rev_id))
374
self.add(new_rev_id, parents, old_lines)
376
338
def inclusions(self, versions):
377
339
"""Return set of all ancestors of given version(s)."""
378
340
i = set(versions)
379
for v in xrange(max(versions), 0, -1):
381
# include all its parents
382
i.update(self._parents[v])
384
## except IndexError:
385
## raise ValueError("version %d not present in weave" % v)
388
def parents(self, version):
389
return self._parents[version]
392
def parent_names(self, version):
393
"""Return version names for parents of a version."""
394
return map(self.idx_to_name, self._parents[self.lookup(version)])
345
# include all its parents
346
i.update(self._parents[v])
350
raise ValueError("version %d not present in weave" % v)
397
353
def minimal_parents(self, version):
437
393
raise IndexError("invalid version number %r" % i)
440
def annotate(self, name_or_index):
441
return list(self.annotate_iter(name_or_index))
444
def annotate_iter(self, name_or_index):
396
def annotate(self, index):
397
return list(self.annotate_iter(index))
400
def annotate_iter(self, version):
445
401
"""Yield list of (index-id, line) pairs for the specified version.
447
403
The index indicates when the line originated in the weave."""
448
incls = [self.maybe_lookup(name_or_index)]
449
for origin, lineno, text in self._extract(incls):
404
for origin, lineno, text in self._extract([version]):
450
405
yield origin, text
453
409
"""Walk the weave.
537
490
result.append((istack[-1], lineno, l))
540
raise WeaveFormatError("unclosed insertion blocks "
541
"at end of weave: %s" % istack)
494
raise WFE("unclosed insertion blocks at end of weave",
543
raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
497
raise WFE("unclosed deletion blocks at end of weave",
548
def get_iter(self, name_or_index):
504
def get_iter(self, version):
549
505
"""Yield lines for the specified version."""
550
incls = [self.maybe_lookup(name_or_index)]
551
for origin, lineno, line in self._extract(incls):
506
for origin, lineno, line in self._extract([version]):
555
def get_text(self, name_or_index):
556
return ''.join(self.get_iter(name_or_index))
557
assert isinstance(version, int)
560
def get_lines(self, name_or_index):
561
return list(self.get_iter(name_or_index))
510
def get(self, index):
511
return list(self.get_iter(index))
567
514
def mash_iter(self, included):
568
515
"""Return composed version of multiple included versions."""
569
included = map(self.maybe_lookup, included)
570
516
for origin, lineno, text in self._extract(included):
760
def join(self, other):
761
"""Integrate versions from other into this weave.
763
The resulting weave contains all the history of both weaves;
764
any version you could retrieve from either self or other can be
765
retrieved from self after this call.
767
It is illegal for the two weaves to contain different values
768
or different parents for any version. See also reweave().
770
if other.numversions() == 0:
771
return # nothing to update, easy
772
# two loops so that we do not change ourselves before verifying it
774
# work through in index order to make sure we get all dependencies
775
for other_idx, name in enumerate(other._names):
776
if self._check_version_consistent(other, other_idx, name):
778
for other_idx, name in enumerate(other._names):
779
# TODO: If all the parents of the other version are already
780
# present then we can avoid some work by just taking the delta
781
# and adjusting the offsets.
782
new_parents = self._imported_parents(other, other_idx)
783
lines = other.get_lines(other_idx)
784
sha1 = other._sha1s[other_idx]
785
self.add(name, new_parents, lines, sha1)
788
def _imported_parents(self, other, other_idx):
789
"""Return list of parents in self corresponding to indexes in other."""
791
for parent_idx in other._parents[other_idx]:
792
parent_name = other._names[parent_idx]
793
if parent_name not in self._names:
794
# should not be possible
795
raise WeaveError("missing parent {%s} of {%s} in %r"
796
% (parent_name, other._name_map[other_idx], self))
797
new_parents.append(self._name_map[parent_name])
800
def _check_version_consistent(self, other, other_idx, name):
801
"""Check if a version in consistent in this and other.
803
To be consistent it must have:
806
* the same direct parents (by name, not index, and disregarding
809
If present & correct return True;
810
if not present in self return False;
811
if inconsistent raise error."""
812
this_idx = self._name_map.get(name, -1)
814
if self._sha1s[this_idx] != other._sha1s[other_idx]:
815
raise WeaveError("inconsistent texts for version {%s} "
816
"when joining weaves"
818
self_parents = self._parents[this_idx]
819
other_parents = other._parents[other_idx]
820
n1 = [self._names[i] for i in self_parents]
821
n2 = [other._names[i] for i in other_parents]
825
raise WeaveParentMismatch("inconsistent parents "
826
"for version {%s}: %s vs %s" % (name, n1, n2))
832
def reweave(self, other):
833
"""Reweave self with other."""
834
new_weave = reweave(self, other)
835
for attr in self.__slots__:
836
setattr(self, attr, getattr(new_weave, attr))
840
"""Combine two weaves and return the result.
842
This works even if a revision R has different parents in
843
wa and wb. In the resulting weave all the parents are given.
845
This is done by just building up a new weave, maintaining ordering
846
of the versions in the two inputs. More efficient approaches
847
might be possible but it should only be necessary to do
848
this operation rarely, when a new previously ghost version is
853
queue_a = range(wa.numversions())
854
queue_b = range(wb.numversions())
855
# first determine combined parents of all versions
856
# map from version name -> all parent names
857
combined_parents = _reweave_parent_graphs(wa, wb)
858
mutter("combined parents: %r", combined_parents)
859
order = topo_sort(combined_parents.iteritems())
860
mutter("order to reweave: %r", order)
862
if name in wa._name_map:
863
lines = wa.get_lines(name)
864
if name in wb._name_map:
865
assert lines == wb.get_lines(name)
867
lines = wb.get_lines(name)
868
wr.add(name, combined_parents[name], lines)
872
def _reweave_parent_graphs(wa, wb):
873
"""Return combined parent ancestry for two weaves.
875
Returned as a list of (version_name, set(parent_names))"""
877
for weave in [wa, wb]:
878
for idx, name in enumerate(weave._names):
879
p = combined.setdefault(name, set())
880
p.update(map(weave.idx_to_name, weave._parents[idx]))
884
712
def weave_toc(w):
added
removed
bzrlib/weave.py
