1
# Copyright (C) 2005-2011 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
from __future__ import absolute_import
19
# TODO: Some kind of command-line display of revision properties:
20
# perhaps show them in log -v and allow them as options to the commit command.
23
from .lazy_import import lazy_import
24
lazy_import(globals(), """
25
from breezy import bugtracker
35
NULL_REVISION = b"null:"
36
CURRENT_REVISION = b"current:"
39
class Revision(object):
40
"""Single revision on a branch.
42
Revisions may know their revision_hash, but only once they've been
43
written out. This is not stored because you cannot write the hash
44
into the file it describes.
46
After bzr 0.0.5 revisions are allowed to have multiple parents.
49
List of parent revision_ids
52
Dictionary of revision properties. These are attached to the
53
revision as extra metadata. The name must be a single
54
word; the value can be an arbitrary string.
57
def __init__(self, revision_id, properties=None, **args):
58
self.revision_id = revision_id
59
if properties is None:
62
self.properties = properties
63
self._check_properties()
66
self.parent_sha1s = []
67
"""Not used anymore - legacy from for 4."""
68
self.__dict__.update(args)
71
return "<Revision id %s>" % self.revision_id
73
def __eq__(self, other):
74
if not isinstance(other, Revision):
77
self.inventory_sha1 == other.inventory_sha1
78
and self.revision_id == other.revision_id
79
and self.timestamp == other.timestamp
80
and self.message == other.message
81
and self.timezone == other.timezone
82
and self.committer == other.committer
83
and self.properties == other.properties
84
and self.parent_ids == other.parent_ids)
86
def __ne__(self, other):
87
return not self.__eq__(other)
89
def _check_properties(self):
90
"""Verify that all revision properties are OK."""
91
for name, value in self.properties.items():
92
# GZ 2017-06-10: What sort of string are properties exactly?
93
not_text = not isinstance(name, (text_type, str))
94
if not_text or osutils.contains_whitespace(name):
95
raise ValueError("invalid property name %r" % name)
96
if not isinstance(value, (text_type, bytes)):
97
raise ValueError("invalid property value %r for %r" %
100
def get_history(self, repository):
101
"""Return the canonical line-of-history for this revision.
103
If ghosts are present this may differ in result from a ghost-free
106
current_revision = self
108
while current_revision is not None:
109
reversed_result.append(current_revision.revision_id)
110
if not len (current_revision.parent_ids):
111
reversed_result.append(None)
112
current_revision = None
114
next_revision_id = current_revision.parent_ids[0]
115
current_revision = repository.get_revision(next_revision_id)
116
reversed_result.reverse()
117
return reversed_result
119
def get_summary(self):
120
"""Get the first line of the log message for this revision.
122
Return an empty string if message is None.
125
return self.message.lstrip().split('\n', 1)[0]
129
def get_apparent_authors(self):
130
"""Return the apparent authors of this revision.
132
If the revision properties contain the names of the authors,
133
return them. Otherwise return the committer name.
135
The return value will be a list containing at least one element.
137
authors = self.properties.get('authors', None)
139
author = self.properties.get('author', self.committer)
144
return authors.split("\n")
147
"""Iterate over the bugs associated with this revision."""
148
bug_property = self.properties.get('bugs', None)
149
if bug_property is None:
151
for line in bug_property.splitlines():
153
url, status = line.split(None, 2)
155
raise bugtracker.InvalidLineInBugsProperty(line)
156
if status not in bugtracker.ALLOWED_BUG_STATUSES:
157
raise bugtracker.InvalidBugStatus(status)
161
def iter_ancestors(revision_id, revision_source, only_present=False):
162
ancestors = (revision_id,)
164
while len(ancestors) > 0:
166
for ancestor in ancestors:
168
yield ancestor, distance
170
revision = revision_source.get_revision(ancestor)
171
except errors.NoSuchRevision as e:
172
if e.revision == revision_id:
177
yield ancestor, distance
178
new_ancestors.extend(revision.parent_ids)
179
ancestors = new_ancestors
183
def find_present_ancestors(revision_id, revision_source):
184
"""Return the ancestors of a revision present in a branch.
186
It's possible that a branch won't have the complete ancestry of
187
one of its revisions.
191
anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
193
for anc_order, (anc_id, anc_distance) in anc_iter:
194
if anc_id not in found_ancestors:
195
found_ancestors[anc_id] = (anc_order, anc_distance)
196
return found_ancestors
199
def __get_closest(intersection):
202
for entry in intersection:
203
if entry[0] == intersection[0][0]:
204
matches.append(entry[2])
208
def is_reserved_id(revision_id):
209
"""Determine whether a revision id is reserved
211
:return: True if the revision is reserved, False otherwise
213
return isinstance(revision_id, bytes) and revision_id.endswith(b':')
216
def check_not_reserved_id(revision_id):
217
"""Raise ReservedId if the supplied revision_id is reserved"""
218
if is_reserved_id(revision_id):
219
raise errors.ReservedId(revision_id)
222
def ensure_null(revision_id):
223
"""Ensure only NULL_REVISION is used to represent the null revision"""
224
if revision_id is None:
226
'NULL_REVISION should be used for the null'
227
' revision instead of None.')
231
def is_null(revision_id):
232
if revision_id is None:
233
raise ValueError('NULL_REVISION should be used for the null'
234
' revision instead of None.')
235
return (revision_id == NULL_REVISION)
added
removed
breezy/revision.py
