/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

Fix formatting, remove catch-all for exceptions when opening local repositories.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
# TODO: Some kind of command-line display of revision properties:
18
 
# perhaps show them in log -v and allow them as options to the commit command.
19
 
 
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
 
""")
26
 
from bzrlib import (
27
 
    errors,
28
 
    symbol_versioning,
29
 
    )
30
 
from bzrlib.osutils import contains_whitespace
31
 
from bzrlib.progress import DummyProgress
32
 
 
33
 
NULL_REVISION="null:"
34
 
CURRENT_REVISION="current:"
35
 
 
36
 
 
37
 
class Revision(object):
38
 
    """Single revision on a branch.
39
 
 
40
 
    Revisions may know their revision_hash, but only once they've been
41
 
    written out.  This is not stored because you cannot write the hash
42
 
    into the file it describes.
43
 
 
44
 
    After bzr 0.0.5 revisions are allowed to have multiple parents.
45
 
 
46
 
    parent_ids
47
 
        List of parent revision_ids
48
 
 
49
 
    properties
50
 
        Dictionary of revision properties.  These are attached to the
51
 
        revision as extra metadata.  The name must be a single
52
 
        word; the value can be an arbitrary string.
53
 
    """
54
 
 
55
 
    def __init__(self, revision_id, properties=None, **args):
56
 
        self.revision_id = revision_id
57
 
        self.properties = properties or {}
58
 
        self._check_properties()
59
 
        self.parent_ids = []
60
 
        self.parent_sha1s = []
61
 
        """Not used anymore - legacy from for 4."""
62
 
        self.__dict__.update(args)
63
 
 
64
 
    def __repr__(self):
65
 
        return "<Revision id %s>" % self.revision_id
66
 
 
67
 
    def __eq__(self, other):
68
 
        if not isinstance(other, Revision):
69
 
            return False
70
 
        # FIXME: rbc 20050930 parent_ids are not being compared
71
 
        return (
72
 
                self.inventory_sha1 == other.inventory_sha1
73
 
                and self.revision_id == other.revision_id
74
 
                and self.timestamp == other.timestamp
75
 
                and self.message == other.message
76
 
                and self.timezone == other.timezone
77
 
                and self.committer == other.committer
78
 
                and self.properties == other.properties)
79
 
 
80
 
    def __ne__(self, other):
81
 
        return not self.__eq__(other)
82
 
 
83
 
    def _check_properties(self):
84
 
        """Verify that all revision properties are OK."""
85
 
        for name, value in self.properties.iteritems():
86
 
            if not isinstance(name, basestring) or contains_whitespace(name):
87
 
                raise ValueError("invalid property name %r" % name)
88
 
            if not isinstance(value, basestring):
89
 
                raise ValueError("invalid property value %r for %r" %
90
 
                                 (name, value))
91
 
 
92
 
    def get_history(self, repository):
93
 
        """Return the canonical line-of-history for this revision.
94
 
 
95
 
        If ghosts are present this may differ in result from a ghost-free
96
 
        repository.
97
 
        """
98
 
        current_revision = self
99
 
        reversed_result = []
100
 
        while current_revision is not None:
101
 
            reversed_result.append(current_revision.revision_id)
102
 
            if not len (current_revision.parent_ids):
103
 
                reversed_result.append(None)
104
 
                current_revision = None
105
 
            else:
106
 
                next_revision_id = current_revision.parent_ids[0]
107
 
                current_revision = repository.get_revision(next_revision_id)
108
 
        reversed_result.reverse()
109
 
        return reversed_result
110
 
 
111
 
    def get_summary(self):
112
 
        """Get the first line of the log message for this revision.
113
 
        """
114
 
        return self.message.lstrip().split('\n', 1)[0]
115
 
 
116
 
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
117
 
    def get_apparent_author(self):
118
 
        """Return the apparent author of this revision.
119
 
 
120
 
        This method is deprecated in favour of get_apparent_authors.
121
 
 
122
 
        If the revision properties contain any author names,
123
 
        return the first. Otherwise return the committer name.
124
 
        """
125
 
        return self.get_apparent_authors()[0]
126
 
 
127
 
    def get_apparent_authors(self):
128
 
        """Return the apparent authors of this revision.
129
 
 
130
 
        If the revision properties contain the names of the authors,
131
 
        return them. Otherwise return the committer name.
132
 
 
133
 
        The return value will be a list containing at least one element.
134
 
        """
135
 
        authors = self.properties.get('authors', None)
136
 
        if authors is None:
137
 
            author = self.properties.get('author', None)
138
 
            if author is None:
139
 
                return [self.committer]
140
 
            return [author]
141
 
        else:
142
 
            return authors.split("\n")
143
 
 
144
 
    def iter_bugs(self):
145
 
        """Iterate over the bugs associated with this revision."""
146
 
        bug_property = self.properties.get('bugs', None)
147
 
        if bug_property is None:
148
 
            return
149
 
        for line in bug_property.splitlines():
150
 
            try:
151
 
                url, status = line.split(None, 2)
152
 
            except ValueError:
153
 
                raise errors.InvalidLineInBugsProperty(line)
154
 
            if status not in bugtracker.ALLOWED_BUG_STATUSES:
155
 
                raise errors.InvalidBugStatus(status)
156
 
            yield url, status
157
 
 
158
 
 
159
 
def iter_ancestors(revision_id, revision_source, only_present=False):
160
 
    ancestors = (revision_id,)
161
 
    distance = 0
162
 
    while len(ancestors) > 0:
163
 
        new_ancestors = []
164
 
        for ancestor in ancestors:
165
 
            if not only_present:
166
 
                yield ancestor, distance
167
 
            try:
168
 
                revision = revision_source.get_revision(ancestor)
169
 
            except errors.NoSuchRevision, e:
170
 
                if e.revision == revision_id:
171
 
                    raise
172
 
                else:
173
 
                    continue
174
 
            if only_present:
175
 
                yield ancestor, distance
176
 
            new_ancestors.extend(revision.parent_ids)
177
 
        ancestors = new_ancestors
178
 
        distance += 1
179
 
 
180
 
 
181
 
def find_present_ancestors(revision_id, revision_source):
182
 
    """Return the ancestors of a revision present in a branch.
183
 
 
184
 
    It's possible that a branch won't have the complete ancestry of
185
 
    one of its revisions.
186
 
 
187
 
    """
188
 
    found_ancestors = {}
189
 
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
190
 
                         only_present=True))
191
 
    for anc_order, (anc_id, anc_distance) in anc_iter:
192
 
        if anc_id not in found_ancestors:
193
 
            found_ancestors[anc_id] = (anc_order, anc_distance)
194
 
    return found_ancestors
195
 
 
196
 
 
197
 
def __get_closest(intersection):
198
 
    intersection.sort()
199
 
    matches = []
200
 
    for entry in intersection:
201
 
        if entry[0] == intersection[0][0]:
202
 
            matches.append(entry[2])
203
 
    return matches
204
 
 
205
 
 
206
 
def is_reserved_id(revision_id):
207
 
    """Determine whether a revision id is reserved
208
 
 
209
 
    :return: True if the revision is is reserved, False otherwise
210
 
    """
211
 
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
212
 
 
213
 
 
214
 
def check_not_reserved_id(revision_id):
215
 
    """Raise ReservedId if the supplied revision_id is reserved"""
216
 
    if is_reserved_id(revision_id):
217
 
        raise errors.ReservedId(revision_id)
218
 
 
219
 
 
220
 
def ensure_null(revision_id):
221
 
    """Ensure only NULL_REVISION is used to represent the null revision"""
222
 
    if revision_id is None:
223
 
        symbol_versioning.warn('NULL_REVISION should be used for the null'
224
 
            ' revision instead of None, as of bzr 0.91.',
225
 
            DeprecationWarning, stacklevel=2)
226
 
        return NULL_REVISION
227
 
    else:
228
 
        return revision_id
229
 
 
230
 
 
231
 
def is_null(revision_id):
232
 
    if revision_id is None:
233
 
        symbol_versioning.warn('NULL_REVISION should be used for the null'
234
 
            ' revision instead of None, as of bzr 0.90.',
235
 
            DeprecationWarning, stacklevel=2)
236
 
    return revision_id in (None, NULL_REVISION)