1
# Copyright (C) 2005, 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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):
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from xml import XMLMixin
23
from cElementTree import Element, ElementTree, SubElement
25
from elementtree.ElementTree import Element, ElementTree, SubElement
27
from errors import BzrError
30
class Revision(XMLMixin):
38
31
"""Single revision on a branch.
40
33
Revisions may know their revision_hash, but only once they've been
41
34
written out. This is not stored because you cannot write the hash
42
35
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.
37
TODO: Perhaps make predecessor be a child element, not an attribute?
55
def __init__(self, revision_id, properties=None, **args):
56
self.revision_id = revision_id
57
if properties is None:
60
self.properties = properties
61
self._check_properties()
39
def __init__(self, **args):
40
self.inventory_id = None
41
self.revision_id = None
62
45
self.committer = None
64
self.parent_sha1s = []
65
"""Not used anymore - legacy from for 4."""
66
47
self.__dict__.update(args)
68
50
def __repr__(self):
69
51
return "<Revision id %s>" % self.revision_id
71
def __eq__(self, other):
72
if not isinstance(other, Revision):
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
82
and self.parent_ids == other.parent_ids)
84
def __ne__(self, other):
85
return not self.__eq__(other)
87
def _check_properties(self):
88
"""Verify that all revision properties are OK."""
89
for name, value in self.properties.iteritems():
90
if not isinstance(name, basestring) or contains_whitespace(name):
91
raise ValueError("invalid property name %r" % name)
92
if not isinstance(value, basestring):
93
raise ValueError("invalid property value %r for %r" %
96
def get_history(self, repository):
97
"""Return the canonical line-of-history for this revision.
99
If ghosts are present this may differ in result from a ghost-free
102
current_revision = self
104
while current_revision is not None:
105
reversed_result.append(current_revision.revision_id)
106
if not len (current_revision.parent_ids):
107
reversed_result.append(None)
108
current_revision = None
110
next_revision_id = current_revision.parent_ids[0]
111
current_revision = repository.get_revision(next_revision_id)
112
reversed_result.reverse()
113
return reversed_result
115
def get_summary(self):
116
"""Get the first line of the log message for this revision.
118
Return an empty string if message is None.
121
return self.message.lstrip().split('\n', 1)[0]
125
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
126
def get_apparent_author(self):
127
"""Return the apparent author of this revision.
129
This method is deprecated in favour of get_apparent_authors.
131
If the revision properties contain any author names,
132
return the first. Otherwise return the committer name.
134
authors = self.get_apparent_authors()
140
def get_apparent_authors(self):
141
"""Return the apparent authors of this revision.
143
If the revision properties contain the names of the authors,
144
return them. Otherwise return the committer name.
146
The return value will be a list containing at least one element.
148
authors = self.properties.get('authors', None)
150
author = self.properties.get('author', self.committer)
155
return authors.split("\n")
158
"""Iterate over the bugs associated with this revision."""
159
bug_property = self.properties.get('bugs', None)
160
if bug_property is None:
162
for line in bug_property.splitlines():
164
url, status = line.split(None, 2)
166
raise errors.InvalidLineInBugsProperty(line)
167
if status not in bugtracker.ALLOWED_BUG_STATUSES:
168
raise errors.InvalidBugStatus(status)
172
def iter_ancestors(revision_id, revision_source, only_present=False):
173
ancestors = (revision_id,)
175
while len(ancestors) > 0:
177
for ancestor in ancestors:
179
yield ancestor, distance
181
revision = revision_source.get_revision(ancestor)
182
except errors.NoSuchRevision, e:
183
if e.revision == revision_id:
188
yield ancestor, distance
189
new_ancestors.extend(revision.parent_ids)
190
ancestors = new_ancestors
194
def find_present_ancestors(revision_id, revision_source):
195
"""Return the ancestors of a revision present in a branch.
197
It's possible that a branch won't have the complete ancestry of
198
one of its revisions.
202
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
204
for anc_order, (anc_id, anc_distance) in anc_iter:
205
if anc_id not in found_ancestors:
206
found_ancestors[anc_id] = (anc_order, anc_distance)
207
return found_ancestors
210
def __get_closest(intersection):
213
for entry in intersection:
214
if entry[0] == intersection[0][0]:
215
matches.append(entry[2])
219
def is_reserved_id(revision_id):
220
"""Determine whether a revision id is reserved
222
:return: True if the revision is reserved, False otherwise
224
return isinstance(revision_id, basestring) and revision_id.endswith(':')
227
def check_not_reserved_id(revision_id):
228
"""Raise ReservedId if the supplied revision_id is reserved"""
229
if is_reserved_id(revision_id):
230
raise errors.ReservedId(revision_id)
233
def ensure_null(revision_id):
234
"""Ensure only NULL_REVISION is used to represent the null revision"""
235
if revision_id is None:
236
symbol_versioning.warn('NULL_REVISION should be used for the null'
237
' revision instead of None, as of bzr 0.91.',
238
DeprecationWarning, stacklevel=2)
244
def is_null(revision_id):
245
if revision_id is None:
246
symbol_versioning.warn('NULL_REVISION should be used for the null'
247
' revision instead of None, as of bzr 0.90.',
248
DeprecationWarning, stacklevel=2)
249
return revision_id in (None, NULL_REVISION)
55
root = Element('revision',
56
committer = self.committer,
57
timestamp = '%.9f' % self.timestamp,
58
revision_id = self.revision_id,
59
inventory_id = self.inventory_id,
60
timezone = str(self.timezone))
62
root.set('precursor', self.precursor)
65
msg = SubElement(root, 'message')
66
msg.text = self.message
72
def from_element(cls, elt):
73
# <changeset> is deprecated...
74
if elt.tag not in ('revision', 'changeset'):
75
raise BzrError("unexpected tag in revision file: %r" % elt)
77
cs = cls(committer = elt.get('committer'),
78
timestamp = float(elt.get('timestamp')),
79
precursor = elt.get('precursor'),
80
revision_id = elt.get('revision_id'),
81
inventory_id = elt.get('inventory_id'))
83
v = elt.get('timezone')
84
cs.timezone = v and int(v)
86
cs.message = elt.findtext('message') # text of <message>
89
from_element = classmethod(from_element)
added
removed
bzrlib/revision.py
