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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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.
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from bzrlib import deprecated_graph
24
from bzrlib import bugtracker
30
from bzrlib.osutils import contains_whitespace
31
from bzrlib.progress import DummyProgress
34
CURRENT_REVISION="current:"
37
class Revision(object):
38
"""Single revision on a branch.
40
Revisions may know their revision_hash, but only once they've been
41
written out. This is not stored because you cannot write the hash
42
into the file it describes.
44
After bzr 0.0.5 revisions are allowed to have multiple parents.
47
List of parent revision_ids
50
Dictionary of revision properties. These are attached to the
51
revision as extra metadata. The name must be a single
52
word; the value can be an arbitrary string.
55
def __init__(self, revision_id, properties=None, **args):
56
self.revision_id = revision_id
57
self.properties = properties or {}
58
self._check_properties()
60
self.parent_sha1s = []
61
"""Not used anymore - legacy from for 4."""
62
self.__dict__.update(args)
65
return "<Revision id %s>" % self.revision_id
67
def __eq__(self, other):
68
if not isinstance(other, Revision):
70
# FIXME: rbc 20050930 parent_ids are not being compared
72
self.inventory_sha1 == other.inventory_sha1
73
and self.revision_id == other.revision_id
74
and self.timestamp == other.timestamp
75
and self.message == other.message
76
and self.timezone == other.timezone
77
and self.committer == other.committer
78
and self.properties == other.properties)
80
def __ne__(self, other):
81
return not self.__eq__(other)
83
def _check_properties(self):
84
"""Verify that all revision properties are OK."""
85
for name, value in self.properties.iteritems():
86
if not isinstance(name, basestring) or contains_whitespace(name):
87
raise ValueError("invalid property name %r" % name)
88
if not isinstance(value, basestring):
89
raise ValueError("invalid property value %r for %r" %
92
def get_history(self, repository):
93
"""Return the canonical line-of-history for this revision.
95
If ghosts are present this may differ in result from a ghost-free
98
current_revision = self
100
while current_revision is not None:
101
reversed_result.append(current_revision.revision_id)
102
if not len (current_revision.parent_ids):
103
reversed_result.append(None)
104
current_revision = None
106
next_revision_id = current_revision.parent_ids[0]
107
current_revision = repository.get_revision(next_revision_id)
108
reversed_result.reverse()
109
return reversed_result
111
def get_summary(self):
112
"""Get the first line of the log message for this revision.
114
return self.message.lstrip().split('\n', 1)[0]
116
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
117
def get_apparent_author(self):
118
"""Return the apparent author of this revision.
120
This method is deprecated in favour of get_apparent_authors.
122
If the revision properties contain any author names,
123
return the first. Otherwise return the committer name.
125
return self.get_apparent_authors()[0]
127
def get_apparent_authors(self):
128
"""Return the apparent authors of this revision.
130
If the revision properties contain the names of the authors,
131
return them. Otherwise return the committer name.
133
The return value will be a list containing at least one element.
135
authors = self.properties.get('authors', None)
137
author = self.properties.get('author', None)
139
return [self.committer]
142
return authors.split("\n")
145
"""Iterate over the bugs associated with this revision."""
146
bug_property = self.properties.get('bugs', None)
147
if bug_property is None:
149
for line in bug_property.splitlines():
151
url, status = line.split(None, 2)
153
raise errors.InvalidLineInBugsProperty(line)
154
if status not in bugtracker.ALLOWED_BUG_STATUSES:
155
raise errors.InvalidBugStatus(status)
159
def iter_ancestors(revision_id, revision_source, only_present=False):
160
ancestors = (revision_id,)
162
while len(ancestors) > 0:
164
for ancestor in ancestors:
166
yield ancestor, distance
168
revision = revision_source.get_revision(ancestor)
169
except errors.NoSuchRevision, e:
170
if e.revision == revision_id:
175
yield ancestor, distance
176
new_ancestors.extend(revision.parent_ids)
177
ancestors = new_ancestors
181
def find_present_ancestors(revision_id, revision_source):
182
"""Return the ancestors of a revision present in a branch.
184
It's possible that a branch won't have the complete ancestry of
185
one of its revisions.
189
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
191
for anc_order, (anc_id, anc_distance) in anc_iter:
192
if anc_id not in found_ancestors:
193
found_ancestors[anc_id] = (anc_order, anc_distance)
194
return found_ancestors
197
def __get_closest(intersection):
200
for entry in intersection:
201
if entry[0] == intersection[0][0]:
202
matches.append(entry[2])
206
def is_reserved_id(revision_id):
207
"""Determine whether a revision id is reserved
209
:return: True if the revision is is reserved, False otherwise
211
return isinstance(revision_id, basestring) and revision_id.endswith(':')
214
def check_not_reserved_id(revision_id):
215
"""Raise ReservedId if the supplied revision_id is reserved"""
216
if is_reserved_id(revision_id):
217
raise errors.ReservedId(revision_id)
220
def ensure_null(revision_id):
221
"""Ensure only NULL_REVISION is used to represent the null revision"""
222
if revision_id is None:
223
symbol_versioning.warn('NULL_REVISION should be used for the null'
224
' revision instead of None, as of bzr 0.91.',
225
DeprecationWarning, stacklevel=2)
231
def is_null(revision_id):
232
if revision_id is None:
233
symbol_versioning.warn('NULL_REVISION should be used for the null'
234
' revision instead of None, as of bzr 0.90.',
235
DeprecationWarning, stacklevel=2)
236
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
