40
52
After bzr 0.0.5 revisions are allowed to have multiple parents.
43
List of parent revision_ids
46
Dictionary of revision properties. These are attached to the
47
revision as extra metadata. The name must be a single
48
word; the value can be an arbitrary string.
55
List of parent revisions, each is a RevisionReference.
51
def __init__(self, revision_id, properties=None, **args):
52
self.revision_id = revision_id
53
self.properties = properties or {}
54
self._check_properties()
56
self.parent_sha1s = []
57
"""Not used anymore - legacy from for 4."""
65
def __init__(self, **args):
58
66
self.__dict__.update(args)
60
70
def __repr__(self):
61
71
return "<Revision id %s>" % self.revision_id
63
def __eq__(self, other):
64
if not isinstance(other, Revision):
66
# FIXME: rbc 20050930 parent_ids are not being compared
68
self.inventory_sha1 == other.inventory_sha1
69
and self.revision_id == other.revision_id
70
and self.timestamp == other.timestamp
71
and self.message == other.message
72
and self.timezone == other.timezone
73
and self.committer == other.committer
74
and self.properties == other.properties)
76
def __ne__(self, other):
77
return not self.__eq__(other)
79
def _check_properties(self):
80
"""Verify that all revision properties are OK."""
81
for name, value in self.properties.iteritems():
82
if not isinstance(name, basestring) or contains_whitespace(name):
83
raise ValueError("invalid property name %r" % name)
84
if not isinstance(value, basestring):
85
raise ValueError("invalid property value %r for %r" %
88
def get_history(self, repository):
89
"""Return the canonical line-of-history for this revision.
91
If ghosts are present this may differ in result from a ghost-free
94
current_revision = self
96
while current_revision is not None:
97
reversed_result.append(current_revision.revision_id)
98
if not len (current_revision.parent_ids):
99
reversed_result.append(None)
100
current_revision = None
102
next_revision_id = current_revision.parent_ids[0]
103
current_revision = repository.get_revision(next_revision_id)
104
reversed_result.reverse()
105
return reversed_result
107
def get_summary(self):
108
"""Get the first line of the log message for this revision.
110
return self.message.split('\n', 1)[0]
113
def is_ancestor(revision_id, candidate_id, branch):
75
from bzrlib.xml import Element, SubElement
77
root = Element('revision',
78
committer = self.committer,
79
timestamp = '%.9f' % self.timestamp,
80
revision_id = self.revision_id,
81
inventory_id = self.inventory_id,
82
inventory_sha1 = self.inventory_sha1,
85
root.set('timezone', str(self.timezone))
88
msg = SubElement(root, 'message')
89
msg.text = self.message
93
pelts = SubElement(root, 'parents')
94
pelts.tail = pelts.text = '\n'
95
for rr in self.parents:
96
assert isinstance(rr, RevisionReference)
97
p = SubElement(pelts, 'revision_ref')
100
p.set('revision_id', rr.revision_id)
102
p.set('revision_sha1', rr.revision_sha1)
107
def from_element(cls, elt):
108
return unpack_revision(elt)
110
from_element = classmethod(from_element)
114
def unpack_revision(elt):
115
"""Convert XML element into Revision object."""
116
# <changeset> is deprecated...
117
if elt.tag not in ('revision', 'changeset'):
118
raise bzrlib.errors.BzrError("unexpected tag in revision file: %r" % elt)
120
rev = Revision(committer = elt.get('committer'),
121
timestamp = float(elt.get('timestamp')),
122
revision_id = elt.get('revision_id'),
123
inventory_id = elt.get('inventory_id'),
124
inventory_sha1 = elt.get('inventory_sha1')
127
precursor = elt.get('precursor')
128
precursor_sha1 = elt.get('precursor_sha1')
130
pelts = elt.find('parents')
134
assert p.tag == 'revision_ref', \
135
"bad parent node tag %r" % p.tag
136
rev_ref = RevisionReference(p.get('revision_id'),
137
p.get('revision_sha1'))
138
rev.parents.append(rev_ref)
142
prec_parent = rev.parents[0].revision_id
143
assert prec_parent == precursor
145
# revisions written prior to 0.0.5 have a single precursor
146
# give as an attribute
147
rev_ref = RevisionReference(precursor, precursor_sha1)
148
rev.parents.append(rev_ref)
150
v = elt.get('timezone')
151
rev.timezone = v and int(v)
153
rev.message = elt.findtext('message') # text of <message>
158
REVISION_ID_RE = None
160
def validate_revision_id(rid):
161
"""Check rid is syntactically valid for a revision id."""
162
global REVISION_ID_RE
163
if not REVISION_ID_RE:
165
REVISION_ID_RE = re.compile('[\w.-]+@[\w.-]+--?\d+--?[0-9a-f]+\Z')
167
if not REVISION_ID_RE.match(rid):
168
raise ValueError("malformed revision-id %r" % rid)
170
def is_ancestor(revision_id, candidate_id, revision_source):
114
171
"""Return true if candidate_id is an ancestor of revision_id.
116
172
A false negative will be returned if any intermediate descendent of
117
173
candidate_id is not present in any of the revision_sources.
119
175
revisions_source is an object supporting a get_revision operation that
120
176
behaves like Branch's.
122
return (candidate_id in branch.repository.get_ancestry(revision_id))
179
for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
180
if ancestor_id == candidate_id:
125
184
def iter_ancestors(revision_id, revision_source, only_present=False):
126
185
ancestors = (revision_id,)
132
191
yield ancestor, distance
134
193
revision = revision_source.get_revision(ancestor)
135
except errors.NoSuchRevision, e:
194
except bzrlib.errors.NoSuchRevision, e:
136
195
if e.revision == revision_id:
141
200
yield ancestor, distance
142
new_ancestors.extend(revision.parent_ids)
201
new_ancestors.extend([p.revision_id for p in revision.parents])
143
202
ancestors = new_ancestors
147
206
def find_present_ancestors(revision_id, revision_source):
148
"""Return the ancestors of a revision present in a branch.
150
It's possible that a branch won't have the complete ancestry of
151
one of its revisions.
154
207
found_ancestors = {}
155
209
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
156
210
only_present=True))
157
211
for anc_order, (anc_id, anc_distance) in anc_iter:
158
if anc_id not in found_ancestors:
212
if not found_ancestors.has_key(anc_id):
159
213
found_ancestors[anc_id] = (anc_order, anc_distance)
160
214
return found_ancestors
163
def __get_closest(intersection):
166
for entry in intersection:
167
if entry[0] == intersection[0][0]:
168
matches.append(entry[2])
172
def revision_graph(revision, revision_source):
173
"""Produce a graph of the ancestry of the specified revision.
175
:return: root, ancestors map, descendants map
216
class AmbiguousBase(bzrlib.errors.BzrError):
217
def __init__(self, bases):
218
msg = "The correct base is unclear, becase %s are all equally close" %\
220
bzrlib.errors.BzrError.__init__(self, msg)
223
def common_ancestor(revision_a, revision_b, revision_source):
224
"""Find the ancestor common to both revisions that is closest to both.
177
revision_source.lock_read()
179
return _revision_graph(revision, revision_source)
181
revision_source.unlock()
184
def _revision_graph(revision, revision_source):
185
"""See revision_graph."""
186
from bzrlib.tsort import topo_sort
187
graph = revision_source.get_revision_graph(revision)
188
# mark all no-parent revisions as being NULL_REVISION parentage.
189
for node, parents in graph.items():
190
if len(parents) == 0:
191
graph[node] = [NULL_REVISION]
192
# add NULL_REVISION to the graph
193
graph[NULL_REVISION] = []
195
# pick a root. If there are multiple roots
196
# this could pick a random one.
197
topo_order = topo_sort(graph.items())
203
# map the descendants of the graph.
204
# and setup our set based return graph.
205
for node in graph.keys():
206
descendants[node] = {}
207
for node, parents in graph.items():
208
for parent in parents:
209
descendants[parent][node] = 1
210
ancestors[node] = set(parents)
212
assert root not in descendants[root]
213
assert root not in ancestors[root]
214
return root, ancestors, descendants
217
def combined_graph(revision_a, revision_b, revision_source):
218
"""Produce a combined ancestry graph.
219
Return graph root, ancestors map, descendants map, set of common nodes"""
220
root, ancestors, descendants = revision_graph(
221
revision_a, revision_source)
222
root_b, ancestors_b, descendants_b = revision_graph(
223
revision_b, revision_source)
225
raise errors.NoCommonRoot(revision_a, revision_b)
227
for node, node_anc in ancestors_b.iteritems():
228
if node in ancestors:
231
ancestors[node] = set()
232
ancestors[node].update(node_anc)
233
for node, node_dec in descendants_b.iteritems():
234
if node not in descendants:
235
descendants[node] = {}
236
descendants[node].update(node_dec)
237
return root, ancestors, descendants, common
240
def common_ancestor(revision_a, revision_b, revision_source,
242
if None in (revision_a, revision_b):
226
from bzrlib.trace import mutter
227
a_ancestors = find_present_ancestors(revision_a, revision_source)
228
b_ancestors = find_present_ancestors(revision_b, revision_source)
231
# a_order is used as a tie-breaker when two equally-good bases are found
232
for revision, (a_order, a_distance) in a_ancestors.iteritems():
233
if b_ancestors.has_key(revision):
234
a_intersection.append((a_distance, a_order, revision))
235
b_intersection.append((b_ancestors[revision][1], a_order, revision))
236
mutter("a intersection: %r" % a_intersection)
237
mutter("b intersection: %r" % b_intersection)
238
def get_closest(intersection):
241
for entry in intersection:
242
if entry[0] == intersection[0][0]:
243
matches.append(entry[2])
246
a_closest = get_closest(a_intersection)
247
if len(a_closest) == 0:
244
if NULL_REVISION in (revision_a, revision_b):
246
# trivial optimisation
247
if revision_a == revision_b:
251
pb.update('Picking ancestor', 1, 3)
252
graph = revision_source.get_revision_graph_with_ghosts(
253
[revision_a, revision_b])
254
# convert to a NULL_REVISION based graph.
255
ancestors = graph.get_ancestors()
256
descendants = graph.get_descendants()
257
common = set(graph.get_ancestry(revision_a)).intersection(
258
set(graph.get_ancestry(revision_b)))
259
descendants[NULL_REVISION] = {}
260
ancestors[NULL_REVISION] = []
261
for root in graph.roots:
262
descendants[NULL_REVISION][root] = 1
263
ancestors[root].append(NULL_REVISION)
264
for ghost in graph.ghosts:
265
# ghosts act as roots for the purpose of finding
266
# the longest paths from the root: any ghost *might*
267
# be directly attached to the root, so we treat them
269
# ghost now descends from NULL
270
descendants[NULL_REVISION][ghost] = 1
271
# that is it has an ancestor of NULL
272
ancestors[ghost] = [NULL_REVISION]
273
# ghost is common if any of ghosts descendants are common:
274
for ghost_descendant in descendants[ghost]:
275
if ghost_descendant in common:
279
common.add(NULL_REVISION)
280
except errors.NoCommonRoot:
281
raise errors.NoCommonAncestor(revision_a, revision_b)
283
pb.update('Picking ancestor', 2, 3)
284
distances = node_distances (descendants, ancestors, root)
285
pb.update('Picking ancestor', 3, 2)
286
farthest = select_farthest(distances, common)
287
if farthest is None or farthest == NULL_REVISION:
288
raise errors.NoCommonAncestor(revision_a, revision_b)
249
b_closest = get_closest(b_intersection)
250
assert len(b_closest) != 0
251
mutter ("a_closest %r" % a_closest)
252
mutter ("b_closest %r" % b_closest)
253
if a_closest[0] in b_closest:
255
elif b_closest[0] in a_closest:
258
raise AmbiguousBase((a_closest[0], b_closest[0]))
294
261
class MultipleRevisionSources(object):
295
"""Proxy that looks in multiple branches for revisions."""
296
262
def __init__(self, *args):
297
263
object.__init__(self)
298
264
assert len(args) != 0
299
265
self._revision_sources = args
301
def revision_parents(self, revision_id):
302
for source in self._revision_sources:
304
return source.revision_parents(revision_id)
305
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
309
267
def get_revision(self, revision_id):
310
268
for source in self._revision_sources:
312
270
return source.get_revision(revision_id)
313
except errors.NoSuchRevision, e:
271
except bzrlib.errors.NoSuchRevision, e:
317
def get_revision_graph(self, revision_id):
318
# we could probe incrementally until the pending
319
# ghosts list stop growing, but its cheaper for now
320
# to just ask for the complete graph for each repository.
322
for source in self._revision_sources:
323
ghost_graph = source.get_revision_graph_with_ghosts()
324
graphs.append(ghost_graph)
327
if not revision_id in graph.get_ancestors():
329
if absent == len(graphs):
330
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
334
pending = set([revision_id])
335
def find_parents(node_id):
336
"""find the parents for node_id."""
338
ancestors = graph.get_ancestors()
340
return ancestors[node_id]
343
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
345
# all the graphs should have identical parent lists
346
node_id = pending.pop()
348
result[node_id] = find_parents(node_id)
349
for parent_node in result[node_id]:
350
if not parent_node in result:
351
pending.add(parent_node)
352
except errors.NoSuchRevision:
357
def get_revision_graph_with_ghosts(self, revision_ids):
358
# query all the sources for their entire graphs
359
# and then build a combined graph for just
362
for source in self._revision_sources:
363
ghost_graph = source.get_revision_graph_with_ghosts()
364
graphs.append(ghost_graph.get_ancestors())
365
for revision_id in revision_ids:
368
if not revision_id in graph:
370
if absent == len(graphs):
371
raise errors.NoSuchRevision(self._revision_sources[0],
376
pending = set(revision_ids)
378
def find_parents(node_id):
379
"""find the parents for node_id."""
382
return graph[node_id]
385
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
387
# all the graphs should have identical parent lists
388
node_id = pending.pop()
390
parents = find_parents(node_id)
391
for parent_node in parents:
393
if (parent_node not in pending and
394
parent_node not in done):
396
pending.add(parent_node)
397
result.add_node(node_id, parents)
399
except errors.NoSuchRevision:
401
result.add_ghost(node_id)
406
for source in self._revision_sources:
410
for source in self._revision_sources:
414
@deprecated_function(zero_eight)
415
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
416
revision_history=None):
417
"""Find the longest line of descent from maybe_ancestor to revision.
418
Revision history is followed where possible.
420
If ancestor_id == rev_id, list will be empty.
421
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
422
If ancestor_id is not an ancestor, NotAncestor will be thrown
424
root, ancestors, descendants = revision_graph(rev_id, rev_source)
425
if len(descendants) == 0:
426
raise errors.NoSuchRevision(rev_source, rev_id)
427
if ancestor_id not in descendants:
428
rev_source.get_revision(ancestor_id)
429
raise errors.NotAncestor(rev_id, ancestor_id)
430
root_descendants = all_descendants(descendants, ancestor_id)
431
root_descendants.add(ancestor_id)
432
if rev_id not in root_descendants:
433
raise errors.NotAncestor(rev_id, ancestor_id)
434
distances = node_distances(descendants, ancestors, ancestor_id,
435
root_descendants=root_descendants)
437
def best_ancestor(rev_id):
439
for anc_id in ancestors[rev_id]:
441
distance = distances[anc_id]
444
if revision_history is not None and anc_id in revision_history:
446
elif best is None or distance > best[1]:
447
best = (anc_id, distance)
452
while next != ancestor_id:
454
next = best_ancestor(next)
added
removed
bzrlib/revision.py
