51
47
After bzr 0.0.5 revisions are allowed to have multiple parents.
54
List of parent revisions, each is a RevisionReference.
50
List of parent revision_ids
53
Dictionary of revision properties. These are attached to the
54
revision as extra metadata. The name must be a single
55
word; the value can be an arbitrary string.
64
def __init__(self, **args):
58
def __init__(self, revision_id, properties=None, **args):
59
self.revision_id = revision_id
60
self.properties = properties or {}
61
self._check_properties()
63
self.parent_sha1s = []
64
"""Not used anymore - legacy from for 4."""
65
65
self.__dict__.update(args)
69
67
def __repr__(self):
70
68
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):
172
"""Return true if candidate_id is an ancestor of revision_id.
173
A false negative will be returned if any intermediate descendent of
174
candidate_id is not present in any of the revision_sources.
176
revisions_source is an object supporting a get_revision operation that
177
behaves like Branch's.
180
from bzrlib.branch import NoSuchRevision
70
def __eq__(self, other):
71
if not isinstance(other, Revision):
73
# FIXME: rbc 20050930 parent_ids are not being compared
75
self.inventory_sha1 == other.inventory_sha1
76
and self.revision_id == other.revision_id
77
and self.timestamp == other.timestamp
78
and self.message == other.message
79
and self.timezone == other.timezone
80
and self.committer == other.committer
81
and self.properties == other.properties)
83
def __ne__(self, other):
84
return not self.__eq__(other)
86
def _check_properties(self):
87
"""Verify that all revision properties are OK."""
88
for name, value in self.properties.iteritems():
89
if not isinstance(name, basestring) or contains_whitespace(name):
90
raise ValueError("invalid property name %r" % name)
91
if not isinstance(value, basestring):
92
raise ValueError("invalid property value %r for %r" %
95
def get_history(self, repository):
96
"""Return the canonical line-of-history for this revision.
98
If ghosts are present this may differ in result from a ghost-free
101
current_revision = self
103
while current_revision is not None:
104
reversed_result.append(current_revision.revision_id)
105
if not len (current_revision.parent_ids):
106
reversed_result.append(None)
107
current_revision = None
109
next_revision_id = current_revision.parent_ids[0]
110
current_revision = repository.get_revision(next_revision_id)
111
reversed_result.reverse()
112
return reversed_result
114
def get_summary(self):
115
"""Get the first line of the log message for this revision.
117
return self.message.lstrip().split('\n', 1)[0]
119
def get_apparent_author(self):
120
"""Return the apparent author of this revision.
122
If the revision properties contain the author name,
123
return it. Otherwise return the committer name.
125
return self.properties.get('author', self.committer)
128
def iter_ancestors(revision_id, revision_source, only_present=False):
181
129
ancestors = (revision_id,)
182
131
while len(ancestors) > 0:
183
132
new_ancestors = []
184
133
for ancestor in ancestors:
185
if ancestor == candidate_id:
135
yield ancestor, distance
188
137
revision = revision_source.get_revision(ancestor)
189
except NoSuchRevision, e:
138
except errors.NoSuchRevision, e:
190
139
if e.revision == revision_id:
194
new_ancestors.extend([p.revision_id for p in revision.parents])
144
yield ancestor, distance
145
new_ancestors.extend(revision.parent_ids)
195
146
ancestors = new_ancestors
150
def find_present_ancestors(revision_id, revision_source):
151
"""Return the ancestors of a revision present in a branch.
153
It's possible that a branch won't have the complete ancestry of
154
one of its revisions.
158
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
160
for anc_order, (anc_id, anc_distance) in anc_iter:
161
if anc_id not in found_ancestors:
162
found_ancestors[anc_id] = (anc_order, anc_distance)
163
return found_ancestors
166
def __get_closest(intersection):
169
for entry in intersection:
170
if entry[0] == intersection[0][0]:
171
matches.append(entry[2])
175
@deprecated_function(symbol_versioning.one_four)
176
def revision_graph(revision, revision_source):
177
"""Produce a graph of the ancestry of the specified revision.
179
:return: root, ancestors map, descendants map
181
revision_source.lock_read()
183
return _revision_graph(revision, revision_source)
185
revision_source.unlock()
188
def _revision_graph(revision, revision_source):
189
"""See revision_graph."""
190
from bzrlib.tsort import topo_sort
191
graph = revision_source.get_revision_graph(revision)
192
# mark all no-parent revisions as being NULL_REVISION parentage.
193
for node, parents in graph.items():
194
if len(parents) == 0:
195
graph[node] = [NULL_REVISION]
196
# add NULL_REVISION to the graph
197
graph[NULL_REVISION] = []
199
# pick a root. If there are multiple roots
200
# this could pick a random one.
201
topo_order = topo_sort(graph.items())
207
# map the descendants of the graph.
208
# and setup our set based return graph.
209
for node in graph.keys():
210
descendants[node] = {}
211
for node, parents in graph.items():
212
for parent in parents:
213
descendants[parent][node] = 1
214
ancestors[node] = set(parents)
216
assert root not in descendants[root]
217
assert root not in ancestors[root]
218
return root, ancestors, descendants
221
@deprecated_function(symbol_versioning.one_three)
222
def combined_graph(revision_a, revision_b, revision_source):
223
"""Produce a combined ancestry graph.
224
Return graph root, ancestors map, descendants map, set of common nodes"""
225
root, ancestors, descendants = revision_graph(
226
revision_a, revision_source)
227
root_b, ancestors_b, descendants_b = revision_graph(
228
revision_b, revision_source)
230
raise errors.NoCommonRoot(revision_a, revision_b)
232
for node, node_anc in ancestors_b.iteritems():
233
if node in ancestors:
236
ancestors[node] = set()
237
ancestors[node].update(node_anc)
238
for node, node_dec in descendants_b.iteritems():
239
if node not in descendants:
240
descendants[node] = {}
241
descendants[node].update(node_dec)
242
return root, ancestors, descendants, common
245
@deprecated_function(symbol_versioning.one_three)
246
def common_ancestor(revision_a, revision_b, revision_source,
248
if None in (revision_a, revision_b):
250
if NULL_REVISION in (revision_a, revision_b):
252
# trivial optimisation
253
if revision_a == revision_b:
257
pb.update('Picking ancestor', 1, 3)
258
graph = revision_source.get_revision_graph_with_ghosts(
259
[revision_a, revision_b])
260
# Shortcut the case where one of the tips is already included in
261
# the other graphs ancestry.
262
ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
263
if revision_b in ancestry_a:
265
ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
266
if revision_a in ancestry_b:
268
# convert to a NULL_REVISION based graph.
269
ancestors = graph.get_ancestors()
270
descendants = graph.get_descendants()
271
common = set(ancestry_a)
272
common.intersection_update(ancestry_b)
273
descendants[NULL_REVISION] = {}
274
ancestors[NULL_REVISION] = []
275
for root in graph.roots:
276
descendants[NULL_REVISION][root] = 1
277
ancestors[root].append(NULL_REVISION)
278
for ghost in graph.ghosts:
279
# ghosts act as roots for the purpose of finding
280
# the longest paths from the root: any ghost *might*
281
# be directly attached to the root, so we treat them
283
# ghost now descends from NULL
284
descendants[NULL_REVISION][ghost] = 1
285
# that is it has an ancestor of NULL
286
ancestors[ghost] = [NULL_REVISION]
287
# ghost is common if any of ghosts descendants are common:
288
for ghost_descendant in descendants[ghost]:
289
if ghost_descendant in common:
293
common.add(NULL_REVISION)
294
except errors.NoCommonRoot:
295
raise errors.NoCommonAncestor(revision_a, revision_b)
297
pb.update('Picking ancestor', 2, 3)
298
distances = node_distances (descendants, ancestors, root)
299
pb.update('Picking ancestor', 3, 2)
300
farthest = select_farthest(distances, common)
301
if farthest is None or farthest == NULL_REVISION:
302
raise errors.NoCommonAncestor(revision_a, revision_b)
198
308
class MultipleRevisionSources(object):
309
"""Proxy that looks in multiple branches for revisions."""
311
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
199
312
def __init__(self, *args):
200
313
object.__init__(self)
201
314
assert len(args) != 0
202
315
self._revision_sources = args
317
def revision_parents(self, revision_id):
318
for source in self._revision_sources:
320
return source.revision_parents(revision_id)
321
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
204
325
def get_revision(self, revision_id):
205
from bzrlib.branch import NoSuchRevision
206
326
for source in self._revision_sources:
208
328
return source.get_revision(revision_id)
209
except NoSuchRevision, e:
329
except errors.NoSuchRevision, e:
333
def get_revision_graph(self, revision_id):
334
# we could probe incrementally until the pending
335
# ghosts list stop growing, but its cheaper for now
336
# to just ask for the complete graph for each repository.
338
for source in self._revision_sources:
339
ghost_graph = source.get_revision_graph_with_ghosts()
340
graphs.append(ghost_graph)
343
if not revision_id in graph.get_ancestors():
345
if absent == len(graphs):
346
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
350
pending = set([revision_id])
351
def find_parents(node_id):
352
"""find the parents for node_id."""
354
ancestors = graph.get_ancestors()
356
return ancestors[node_id]
359
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
361
# all the graphs should have identical parent lists
362
node_id = pending.pop()
364
result[node_id] = find_parents(node_id)
365
for parent_node in result[node_id]:
366
if not parent_node in result:
367
pending.add(parent_node)
368
except errors.NoSuchRevision:
373
def get_revision_graph_with_ghosts(self, revision_ids):
374
# query all the sources for their entire graphs
375
# and then build a combined graph for just
378
for source in self._revision_sources:
379
ghost_graph = source.get_revision_graph_with_ghosts()
380
graphs.append(ghost_graph.get_ancestors())
381
for revision_id in revision_ids:
384
if not revision_id in graph:
386
if absent == len(graphs):
387
raise errors.NoSuchRevision(self._revision_sources[0],
392
pending = set(revision_ids)
394
def find_parents(node_id):
395
"""find the parents for node_id."""
398
return graph[node_id]
401
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
403
# all the graphs should have identical parent lists
404
node_id = pending.pop()
406
parents = find_parents(node_id)
407
for parent_node in parents:
409
if (parent_node not in pending and
410
parent_node not in done):
412
pending.add(parent_node)
413
result.add_node(node_id, parents)
415
except errors.NoSuchRevision:
417
result.add_ghost(node_id)
422
for source in self._revision_sources:
426
for source in self._revision_sources:
430
def is_reserved_id(revision_id):
431
"""Determine whether a revision id is reserved
433
:return: True if the revision is is reserved, False otherwise
435
return isinstance(revision_id, basestring) and revision_id.endswith(':')
438
def check_not_reserved_id(revision_id):
439
"""Raise ReservedId if the supplied revision_id is reserved"""
440
if is_reserved_id(revision_id):
441
raise errors.ReservedId(revision_id)
444
def ensure_null(revision_id):
445
"""Ensure only NULL_REVISION is used to represent the null revision"""
446
if revision_id is None:
447
symbol_versioning.warn('NULL_REVISION should be used for the null'
448
' revision instead of None, as of bzr 0.91.',
449
DeprecationWarning, stacklevel=2)
455
def is_null(revision_id):
456
if revision_id is None:
457
symbol_versioning.warn('NULL_REVISION should be used for the null'
458
' revision instead of None, as of bzr 0.90.',
459
DeprecationWarning, stacklevel=2)
460
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
