← 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: 2006-06-19 19:48:46 UTC
  • mto: This revision was merged to the branch mainline in revision 1793.
  • Revision ID: abentley@panoramicfeedback.com-20060619194846-dfc4bfa8a1182bd1
Add advice on skipping tests to HACKING

Show diffs side-by-side

added added

removed removed

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