/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

  • Committer: Robert Collins
  • Date: 2010-05-05 00:05:29 UTC
  • mto: This revision was merged to the branch mainline in revision 5206.
  • Revision ID: robertc@robertcollins.net-20100505000529-ltmllyms5watqj5u
Make 'pydoc bzrlib.tests.build_tree_shape' useful.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revision.py
1
 
# (C) 2005 Canonical
2
 
 
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
 
import bzrlib.errors
22
 
import bzrlib.errors as errors
23
 
from bzrlib.graph import node_distances, select_farthest, all_descendants, Graph
 
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
    )
24
30
from bzrlib.osutils import contains_whitespace
25
 
from bzrlib.progress import DummyProgress
26
31
 
27
32
NULL_REVISION="null:"
 
33
CURRENT_REVISION="current:"
 
34
 
28
35
 
29
36
class Revision(object):
30
37
    """Single revision on a branch.
40
47
 
41
48
    properties
42
49
        Dictionary of revision properties.  These are attached to the
43
 
        revision as extra metadata.  The name must be a single 
 
50
        revision as extra metadata.  The name must be a single
44
51
        word; the value can be an arbitrary string.
45
52
    """
46
 
    
 
53
 
47
54
    def __init__(self, revision_id, properties=None, **args):
48
55
        self.revision_id = revision_id
49
 
        self.properties = properties or {}
50
 
        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
51
62
        self.parent_ids = []
52
63
        self.parent_sha1s = []
 
64
        """Not used anymore - legacy from for 4."""
53
65
        self.__dict__.update(args)
54
66
 
55
67
    def __repr__(self):
58
70
    def __eq__(self, other):
59
71
        if not isinstance(other, Revision):
60
72
            return False
61
 
        # FIXME: rbc 20050930 parent_ids are not being compared
62
73
        return (
63
74
                self.inventory_sha1 == other.inventory_sha1
64
75
                and self.revision_id == other.revision_id
66
77
                and self.message == other.message
67
78
                and self.timezone == other.timezone
68
79
                and self.committer == other.committer
69
 
                and self.properties == other.properties)
 
80
                and self.properties == other.properties
 
81
                and self.parent_ids == other.parent_ids)
70
82
 
71
83
    def __ne__(self, other):
72
84
        return not self.__eq__(other)
73
85
 
74
86
    def _check_properties(self):
75
 
        """Verify that all revision properties are OK.
76
 
        """
 
87
        """Verify that all revision properties are OK."""
77
88
        for name, value in self.properties.iteritems():
78
89
            if not isinstance(name, basestring) or contains_whitespace(name):
79
90
                raise ValueError("invalid property name %r" % name)
80
91
            if not isinstance(value, basestring):
81
 
                raise ValueError("invalid property value %r for %r" % 
82
 
                                 (name, value))
 
92
                raise ValueError("invalid property value %r for %r" %
 
93
                                 (value, name))
83
94
 
84
95
    def get_history(self, repository):
85
96
        """Return the canonical line-of-history for this revision.
100
111
        reversed_result.reverse()
101
112
        return reversed_result
102
113
 
103
 
 
104
 
def is_ancestor(revision_id, candidate_id, branch):
105
 
    """Return true if candidate_id is an ancestor of revision_id.
106
 
 
107
 
    A false negative will be returned if any intermediate descendent of
108
 
    candidate_id is not present in any of the revision_sources.
109
 
    
110
 
    revisions_source is an object supporting a get_revision operation that
111
 
    behaves like Branch's.
112
 
    """
113
 
    return candidate_id in branch.repository.get_ancestry(revision_id)
 
114
    def get_summary(self):
 
115
        """Get the first line of the log message for this revision.
 
116
 
 
117
        Return an empty string if message is None.
 
118
        """
 
119
        if self.message:
 
120
            return self.message.lstrip().split('\n', 1)[0]
 
121
        else:
 
122
            return ''
 
123
 
 
124
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((1, 13, 0)))
 
125
    def get_apparent_author(self):
 
126
        """Return the apparent author of this revision.
 
127
 
 
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
114
169
 
115
170
 
116
171
def iter_ancestors(revision_id, revision_source, only_present=False):
123
178
                yield ancestor, distance
124
179
            try:
125
180
                revision = revision_source.get_revision(ancestor)
126
 
            except bzrlib.errors.NoSuchRevision, e:
 
181
            except errors.NoSuchRevision, e:
127
182
                if e.revision == revision_id:
128
 
                    raise 
 
183
                    raise
129
184
                else:
130
185
                    continue
131
186
            if only_present:
139
194
    """Return the ancestors of a revision present in a branch.
140
195
 
141
196
    It's possible that a branch won't have the complete ancestry of
142
 
    one of its revisions.  
 
197
    one of its revisions.
143
198
 
144
199
    """
145
200
    found_ancestors = {}
146
201
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
147
202
                         only_present=True))
148
203
    for anc_order, (anc_id, anc_distance) in anc_iter:
149
 
        if not found_ancestors.has_key(anc_id):
 
204
        if anc_id not in found_ancestors:
150
205
            found_ancestors[anc_id] = (anc_order, anc_distance)
151
206
    return found_ancestors
152
 
    
 
207
 
153
208
 
154
209
def __get_closest(intersection):
155
210
    intersection.sort()
156
 
    matches = [] 
 
211
    matches = []
157
212
    for entry in intersection:
158
213
        if entry[0] == intersection[0][0]:
159
214
            matches.append(entry[2])
160
215
    return matches
161
216
 
162
217
 
163
 
def revision_graph(revision, revision_source):
164
 
    """Produce a graph of the ancestry of the specified revision.
165
 
    
166
 
    :return: root, ancestors map, descendants map
167
 
    """
168
 
    revision_source.lock_read()
169
 
    try:
170
 
        return _revision_graph(revision, revision_source)
171
 
    finally:
172
 
        revision_source.unlock()
173
 
 
174
 
 
175
 
def _revision_graph(revision, revision_source):
176
 
    """See revision_graph."""
177
 
    from bzrlib.tsort import topo_sort
178
 
    graph = revision_source.get_revision_graph(revision)
179
 
    # mark all no-parent revisions as being NULL_REVISION parentage.
180
 
    for node, parents in graph.items():
181
 
        if len(parents) == 0:
182
 
            graph[node] = [NULL_REVISION]
183
 
    # add NULL_REVISION to the graph
184
 
    graph[NULL_REVISION] = []
185
 
 
186
 
    # pick a root. If there are multiple roots
187
 
    # this could pick a random one.
188
 
    topo_order = topo_sort(graph.items())
189
 
    root = topo_order[0]
190
 
 
191
 
    ancestors = {}
192
 
    descendants = {}
193
 
 
194
 
    # map the descendants of the graph.
195
 
    # and setup our set based return graph.
196
 
    for node in graph.keys():
197
 
        descendants[node] = {}
198
 
    for node, parents in graph.items():
199
 
        for parent in parents:
200
 
            descendants[parent][node] = 1
201
 
        ancestors[node] = set(parents)
202
 
 
203
 
    assert root not in descendants[root]
204
 
    assert root not in ancestors[root]
205
 
    return root, ancestors, descendants
206
 
 
207
 
 
208
 
def combined_graph(revision_a, revision_b, revision_source):
209
 
    """Produce a combined ancestry graph.
210
 
    Return graph root, ancestors map, descendants map, set of common nodes"""
211
 
    root, ancestors, descendants = revision_graph(
212
 
        revision_a, revision_source)
213
 
    root_b, ancestors_b, descendants_b = revision_graph(
214
 
        revision_b, revision_source)
215
 
    if root != root_b:
216
 
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
217
 
    common = set()
218
 
    for node, node_anc in ancestors_b.iteritems():
219
 
        if node in ancestors:
220
 
            common.add(node)
221
 
        else:
222
 
            ancestors[node] = set()
223
 
        ancestors[node].update(node_anc)
224
 
    for node, node_dec in descendants_b.iteritems():
225
 
        if node not in descendants:
226
 
            descendants[node] = {}
227
 
        descendants[node].update(node_dec)
228
 
    return root, ancestors, descendants, common
229
 
 
230
 
 
231
 
def common_ancestor(revision_a, revision_b, revision_source, 
232
 
                    pb=DummyProgress()):
233
 
    if None in (revision_a, revision_b):
234
 
        return None
235
 
    # trivial optimisation
236
 
    if revision_a == revision_b:
237
 
        return revision_a
238
 
    try:
239
 
        try:
240
 
            pb.update('Picking ancestor', 1, 3)
241
 
            graph = revision_source.get_revision_graph_with_ghosts(
242
 
                [revision_a, revision_b])
243
 
            # convert to a NULL_REVISION based graph.
244
 
            ancestors = graph.get_ancestors()
245
 
            descendants = graph.get_descendants()
246
 
            common = set(graph.get_ancestry(revision_a)).intersection(
247
 
                     set(graph.get_ancestry(revision_b)))
248
 
            descendants[NULL_REVISION] = {}
249
 
            ancestors[NULL_REVISION] = []
250
 
            for root in graph.roots:
251
 
                descendants[NULL_REVISION][root] = 1
252
 
                ancestors[root].append(NULL_REVISION)
253
 
            if len(graph.roots) == 0:
254
 
                # no reachable roots - not handled yet.
255
 
                raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
256
 
            root = NULL_REVISION
257
 
            common.add(NULL_REVISION)
258
 
        except bzrlib.errors.NoCommonRoot:
259
 
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
260
 
            
261
 
        pb.update('Picking ancestor', 2, 3)
262
 
        distances = node_distances (descendants, ancestors, root)
263
 
        pb.update('Picking ancestor', 3, 2)
264
 
        farthest = select_farthest(distances, common)
265
 
        if farthest is None or farthest == NULL_REVISION:
266
 
            raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
267
 
    finally:
268
 
        pb.clear()
269
 
    return farthest
270
 
 
271
 
 
272
 
class MultipleRevisionSources(object):
273
 
    """Proxy that looks in multiple branches for revisions."""
274
 
    def __init__(self, *args):
275
 
        object.__init__(self)
276
 
        assert len(args) != 0
277
 
        self._revision_sources = args
278
 
 
279
 
    def revision_parents(self, revision_id):
280
 
        for source in self._revision_sources:
281
 
            try:
282
 
                return source.revision_parents(revision_id)
283
 
            except (errors.WeaveRevisionNotPresent, errors.NoSuchRevision), e:
284
 
                pass
285
 
        raise e
286
 
 
287
 
    def get_revision(self, revision_id):
288
 
        for source in self._revision_sources:
289
 
            try:
290
 
                return source.get_revision(revision_id)
291
 
            except bzrlib.errors.NoSuchRevision, e:
292
 
                pass
293
 
        raise e
294
 
 
295
 
    def get_revision_graph(self, revision_id):
296
 
        # we could probe incrementally until the pending
297
 
        # ghosts list stop growing, but its cheaper for now
298
 
        # to just ask for the complete graph for each repository.
299
 
        graphs = []
300
 
        for source in self._revision_sources:
301
 
            ghost_graph = source.get_revision_graph_with_ghosts()
302
 
            graphs.append(ghost_graph)
303
 
        absent = 0
304
 
        for graph in graphs:
305
 
            if not revision_id in graph.get_ancestors():
306
 
                absent += 1
307
 
        if absent == len(graphs):
308
 
            raise errors.NoSuchRevision(self._revision_sources[0], revision_id)
309
 
 
310
 
        # combine the graphs
311
 
        result = {}
312
 
        pending = set([revision_id])
313
 
        def find_parents(node_id):
314
 
            """find the parents for node_id."""
315
 
            for graph in graphs:
316
 
                ancestors = graph.get_ancestors()
317
 
                try:
318
 
                    return ancestors[node_id]
319
 
                except KeyError:
320
 
                    pass
321
 
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
322
 
        while len(pending):
323
 
            # all the graphs should have identical parent lists
324
 
            node_id = pending.pop()
325
 
            try:
326
 
                result[node_id] = find_parents(node_id)
327
 
                for parent_node in result[node_id]:
328
 
                    if not parent_node in result:
329
 
                        pending.add(parent_node)
330
 
            except errors.NoSuchRevision:
331
 
                # ghost, ignore it.
332
 
                pass
333
 
        return result
334
 
 
335
 
    def get_revision_graph_with_ghosts(self, revision_ids):
336
 
        # query all the sources for their entire graphs 
337
 
        # and then build a combined graph for just
338
 
        # revision_ids.
339
 
        graphs = []
340
 
        for source in self._revision_sources:
341
 
            ghost_graph = source.get_revision_graph_with_ghosts()
342
 
            graphs.append(ghost_graph.get_ancestors())
343
 
        for revision_id in revision_ids:
344
 
            absent = 0
345
 
            for graph in graphs:
346
 
                    if not revision_id in graph:
347
 
                        absent += 1
348
 
            if absent == len(graphs):
349
 
                raise errors.NoSuchRevision(self._revision_sources[0],
350
 
                                            revision_id)
351
 
 
352
 
        # combine the graphs
353
 
        result = Graph()
354
 
        pending = set(revision_ids)
355
 
        done = set()
356
 
        def find_parents(node_id):
357
 
            """find the parents for node_id."""
358
 
            for graph in graphs:
359
 
                try:
360
 
                    return graph[node_id]
361
 
                except KeyError:
362
 
                    pass
363
 
            raise errors.NoSuchRevision(self._revision_sources[0], node_id)
364
 
        while len(pending):
365
 
            # all the graphs should have identical parent lists
366
 
            node_id = pending.pop()
367
 
            try:
368
 
                parents = find_parents(node_id)
369
 
                for parent_node in parents:
370
 
                    # queued or done? 
371
 
                    if (parent_node not in pending and
372
 
                        parent_node not in done):
373
 
                        # no, queue
374
 
                        pending.add(parent_node)
375
 
                result.add_node(node_id, parents)
376
 
                done.add(node_id)
377
 
            except errors.NoSuchRevision:
378
 
                # ghost
379
 
                result.add_ghost(node_id)
380
 
                continue
381
 
        return result
382
 
 
383
 
    def lock_read(self):
384
 
        for source in self._revision_sources:
385
 
            source.lock_read()
386
 
 
387
 
    def unlock(self):
388
 
        for source in self._revision_sources:
389
 
            source.unlock()
390
 
 
391
 
 
392
 
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
393
 
                              revision_history=None):
394
 
    """Find the longest line of descent from maybe_ancestor to revision.
395
 
    Revision history is followed where possible.
396
 
 
397
 
    If ancestor_id == rev_id, list will be empty.
398
 
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
399
 
    If ancestor_id is not an ancestor, NotAncestor will be thrown
400
 
    """
401
 
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
402
 
    if len(descendants) == 0:
403
 
        raise NoSuchRevision(rev_source, rev_id)
404
 
    if ancestor_id not in descendants:
405
 
        rev_source.get_revision(ancestor_id)
406
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
407
 
    root_descendants = all_descendants(descendants, ancestor_id)
408
 
    root_descendants.add(ancestor_id)
409
 
    if rev_id not in root_descendants:
410
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
411
 
    distances = node_distances(descendants, ancestors, ancestor_id,
412
 
                               root_descendants=root_descendants)
413
 
 
414
 
    def best_ancestor(rev_id):
415
 
        best = None
416
 
        for anc_id in ancestors[rev_id]:
417
 
            try:
418
 
                distance = distances[anc_id]
419
 
            except KeyError:
420
 
                continue
421
 
            if revision_history is not None and anc_id in revision_history:
422
 
                return anc_id
423
 
            elif best is None or distance > best[1]:
424
 
                best = (anc_id, distance)
425
 
        return best[0]
426
 
 
427
 
    next = rev_id
428
 
    path = []
429
 
    while next != ancestor_id:
430
 
        path.append(next)
431
 
        next = best_ancestor(next)
432
 
    path.reverse()
433
 
    return path
 
218
def is_reserved_id(revision_id):
 
219
    """Determine whether a revision id is reserved
 
220
 
 
221
    :return: True if the revision is reserved, False otherwise
 
222
    """
 
223
    return isinstance(revision_id, basestring) and revision_id.endswith(':')
 
224
 
 
225
 
 
226
def check_not_reserved_id(revision_id):
 
227
    """Raise ReservedId if the supplied revision_id is reserved"""
 
228
    if is_reserved_id(revision_id):
 
229
        raise errors.ReservedId(revision_id)
 
230
 
 
231
 
 
232
def ensure_null(revision_id):
 
233
    """Ensure only NULL_REVISION is used to represent the null revision"""
 
234
    if revision_id is None:
 
235
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
236
            ' revision instead of None, as of bzr 0.91.',
 
237
            DeprecationWarning, stacklevel=2)
 
238
        return NULL_REVISION
 
239
    else:
 
240
        return revision_id
 
241
 
 
242
 
 
243
def is_null(revision_id):
 
244
    if revision_id is None:
 
245
        symbol_versioning.warn('NULL_REVISION should be used for the null'
 
246
            ' revision instead of None, as of bzr 0.90.',
 
247
            DeprecationWarning, stacklevel=2)
 
248
    return revision_id in (None, NULL_REVISION)