~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/revisionspec.py

  • Committer: John Arbash Meinel
  • Date: 2006-10-06 07:13:51 UTC
  • mto: This revision was merged to the branch mainline in revision 2071.
  • Revision ID: john@arbash-meinel.com-20061006071351-e3fdd47eed1c3e7e
lazy import revisionspec and errors for bzrlib.options

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
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
21
21
 
22
22
from bzrlib import (
23
23
    errors,
24
 
    osutils,
25
24
    revision,
26
25
    symbol_versioning,
27
26
    trace,
28
 
    tsort,
29
27
    )
30
28
 
31
29
 
33
31
 
34
32
 
35
33
class RevisionInfo(object):
36
 
    """The results of applying a revision specification to a branch."""
37
 
 
38
 
    help_txt = """The results of applying a revision specification to a branch.
 
34
    """The results of applying a revision specification to a branch.
39
35
 
40
36
    An instance has two useful attributes: revno, and rev_id.
41
37
 
94
90
        return '<bzrlib.revisionspec.RevisionInfo object %s, %s for %r>' % (
95
91
            self.revno, self.rev_id, self.branch)
96
92
 
97
 
    @staticmethod
98
 
    def from_revision_id(branch, revision_id, revs):
99
 
        """Construct a RevisionInfo given just the id.
100
 
 
101
 
        Use this if you don't know or care what the revno is.
102
 
        """
103
 
        try:
104
 
            revno = revs.index(revision_id) + 1
105
 
        except ValueError:
106
 
            revno = None
107
 
        return RevisionInfo(branch, revno, revision_id)
108
 
 
109
93
 
110
94
# classes in this list should have a "prefix" attribute, against which
111
95
# string specs are matched
114
98
 
115
99
 
116
100
class RevisionSpec(object):
117
 
    """A parsed revision specification."""
118
 
 
119
 
    help_txt = """A parsed revision specification.
 
101
    """A parsed revision specification.
120
102
 
121
103
    A revision specification can be an integer, in which case it is
122
104
    assumed to be a revno (though this will translate negative values
170
152
        else:
171
153
            # RevisionSpec_revno is special cased, because it is the only
172
154
            # one that directly handles plain integers
173
 
            # TODO: This should not be special cased rather it should be
174
 
            # a method invocation on spectype.canparse()
175
155
            global _revno_regex
176
156
            if _revno_regex is None:
177
 
                _revno_regex = re.compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
 
157
                _revno_regex = re.compile(r'-?\d+(:.*)?$')
178
158
            if _revno_regex.match(spec) is not None:
179
159
                return RevisionSpec_revno(spec, _internal=True)
180
160
 
219
199
        if branch:
220
200
            revs = branch.revision_history()
221
201
        else:
222
 
            # this should never trigger.
223
 
            # TODO: make it a deprecated code path. RBC 20060928
224
202
            revs = None
225
203
        return self._match_on_and_check(branch, revs)
226
204
 
257
235
# private API
258
236
 
259
237
class RevisionSpec_revno(RevisionSpec):
260
 
    """Selects a revision using a number."""
261
 
 
262
 
    help_txt = """Selects a revision using a number.
263
 
 
264
 
    Use an integer to specify a revision in the history of the branch.
265
 
    Optionally a branch can be specified. The 'revno:' prefix is optional.
266
 
    A negative number will count from the end of the branch (-1 is the
267
 
    last revision, -2 the previous one). If the negative number is larger
268
 
    than the branch's history, the first revision is returned.
269
 
    examples:
270
 
      revno:1                   -> return the first revision
271
 
      revno:3:/path/to/branch   -> return the 3rd revision of
272
 
                                   the branch '/path/to/branch'
273
 
      revno:-1                  -> The last revision in a branch.
274
 
      -2:http://other/branch    -> The second to last revision in the
275
 
                                   remote branch.
276
 
      -1000000                  -> Most likely the first revision, unless
277
 
                                   your history is very long.
278
 
    """
279
238
    prefix = 'revno:'
280
239
 
281
240
    def _match_on(self, branch, revs):
296
255
        else:
297
256
            try:
298
257
                revno = int(revno_spec)
299
 
                dotted = False
300
 
            except ValueError:
301
 
                # dotted decimal. This arguably should not be here
302
 
                # but the from_string method is a little primitive 
303
 
                # right now - RBC 20060928
304
 
                try:
305
 
                    match_revno = tuple((int(number) for number in revno_spec.split('.')))
306
 
                except ValueError, e:
307
 
                    raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
308
 
 
309
 
                dotted = True
 
258
            except ValueError, e:
 
259
                raise errors.InvalidRevisionSpec(self.user_spec,
 
260
                                                 branch, e)
310
261
 
311
262
        if branch_spec:
312
 
            # the user has override the branch to look in.
313
 
            # we need to refresh the revision_history map and
314
 
            # the branch object.
315
263
            from bzrlib.branch import Branch
316
264
            branch = Branch.open(branch_spec)
317
265
            # Need to use a new revision history
318
266
            # because we are using a specific branch
319
267
            revs = branch.revision_history()
320
268
 
321
 
        if dotted:
322
 
            branch.lock_read()
323
 
            try:
324
 
                revision_id_to_revno = branch.get_revision_id_to_revno_map()
325
 
                revisions = [revision_id for revision_id, revno
326
 
                             in revision_id_to_revno.iteritems()
327
 
                             if revno == match_revno]
328
 
            finally:
329
 
                branch.unlock()
330
 
            if len(revisions) != 1:
331
 
                return RevisionInfo(branch, None, None)
 
269
        if revno < 0:
 
270
            if (-revno) >= len(revs):
 
271
                revno = 1
332
272
            else:
333
 
                # there is no traditional 'revno' for dotted-decimal revnos.
334
 
                # so for  API compatability we return None.
335
 
                return RevisionInfo(branch, None, revisions[0])
336
 
        else:
337
 
            if revno < 0:
338
 
                # if get_rev_id supported negative revnos, there would not be a
339
 
                # need for this special case.
340
 
                if (-revno) >= len(revs):
341
 
                    revno = 1
342
 
                else:
343
 
                    revno = len(revs) + revno + 1
344
 
            try:
345
 
                revision_id = branch.get_rev_id(revno, revs)
346
 
            except errors.NoSuchRevision:
347
 
                raise errors.InvalidRevisionSpec(self.user_spec, branch)
 
273
                revno = len(revs) + revno + 1
 
274
        try:
 
275
            revision_id = branch.get_rev_id(revno, revs)
 
276
        except errors.NoSuchRevision:
 
277
            raise errors.InvalidRevisionSpec(self.user_spec, branch)
348
278
        return RevisionInfo(branch, revno, revision_id)
349
279
        
350
280
    def needs_branch(self):
363
293
 
364
294
 
365
295
class RevisionSpec_revid(RevisionSpec):
366
 
    """Selects a revision using the revision id."""
367
 
 
368
 
    help_txt = """Selects a revision using the revision id.
369
 
 
370
 
    Supply a specific revision id, that can be used to specify any
371
 
    revision id in the ancestry of the branch. 
372
 
    Including merges, and pending merges.
373
 
    examples:
374
 
      revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
375
 
    """    
376
296
    prefix = 'revid:'
377
297
 
378
298
    def _match_on(self, branch, revs):
379
 
        # self.spec comes straight from parsing the command line arguments,
380
 
        # so we expect it to be a Unicode string. Switch it to the internal
381
 
        # representation.
382
 
        revision_id = osutils.safe_revision_id(self.spec, warn=False)
383
 
        return RevisionInfo.from_revision_id(branch, revision_id, revs)
 
299
        try:
 
300
            revno = revs.index(self.spec) + 1
 
301
        except ValueError:
 
302
            revno = None
 
303
        return RevisionInfo(branch, revno, self.spec)
384
304
 
385
305
SPEC_TYPES.append(RevisionSpec_revid)
386
306
 
387
307
 
388
308
class RevisionSpec_last(RevisionSpec):
389
 
    """Selects the nth revision from the end."""
390
 
 
391
 
    help_txt = """Selects the nth revision from the end.
392
 
 
393
 
    Supply a positive number to get the nth revision from the end.
394
 
    This is the same as supplying negative numbers to the 'revno:' spec.
395
 
    examples:
396
 
      last:1        -> return the last revision
397
 
      last:3        -> return the revision 2 before the end.
398
 
    """    
399
309
 
400
310
    prefix = 'last:'
401
311
 
424
334
 
425
335
 
426
336
class RevisionSpec_before(RevisionSpec):
427
 
    """Selects the parent of the revision specified."""
428
 
 
429
 
    help_txt = """Selects the parent of the revision specified.
430
 
 
431
 
    Supply any revision spec to return the parent of that revision.
432
 
    It is an error to request the parent of the null revision (before:0).
433
 
    This is mostly useful when inspecting revisions that are not in the
434
 
    revision history of a branch.
435
 
 
436
 
    examples:
437
 
      before:1913    -> Return the parent of revno 1913 (revno 1912)
438
 
      before:revid:aaaa@bbbb-1234567890  -> return the parent of revision
439
 
                                            aaaa@bbbb-1234567890
440
 
      bzr diff -r before:revid:aaaa..revid:aaaa
441
 
            -> Find the changes between revision 'aaaa' and its parent.
442
 
               (what changes did 'aaaa' introduce)
443
 
    """
444
337
 
445
338
    prefix = 'before:'
446
339
    
474
367
 
475
368
 
476
369
class RevisionSpec_tag(RevisionSpec):
477
 
    """Select a revision identified by tag name"""
478
 
 
479
 
    help_txt = """Selects a revision identified by a tag name.
480
 
 
481
 
    Tags are stored in the branch and created by the 'tag' command.
482
 
    """
483
 
 
484
370
    prefix = 'tag:'
485
371
 
486
372
    def _match_on(self, branch, revs):
487
 
        # Can raise tags not supported, NoSuchTag, etc
488
 
        return RevisionInfo.from_revision_id(branch,
489
 
            branch.tags.lookup_tag(self.spec),
490
 
            revs)
 
373
        raise errors.InvalidRevisionSpec(self.user_spec, branch,
 
374
                                         'tag: namespace registered,'
 
375
                                         ' but not implemented')
491
376
 
492
377
SPEC_TYPES.append(RevisionSpec_tag)
493
378
 
512
397
 
513
398
 
514
399
class RevisionSpec_date(RevisionSpec):
515
 
    """Selects a revision on the basis of a datestamp."""
516
 
 
517
 
    help_txt = """Selects a revision on the basis of a datestamp.
518
 
 
519
 
    Supply a datestamp to select the first revision that matches the date.
520
 
    Date can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
521
 
    Matches the first entry after a given date (either at midnight or
522
 
    at a specified time).
523
 
 
524
 
    One way to display all the changes since yesterday would be:
525
 
        bzr log -r date:yesterday..-1
526
 
 
527
 
    examples:
528
 
      date:yesterday            -> select the first revision since yesterday
529
 
      date:2006-08-14,17:10:14  -> select the first revision after
530
 
                                   August 14th, 2006 at 5:10pm.
531
 
    """    
532
400
    prefix = 'date:'
533
401
    _date_re = re.compile(
534
402
            r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
537
405
        )
538
406
 
539
407
    def _match_on(self, branch, revs):
540
 
        """Spec for date revisions:
 
408
        """
 
409
        Spec for date revisions:
541
410
          date:value
542
411
          value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
543
412
          matches the first entry after a given date (either at midnight or
544
413
          at a specified time).
 
414
 
 
415
          So the proper way of saying 'give me all entries for today' is:
 
416
              -r date:yesterday..date:today
545
417
        """
546
 
        #  XXX: This doesn't actually work
547
 
        #  So the proper way of saying 'give me all entries for today' is:
548
 
        #      -r date:yesterday..date:today
549
418
        today = datetime.datetime.fromordinal(datetime.date.today().toordinal())
550
419
        if self.spec.lower() == 'yesterday':
551
420
            dt = today - datetime.timedelta(days=1)
598
467
 
599
468
 
600
469
class RevisionSpec_ancestor(RevisionSpec):
601
 
    """Selects a common ancestor with a second branch."""
602
 
 
603
 
    help_txt = """Selects a common ancestor with a second branch.
604
 
 
605
 
    Supply the path to a branch to select the common ancestor.
606
 
 
607
 
    The common ancestor is the last revision that existed in both
608
 
    branches. Usually this is the branch point, but it could also be
609
 
    a revision that was merged.
610
 
 
611
 
    This is frequently used with 'diff' to return all of the changes
612
 
    that your branch introduces, while excluding the changes that you
613
 
    have not merged from the remote branch.
614
 
 
615
 
    examples:
616
 
      ancestor:/path/to/branch
617
 
      $ bzr diff -r ancestor:../../mainline/branch
618
 
    """
619
470
    prefix = 'ancestor:'
620
471
 
621
472
    def _match_on(self, branch, revs):
 
473
        from bzrlib.branch import Branch
 
474
 
622
475
        trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
623
 
        return self._find_revision_info(branch, self.spec)
624
 
 
625
 
    @staticmethod
626
 
    def _find_revision_info(branch, other_location):
627
 
        from bzrlib.branch import Branch
628
 
 
629
 
        other_branch = Branch.open(other_location)
 
476
        other_branch = Branch.open(self.spec)
630
477
        revision_a = branch.last_revision()
631
478
        revision_b = other_branch.last_revision()
632
479
        for r, b in ((revision_a, branch), (revision_b, other_branch)):
634
481
                raise errors.NoCommits(b)
635
482
        revision_source = revision.MultipleRevisionSources(
636
483
                branch.repository, other_branch.repository)
637
 
        graph = branch.repository.get_graph(other_branch.repository)
638
 
        revision_a = revision.ensure_null(revision_a)
639
 
        revision_b = revision.ensure_null(revision_b)
640
 
        if revision.NULL_REVISION in (revision_a, revision_b):
641
 
            rev_id = revision.NULL_REVISION
642
 
        else:
643
 
            rev_id = graph.find_unique_lca(revision_a, revision_b)
644
 
            if rev_id == revision.NULL_REVISION:
645
 
                raise errors.NoCommonAncestor(revision_a, revision_b)
 
484
        rev_id = revision.common_ancestor(revision_a, revision_b,
 
485
                                          revision_source)
646
486
        try:
647
487
            revno = branch.revision_id_to_revno(rev_id)
648
488
        except errors.NoSuchRevision:
649
489
            revno = None
650
490
        return RevisionInfo(branch, revno, rev_id)
651
 
 
652
 
 
 
491
        
653
492
SPEC_TYPES.append(RevisionSpec_ancestor)
654
493
 
655
494
 
656
495
class RevisionSpec_branch(RevisionSpec):
657
 
    """Selects the last revision of a specified branch."""
658
 
 
659
 
    help_txt = """Selects the last revision of a specified branch.
660
 
 
661
 
    Supply the path to a branch to select its last revision.
662
 
 
663
 
    examples:
664
 
      branch:/path/to/branch
 
496
    """A branch: revision specifier.
 
497
 
 
498
    This takes the path to a branch and returns its tip revision id.
665
499
    """
666
500
    prefix = 'branch:'
667
501
 
680
514
        return RevisionInfo(branch, revno, revision_b)
681
515
        
682
516
SPEC_TYPES.append(RevisionSpec_branch)
683
 
 
684
 
 
685
 
class RevisionSpec_submit(RevisionSpec_ancestor):
686
 
    """Selects a common ancestor with a submit branch."""
687
 
 
688
 
    help_txt = """Selects a common ancestor with the submit branch.
689
 
 
690
 
    Diffing against this shows all the changes that were made in this branch,
691
 
    and is a good predictor of what merge will do.  The submit branch is
692
 
    used by the bundle and merge directive comands.  If no submit branch
693
 
    is specified, the parent branch is used instead.
694
 
 
695
 
    The common ancestor is the last revision that existed in both
696
 
    branches. Usually this is the branch point, but it could also be
697
 
    a revision that was merged.
698
 
 
699
 
    examples:
700
 
      $ bzr diff -r submit:
701
 
    """
702
 
 
703
 
    prefix = 'submit:'
704
 
 
705
 
    def _match_on(self, branch, revs):
706
 
        trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
707
 
        submit_location = branch.get_submit_branch()
708
 
        location_type = 'submit branch'
709
 
        if submit_location is None:
710
 
            submit_location = branch.get_parent()
711
 
            location_type = 'parent branch'
712
 
        if submit_location is None:
713
 
            raise errors.NoSubmitBranch(branch)
714
 
        trace.note('Using %s %s', location_type, submit_location)
715
 
        return self._find_revision_info(branch, submit_location)
716
 
 
717
 
 
718
 
SPEC_TYPES.append(RevisionSpec_submit)