51
36
After bzr 0.0.5 revisions are allowed to have multiple parents.
54
List of parent revisions, each is a RevisionReference.
39
List of parent revision_ids
42
Dictionary of revision properties. These are attached to the
43
revision as extra metadata. The name must be a single
44
word; the value can be an arbitrary string.
64
def __init__(self, **args):
47
def __init__(self, revision_id, properties=None, **args):
48
self.revision_id = revision_id
49
self.properties = properties or {}
50
self._check_properties()
52
self.parent_sha1s = []
65
53
self.__dict__.update(args)
69
55
def __repr__(self):
70
56
return "<Revision id %s>" % self.revision_id
74
from bzrlib.xml import Element, SubElement
76
root = Element('revision',
77
committer = self.committer,
78
timestamp = '%.9f' % self.timestamp,
79
revision_id = self.revision_id,
80
inventory_id = self.inventory_id,
81
inventory_sha1 = self.inventory_sha1,
84
root.set('timezone', str(self.timezone))
87
msg = SubElement(root, 'message')
88
msg.text = self.message
92
pelts = SubElement(root, 'parents')
93
pelts.tail = pelts.text = '\n'
94
for rr in self.parents:
95
assert isinstance(rr, RevisionReference)
96
p = SubElement(pelts, 'revision_ref')
99
p.set('revision_id', rr.revision_id)
101
p.set('revision_sha1', rr.revision_sha1)
106
def from_element(cls, elt):
107
return unpack_revision(elt)
109
from_element = classmethod(from_element)
113
def unpack_revision(elt):
114
"""Convert XML element into Revision object."""
115
# <changeset> is deprecated...
116
from bzrlib.errors import BzrError
118
if elt.tag not in ('revision', 'changeset'):
119
raise BzrError("unexpected tag in revision file: %r" % elt)
121
rev = Revision(committer = elt.get('committer'),
122
timestamp = float(elt.get('timestamp')),
123
revision_id = elt.get('revision_id'),
124
inventory_id = elt.get('inventory_id'),
125
inventory_sha1 = elt.get('inventory_sha1')
128
precursor = elt.get('precursor')
129
precursor_sha1 = elt.get('precursor_sha1')
131
pelts = elt.find('parents')
135
assert p.tag == 'revision_ref', \
136
"bad parent node tag %r" % p.tag
137
rev_ref = RevisionReference(p.get('revision_id'),
138
p.get('revision_sha1'))
139
rev.parents.append(rev_ref)
143
prec_parent = rev.parents[0].revision_id
144
assert prec_parent == precursor
146
# revisions written prior to 0.0.5 have a single precursor
147
# give as an attribute
148
rev_ref = RevisionReference(precursor, precursor_sha1)
149
rev.parents.append(rev_ref)
151
v = elt.get('timezone')
152
rev.timezone = v and int(v)
154
rev.message = elt.findtext('message') # text of <message>
159
REVISION_ID_RE = None
161
def validate_revision_id(rid):
162
"""Check rid is syntactically valid for a revision id."""
163
global REVISION_ID_RE
164
if not REVISION_ID_RE:
166
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
168
if not REVISION_ID_RE.match(rid):
169
raise ValueError("malformed revision-id %r" % rid)
171
def is_ancestor(revision_id, candidate_id, revision_source):
58
def __eq__(self, other):
59
if not isinstance(other, Revision):
61
# FIXME: rbc 20050930 parent_ids are not being compared
63
self.inventory_sha1 == other.inventory_sha1
64
and self.revision_id == other.revision_id
65
and self.timestamp == other.timestamp
66
and self.message == other.message
67
and self.timezone == other.timezone
68
and self.committer == other.committer
69
and self.properties == other.properties)
71
def __ne__(self, other):
72
return not self.__eq__(other)
74
def _check_properties(self):
75
"""Verify that all revision properties are OK.
77
for name, value in self.properties.iteritems():
78
if not isinstance(name, basestring) or contains_whitespace(name):
79
raise ValueError("invalid property name %r" % name)
80
if not isinstance(value, basestring):
81
raise ValueError("invalid property value %r for %r" %
84
def get_history(self, repository):
85
"""Return the canonical line-of-history for this revision.
87
If ghosts are present this may differ in result from a ghost-free
90
current_revision = self
92
while current_revision is not None:
93
reversed_result.append(current_revision.revision_id)
94
if not len (current_revision.parent_ids):
95
reversed_result.append(None)
96
current_revision = None
98
next_revision_id = current_revision.parent_ids[0]
99
current_revision = repository.get_revision(next_revision_id)
100
reversed_result.reverse()
101
return reversed_result
104
def is_ancestor(revision_id, candidate_id, branch):
172
105
"""Return true if candidate_id is an ancestor of revision_id.
173
107
A false negative will be returned if any intermediate descendent of
174
108
candidate_id is not present in any of the revision_sources.
176
110
revisions_source is an object supporting a get_revision operation that
177
111
behaves like Branch's.
180
from bzrlib.branch import NoSuchRevision
113
return candidate_id in branch.repository.get_ancestry(revision_id)
116
def iter_ancestors(revision_id, revision_source, only_present=False):
181
117
ancestors = (revision_id,)
182
119
while len(ancestors) > 0:
183
120
new_ancestors = []
184
121
for ancestor in ancestors:
185
if ancestor == candidate_id:
123
yield ancestor, distance
188
125
revision = revision_source.get_revision(ancestor)
189
except NoSuchRevision, e:
126
except bzrlib.errors.NoSuchRevision, e:
190
127
if e.revision == revision_id:
194
new_ancestors.extend([p.revision_id for p in revision.parents])
132
yield ancestor, distance
133
new_ancestors.extend(revision.parent_ids)
195
134
ancestors = new_ancestors
138
def find_present_ancestors(revision_id, revision_source):
139
"""Return the ancestors of a revision present in a branch.
141
It's possible that a branch won't have the complete ancestry of
142
one of its revisions.
146
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
148
for anc_order, (anc_id, anc_distance) in anc_iter:
149
if not found_ancestors.has_key(anc_id):
150
found_ancestors[anc_id] = (anc_order, anc_distance)
151
return found_ancestors
154
def __get_closest(intersection):
157
for entry in intersection:
158
if entry[0] == intersection[0][0]:
159
matches.append(entry[2])
163
def revision_graph(revision, revision_source):
164
"""Produce a graph of the ancestry of the specified revision.
166
:return: root, ancestors map, descendants map
168
revision_source.lock_read()
170
return _revision_graph(revision, revision_source)
172
revision_source.unlock()
175
def _revision_graph(revision, revision_source):
176
"""See revision_graph."""
177
from bzrlib.tsort import topo_sort
178
graph = revision_source.get_revision_graph(revision)
179
# mark all no-parent revisions as being NULL_REVISION parentage.
180
for node, parents in graph.items():
181
if len(parents) == 0:
182
graph[node] = [NULL_REVISION]
183
# add NULL_REVISION to the graph
184
graph[NULL_REVISION] = []
186
# pick a root. If there are multiple roots
187
# this could pick a random one.
188
topo_order = topo_sort(graph.items())
194
# map the descendants of the graph.
195
# and setup our set based return graph.
196
for node in graph.keys():
197
descendants[node] = {}
198
for node, parents in graph.items():
199
for parent in parents:
200
descendants[parent][node] = 1
201
ancestors[node] = set(parents)
203
assert root not in descendants[root]
204
assert root not in ancestors[root]
205
return root, ancestors, descendants
208
def combined_graph(revision_a, revision_b, revision_source):
209
"""Produce a combined ancestry graph.
210
Return graph root, ancestors map, descendants map, set of common nodes"""
211
root, ancestors, descendants = revision_graph(
212
revision_a, revision_source)
213
root_b, ancestors_b, descendants_b = revision_graph(
214
revision_b, revision_source)
216
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
218
for node, node_anc in ancestors_b.iteritems():
219
if node in ancestors:
222
ancestors[node] = set()
223
ancestors[node].update(node_anc)
224
for node, node_dec in descendants_b.iteritems():
225
if node not in descendants:
226
descendants[node] = {}
227
descendants[node].update(node_dec)
228
return root, ancestors, descendants, common
231
def common_ancestor(revision_a, revision_b, revision_source,
233
if None in (revision_a, revision_b):
235
# trivial optimisation
236
if revision_a == revision_b:
240
pb.update('Picking ancestor', 1, 3)
241
graph = revision_source.get_revision_graph_with_ghosts(
242
[revision_a, revision_b])
243
# convert to a NULL_REVISION based graph.
244
ancestors = graph.get_ancestors()
245
descendants = graph.get_descendants()
246
common = set(graph.get_ancestry(revision_a)).intersection(
247
set(graph.get_ancestry(revision_b)))
248
descendants[NULL_REVISION] = {}
249
ancestors[NULL_REVISION] = []
250
for root in graph.roots:
251
descendants[NULL_REVISION][root] = 1
252
ancestors[root].append(NULL_REVISION)
253
if len(graph.roots) == 0:
254
# no reachable roots - not handled yet.
255
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
257
common.add(NULL_REVISION)
258
except bzrlib.errors.NoCommonRoot:
259
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
261
pb.update('Picking ancestor', 2, 3)
262
distances = node_distances (descendants, ancestors, root)
263
pb.update('Picking ancestor', 3, 2)
264
farthest = select_farthest(distances, common)
265
if farthest is None or farthest == NULL_REVISION:
266
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
198
272
class MultipleRevisionSources(object):
273
"""Proxy that looks in multiple branches for revisions."""
199
274
def __init__(self, *args):
200
275
object.__init__(self)
201
276
assert len(args) != 0
202
277
self._revision_sources = args
279
def revision_parents(self, revision_id):
280
for source in self._revision_sources:
282
return source.revision_parents(revision_id)
283
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
204
287
def get_revision(self, revision_id):
205
from bzrlib.branch import NoSuchRevision
206
288
for source in self._revision_sources:
208
290
return source.get_revision(revision_id)
209
except NoSuchRevision, e:
291
except bzrlib.errors.NoSuchRevision, e:
295
def get_revision_graph(self, revision_id):
296
# we could probe incrementally until the pending
297
# ghosts list stop growing, but its cheaper for now
298
# to just ask for the complete graph for each repository.
300
for source in self._revision_sources:
301
ghost_graph = source.get_revision_graph_with_ghosts()
302
graphs.append(ghost_graph)
305
if not revision_id in graph.get_ancestors():
307
if absent == len(graphs):
308
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
312
pending = set([revision_id])
313
def find_parents(node_id):
314
"""find the parents for node_id."""
316
ancestors = graph.get_ancestors()
318
return ancestors[node_id]
321
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
323
# all the graphs should have identical parent lists
324
node_id = pending.pop()
326
result[node_id] = find_parents(node_id)
327
for parent_node in result[node_id]:
328
if not parent_node in result:
329
pending.add(parent_node)
330
except errors.NoSuchRevision:
335
def get_revision_graph_with_ghosts(self, revision_ids):
336
# query all the sources for their entire graphs
337
# and then build a combined graph for just
340
for source in self._revision_sources:
341
ghost_graph = source.get_revision_graph_with_ghosts()
342
graphs.append(ghost_graph.get_ancestors())
343
for revision_id in revision_ids:
346
if not revision_id in graph:
348
if absent == len(graphs):
349
raise errors.NoSuchRevision(self._revision_sources[0],
354
pending = set(revision_ids)
356
def find_parents(node_id):
357
"""find the parents for node_id."""
360
return graph[node_id]
363
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
365
# all the graphs should have identical parent lists
366
node_id = pending.pop()
368
parents = find_parents(node_id)
369
for parent_node in parents:
371
if (parent_node not in pending and
372
parent_node not in done):
374
pending.add(parent_node)
375
result.add_node(node_id, parents)
377
except errors.NoSuchRevision:
379
result.add_ghost(node_id)
384
for source in self._revision_sources:
388
for source in self._revision_sources:
392
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
393
revision_history=None):
394
"""Find the longest line of descent from maybe_ancestor to revision.
395
Revision history is followed where possible.
397
If ancestor_id == rev_id, list will be empty.
398
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
399
If ancestor_id is not an ancestor, NotAncestor will be thrown
401
root, ancestors, descendants = revision_graph(rev_id, rev_source)
402
if len(descendants) == 0:
403
raise NoSuchRevision(rev_source, rev_id)
404
if ancestor_id not in descendants:
405
rev_source.get_revision(ancestor_id)
406
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
407
root_descendants = all_descendants(descendants, ancestor_id)
408
root_descendants.add(ancestor_id)
409
if rev_id not in root_descendants:
410
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
411
distances = node_distances(descendants, ancestors, ancestor_id,
412
root_descendants=root_descendants)
414
def best_ancestor(rev_id):
416
for anc_id in ancestors[rev_id]:
418
distance = distances[anc_id]
421
if revision_history is not None and anc_id in revision_history:
423
elif best is None or distance > best[1]:
424
best = (anc_id, distance)
429
while next != ancestor_id:
431
next = best_ancestor(next)
added
removed
bzrlib/revision.py
