← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisionspec.py

  • Committer: Martin Pool
  • Date: 2006-11-02 10:20:19 UTC
  • mfrom: (2114 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2119.
  • Revision ID: mbp@sourcefrog.net-20061102102019-9a5a02f485dff6f6
merge bzr.dev and reconcile several changes, also some test fixes

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revisionspec.py
1
1
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
 
18
import bisect
18
19
import datetime
19
20
import re
20
 
from bzrlib.errors import BzrError, NoSuchRevision, NoCommits
 
21
 
 
22
from bzrlib import (
 
23
    errors,
 
24
    revision,
 
25
    symbol_versioning,
 
26
    trace,
 
27
    tsort,
 
28
    )
 
29
 
21
30
 
22
31
_marker = []
23
32
 
 
33
 
24
34
class RevisionInfo(object):
25
35
    """The results of applying a revision specification to a branch.
26
36
 
57
67
        # TODO: otherwise, it should depend on how I was built -
58
68
        # if it's in_history(branch), then check revision_history(),
59
69
        # if it's in_store(branch), do the check below
60
 
        return self.branch.revision_store.has_id(self.rev_id)
 
70
        return self.branch.repository.has_revision(self.rev_id)
61
71
 
62
72
    def __len__(self):
63
73
        return 2
68
78
        raise IndexError(index)
69
79
 
70
80
    def get(self):
71
 
        return self.branch.get_revision(self.rev_id)
 
81
        return self.branch.repository.get_revision(self.rev_id)
72
82
 
73
83
    def __eq__(self, other):
74
84
        if type(other) not in (tuple, list, type(self)):
81
91
        return '<bzrlib.revisionspec.RevisionInfo object %s, %s for %r>' % (
82
92
            self.revno, self.rev_id, self.branch)
83
93
 
 
94
 
84
95
# classes in this list should have a "prefix" attribute, against which
85
96
# string specs are matched
86
97
SPEC_TYPES = []
 
98
_revno_regex = None
 
99
 
87
100
 
88
101
class RevisionSpec(object):
89
102
    """A parsed revision specification.
104
117
 
105
118
    prefix = None
106
119
 
107
 
    def __new__(cls, spec, foo=_marker):
108
 
        """Parse a revision specifier.
 
120
    def __new__(cls, spec, _internal=False):
 
121
        if _internal:
 
122
            return object.__new__(cls, spec, _internal=_internal)
 
123
 
 
124
        symbol_versioning.warn('Creating a RevisionSpec directly has'
 
125
                               ' been deprecated in version 0.11. Use'
 
126
                               ' RevisionSpec.from_string()'
 
127
                               ' instead.',
 
128
                               DeprecationWarning, stacklevel=2)
 
129
        return RevisionSpec.from_string(spec)
 
130
 
 
131
    @staticmethod
 
132
    def from_string(spec):
 
133
        """Parse a revision spec string into a RevisionSpec object.
 
134
 
 
135
        :param spec: A string specified by the user
 
136
        :return: A RevisionSpec object that understands how to parse the
 
137
            supplied notation.
109
138
        """
 
139
        if not isinstance(spec, (type(None), basestring)):
 
140
            raise TypeError('error')
 
141
 
110
142
        if spec is None:
111
 
            return object.__new__(RevisionSpec, spec)
112
 
 
113
 
        try:
114
 
            spec = int(spec)
115
 
        except ValueError:
116
 
            pass
117
 
 
118
 
        if isinstance(spec, int):
119
 
            return object.__new__(RevisionSpec_int, spec)
120
 
        elif isinstance(spec, basestring):
121
 
            for spectype in SPEC_TYPES:
122
 
                if spec.startswith(spectype.prefix):
123
 
                    return object.__new__(spectype, spec)
124
 
            else:
125
 
                raise BzrError('No namespace registered for string: %r' %
126
 
                               spec)
 
143
            return RevisionSpec(None, _internal=True)
 
144
 
 
145
        assert isinstance(spec, basestring), \
 
146
            "You should only supply strings not %s" % (type(spec),)
 
147
 
 
148
        for spectype in SPEC_TYPES:
 
149
            if spec.startswith(spectype.prefix):
 
150
                trace.mutter('Returning RevisionSpec %s for %s',
 
151
                             spectype.__name__, spec)
 
152
                return spectype(spec, _internal=True)
127
153
        else:
128
 
            raise TypeError('Unhandled revision type %s' % spec)
129
 
 
130
 
    def __init__(self, spec):
 
154
            # RevisionSpec_revno is special cased, because it is the only
 
155
            # one that directly handles plain integers
 
156
            # TODO: This should not be special cased rather it should be
 
157
            # a method invocation on spectype.canparse()
 
158
            global _revno_regex
 
159
            if _revno_regex is None:
 
160
                _revno_regex = re.compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
 
161
            if _revno_regex.match(spec) is not None:
 
162
                return RevisionSpec_revno(spec, _internal=True)
 
163
 
 
164
            raise errors.NoSuchRevisionSpec(spec)
 
165
 
 
166
    def __init__(self, spec, _internal=False):
 
167
        """Create a RevisionSpec referring to the Null revision.
 
168
 
 
169
        :param spec: The original spec supplied by the user
 
170
        :param _internal: Used to ensure that RevisionSpec is not being
 
171
            called directly. Only from RevisionSpec.from_string()
 
172
        """
 
173
        if not _internal:
 
174
            # XXX: Update this after 0.10 is released
 
175
            symbol_versioning.warn('Creating a RevisionSpec directly has'
 
176
                                   ' been deprecated in version 0.11. Use'
 
177
                                   ' RevisionSpec.from_string()'
 
178
                                   ' instead.',
 
179
                                   DeprecationWarning, stacklevel=2)
 
180
        self.user_spec = spec
131
181
        if self.prefix and spec.startswith(self.prefix):
132
182
            spec = spec[len(self.prefix):]
133
183
        self.spec = spec
134
184
 
135
185
    def _match_on(self, branch, revs):
 
186
        trace.mutter('Returning RevisionSpec._match_on: None')
136
187
        return RevisionInfo(branch, 0, None)
137
188
 
138
189
    def _match_on_and_check(self, branch, revs):
143
194
            # special case - the empty tree
144
195
            return info
145
196
        elif self.prefix:
146
 
            raise NoSuchRevision(branch, self.prefix + str(self.spec))
 
197
            raise errors.InvalidRevisionSpec(self.user_spec, branch)
147
198
        else:
148
 
            raise NoSuchRevision(branch, str(self.spec))
 
199
            raise errors.InvalidRevisionSpec(self.spec, branch)
149
200
 
150
201
    def in_history(self, branch):
151
 
        revs = branch.revision_history()
 
202
        if branch:
 
203
            revs = branch.revision_history()
 
204
        else:
 
205
            # this should never trigger.
 
206
            # TODO: make it a deprecated code path. RBC 20060928
 
207
            revs = None
152
208
        return self._match_on_and_check(branch, revs)
153
209
 
154
210
        # FIXME: in_history is somewhat broken,
163
219
        
164
220
    def __repr__(self):
165
221
        # this is mostly for helping with testing
166
 
        return '<%s %s%s>' % (self.__class__.__name__,
167
 
                              self.prefix or '',
168
 
                              self.spec)
 
222
        return '<%s %s>' % (self.__class__.__name__,
 
223
                              self.user_spec)
 
224
    
 
225
    def needs_branch(self):
 
226
        """Whether this revision spec needs a branch.
 
227
 
 
228
        Set this to False the branch argument of _match_on is not used.
 
229
        """
 
230
        return True
 
231
 
 
232
    def get_branch(self):
 
233
        """When the revision specifier contains a branch location, return it.
 
234
        
 
235
        Otherwise, return None.
 
236
        """
 
237
        return None
169
238
 
170
239
 
171
240
# private API
172
241
 
173
 
class RevisionSpec_int(RevisionSpec):
174
 
    """Spec is a number.  Special case."""
175
 
    def __init__(self, spec):
176
 
        self.spec = int(spec)
177
 
 
178
 
    def _match_on(self, branch, revs):
179
 
        if self.spec < 0:
180
 
            revno = len(revs) + self.spec + 1
181
 
        else:
182
 
            revno = self.spec
183
 
        rev_id = branch.get_rev_id(revno, revs)
184
 
        return RevisionInfo(branch, revno, rev_id)
185
 
 
186
 
 
187
242
class RevisionSpec_revno(RevisionSpec):
188
243
    prefix = 'revno:'
189
244
 
190
245
    def _match_on(self, branch, revs):
191
246
        """Lookup a revision by revision number"""
192
 
        try:
193
 
            return RevisionInfo(branch, int(self.spec))
194
 
        except ValueError:
195
 
            return RevisionInfo(branch, None)
 
247
        loc = self.spec.find(':')
 
248
        if loc == -1:
 
249
            revno_spec = self.spec
 
250
            branch_spec = None
 
251
        else:
 
252
            revno_spec = self.spec[:loc]
 
253
            branch_spec = self.spec[loc+1:]
 
254
 
 
255
        if revno_spec == '':
 
256
            if not branch_spec:
 
257
                raise errors.InvalidRevisionSpec(self.user_spec,
 
258
                        branch, 'cannot have an empty revno and no branch')
 
259
            revno = None
 
260
        else:
 
261
            try:
 
262
                revno = int(revno_spec)
 
263
                dotted = False
 
264
            except ValueError:
 
265
                # dotted decimal. This arguably should not be here
 
266
                # but the from_string method is a little primitive 
 
267
                # right now - RBC 20060928
 
268
                try:
 
269
                    match_revno = tuple((int(number) for number in revno_spec.split('.')))
 
270
                except ValueError, e:
 
271
                    raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
 
272
 
 
273
                dotted = True
 
274
 
 
275
        if branch_spec:
 
276
            # the user has override the branch to look in.
 
277
            # we need to refresh the revision_history map and
 
278
            # the branch object.
 
279
            from bzrlib.branch import Branch
 
280
            branch = Branch.open(branch_spec)
 
281
            # Need to use a new revision history
 
282
            # because we are using a specific branch
 
283
            revs = branch.revision_history()
 
284
 
 
285
        if dotted:
 
286
            branch.lock_read()
 
287
            try:
 
288
                last_rev = branch.last_revision()
 
289
                merge_sorted_revisions = tsort.merge_sort(
 
290
                    branch.repository.get_revision_graph(last_rev),
 
291
                    last_rev,
 
292
                    generate_revno=True)
 
293
                def match(item):
 
294
                    return item[3] == match_revno
 
295
                revisions = filter(match, merge_sorted_revisions)
 
296
            finally:
 
297
                branch.unlock()
 
298
            if len(revisions) != 1:
 
299
                return RevisionInfo(branch, None, None)
 
300
            else:
 
301
                # there is no traditional 'revno' for dotted-decimal revnos.
 
302
                # so for  API compatability we return None.
 
303
                return RevisionInfo(branch, None, revisions[0][1])
 
304
        else:
 
305
            if revno < 0:
 
306
                if (-revno) >= len(revs):
 
307
                    revno = 1
 
308
                else:
 
309
                    revno = len(revs) + revno + 1
 
310
            try:
 
311
                revision_id = branch.get_rev_id(revno, revs)
 
312
            except errors.NoSuchRevision:
 
313
                raise errors.InvalidRevisionSpec(self.user_spec, branch)
 
314
        return RevisionInfo(branch, revno, revision_id)
 
315
        
 
316
    def needs_branch(self):
 
317
        return self.spec.find(':') == -1
 
318
 
 
319
    def get_branch(self):
 
320
        if self.spec.find(':') == -1:
 
321
            return None
 
322
        else:
 
323
            return self.spec[self.spec.find(':')+1:]
 
324
 
 
325
# Old compatibility 
 
326
RevisionSpec_int = RevisionSpec_revno
196
327
 
197
328
SPEC_TYPES.append(RevisionSpec_revno)
198
329
 
202
333
 
203
334
    def _match_on(self, branch, revs):
204
335
        try:
205
 
            return RevisionInfo(branch, revs.index(self.spec) + 1, self.spec)
 
336
            revno = revs.index(self.spec) + 1
206
337
        except ValueError:
207
 
            return RevisionInfo(branch, None)
 
338
            revno = None
 
339
        return RevisionInfo(branch, revno, self.spec)
208
340
 
209
341
SPEC_TYPES.append(RevisionSpec_revid)
210
342
 
214
346
    prefix = 'last:'
215
347
 
216
348
    def _match_on(self, branch, revs):
 
349
        if self.spec == '':
 
350
            if not revs:
 
351
                raise errors.NoCommits(branch)
 
352
            return RevisionInfo(branch, len(revs), revs[-1])
 
353
 
217
354
        try:
218
355
            offset = int(self.spec)
219
 
        except ValueError:
220
 
            return RevisionInfo(branch, None)
221
 
        else:
222
 
            if offset <= 0:
223
 
                raise BzrError('You must supply a positive value for --revision last:XXX')
224
 
            return RevisionInfo(branch, len(revs) - offset + 1)
 
356
        except ValueError, e:
 
357
            raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
 
358
 
 
359
        if offset <= 0:
 
360
            raise errors.InvalidRevisionSpec(self.user_spec, branch,
 
361
                                             'you must supply a positive value')
 
362
        revno = len(revs) - offset + 1
 
363
        try:
 
364
            revision_id = branch.get_rev_id(revno, revs)
 
365
        except errors.NoSuchRevision:
 
366
            raise errors.InvalidRevisionSpec(self.user_spec, branch)
 
367
        return RevisionInfo(branch, revno, revision_id)
225
368
 
226
369
SPEC_TYPES.append(RevisionSpec_last)
227
370
 
231
374
    prefix = 'before:'
232
375
    
233
376
    def _match_on(self, branch, revs):
234
 
        r = RevisionSpec(self.spec)._match_on(branch, revs)
235
 
        if (r.revno is None) or (r.revno == 0):
236
 
            return r
237
 
        return RevisionInfo(branch, r.revno - 1)
 
377
        r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
 
378
        if r.revno == 0:
 
379
            raise errors.InvalidRevisionSpec(self.user_spec, branch,
 
380
                                         'cannot go before the null: revision')
 
381
        if r.revno is None:
 
382
            # We need to use the repository history here
 
383
            rev = branch.repository.get_revision(r.rev_id)
 
384
            if not rev.parent_ids:
 
385
                revno = 0
 
386
                revision_id = None
 
387
            else:
 
388
                revision_id = rev.parent_ids[0]
 
389
                try:
 
390
                    revno = revs.index(revision_id) + 1
 
391
                except ValueError:
 
392
                    revno = None
 
393
        else:
 
394
            revno = r.revno - 1
 
395
            try:
 
396
                revision_id = branch.get_rev_id(revno, revs)
 
397
            except errors.NoSuchRevision:
 
398
                raise errors.InvalidRevisionSpec(self.user_spec,
 
399
                                                 branch)
 
400
        return RevisionInfo(branch, revno, revision_id)
238
401
 
239
402
SPEC_TYPES.append(RevisionSpec_before)
240
403
 
243
406
    prefix = 'tag:'
244
407
 
245
408
    def _match_on(self, branch, revs):
246
 
        raise BzrError('tag: namespace registered, but not implemented.')
 
409
        raise errors.InvalidRevisionSpec(self.user_spec, branch,
 
410
                                         'tag: namespace registered,'
 
411
                                         ' but not implemented')
247
412
 
248
413
SPEC_TYPES.append(RevisionSpec_tag)
249
414
 
250
415
 
 
416
class _RevListToTimestamps(object):
 
417
    """This takes a list of revisions, and allows you to bisect by date"""
 
418
 
 
419
    __slots__ = ['revs', 'branch']
 
420
 
 
421
    def __init__(self, revs, branch):
 
422
        self.revs = revs
 
423
        self.branch = branch
 
424
 
 
425
    def __getitem__(self, index):
 
426
        """Get the date of the index'd item"""
 
427
        r = self.branch.repository.get_revision(self.revs[index])
 
428
        # TODO: Handle timezone.
 
429
        return datetime.datetime.fromtimestamp(r.timestamp)
 
430
 
 
431
    def __len__(self):
 
432
        return len(self.revs)
 
433
 
 
434
 
251
435
class RevisionSpec_date(RevisionSpec):
252
436
    prefix = 'date:'
253
437
    _date_re = re.compile(
265
449
          at a specified time).
266
450
 
267
451
          So the proper way of saying 'give me all entries for today' is:
268
 
              -r date:today..date:tomorrow
 
452
              -r date:yesterday..date:today
269
453
        """
270
454
        today = datetime.datetime.fromordinal(datetime.date.today().toordinal())
271
455
        if self.spec.lower() == 'yesterday':
277
461
        else:
278
462
            m = self._date_re.match(self.spec)
279
463
            if not m or (not m.group('date') and not m.group('time')):
280
 
                raise BzrError('Invalid revision date %r' % self.spec)
281
 
 
282
 
            if m.group('date'):
283
 
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
284
 
            else:
285
 
                year, month, day = today.year, today.month, today.day
286
 
            if m.group('time'):
287
 
                hour = int(m.group('hour'))
288
 
                minute = int(m.group('minute'))
289
 
                if m.group('second'):
290
 
                    second = int(m.group('second'))
291
 
                else:
292
 
                    second = 0
293
 
            else:
294
 
                hour, minute, second = 0,0,0
 
464
                raise errors.InvalidRevisionSpec(self.user_spec,
 
465
                                                 branch, 'invalid date')
 
466
 
 
467
            try:
 
468
                if m.group('date'):
 
469
                    year = int(m.group('year'))
 
470
                    month = int(m.group('month'))
 
471
                    day = int(m.group('day'))
 
472
                else:
 
473
                    year = today.year
 
474
                    month = today.month
 
475
                    day = today.day
 
476
 
 
477
                if m.group('time'):
 
478
                    hour = int(m.group('hour'))
 
479
                    minute = int(m.group('minute'))
 
480
                    if m.group('second'):
 
481
                        second = int(m.group('second'))
 
482
                    else:
 
483
                        second = 0
 
484
                else:
 
485
                    hour, minute, second = 0,0,0
 
486
            except ValueError:
 
487
                raise errors.InvalidRevisionSpec(self.user_spec,
 
488
                                                 branch, 'invalid date')
295
489
 
296
490
            dt = datetime.datetime(year=year, month=month, day=day,
297
491
                    hour=hour, minute=minute, second=second)
298
 
        first = dt
299
 
        for i in range(len(revs)):
300
 
            r = branch.get_revision(revs[i])
301
 
            # TODO: Handle timezone.
302
 
            dt = datetime.datetime.fromtimestamp(r.timestamp)
303
 
            if first <= dt:
304
 
                return RevisionInfo(branch, i+1)
305
 
        return RevisionInfo(branch, None)
 
492
        branch.lock_read()
 
493
        try:
 
494
            rev = bisect.bisect(_RevListToTimestamps(revs, branch), dt)
 
495
        finally:
 
496
            branch.unlock()
 
497
        if rev == len(revs):
 
498
            return RevisionInfo(branch, None)
 
499
        else:
 
500
            return RevisionInfo(branch, rev + 1)
306
501
 
307
502
SPEC_TYPES.append(RevisionSpec_date)
308
503
 
311
506
    prefix = 'ancestor:'
312
507
 
313
508
    def _match_on(self, branch, revs):
314
 
        from branch import Branch
315
 
        from revision import common_ancestor, MultipleRevisionSources
316
 
        other_branch = Branch.open_containing(self.spec)[0]
 
509
        from bzrlib.branch import Branch
 
510
 
 
511
        trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
 
512
        other_branch = Branch.open(self.spec)
317
513
        revision_a = branch.last_revision()
318
514
        revision_b = other_branch.last_revision()
319
515
        for r, b in ((revision_a, branch), (revision_b, other_branch)):
320
 
            if r is None:
321
 
                raise NoCommits(b)
322
 
        revision_source = MultipleRevisionSources(branch, other_branch)
323
 
        rev_id = common_ancestor(revision_a, revision_b, revision_source)
 
516
            if r in (None, revision.NULL_REVISION):
 
517
                raise errors.NoCommits(b)
 
518
        revision_source = revision.MultipleRevisionSources(
 
519
                branch.repository, other_branch.repository)
 
520
        rev_id = revision.common_ancestor(revision_a, revision_b,
 
521
                                          revision_source)
324
522
        try:
325
523
            revno = branch.revision_id_to_revno(rev_id)
326
 
        except NoSuchRevision:
 
524
        except errors.NoSuchRevision:
327
525
            revno = None
328
526
        return RevisionInfo(branch, revno, rev_id)
329
527
        
330
528
SPEC_TYPES.append(RevisionSpec_ancestor)
331
529
 
 
530
 
332
531
class RevisionSpec_branch(RevisionSpec):
333
532
    """A branch: revision specifier.
334
533
 
337
536
    prefix = 'branch:'
338
537
 
339
538
    def _match_on(self, branch, revs):
340
 
        from branch import Branch
341
 
        from fetch import greedy_fetch
342
 
        other_branch = Branch.open_containing(self.spec)[0]
 
539
        from bzrlib.branch import Branch
 
540
        other_branch = Branch.open(self.spec)
343
541
        revision_b = other_branch.last_revision()
344
 
        if revision_b is None:
345
 
            raise NoCommits(other_branch)
 
542
        if revision_b in (None, revision.NULL_REVISION):
 
543
            raise errors.NoCommits(other_branch)
346
544
        # pull in the remote revisions so we can diff
347
 
        greedy_fetch(branch, other_branch, revision=revision_b)
 
545
        branch.fetch(other_branch, revision_b)
348
546
        try:
349
547
            revno = branch.revision_id_to_revno(revision_b)
350
 
        except NoSuchRevision:
 
548
        except errors.NoSuchRevision:
351
549
            revno = None
352
550
        return RevisionInfo(branch, revno, revision_b)
353
551