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):
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):
172
130
"""Return true if candidate_id is an ancestor of revision_id.
173
132
A false negative will be returned if any intermediate descendent of
174
133
candidate_id is not present in any of the revision_sources.
176
135
revisions_source is an object supporting a get_revision operation that
177
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)
180
from bzrlib.branch import NoSuchRevision
141
return branch.repository.get_graph().is_ancestor(candidate_id, revision_id)
144
def iter_ancestors(revision_id, revision_source, only_present=False):
181
145
ancestors = (revision_id,)
182
147
while len(ancestors) > 0:
183
148
new_ancestors = []
184
149
for ancestor in ancestors:
185
if ancestor == candidate_id:
151
yield ancestor, distance
188
153
revision = revision_source.get_revision(ancestor)
189
except NoSuchRevision, e:
154
except errors.NoSuchRevision, e:
190
155
if e.revision == revision_id:
194
new_ancestors.extend([p.revision_id for p in revision.parents])
160
yield ancestor, distance
161
new_ancestors.extend(revision.parent_ids)
195
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
@deprecated_function(symbol_versioning.one_four)
192
def revision_graph(revision, revision_source):
193
"""Produce a graph of the ancestry of the specified revision.
195
:return: root, ancestors map, descendants map
197
revision_source.lock_read()
199
return _revision_graph(revision, revision_source)
201
revision_source.unlock()
204
def _revision_graph(revision, revision_source):
205
"""See revision_graph."""
206
from bzrlib.tsort import topo_sort
207
graph = revision_source.get_revision_graph(revision)
208
# mark all no-parent revisions as being NULL_REVISION parentage.
209
for node, parents in graph.items():
210
if len(parents) == 0:
211
graph[node] = [NULL_REVISION]
212
# add NULL_REVISION to the graph
213
graph[NULL_REVISION] = []
215
# pick a root. If there are multiple roots
216
# this could pick a random one.
217
topo_order = topo_sort(graph.items())
223
# map the descendants of the graph.
224
# and setup our set based return graph.
225
for node in graph.keys():
226
descendants[node] = {}
227
for node, parents in graph.items():
228
for parent in parents:
229
descendants[parent][node] = 1
230
ancestors[node] = set(parents)
232
assert root not in descendants[root]
233
assert root not in ancestors[root]
234
return root, ancestors, descendants
237
@deprecated_function(symbol_versioning.one_three)
238
def combined_graph(revision_a, revision_b, revision_source):
239
"""Produce a combined ancestry graph.
240
Return graph root, ancestors map, descendants map, set of common nodes"""
241
root, ancestors, descendants = revision_graph(
242
revision_a, revision_source)
243
root_b, ancestors_b, descendants_b = revision_graph(
244
revision_b, revision_source)
246
raise errors.NoCommonRoot(revision_a, revision_b)
248
for node, node_anc in ancestors_b.iteritems():
249
if node in ancestors:
252
ancestors[node] = set()
253
ancestors[node].update(node_anc)
254
for node, node_dec in descendants_b.iteritems():
255
if node not in descendants:
256
descendants[node] = {}
257
descendants[node].update(node_dec)
258
return root, ancestors, descendants, common
261
@deprecated_function(symbol_versioning.one_three)
262
def common_ancestor(revision_a, revision_b, revision_source,
264
if None in (revision_a, revision_b):
266
if NULL_REVISION in (revision_a, revision_b):
268
# trivial optimisation
269
if revision_a == revision_b:
273
pb.update('Picking ancestor', 1, 3)
274
graph = revision_source.get_revision_graph_with_ghosts(
275
[revision_a, revision_b])
276
# Shortcut the case where one of the tips is already included in
277
# the other graphs ancestry.
278
ancestry_a = graph.get_ancestry(revision_a, topo_sorted=False)
279
if revision_b in ancestry_a:
281
ancestry_b = graph.get_ancestry(revision_b, topo_sorted=False)
282
if revision_a in ancestry_b:
284
# convert to a NULL_REVISION based graph.
285
ancestors = graph.get_ancestors()
286
descendants = graph.get_descendants()
287
common = set(ancestry_a)
288
common.intersection_update(ancestry_b)
289
descendants[NULL_REVISION] = {}
290
ancestors[NULL_REVISION] = []
291
for root in graph.roots:
292
descendants[NULL_REVISION][root] = 1
293
ancestors[root].append(NULL_REVISION)
294
for ghost in graph.ghosts:
295
# ghosts act as roots for the purpose of finding
296
# the longest paths from the root: any ghost *might*
297
# be directly attached to the root, so we treat them
299
# ghost now descends from NULL
300
descendants[NULL_REVISION][ghost] = 1
301
# that is it has an ancestor of NULL
302
ancestors[ghost] = [NULL_REVISION]
303
# ghost is common if any of ghosts descendants are common:
304
for ghost_descendant in descendants[ghost]:
305
if ghost_descendant in common:
309
common.add(NULL_REVISION)
310
except errors.NoCommonRoot:
311
raise errors.NoCommonAncestor(revision_a, revision_b)
313
pb.update('Picking ancestor', 2, 3)
314
distances = node_distances (descendants, ancestors, root)
315
pb.update('Picking ancestor', 3, 2)
316
farthest = select_farthest(distances, common)
317
if farthest is None or farthest == NULL_REVISION:
318
raise errors.NoCommonAncestor(revision_a, revision_b)
198
324
class MultipleRevisionSources(object):
325
"""Proxy that looks in multiple branches for revisions."""
327
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
199
328
def __init__(self, *args):
200
329
object.__init__(self)
201
330
assert len(args) != 0
202
331
self._revision_sources = args
333
def revision_parents(self, revision_id):
334
for source in self._revision_sources:
336
return source.revision_parents(revision_id)
337
except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
204
341
def get_revision(self, revision_id):
205
from bzrlib.branch import NoSuchRevision
206
342
for source in self._revision_sources:
208
344
return source.get_revision(revision_id)
209
except NoSuchRevision, e:
345
except errors.NoSuchRevision, e:
349
def get_revision_graph(self, revision_id):
350
# we could probe incrementally until the pending
351
# ghosts list stop growing, but its cheaper for now
352
# to just ask for the complete graph for each repository.
354
for source in self._revision_sources:
355
ghost_graph = source.get_revision_graph_with_ghosts()
356
graphs.append(ghost_graph)
359
if not revision_id in graph.get_ancestors():
361
if absent == len(graphs):
362
raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
366
pending = set([revision_id])
367
def find_parents(node_id):
368
"""find the parents for node_id."""
370
ancestors = graph.get_ancestors()
372
return ancestors[node_id]
375
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
377
# all the graphs should have identical parent lists
378
node_id = pending.pop()
380
result[node_id] = find_parents(node_id)
381
for parent_node in result[node_id]:
382
if not parent_node in result:
383
pending.add(parent_node)
384
except errors.NoSuchRevision:
389
def get_revision_graph_with_ghosts(self, revision_ids):
390
# query all the sources for their entire graphs
391
# and then build a combined graph for just
394
for source in self._revision_sources:
395
ghost_graph = source.get_revision_graph_with_ghosts()
396
graphs.append(ghost_graph.get_ancestors())
397
for revision_id in revision_ids:
400
if not revision_id in graph:
402
if absent == len(graphs):
403
raise errors.NoSuchRevision(self._revision_sources[0],
408
pending = set(revision_ids)
410
def find_parents(node_id):
411
"""find the parents for node_id."""
414
return graph[node_id]
417
raise errors.NoSuchRevision(self._revision_sources[0], node_id)
419
# all the graphs should have identical parent lists
420
node_id = pending.pop()
422
parents = find_parents(node_id)
423
for parent_node in parents:
425
if (parent_node not in pending and
426
parent_node not in done):
428
pending.add(parent_node)
429
result.add_node(node_id, parents)
431
except errors.NoSuchRevision:
433
result.add_ghost(node_id)
438
for source in self._revision_sources:
442
for source in self._revision_sources:
446
def is_reserved_id(revision_id):
447
"""Determine whether a revision id is reserved
449
:return: True if the revision is is reserved, False otherwise
451
return isinstance(revision_id, basestring) and revision_id.endswith(':')
454
def check_not_reserved_id(revision_id):
455
"""Raise ReservedId if the supplied revision_id is reserved"""
456
if is_reserved_id(revision_id):
457
raise errors.ReservedId(revision_id)
460
def ensure_null(revision_id):
461
"""Ensure only NULL_REVISION is used to represent the null revision"""
462
if revision_id is None:
463
symbol_versioning.warn('NULL_REVISION should be used for the null'
464
' revision instead of None, as of bzr 0.91.',
465
DeprecationWarning, stacklevel=2)
471
def is_null(revision_id):
472
if revision_id is None:
473
symbol_versioning.warn('NULL_REVISION should be used for the null'
474
' revision instead of None, as of bzr 0.90.',
475
DeprecationWarning, stacklevel=2)
476
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
