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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
# TODO: Some kind of command-line display of revision properties:
17
# TODO: Some kind of command-line display of revision properties:
18
18
# perhaps show them in log -v and allow them as options to the commit command.
21
21
from bzrlib.lazy_import import lazy_import
22
22
lazy_import(globals(), """
23
23
from bzrlib import deprecated_graph
24
from bzrlib import bugtracker
25
26
from bzrlib import (
29
30
from bzrlib.osutils import contains_whitespace
30
from bzrlib.progress import DummyProgress
32
32
NULL_REVISION="null:"
33
33
CURRENT_REVISION="current:"
49
49
Dictionary of revision properties. These are attached to the
50
revision as extra metadata. The name must be a single
50
revision as extra metadata. The name must be a single
51
51
word; the value can be an arbitrary string.
54
54
def __init__(self, revision_id, properties=None, **args):
55
55
self.revision_id = revision_id
56
self.properties = properties or {}
57
self._check_properties()
56
if properties is None:
59
self.properties = properties
60
self._check_properties()
58
62
self.parent_ids = []
59
63
self.parent_sha1s = []
60
64
"""Not used anymore - legacy from for 4."""
66
70
def __eq__(self, other):
67
71
if not isinstance(other, Revision):
69
# FIXME: rbc 20050930 parent_ids are not being compared
71
74
self.inventory_sha1 == other.inventory_sha1
72
75
and self.revision_id == other.revision_id
74
77
and self.message == other.message
75
78
and self.timezone == other.timezone
76
79
and self.committer == other.committer
77
and self.properties == other.properties)
80
and self.properties == other.properties
81
and self.parent_ids == other.parent_ids)
79
83
def __ne__(self, other):
80
84
return not self.__eq__(other)
85
89
if not isinstance(name, basestring) or contains_whitespace(name):
86
90
raise ValueError("invalid property name %r" % name)
87
91
if not isinstance(value, basestring):
88
raise ValueError("invalid property value %r for %r" %
92
raise ValueError("invalid property value %r for %r" %
91
95
def get_history(self, repository):
92
96
"""Return the canonical line-of-history for this revision.
110
114
def get_summary(self):
111
115
"""Get the first line of the log message for this revision.
117
Return an empty string if message is None.
113
return self.message.lstrip().split('\n', 1)[0]
120
return self.message.lstrip().split('\n', 1)[0]
124
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
115
125
def get_apparent_author(self):
116
126
"""Return the apparent author of this revision.
118
If the revision properties contain the author name,
119
return it. Otherwise return the committer name.
121
return self.properties.get('author', self.committer)
128
This method is deprecated in favour of get_apparent_authors.
130
If the revision properties contain any author names,
131
return the first. Otherwise return the committer name.
133
authors = self.get_apparent_authors()
139
def get_apparent_authors(self):
140
"""Return the apparent authors of this revision.
142
If the revision properties contain the names of the authors,
143
return them. Otherwise return the committer name.
145
The return value will be a list containing at least one element.
147
authors = self.properties.get('authors', None)
149
author = self.properties.get('author', self.committer)
154
return authors.split("\n")
157
"""Iterate over the bugs associated with this revision."""
158
bug_property = self.properties.get('bugs', None)
159
if bug_property is None:
161
for line in bug_property.splitlines():
163
url, status = line.split(None, 2)
165
raise errors.InvalidLineInBugsProperty(line)
166
if status not in bugtracker.ALLOWED_BUG_STATUSES:
167
raise errors.InvalidBugStatus(status)
124
171
def iter_ancestors(revision_id, revision_source, only_present=False):
157
204
if anc_id not in found_ancestors:
158
205
found_ancestors[anc_id] = (anc_order, anc_distance)
159
206
return found_ancestors
162
209
def __get_closest(intersection):
163
210
intersection.sort()
165
212
for entry in intersection:
166
213
if entry[0] == intersection[0][0]:
167
214
matches.append(entry[2])
171
218
def is_reserved_id(revision_id):
172
219
"""Determine whether a revision id is reserved
174
:return: True if the revision is is reserved, False otherwise
221
:return: True if the revision is reserved, False otherwise
176
223
return isinstance(revision_id, basestring) and revision_id.endswith(':')