35
59
into the file it describes.
37
61
After bzr 0.0.5 revisions are allowed to have multiple parents.
40
List of parent revision_ids
43
Dictionary of revision properties. These are attached to the
44
revision as extra metadata. The name must be a single
45
word; the value can be an arbitrary string.
62
To support old clients this is written out in a slightly redundant
63
form: the first parent as the predecessor. This will eventually
67
List of parent revisions, each is a RevisionReference.
48
def __init__(self, revision_id, properties=None, **args):
49
self.revision_id = revision_id
50
self.properties = properties or {}
51
self._check_properties()
53
self.parent_sha1s = []
77
def __init__(self, **args):
54
78
self.__dict__.update(args)
81
def _get_precursor(self):
82
from warnings import warn
83
warn("Revision.precursor is deprecated", stacklevel=2)
85
return self.parents[0].revision_id
90
def _get_precursor_sha1(self):
91
from warnings import warn
92
warn("Revision.precursor_sha1 is deprecated", stacklevel=2)
94
return self.parents[0].revision_sha1
100
raise Exception("can't assign to precursor anymore")
103
precursor = property(_get_precursor, _fail, _fail)
104
precursor_sha1 = property(_get_precursor_sha1, _fail, _fail)
56
108
def __repr__(self):
57
109
return "<Revision id %s>" % self.revision_id
59
def __eq__(self, other):
60
if not isinstance(other, Revision):
62
# FIXME: rbc 20050930 parent_ids are not being compared
64
self.inventory_sha1 == other.inventory_sha1
65
and self.revision_id == other.revision_id
66
and self.timestamp == other.timestamp
67
and self.message == other.message
68
and self.timezone == other.timezone
69
and self.committer == other.committer
70
and self.properties == other.properties)
72
def __ne__(self, other):
73
return not self.__eq__(other)
75
def _check_properties(self):
76
"""Verify that all revision properties are OK.
78
for name, value in self.properties.iteritems():
79
if not isinstance(name, basestring) or contains_whitespace(name):
80
raise ValueError("invalid property name %r" % name)
81
if not isinstance(value, basestring):
82
raise ValueError("invalid property value %r for %r" %
85
def get_history(self, repository):
86
"""Return the canonical line-of-history for this revision.
88
If ghosts are present this may differ in result from a ghost-free
91
current_revision = self
93
while current_revision is not None:
94
reversed_result.append(current_revision.revision_id)
95
if not len (current_revision.parent_ids):
96
reversed_result.append(None)
97
current_revision = None
99
next_revision_id = current_revision.parent_ids[0]
100
current_revision = repository.get_revision(next_revision_id)
101
reversed_result.reverse()
102
return reversed_result
104
def get_summary(self):
105
"""Get the first line of the log message for this revision.
107
return self.message.split('\n', 1)[0]
110
def is_ancestor(revision_id, candidate_id, branch):
111
"""Return true if candidate_id is an ancestor of revision_id.
113
A false negative will be returned if any intermediate descendent of
114
candidate_id is not present in any of the revision_sources.
116
revisions_source is an object supporting a get_revision operation that
117
behaves like Branch's.
119
return candidate_id in branch.repository.get_ancestry(revision_id)
122
def iter_ancestors(revision_id, revision_source, only_present=False):
123
ancestors = (revision_id,)
125
while len(ancestors) > 0:
127
for ancestor in ancestors:
129
yield ancestor, distance
131
revision = revision_source.get_revision(ancestor)
132
except bzrlib.errors.NoSuchRevision, e:
133
if e.revision == revision_id:
138
yield ancestor, distance
139
new_ancestors.extend(revision.parent_ids)
140
ancestors = new_ancestors
144
def find_present_ancestors(revision_id, revision_source):
145
"""Return the ancestors of a revision present in a branch.
147
It's possible that a branch won't have the complete ancestry of
148
one of its revisions.
152
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
154
for anc_order, (anc_id, anc_distance) in anc_iter:
155
if not found_ancestors.has_key(anc_id):
156
found_ancestors[anc_id] = (anc_order, anc_distance)
157
return found_ancestors
160
def __get_closest(intersection):
163
for entry in intersection:
164
if entry[0] == intersection[0][0]:
165
matches.append(entry[2])
169
def revision_graph(revision, revision_source):
170
"""Produce a graph of the ancestry of the specified revision.
172
:return: root, ancestors map, descendants map
174
revision_source.lock_read()
176
return _revision_graph(revision, revision_source)
178
revision_source.unlock()
181
def _revision_graph(revision, revision_source):
182
"""See revision_graph."""
183
from bzrlib.tsort import topo_sort
184
graph = revision_source.get_revision_graph(revision)
185
# mark all no-parent revisions as being NULL_REVISION parentage.
186
for node, parents in graph.items():
187
if len(parents) == 0:
188
graph[node] = [NULL_REVISION]
189
# add NULL_REVISION to the graph
190
graph[NULL_REVISION] = []
192
# pick a root. If there are multiple roots
193
# this could pick a random one.
194
topo_order = topo_sort(graph.items())
200
# map the descendants of the graph.
201
# and setup our set based return graph.
202
for node in graph.keys():
203
descendants[node] = {}
204
for node, parents in graph.items():
205
for parent in parents:
206
descendants[parent][node] = 1
207
ancestors[node] = set(parents)
209
assert root not in descendants[root]
210
assert root not in ancestors[root]
211
return root, ancestors, descendants
214
def combined_graph(revision_a, revision_b, revision_source):
215
"""Produce a combined ancestry graph.
216
Return graph root, ancestors map, descendants map, set of common nodes"""
217
root, ancestors, descendants = revision_graph(
218
revision_a, revision_source)
219
root_b, ancestors_b, descendants_b = revision_graph(
220
revision_b, revision_source)
222
raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
224
for node, node_anc in ancestors_b.iteritems():
225
if node in ancestors:
228
ancestors[node] = set()
229
ancestors[node].update(node_anc)
230
for node, node_dec in descendants_b.iteritems():
231
if node not in descendants:
232
descendants[node] = {}
233
descendants[node].update(node_dec)
234
return root, ancestors, descendants, common
237
def common_ancestor(revision_a, revision_b, revision_source,
239
if None in (revision_a, revision_b):
241
# trivial optimisation
242
if revision_a == revision_b:
246
pb.update('Picking ancestor', 1, 3)
247
graph = revision_source.get_revision_graph_with_ghosts(
248
[revision_a, revision_b])
249
# convert to a NULL_REVISION based graph.
250
ancestors = graph.get_ancestors()
251
descendants = graph.get_descendants()
252
common = set(graph.get_ancestry(revision_a)).intersection(
253
set(graph.get_ancestry(revision_b)))
254
descendants[NULL_REVISION] = {}
255
ancestors[NULL_REVISION] = []
256
for root in graph.roots:
257
descendants[NULL_REVISION][root] = 1
258
ancestors[root].append(NULL_REVISION)
259
for ghost in graph.ghosts:
260
# ghosts act as roots for the purpose of finding
261
# the longest paths from the root: any ghost *might*
262
# be directly attached to the root, so we treat them
264
# ghost now descends from NULL
265
descendants[NULL_REVISION][ghost] = 1
266
# that is it has an ancestor of NULL
267
ancestors[ghost] = [NULL_REVISION]
268
# ghost is common if any of ghosts descendants are common:
269
for ghost_descendant in descendants[ghost]:
270
if ghost_descendant in common:
112
def to_element(self):
113
root = Element('revision',
114
committer = self.committer,
115
timestamp = '%.9f' % self.timestamp,
116
revision_id = self.revision_id,
117
inventory_id = self.inventory_id,
118
inventory_sha1 = self.inventory_sha1,
121
root.set('timezone', str(self.timezone))
124
msg = SubElement(root, 'message')
125
msg.text = self.message
129
# first parent stored as precursor for compatability with 0.0.5 and
132
root.set('precursor', pr.revision_id)
134
root.set('precursor_sha1', pr.revision_sha1)
274
common.add(NULL_REVISION)
275
except bzrlib.errors.NoCommonRoot:
276
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
278
pb.update('Picking ancestor', 2, 3)
279
distances = node_distances (descendants, ancestors, root)
280
pb.update('Picking ancestor', 3, 2)
281
farthest = select_farthest(distances, common)
282
if farthest is None or farthest == NULL_REVISION:
283
raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
289
class MultipleRevisionSources(object):
290
"""Proxy that looks in multiple branches for revisions."""
291
def __init__(self, *args):
292
object.__init__(self)
293
assert len(args) != 0
294
self._revision_sources = args
296
def revision_parents(self, revision_id):
297
for source in self._revision_sources:
299
return source.revision_parents(revision_id)
300
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
304
def get_revision(self, revision_id):
305
for source in self._revision_sources:
307
return source.get_revision(revision_id)
308
except bzrlib.errors.NoSuchRevision, e:
312
def get_revision_graph(self, revision_id):
313
# we could probe incrementally until the pending
314
# ghosts list stop growing, but its cheaper for now
315
# to just ask for the complete graph for each repository.
317
for source in self._revision_sources:
318
ghost_graph = source.get_revision_graph_with_ghosts()
319
graphs.append(ghost_graph)
322
if not revision_id in graph.get_ancestors():
324
if absent == len(graphs):
325
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
329
pending = set([revision_id])
330
def find_parents(node_id):
331
"""find the parents for node_id."""
333
ancestors = graph.get_ancestors()
335
return ancestors[node_id]
338
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
340
# all the graphs should have identical parent lists
341
node_id = pending.pop()
343
result[node_id] = find_parents(node_id)
344
for parent_node in result[node_id]:
345
if not parent_node in result:
346
pending.add(parent_node)
347
except errors.NoSuchRevision:
352
def get_revision_graph_with_ghosts(self, revision_ids):
353
# query all the sources for their entire graphs
354
# and then build a combined graph for just
357
for source in self._revision_sources:
358
ghost_graph = source.get_revision_graph_with_ghosts()
359
graphs.append(ghost_graph.get_ancestors())
360
for revision_id in revision_ids:
363
if not revision_id in graph:
365
if absent == len(graphs):
366
raise errors.NoSuchRevision(self._revision_sources[0],
371
pending = set(revision_ids)
373
def find_parents(node_id):
374
"""find the parents for node_id."""
377
return graph[node_id]
380
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
382
# all the graphs should have identical parent lists
383
node_id = pending.pop()
385
parents = find_parents(node_id)
386
for parent_node in parents:
388
if (parent_node not in pending and
389
parent_node not in done):
391
pending.add(parent_node)
392
result.add_node(node_id, parents)
394
except errors.NoSuchRevision:
396
result.add_ghost(node_id)
401
for source in self._revision_sources:
405
for source in self._revision_sources:
409
@deprecated_function(zero_eight)
410
def get_intervening_revisions(ancestor_id, rev_id, rev_source,
411
revision_history=None):
412
"""Find the longest line of descent from maybe_ancestor to revision.
413
Revision history is followed where possible.
415
If ancestor_id == rev_id, list will be empty.
416
Otherwise, rev_id will be the last entry. ancestor_id will never appear.
417
If ancestor_id is not an ancestor, NotAncestor will be thrown
419
root, ancestors, descendants = revision_graph(rev_id, rev_source)
420
if len(descendants) == 0:
421
raise NoSuchRevision(rev_source, rev_id)
422
if ancestor_id not in descendants:
423
rev_source.get_revision(ancestor_id)
424
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
425
root_descendants = all_descendants(descendants, ancestor_id)
426
root_descendants.add(ancestor_id)
427
if rev_id not in root_descendants:
428
raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
429
distances = node_distances(descendants, ancestors, ancestor_id,
430
root_descendants=root_descendants)
432
def best_ancestor(rev_id):
434
for anc_id in ancestors[rev_id]:
436
distance = distances[anc_id]
439
if revision_history is not None and anc_id in revision_history:
441
elif best is None or distance > best[1]:
442
best = (anc_id, distance)
447
while next != ancestor_id:
449
next = best_ancestor(next)
137
pelts = SubElement(root, 'parents')
138
pelts.tail = pelts.text = '\n'
139
for rr in self.parents:
140
assert isinstance(rr, RevisionReference)
141
p = SubElement(pelts, 'revision_ref')
143
p.set('revision_id', rr.revision_id)
145
p.set('revision_sha1', rr.revision_sha1)
150
def from_element(cls, elt):
151
return unpack_revision(elt)
153
from_element = classmethod(from_element)
157
def unpack_revision(elt):
158
"""Convert XML element into Revision object."""
159
# <changeset> is deprecated...
160
if elt.tag not in ('revision', 'changeset'):
161
raise BzrError("unexpected tag in revision file: %r" % elt)
163
rev = Revision(committer = elt.get('committer'),
164
timestamp = float(elt.get('timestamp')),
165
revision_id = elt.get('revision_id'),
166
inventory_id = elt.get('inventory_id'),
167
inventory_sha1 = elt.get('inventory_sha1')
170
precursor = elt.get('precursor')
171
precursor_sha1 = elt.get('precursor_sha1')
173
pelts = elt.find('parents')
176
# revisions written prior to 0.0.5 have a single precursor
177
# give as an attribute
178
rev_ref = RevisionReference(precursor, precursor_sha1)
179
rev.parents.append(rev_ref)
182
assert p.tag == 'revision_ref', \
183
"bad parent node tag %r" % p.tag
184
rev_ref = RevisionReference(p.get('revision_id'),
185
p.get('revision_sha1'))
186
rev.parents.append(rev_ref)
188
v = elt.get('timezone')
189
rev.timezone = v and int(v)
191
rev.message = elt.findtext('message') # text of <message>
added
removed
bzrlib/revision.py
