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.
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from bzrlib import deprecated_graph
29
from bzrlib.osutils import contains_whitespace
30
from bzrlib.progress import DummyProgress
33
CURRENT_REVISION="current:"
36
class Revision(object):
37
"""Single revision on a branch.
39
Revisions may know their revision_hash, but only once they've been
40
written out. This is not stored because you cannot write the hash
41
into the file it describes.
43
After bzr 0.0.5 revisions are allowed to have multiple parents.
46
List of parent revision_ids
49
Dictionary of revision properties. These are attached to the
50
revision as extra metadata. The name must be a single
51
word; the value can be an arbitrary string.
54
def __init__(self, revision_id, properties=None, **args):
55
self.revision_id = revision_id
56
self.properties = properties or {}
57
self._check_properties()
59
self.parent_sha1s = []
60
"""Not used anymore - legacy from for 4."""
61
self.__dict__.update(args)
64
return "<Revision id %s>" % self.revision_id
66
def __eq__(self, other):
67
if not isinstance(other, Revision):
69
# FIXME: rbc 20050930 parent_ids are not being compared
71
self.inventory_sha1 == other.inventory_sha1
72
and self.revision_id == other.revision_id
73
and self.timestamp == other.timestamp
74
and self.message == other.message
75
and self.timezone == other.timezone
76
and self.committer == other.committer
77
and self.properties == other.properties)
79
def __ne__(self, other):
80
return not self.__eq__(other)
82
def _check_properties(self):
83
"""Verify that all revision properties are OK."""
84
for name, value in self.properties.iteritems():
85
if not isinstance(name, basestring) or contains_whitespace(name):
86
raise ValueError("invalid property name %r" % name)
87
if not isinstance(value, basestring):
88
raise ValueError("invalid property value %r for %r" %
91
def get_history(self, repository):
92
"""Return the canonical line-of-history for this revision.
94
If ghosts are present this may differ in result from a ghost-free
97
current_revision = self
99
while current_revision is not None:
100
reversed_result.append(current_revision.revision_id)
101
if not len (current_revision.parent_ids):
102
reversed_result.append(None)
103
current_revision = None
105
next_revision_id = current_revision.parent_ids[0]
106
current_revision = repository.get_revision(next_revision_id)
107
reversed_result.reverse()
108
return reversed_result
110
def get_summary(self):
111
"""Get the first line of the log message for this revision.
113
return self.message.lstrip().split('\n', 1)[0]
115
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
116
def get_apparent_author(self):
117
"""Return the apparent author of this revision.
119
This method is deprecated in favour of get_apparent_authors.
121
If the revision properties contain any author names,
122
return the first. Otherwise return the committer name.
124
return self.get_apparent_authors()[0]
126
def get_apparent_authors(self):
127
"""Return the apparent authors of this revision.
129
If the revision properties contain the names of the authors,
130
return them. Otherwise return the committer name.
132
The return value will be a list containing at least one element.
134
authors = self.properties.get('authors', None)
136
author = self.properties.get('author', None)
138
return [self.committer]
141
return authors.split("\n")
144
def iter_ancestors(revision_id, revision_source, only_present=False):
145
ancestors = (revision_id,)
147
while len(ancestors) > 0:
149
for ancestor in ancestors:
151
yield ancestor, distance
153
revision = revision_source.get_revision(ancestor)
154
except errors.NoSuchRevision, e:
155
if e.revision == revision_id:
160
yield ancestor, distance
161
new_ancestors.extend(revision.parent_ids)
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 is_reserved_id(revision_id):
192
"""Determine whether a revision id is reserved
194
:return: True if the revision is is reserved, False otherwise
196
return isinstance(revision_id, basestring) and revision_id.endswith(':')
199
def check_not_reserved_id(revision_id):
200
"""Raise ReservedId if the supplied revision_id is reserved"""
201
if is_reserved_id(revision_id):
202
raise errors.ReservedId(revision_id)
205
def ensure_null(revision_id):
206
"""Ensure only NULL_REVISION is used to represent the null revision"""
207
if revision_id is None:
208
symbol_versioning.warn('NULL_REVISION should be used for the null'
209
' revision instead of None, as of bzr 0.91.',
210
DeprecationWarning, stacklevel=2)
216
def is_null(revision_id):
217
if revision_id is None:
218
symbol_versioning.warn('NULL_REVISION should be used for the null'
219
' revision instead of None, as of bzr 0.90.',
220
DeprecationWarning, stacklevel=2)
221
return revision_id in (None, NULL_REVISION)
added
removed
bzrlib/revision.py
