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()
61
self.parent_sha1s = []
62
"""Not used anymore - legacy from for 4."""
63
self.__dict__.update(args)
66
return "<Revision id %s>" % self.revision_id
68
def __eq__(self, other):
69
if not isinstance(other, Revision):
71
# FIXME: rbc 20050930 parent_ids are not being compared
73
self.inventory_sha1 == other.inventory_sha1
74
and self.revision_id == other.revision_id
75
and self.timestamp == other.timestamp
76
and self.message == other.message
77
and self.timezone == other.timezone
78
and self.committer == other.committer
79
and self.properties == other.properties)
81
def __ne__(self, other):
82
return not self.__eq__(other)
84
def _check_properties(self):
85
"""Verify that all revision properties are OK."""
86
for name, value in self.properties.iteritems():
87
if not isinstance(name, basestring) or contains_whitespace(name):
88
raise ValueError("invalid property name %r" % name)
89
if not isinstance(value, basestring):
90
raise ValueError("invalid property value %r for %r" %
93
def get_history(self, repository):
94
"""Return the canonical line-of-history for this revision.
96
If ghosts are present this may differ in result from a ghost-free
99
current_revision = self
101
while current_revision is not None:
102
reversed_result.append(current_revision.revision_id)
103
if not len (current_revision.parent_ids):
104
reversed_result.append(None)
105
current_revision = None
107
next_revision_id = current_revision.parent_ids[0]
108
current_revision = repository.get_revision(next_revision_id)
109
reversed_result.reverse()
110
return reversed_result
112
def get_summary(self):
113
"""Get the first line of the log message for this revision.
115
return self.message.lstrip().split('\n', 1)[0]
117
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
118
def get_apparent_author(self):
119
"""Return the apparent author of this revision.
121
This method is deprecated in favour of get_apparent_authors.
123
If the revision properties contain any author names,
124
return the first. Otherwise return the committer name.
126
authors = self.get_apparent_authors()
132
def get_apparent_authors(self):
133
"""Return the apparent authors of this revision.
135
If the revision properties contain the names of the authors,
136
return them. Otherwise return the committer name.
138
The return value will be a list containing at least one element.
140
authors = self.properties.get('authors', None)
142
author = self.properties.get('author', self.committer)
147
return authors.split("\n")
150
"""Iterate over the bugs associated with this revision."""
151
bug_property = self.properties.get('bugs', None)
152
if bug_property is None:
154
for line in bug_property.splitlines():
156
url, status = line.split(None, 2)
158
raise errors.InvalidLineInBugsProperty(line)
159
if status not in bugtracker.ALLOWED_BUG_STATUSES:
160
raise errors.InvalidBugStatus(status)
164
def iter_ancestors(revision_id, revision_source, only_present=False):
165
ancestors = (revision_id,)
167
while len(ancestors) > 0:
169
for ancestor in ancestors:
171
yield ancestor, distance
173
revision = revision_source.get_revision(ancestor)
174
except errors.NoSuchRevision, e:
175
if e.revision == revision_id:
180
yield ancestor, distance
181
new_ancestors.extend(revision.parent_ids)
182
ancestors = new_ancestors
186
def find_present_ancestors(revision_id, revision_source):
187
"""Return the ancestors of a revision present in a branch.
189
It's possible that a branch won't have the complete ancestry of
190
one of its revisions.
194
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
196
for anc_order, (anc_id, anc_distance) in anc_iter:
197
if anc_id not in found_ancestors:
198
found_ancestors[anc_id] = (anc_order, anc_distance)
199
return found_ancestors
202
def __get_closest(intersection):
205
for entry in intersection:
206
if entry[0] == intersection[0][0]:
207
matches.append(entry[2])
211
def is_reserved_id(revision_id):
212
"""Determine whether a revision id is reserved
214
:return: True if the revision is reserved, False otherwise
216
return isinstance(revision_id, basestring) and revision_id.endswith(':')
219
def check_not_reserved_id(revision_id):
220
"""Raise ReservedId if the supplied revision_id is reserved"""
221
if is_reserved_id(revision_id):
222
raise errors.ReservedId(revision_id)
225
def ensure_null(revision_id):
226
"""Ensure only NULL_REVISION is used to represent the null revision"""
227
if revision_id is None:
228
symbol_versioning.warn('NULL_REVISION should be used for the null'
229
' revision instead of None, as of bzr 0.91.',
230
DeprecationWarning, stacklevel=2)
236
def is_null(revision_id):
237
if revision_id is None:
238
symbol_versioning.warn('NULL_REVISION should be used for the null'
239
' revision instead of None, as of bzr 0.90.',
240
DeprecationWarning, stacklevel=2)
241
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
