1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: Some kind of command-line display of revision properties:
18
# perhaps show them in log -v and allow them as options to the commit command.
25
from bzrlib.osutils import contains_whitespace
26
from bzrlib.progress import DummyProgress
29
CURRENT_REVISION="current:"
32
class Revision(object):
33
"""Single revision on a branch.
35
Revisions may know their revision_hash, but only once they've been
36
written out. This is not stored because you cannot write the hash
37
into the file it describes.
39
After bzr 0.0.5 revisions are allowed to have multiple parents.
42
List of parent revision_ids
45
Dictionary of revision properties. These are attached to the
46
revision as extra metadata. The name must be a single
47
word; the value can be an arbitrary string.
50
def __init__(self, revision_id, properties=None, **args):
51
self.revision_id = revision_id
52
self.properties = properties or {}
53
self._check_properties()
55
self.parent_sha1s = []
56
"""Not used anymore - legacy from for 4."""
57
self.__dict__.update(args)
60
return "<Revision id %s>" % self.revision_id
62
def __eq__(self, other):
63
if not isinstance(other, Revision):
65
# FIXME: rbc 20050930 parent_ids are not being compared
67
self.inventory_sha1 == other.inventory_sha1
68
and self.revision_id == other.revision_id
69
and self.timestamp == other.timestamp
70
and self.message == other.message
71
and self.timezone == other.timezone
72
and self.committer == other.committer
73
and self.properties == other.properties)
75
def __ne__(self, other):
76
return not self.__eq__(other)
78
def _check_properties(self):
79
"""Verify that all revision properties are OK."""
80
for name, value in self.properties.iteritems():
81
if not isinstance(name, basestring) or contains_whitespace(name):
82
raise ValueError("invalid property name %r" % name)
83
if not isinstance(value, basestring):
84
raise ValueError("invalid property value %r for %r" %
87
def get_history(self, repository):
88
"""Return the canonical line-of-history for this revision.
90
If ghosts are present this may differ in result from a ghost-free
93
current_revision = self
95
while current_revision is not None:
96
reversed_result.append(current_revision.revision_id)
97
if not len (current_revision.parent_ids):
98
reversed_result.append(None)
99
current_revision = None
101
next_revision_id = current_revision.parent_ids[0]
102
current_revision = repository.get_revision(next_revision_id)
103
reversed_result.reverse()
104
return reversed_result
106
def get_summary(self):
107
"""Get the first line of the log message for this revision.
109
return self.message.lstrip().split('\n', 1)[0]
111
def get_apparent_author(self):
112
"""Return the apparent author of this revision.
114
If the revision properties contain the author name,
115
return it. Otherwise return the committer name.
117
return self.properties.get('author', self.committer)
120
def iter_ancestors(revision_id, revision_source, only_present=False):
121
ancestors = (revision_id,)
123
while len(ancestors) > 0:
125
for ancestor in ancestors:
127
yield ancestor, distance
129
revision = revision_source.get_revision(ancestor)
130
except errors.NoSuchRevision, e:
131
if e.revision == revision_id:
136
yield ancestor, distance
137
new_ancestors.extend(revision.parent_ids)
138
ancestors = new_ancestors
142
def find_present_ancestors(revision_id, revision_source):
143
"""Return the ancestors of a revision present in a branch.
145
It's possible that a branch won't have the complete ancestry of
146
one of its revisions.
150
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
152
for anc_order, (anc_id, anc_distance) in anc_iter:
153
if anc_id not in found_ancestors:
154
found_ancestors[anc_id] = (anc_order, anc_distance)
155
return found_ancestors
158
def __get_closest(intersection):
161
for entry in intersection:
162
if entry[0] == intersection[0][0]:
163
matches.append(entry[2])
167
def is_reserved_id(revision_id):
168
"""Determine whether a revision id is reserved
170
:return: True if the revision is is reserved, False otherwise
172
return isinstance(revision_id, basestring) and revision_id.endswith(':')
175
def check_not_reserved_id(revision_id):
176
"""Raise ReservedId if the supplied revision_id is reserved"""
177
if is_reserved_id(revision_id):
178
raise errors.ReservedId(revision_id)
181
def ensure_null(revision_id):
182
"""Ensure only NULL_REVISION is used to represent the null revision"""
183
if revision_id is None:
184
symbol_versioning.warn('NULL_REVISION should be used for the null'
185
' revision instead of None, as of bzr 0.91.',
186
DeprecationWarning, stacklevel=2)
192
def is_null(revision_id):
193
if revision_id is None:
194
symbol_versioning.warn('NULL_REVISION should be used for the null'
195
' revision instead of None, as of bzr 0.90.',
196
DeprecationWarning, stacklevel=2)
197
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
