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 (
49
50
Dictionary of revision properties. These are attached to the
50
revision as extra metadata. The name must be a single
51
revision as extra metadata. The name must be a single
51
52
word; the value can be an arbitrary string.
54
55
def __init__(self, revision_id, properties=None, **args):
55
56
self.revision_id = revision_id
56
self.properties = properties or {}
57
self._check_properties()
57
if properties is None:
60
self.properties = properties
61
self._check_properties()
58
63
self.parent_ids = []
59
64
self.parent_sha1s = []
60
65
"""Not used anymore - legacy from for 4."""
66
71
def __eq__(self, other):
67
72
if not isinstance(other, Revision):
69
# FIXME: rbc 20050930 parent_ids are not being compared
71
75
self.inventory_sha1 == other.inventory_sha1
72
76
and self.revision_id == other.revision_id
74
78
and self.message == other.message
75
79
and self.timezone == other.timezone
76
80
and self.committer == other.committer
77
and self.properties == other.properties)
81
and self.properties == other.properties
82
and self.parent_ids == other.parent_ids)
79
84
def __ne__(self, other):
80
85
return not self.__eq__(other)
85
90
if not isinstance(name, basestring) or contains_whitespace(name):
86
91
raise ValueError("invalid property name %r" % name)
87
92
if not isinstance(value, basestring):
88
raise ValueError("invalid property value %r for %r" %
93
raise ValueError("invalid property value %r for %r" %
91
96
def get_history(self, repository):
92
97
"""Return the canonical line-of-history for this revision.
110
115
def get_summary(self):
111
116
"""Get the first line of the log message for this revision.
118
Return an empty string if message is None.
113
return self.message.lstrip().split('\n', 1)[0]
121
return self.message.lstrip().split('\n', 1)[0]
125
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
115
126
def get_apparent_author(self):
116
127
"""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)
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)
124
172
def iter_ancestors(revision_id, revision_source, only_present=False):
157
205
if anc_id not in found_ancestors:
158
206
found_ancestors[anc_id] = (anc_order, anc_distance)
159
207
return found_ancestors
162
210
def __get_closest(intersection):
163
211
intersection.sort()
165
213
for entry in intersection:
166
214
if entry[0] == intersection[0][0]:
167
215
matches.append(entry[2])
171
219
def is_reserved_id(revision_id):
172
220
"""Determine whether a revision id is reserved
174
:return: True if the revision is is reserved, False otherwise
222
:return: True if the revision is reserved, False otherwise
176
224
return isinstance(revision_id, basestring) and revision_id.endswith(':')