~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revision.py

  • Committer: Robert Collins
  • Date: 2005-08-24 07:40:52 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050824074052-2e9ec0dd13958d20
make tests stop at the first failure, preventing multi-page omgs

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
 
17
17
 
18
18
import bzrlib.errors
19
 
from bzrlib.graph import node_distances, select_farthest, all_descendants
20
19
 
21
 
NULL_REVISION="null:"
22
20
 
23
21
class RevisionReference(object):
24
22
    """
72
70
    def __repr__(self):
73
71
        return "<Revision id %s>" % self.revision_id
74
72
 
75
 
    def __eq__(self, other):
76
 
        if not isinstance(other, Revision):
77
 
            return False
78
 
        return (self.inventory_id == other.inventory_id
79
 
                and self.inventory_sha1 == other.inventory_sha1
80
 
                and self.revision_id == other.revision_id
81
 
                and self.timestamp == other.timestamp
82
 
                and self.message == other.message
83
 
                and self.timezone == other.timezone
84
 
                and self.committer == other.committer)
85
 
 
86
 
    def __ne__(self, other):
87
 
        return not self.__eq__(other)
88
 
 
89
 
        
 
73
        
 
74
    def to_element(self):
 
75
        from bzrlib.xml import Element, SubElement
 
76
        
 
77
        root = Element('revision',
 
78
                       committer = self.committer,
 
79
                       timestamp = '%.9f' % self.timestamp,
 
80
                       revision_id = self.revision_id,
 
81
                       inventory_id = self.inventory_id,
 
82
                       inventory_sha1 = self.inventory_sha1,
 
83
                       )
 
84
        if self.timezone:
 
85
            root.set('timezone', str(self.timezone))
 
86
        root.text = '\n'
 
87
        
 
88
        msg = SubElement(root, 'message')
 
89
        msg.text = self.message
 
90
        msg.tail = '\n'
 
91
 
 
92
        if self.parents:
 
93
            pelts = SubElement(root, 'parents')
 
94
            pelts.tail = pelts.text = '\n'
 
95
            for rr in self.parents:
 
96
                assert isinstance(rr, RevisionReference)
 
97
                p = SubElement(pelts, 'revision_ref')
 
98
                p.tail = '\n'
 
99
                assert rr.revision_id
 
100
                p.set('revision_id', rr.revision_id)
 
101
                if rr.revision_sha1:
 
102
                    p.set('revision_sha1', rr.revision_sha1)
 
103
 
 
104
        return root
 
105
 
 
106
 
 
107
    def from_element(cls, elt):
 
108
        return unpack_revision(elt)
 
109
 
 
110
    from_element = classmethod(from_element)
 
111
 
 
112
 
 
113
 
 
114
def unpack_revision(elt):
 
115
    """Convert XML element into Revision object."""
 
116
    # <changeset> is deprecated...
 
117
    if elt.tag not in ('revision', 'changeset'):
 
118
        raise bzrlib.errors.BzrError("unexpected tag in revision file: %r" % elt)
 
119
 
 
120
    rev = Revision(committer = elt.get('committer'),
 
121
                   timestamp = float(elt.get('timestamp')),
 
122
                   revision_id = elt.get('revision_id'),
 
123
                   inventory_id = elt.get('inventory_id'),
 
124
                   inventory_sha1 = elt.get('inventory_sha1')
 
125
                   )
 
126
 
 
127
    precursor = elt.get('precursor')
 
128
    precursor_sha1 = elt.get('precursor_sha1')
 
129
 
 
130
    pelts = elt.find('parents')
 
131
 
 
132
    if pelts:
 
133
        for p in pelts:
 
134
            assert p.tag == 'revision_ref', \
 
135
                   "bad parent node tag %r" % p.tag
 
136
            rev_ref = RevisionReference(p.get('revision_id'),
 
137
                                        p.get('revision_sha1'))
 
138
            rev.parents.append(rev_ref)
 
139
 
 
140
        if precursor:
 
141
            # must be consistent
 
142
            prec_parent = rev.parents[0].revision_id
 
143
            assert prec_parent == precursor
 
144
    elif precursor:
 
145
        # revisions written prior to 0.0.5 have a single precursor
 
146
        # give as an attribute
 
147
        rev_ref = RevisionReference(precursor, precursor_sha1)
 
148
        rev.parents.append(rev_ref)
 
149
 
 
150
    v = elt.get('timezone')
 
151
    rev.timezone = v and int(v)
 
152
 
 
153
    rev.message = elt.findtext('message') # text of <message>
 
154
    return rev
 
155
 
 
156
 
90
157
 
91
158
REVISION_ID_RE = None
92
159
 
108
175
    revisions_source is an object supporting a get_revision operation that
109
176
    behaves like Branch's.
110
177
    """
111
 
    if candidate_id is None:
112
 
        return True
113
 
    for ancestor_id, distance in iter_ancestors(revision_id, revision_source):
114
 
        if ancestor_id == candidate_id:
115
 
            return True
116
 
    return False
117
178
 
118
 
def iter_ancestors(revision_id, revision_source, only_present=False):
119
179
    ancestors = (revision_id,)
120
 
    distance = 0
121
180
    while len(ancestors) > 0:
122
181
        new_ancestors = []
123
182
        for ancestor in ancestors:
124
 
            if not only_present:
125
 
                yield ancestor, distance
 
183
            if ancestor == candidate_id:
 
184
                return True
126
185
            try:
127
186
                revision = revision_source.get_revision(ancestor)
128
187
            except bzrlib.errors.NoSuchRevision, e:
130
189
                    raise 
131
190
                else:
132
191
                    continue
133
 
            if only_present:
134
 
                yield ancestor, distance
135
192
            new_ancestors.extend([p.revision_id for p in revision.parents])
136
193
        ancestors = new_ancestors
137
 
        distance += 1
138
 
 
139
 
 
140
 
def find_present_ancestors(revision_id, revision_source):
141
 
    """Return the ancestors of a revision present in a branch.
142
 
 
143
 
    It's possible that a branch won't have the complete ancestry of
144
 
    one of its revisions.  
145
 
 
146
 
    """
147
 
    found_ancestors = {}
148
 
    anc_iter = enumerate(iter_ancestors(revision_id, revision_source,
149
 
                         only_present=True))
150
 
    for anc_order, (anc_id, anc_distance) in anc_iter:
151
 
        if not found_ancestors.has_key(anc_id):
152
 
            found_ancestors[anc_id] = (anc_order, anc_distance)
153
 
    return found_ancestors
154
 
    
155
 
 
156
 
def __get_closest(intersection):
157
 
    intersection.sort()
158
 
    matches = [] 
159
 
    for entry in intersection:
160
 
        if entry[0] == intersection[0][0]:
161
 
            matches.append(entry[2])
162
 
    return matches
163
 
 
164
 
 
165
 
def old_common_ancestor(revision_a, revision_b, revision_source):
166
 
    """Find the ancestor common to both revisions that is closest to both.
167
 
    """
168
 
    from bzrlib.trace import mutter
169
 
    a_ancestors = find_present_ancestors(revision_a, revision_source)
170
 
    b_ancestors = find_present_ancestors(revision_b, revision_source)
171
 
    a_intersection = []
172
 
    b_intersection = []
173
 
    # a_order is used as a tie-breaker when two equally-good bases are found
174
 
    for revision, (a_order, a_distance) in a_ancestors.iteritems():
175
 
        if b_ancestors.has_key(revision):
176
 
            a_intersection.append((a_distance, a_order, revision))
177
 
            b_intersection.append((b_ancestors[revision][1], a_order, revision))
178
 
    mutter("a intersection: %r" % a_intersection)
179
 
    mutter("b intersection: %r" % b_intersection)
180
 
 
181
 
    a_closest = __get_closest(a_intersection)
182
 
    if len(a_closest) == 0:
183
 
        return None
184
 
    b_closest = __get_closest(b_intersection)
185
 
    assert len(b_closest) != 0
186
 
    mutter ("a_closest %r" % a_closest)
187
 
    mutter ("b_closest %r" % b_closest)
188
 
    if a_closest[0] in b_closest:
189
 
        return a_closest[0]
190
 
    elif b_closest[0] in a_closest:
191
 
        return b_closest[0]
192
 
    else:
193
 
        raise bzrlib.errors.AmbiguousBase((a_closest[0], b_closest[0]))
194
 
    return a_closest[0]
195
 
 
196
 
def revision_graph(revision, revision_source):
197
 
    """Produce a graph of the ancestry of the specified revision.
198
 
    Return root, ancestors map, descendants map
199
 
 
200
 
    TODO: Produce graphs with the NULL revision as root, so that we can find
201
 
    a common even when trees are not branches don't represent a single line
202
 
    of descent.
203
 
    """
204
 
    ancestors = {}
205
 
    descendants = {}
206
 
    lines = [revision]
207
 
    root = None
208
 
    descendants[revision] = {}
209
 
    while len(lines) > 0:
210
 
        new_lines = set()
211
 
        for line in lines:
212
 
            if line == NULL_REVISION:
213
 
                parents = []
214
 
                root = NULL_REVISION
215
 
            else:
216
 
                try:
217
 
                    rev = revision_source.get_revision(line)
218
 
                    parents = [p.revision_id for p in rev.parents]
219
 
                    if len(parents) == 0:
220
 
                        parents = [NULL_REVISION]
221
 
                except bzrlib.errors.NoSuchRevision:
222
 
                    if line == revision:
223
 
                        raise
224
 
                    parents = None
225
 
            if parents is not None:
226
 
                for parent in parents:
227
 
                    if parent not in ancestors:
228
 
                        new_lines.add(parent)
229
 
                    if parent not in descendants:
230
 
                        descendants[parent] = {}
231
 
                    descendants[parent][line] = 1
232
 
            if parents is not None:
233
 
                ancestors[line] = set(parents)
234
 
        lines = new_lines
235
 
    assert root not in descendants[root]
236
 
    assert root not in ancestors[root]
237
 
    return root, ancestors, descendants
238
 
 
239
 
def combined_graph(revision_a, revision_b, revision_source):
240
 
    """Produce a combined ancestry graph.
241
 
    Return graph root, ancestors map, descendants map, set of common nodes"""
242
 
    root, ancestors, descendants = revision_graph(revision_a, revision_source)
243
 
    root_b, ancestors_b, descendants_b = revision_graph(revision_b, 
244
 
                                                        revision_source)
245
 
    if root != root_b:
246
 
        raise bzrlib.errors.NoCommonRoot(revision_a, revision_b)
247
 
    common = set()
248
 
    for node, node_anc in ancestors_b.iteritems():
249
 
        if node in ancestors:
250
 
            common.add(node)
251
 
        else:
252
 
            ancestors[node] = set()
253
 
        ancestors[node].update(node_anc)
254
 
    for node, node_dec in descendants_b.iteritems():
255
 
        if node not in descendants:
256
 
            descendants[node] = set()
257
 
        descendants[node].update(node_dec)
258
 
    return root, ancestors, descendants, common
259
 
 
260
 
def common_ancestor(revision_a, revision_b, revision_source):
261
 
    try:
262
 
        root, ancestors, descendants, common = \
263
 
            combined_graph(revision_a, revision_b, revision_source)
264
 
    except bzrlib.errors.NoCommonRoot:
265
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
266
 
        
267
 
    distances = node_distances (descendants, ancestors, root)
268
 
    farthest = select_farthest(distances, common)
269
 
    if farthest is None or farthest == NULL_REVISION:
270
 
        raise bzrlib.errors.NoCommonAncestor(revision_a, revision_b)
271
 
    return farthest
 
194
 
272
195
 
273
196
class MultipleRevisionSources(object):
274
 
    """Proxy that looks in multiple branches for revisions."""
275
197
    def __init__(self, *args):
276
198
        object.__init__(self)
277
199
        assert len(args) != 0
284
206
            except bzrlib.errors.NoSuchRevision, e:
285
207
                pass
286
208
        raise e
287
 
 
288
 
def get_intervening_revisions(ancestor_id, rev_id, rev_source, 
289
 
                              revision_history=None):
290
 
    """Find the longest line of descent from maybe_ancestor to revision.
291
 
    Revision history is followed where possible.
292
 
 
293
 
    If ancestor_id == rev_id, list will be empty.
294
 
    Otherwise, rev_id will be the last entry.  ancestor_id will never appear.
295
 
    If ancestor_id is not an ancestor, NotAncestor will be thrown
296
 
    """
297
 
    root, ancestors, descendants = revision_graph(rev_id, rev_source)
298
 
    if len(descendants) == 0:
299
 
        raise NoSuchRevision(rev_source, rev_id)
300
 
    if ancestor_id not in descendants:
301
 
        rev_source.get_revision(ancestor_id)
302
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
303
 
    root_descendants = all_descendants(descendants, ancestor_id)
304
 
    root_descendants.add(ancestor_id)
305
 
    if rev_id not in root_descendants:
306
 
        raise bzrlib.errors.NotAncestor(rev_id, ancestor_id)
307
 
    distances = node_distances(descendants, ancestors, ancestor_id,
308
 
                               root_descendants=root_descendants)
309
 
 
310
 
    def best_ancestor(rev_id):
311
 
        best = None
312
 
        for anc_id in ancestors[rev_id]:
313
 
            try:
314
 
                distance = distances[anc_id]
315
 
            except KeyError:
316
 
                continue
317
 
            if revision_history is not None and anc_id in revision_history:
318
 
                return anc_id
319
 
            elif best is None or distance > best[1]:
320
 
                best = (anc_id, distance)
321
 
        return best[0]
322
 
 
323
 
    next = rev_id
324
 
    path = []
325
 
    while next != ancestor_id:
326
 
        path.append(next)
327
 
        next = best_ancestor(next)
328
 
    path.reverse()
329
 
    return path