← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-03-11 13:47:06 UTC
  • mfrom: (5051.3.16 use-branch-open)
  • Revision ID: pqm@pqm.ubuntu.com-20100311134706-kaerqhx3lf7xn6rh
(Jelmer) Pass colocated branch names further down the call stack.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
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
12
12
#
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
16
16
 
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.
19
19
 
20
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
 
23
from bzrlib import deprecated_graph
 
24
from bzrlib import bugtracker
 
25
""")
21
26
from bzrlib import (
22
27
    errors,
23
28
    symbol_versioning,
24
29
    )
25
30
from bzrlib.osutils import contains_whitespace
26
 
from bzrlib.progress import DummyProgress
27
31
 
28
32
NULL_REVISION="null:"
29
33
CURRENT_REVISION="current:"
43
47
 
44
48
    properties
45
49
        Dictionary of revision properties.  These are attached to the
46
 
        revision as extra metadata.  The name must be a single 
 
50
        revision as extra metadata.  The name must be a single
47
51
        word; the value can be an arbitrary string.
48
52
    """
49
 
    
 
53
 
50
54
    def __init__(self, revision_id, properties=None, **args):
51
55
        self.revision_id = revision_id
52
 
        self.properties = properties or {}
53
 
        self._check_properties()
 
56
        if properties is None:
 
57
            self.properties = {}
 
58
        else:
 
59
            self.properties = properties
 
60
            self._check_properties()
 
61
        self.committer = None
54
62
        self.parent_ids = []
55
63
        self.parent_sha1s = []
56
64
        """Not used anymore - legacy from for 4."""
62
70
    def __eq__(self, other):
63
71
        if not isinstance(other, Revision):
64
72
            return False
65
 
        # FIXME: rbc 20050930 parent_ids are not being compared
66
73
        return (
67
74
                self.inventory_sha1 == other.inventory_sha1
68
75
                and self.revision_id == other.revision_id
70
77
                and self.message == other.message
71
78
                and self.timezone == other.timezone
72
79
                and self.committer == other.committer
73
 
                and self.properties == other.properties)
 
80
                and self.properties == other.properties
 
81
                and self.parent_ids == other.parent_ids)
74
82
 
75
83
    def __ne__(self, other):
76
84
        return not self.__eq__(other)
81
89
            if not isinstance(name, basestring) or contains_whitespace(name):
82
90
                raise ValueError("invalid property name %r" % name)
83
91
            if not isinstance(value, basestring):
84
 
                raise ValueError("invalid property value %r for %r" % 
85
 
                                 (name, value))
 
92
                raise ValueError("invalid property value %r for %r" %
 
93
                                 (value, name))
86
94
 
87
95
    def get_history(self, repository):
88
96
        """Return the canonical line-of-history for this revision.
105
113
 
106
114
    def get_summary(self):
107
115
        """Get the first line of the log message for this revision.
 
116
 
 
117
        Return an empty string if message is None.
108
118
        """
109
 
        return self.message.lstrip().split('\n', 1)[0]
 
119
        if self.message:
 
120
            return self.message.lstrip().split('\n', 1)[0]
 
121
        else:
 
122
            return ''
110
123
 
 
124
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
111
125
    def get_apparent_author(self):
112
126
        """Return the apparent author of this revision.
113
127
 
114
 
        If the revision properties contain the author name,
115
 
        return it. Otherwise return the committer name.
116
 
        """
117
 
        return self.properties.get('author', self.committer)
 
128
        This method is deprecated in favour of get_apparent_authors.
 
129
 
 
130
        If the revision properties contain any author names,
 
131
        return the first. Otherwise return the committer name.
 
132
        """
 
133
        authors = self.get_apparent_authors()
 
134
        if authors:
 
135
            return authors[0]
 
136
        else:
 
137
            return None
 
138
 
 
139
    def get_apparent_authors(self):
 
140
        """Return the apparent authors of this revision.
 
141
 
 
142
        If the revision properties contain the names of the authors,
 
143
        return them. Otherwise return the committer name.
 
144
 
 
145
        The return value will be a list containing at least one element.
 
146
        """
 
147
        authors = self.properties.get('authors', None)
 
148
        if authors is None:
 
149
            author = self.properties.get('author', self.committer)
 
150
            if author is None:
 
151
                return []
 
152
            return [author]
 
153
        else:
 
154
            return authors.split("\n")
 
155
 
 
156
    def iter_bugs(self):
 
157
        """Iterate over the bugs associated with this revision."""
 
158
        bug_property = self.properties.get('bugs', None)
 
159
        if bug_property is None:
 
160
            return
 
161
        for line in bug_property.splitlines():
 
162
            try:
 
163
                url, status = line.split(None, 2)
 
164
            except ValueError:
 
165
                raise errors.InvalidLineInBugsProperty(line)
 
166
            if status not in bugtracker.ALLOWED_BUG_STATUSES:
 
167
                raise errors.InvalidBugStatus(status)
 
168
            yield url, status
118
169
 
119
170
 
120
171
def iter_ancestors(revision_id, revision_source, only_present=False):
129
180
                revision = revision_source.get_revision(ancestor)
130
181
            except errors.NoSuchRevision, e:
131
182
                if e.revision == revision_id:
132
 
                    raise 
 
183
                    raise
133
184
                else:
134
185
                    continue
135
186
            if only_present:
143
194
    """Return the ancestors of a revision present in a branch.
144
195
 
145
196
    It's possible that a branch won't have the complete ancestry of
146
 
    one of its revisions.  
 
197
    one of its revisions.
147
198
 
148
199
    """
149
200
    found_ancestors = {}
153
204
        if anc_id not in found_ancestors:
154
205
            found_ancestors[anc_id] = (anc_order, anc_distance)
155
206
    return found_ancestors
156
 
    
 
207
 
157
208
 
158
209
def __get_closest(intersection):
159
210
    intersection.sort()
160
 
    matches = [] 
 
211
    matches = []
161
212
    for entry in intersection:
162
213
        if entry[0] == intersection[0][0]:
163
214
            matches.append(entry[2])
167
218
def is_reserved_id(revision_id):
168
219
    """Determine whether a revision id is reserved
169
220
 
170
 
    :return: True if the revision is is reserved, False otherwise
 
221
    :return: True if the revision is reserved, False otherwise
171
222
    """
172
223
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
173
224