← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Aaron Bentley
  • Date: 2008-11-04 19:59:11 UTC
  • mto: This revision was merged to the branch mainline in revision 3823.
  • Revision ID: aaron@aaronbentley.com-20081104195911-oe0co22ksc2bio8p
Update NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
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
24
""")
26
25
from bzrlib import (
27
26
    errors,
28
27
    symbol_versioning,
29
28
    )
30
29
from bzrlib.osutils import contains_whitespace
 
30
from bzrlib.progress import DummyProgress
31
31
 
32
32
NULL_REVISION="null:"
33
33
CURRENT_REVISION="current:"
47
47
 
48
48
    properties
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.
52
52
    """
53
 
 
 
53
    
54
54
    def __init__(self, revision_id, properties=None, **args):
55
55
        self.revision_id = revision_id
56
 
        if properties is None:
57
 
            self.properties = {}
58
 
        else:
59
 
            self.properties = properties
60
 
            self._check_properties()
61
 
        self.committer = None
 
56
        self.properties = properties or {}
 
57
        self._check_properties()
62
58
        self.parent_ids = []
63
59
        self.parent_sha1s = []
64
60
        """Not used anymore - legacy from for 4."""
70
66
    def __eq__(self, other):
71
67
        if not isinstance(other, Revision):
72
68
            return False
 
69
        # FIXME: rbc 20050930 parent_ids are not being compared
73
70
        return (
74
71
                self.inventory_sha1 == other.inventory_sha1
75
72
                and self.revision_id == other.revision_id
77
74
                and self.message == other.message
78
75
                and self.timezone == other.timezone
79
76
                and self.committer == other.committer
80
 
                and self.properties == other.properties
81
 
                and self.parent_ids == other.parent_ids)
 
77
                and self.properties == other.properties)
82
78
 
83
79
    def __ne__(self, other):
84
80
        return not self.__eq__(other)
89
85
            if not isinstance(name, basestring) or contains_whitespace(name):
90
86
                raise ValueError("invalid property name %r" % name)
91
87
            if not isinstance(value, basestring):
92
 
                raise ValueError("invalid property value %r for %r" %
93
 
                                 (value, name))
 
88
                raise ValueError("invalid property value %r for %r" % 
 
89
                                 (name, value))
94
90
 
95
91
    def get_history(self, repository):
96
92
        """Return the canonical line-of-history for this revision.
113
109
 
114
110
    def get_summary(self):
115
111
        """Get the first line of the log message for this revision.
116
 
 
117
 
        Return an empty string if message is None.
118
112
        """
119
 
        if self.message:
120
 
            return self.message.lstrip().split('\n', 1)[0]
121
 
        else:
122
 
            return ''
 
113
        return self.message.lstrip().split('\n', 1)[0]
123
114
 
124
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
125
115
    def get_apparent_author(self):
126
116
        """Return the apparent author of this revision.
127
117
 
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
        If the revision properties contain the author name,
 
119
        return it. Otherwise return the committer name.
 
120
        """
 
121
        return self.properties.get('author', self.committer)
169
122
 
170
123
 
171
124
def iter_ancestors(revision_id, revision_source, only_present=False):
180
133
                revision = revision_source.get_revision(ancestor)
181
134
            except errors.NoSuchRevision, e:
182
135
                if e.revision == revision_id:
183
 
                    raise
 
136
                    raise 
184
137
                else:
185
138
                    continue
186
139
            if only_present:
194
147
    """Return the ancestors of a revision present in a branch.
195
148
 
196
149
    It's possible that a branch won't have the complete ancestry of
197
 
    one of its revisions.
 
150
    one of its revisions.  
198
151
 
199
152
    """
200
153
    found_ancestors = {}
204
157
        if anc_id not in found_ancestors:
205
158
            found_ancestors[anc_id] = (anc_order, anc_distance)
206
159
    return found_ancestors
207
 
 
 
160
    
208
161
 
209
162
def __get_closest(intersection):
210
163
    intersection.sort()
211
 
    matches = []
 
164
    matches = [] 
212
165
    for entry in intersection:
213
166
        if entry[0] == intersection[0][0]:
214
167
            matches.append(entry[2])
218
171
def is_reserved_id(revision_id):
219
172
    """Determine whether a revision id is reserved
220
173
 
221
 
    :return: True if the revision is reserved, False otherwise
 
174
    :return: True if the revision is is reserved, False otherwise
222
175
    """
223
176
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
224
177