52
47
After bzr 0.0.5 revisions are allowed to have multiple parents.
55
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.
65
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."""
66
65
self.__dict__.update(args)
70
67
def __repr__(self):
71
68
return "<Revision id %s>" % self.revision_id
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):
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
@deprecated_function(symbol_versioning.one_zero)
129
def is_ancestor(revision_id, candidate_id, branch):
171
130
"""Return true if candidate_id is an ancestor of revision_id.
172
132
A false negative will be returned if any intermediate descendent of
173
133
candidate_id is not present in any of the revision_sources.
175
135
revisions_source is an object supporting a get_revision operation that
176
136
behaves like Branch's.
138
This function is deprecated, it is better for callers to directly use
139
Graph.is_ancestor() (just watch out that the parameter order is switched)
141
return branch.repository.get_graph().is_ancestor(candidate_id, revision_id)
144
def iter_ancestors(revision_id, revision_source, only_present=False):
179
145
ancestors = (revision_id,)
180
147
while len(ancestors) > 0:
181
148
new_ancestors = []
182
149
for ancestor in ancestors:
183
if ancestor == candidate_id:
151
yield ancestor, distance
186
153
revision = revision_source.get_revision(ancestor)
187
except bzrlib.errors.NoSuchRevision, e:
154
except errors.NoSuchRevision, e:
188
155
if e.revision == revision_id:
192
new_ancestors.extend([p.revision_id for p in revision.parents])
160
yield ancestor, distance
161
new_ancestors.extend(revision.parent_ids)
193
162
ancestors = new_ancestors
166
def find_present_ancestors(revision_id, revision_source):
167
"""Return the ancestors of a revision present in a branch.
169
It's possible that a branch won't have the complete ancestry of
170
one of its revisions.
174
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
176
for anc_order, (anc_id, anc_distance) in anc_iter:
177
if anc_id not in found_ancestors:
178
found_ancestors[anc_id] = (anc_order, anc_distance)
179
return found_ancestors
182
def __get_closest(intersection):
185
for entry in intersection:
186
if entry[0] == intersection[0][0]:
187
matches.append(entry[2])
191
def revision_graph(revision, revision_source):
192
"""Produce a graph of the ancestry of the specified revision.
194
:return: root, ancestors map, descendants map
196
revision_source.lock_read()
198
return _revision_graph(revision, revision_source)
200
revision_source.unlock()
203
def _revision_graph(revision, revision_source):
204
"""See revision_graph."""
205
from bzrlib.tsort import topo_sort
206
graph = revision_source.get_revision_graph(revision)
207
# mark all no-parent revisions as being NULL_REVISION parentage.
208
for node, parents in graph.items():
209
if len(parents) == 0:
210
graph[node] = [NULL_REVISION]
211
# add NULL_REVISION to the graph
212
graph[NULL_REVISION] = []
214
# pick a root. If there are multiple roots
215
# this could pick a random one.
216
topo_order = topo_sort(graph.items())
222
# map the descendants of the graph.
223
# and setup our set based return graph.
224
for node in graph.keys():
225
descendants[node] = {}
226
for node, parents in graph.items():
227
for parent in parents:
228
descendants[parent][node] = 1
229
ancestors[node] = set(parents)
231
assert root not in descendants[root]
232
assert root not in ancestors[root]
233
return root, ancestors, descendants
236
def combined_graph(revision_a, revision_b, revision_source):
237
"""Produce a combined ancestry graph.
238
Return graph root, ancestors map, descendants map, set of common nodes"""
239
root, ancestors, descendants = revision_graph(
240
revision_a, revision_source)
241
root_b, ancestors_b, descendants_b = revision_graph(
242
revision_b, revision_source)
244
raise errors.NoCommonRoot(revision_a, revision_b)
246
for node, node_anc in ancestors_b.iteritems():
247
if node in ancestors:
250
ancestors[node] = set()
251
ancestors[node].update(node_anc)
252
for node, node_dec in descendants_b.iteritems():
253
if node not in descendants:
254
descendants[node] = {}
255
descendants[node].update(node_dec)
256
return root, ancestors, descendants, common
259
def common_ancestor(revision_a, revision_b, revision_source,
261
if None in (revision_a, revision_b):
263
if NULL_REVISION in (revision_a, revision_b):
265
# trivial optimisation
266
if revision_a == revision_b:
270
pb.update('Picking ancestor', 1, 3)
271
graph = revision_source.get_revision_graph_with_ghosts(
272
[revision_a, revision_b])
273
# Shortcut the case where one of the tips is already included in
274
# the other graphs ancestry.
275
ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
276
if revision_b in ancestry_a:
278
ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
279
if revision_a in ancestry_b:
281
# convert to a NULL_REVISION based graph.
282
ancestors = graph.get_ancestors()
283
descendants = graph.get_descendants()
284
common = set(ancestry_a)
285
common.intersection_update(ancestry_b)
286
descendants[NULL_REVISION] = {}
287
ancestors[NULL_REVISION] = []
288
for root in graph.roots:
289
descendants[NULL_REVISION][root] = 1
290
ancestors[root].append(NULL_REVISION)
291
for ghost in graph.ghosts:
292
# ghosts act as roots for the purpose of finding
293
# the longest paths from the root: any ghost *might*
294
# be directly attached to the root, so we treat them
296
# ghost now descends from NULL
297
descendants[NULL_REVISION][ghost] = 1
298
# that is it has an ancestor of NULL
299
ancestors[ghost] = [NULL_REVISION]
300
# ghost is common if any of ghosts descendants are common:
301
for ghost_descendant in descendants[ghost]:
302
if ghost_descendant in common:
306
common.add(NULL_REVISION)
307
except errors.NoCommonRoot:
308
raise errors.NoCommonAncestor(revision_a, revision_b)
310
pb.update('Picking ancestor', 2, 3)
311
distances = node_distances (descendants, ancestors, root)
312
pb.update('Picking ancestor', 3, 2)
313
farthest = select_farthest(distances, common)
314
if farthest is None or farthest == NULL_REVISION:
315
raise errors.NoCommonAncestor(revision_a, revision_b)
196
321
class MultipleRevisionSources(object):
322
"""Proxy that looks in multiple branches for revisions."""
197
323
def __init__(self, *args):
198
324
object.__init__(self)
199
325
assert len(args) != 0
200
326
self._revision_sources = args
328
def revision_parents(self, revision_id):
329
for source in self._revision_sources:
331
return source.revision_parents(revision_id)
332
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
202
336
def get_revision(self, revision_id):
203
337
for source in self._revision_sources:
205
339
return source.get_revision(revision_id)
206
except bzrlib.errors.NoSuchRevision, e:
340
except errors.NoSuchRevision, e:
344
def get_revision_graph(self, revision_id):
345
# we could probe incrementally until the pending
346
# ghosts list stop growing, but its cheaper for now
347
# to just ask for the complete graph for each repository.
349
for source in self._revision_sources:
350
ghost_graph = source.get_revision_graph_with_ghosts()
351
graphs.append(ghost_graph)
354
if not revision_id in graph.get_ancestors():
356
if absent == len(graphs):
357
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
361
pending = set([revision_id])
362
def find_parents(node_id):
363
"""find the parents for node_id."""
365
ancestors = graph.get_ancestors()
367
return ancestors[node_id]
370
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
372
# all the graphs should have identical parent lists
373
node_id = pending.pop()
375
result[node_id] = find_parents(node_id)
376
for parent_node in result[node_id]:
377
if not parent_node in result:
378
pending.add(parent_node)
379
except errors.NoSuchRevision:
384
def get_revision_graph_with_ghosts(self, revision_ids):
385
# query all the sources for their entire graphs
386
# and then build a combined graph for just
389
for source in self._revision_sources:
390
ghost_graph = source.get_revision_graph_with_ghosts()
391
graphs.append(ghost_graph.get_ancestors())
392
for revision_id in revision_ids:
395
if not revision_id in graph:
397
if absent == len(graphs):
398
raise errors.NoSuchRevision(self._revision_sources[0],
403
pending = set(revision_ids)
405
def find_parents(node_id):
406
"""find the parents for node_id."""
409
return graph[node_id]
412
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
414
# all the graphs should have identical parent lists
415
node_id = pending.pop()
417
parents = find_parents(node_id)
418
for parent_node in parents:
420
if (parent_node not in pending and
421
parent_node not in done):
423
pending.add(parent_node)
424
result.add_node(node_id, parents)
426
except errors.NoSuchRevision:
428
result.add_ghost(node_id)
433
for source in self._revision_sources:
437
for source in self._revision_sources:
441
def is_reserved_id(revision_id):
442
"""Determine whether a revision id is reserved
444
:return: True if the revision is is reserved, False otherwise
446
return isinstance(revision_id, basestring) and revision_id.endswith(':')
449
def check_not_reserved_id(revision_id):
450
"""Raise ReservedId if the supplied revision_id is reserved"""
451
if is_reserved_id(revision_id):
452
raise errors.ReservedId(revision_id)
455
def ensure_null(revision_id):
456
"""Ensure only NULL_REVISION is used to represent the null revision"""
457
if revision_id is None:
458
symbol_versioning.warn('NULL_REVISION should be used for the null'
459
' revision instead of None, as of bzr 0.91.',
460
DeprecationWarning, stacklevel=2)
466
def is_null(revision_id):
467
if revision_id is None:
468
symbol_versioning.warn('NULL_REVISION should be used for the null'
469
' revision instead of None, as of bzr 0.90.',
470
DeprecationWarning, stacklevel=2)
471
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
