← 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: 2008-10-20 23:58:12 UTC
  • mto: This revision was merged to the branch mainline in revision 3787.
  • Revision ID: mbp@sourcefrog.net-20081020235812-itg90mk0u4dez92z
lp-upload-release now handles names like bzr-1.8.tar.gz

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revisionspec.py
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
17
 
18
18
import re
26
26
from bzrlib import (
27
27
    errors,
28
28
    osutils,
29
 
    registry,
30
29
    revision,
31
30
    symbol_versioning,
32
31
    trace,
113
112
        return RevisionInfo(branch, revno, revision_id)
114
113
 
115
114
 
 
115
# classes in this list should have a "prefix" attribute, against which
 
116
# string specs are matched
 
117
SPEC_TYPES = []
116
118
_revno_regex = None
117
119
 
118
120
 
121
123
 
122
124
    help_txt = """A parsed revision specification.
123
125
 
124
 
    A revision specification is a string, which may be unambiguous about
125
 
    what it represents by giving a prefix like 'date:' or 'revid:' etc,
126
 
    or it may have no prefix, in which case it's tried against several
127
 
    specifier types in sequence to determine what the user meant.
 
126
    A revision specification can be an integer, in which case it is
 
127
    assumed to be a revno (though this will translate negative values
 
128
    into positive ones); or it can be a string, in which case it is
 
129
    parsed for something like 'date:' or 'revid:' etc.
128
130
 
129
131
    Revision specs are an UI element, and they have been moved out
130
132
    of the branch class to leave "back-end" classes unaware of such
137
139
 
138
140
    prefix = None
139
141
    wants_revision_history = True
140
 
    dwim_catchable_exceptions = (errors.InvalidRevisionSpec,)
141
 
    """Exceptions that RevisionSpec_dwim._match_on will catch.
142
 
 
143
 
    If the revspec is part of ``dwim_revspecs``, it may be tried with an
144
 
    invalid revspec and raises some exception. The exceptions mentioned here
145
 
    will not be reported to the user but simply ignored without stopping the
146
 
    dwim processing.
147
 
    """
148
142
 
149
143
    @staticmethod
150
144
    def from_string(spec):
159
153
 
160
154
        if spec is None:
161
155
            return RevisionSpec(None, _internal=True)
162
 
        match = revspec_registry.get_prefix(spec)
163
 
        if match is not None:
164
 
            spectype, specsuffix = match
165
 
            trace.mutter('Returning RevisionSpec %s for %s',
166
 
                         spectype.__name__, spec)
167
 
            return spectype(spec, _internal=True)
 
156
        for spectype in SPEC_TYPES:
 
157
            if spec.startswith(spectype.prefix):
 
158
                trace.mutter('Returning RevisionSpec %s for %s',
 
159
                             spectype.__name__, spec)
 
160
                return spectype(spec, _internal=True)
168
161
        else:
169
 
            for spectype in SPEC_TYPES:
170
 
                if spec.startswith(spectype.prefix):
171
 
                    trace.mutter('Returning RevisionSpec %s for %s',
172
 
                                 spectype.__name__, spec)
173
 
                    return spectype(spec, _internal=True)
174
 
            # Otherwise treat it as a DWIM, build the RevisionSpec object and
175
 
            # wait for _match_on to be called.
176
 
            return RevisionSpec_dwim(spec, _internal=True)
 
162
            # RevisionSpec_revno is special cased, because it is the only
 
163
            # one that directly handles plain integers
 
164
            # TODO: This should not be special cased rather it should be
 
165
            # a method invocation on spectype.canparse()
 
166
            global _revno_regex
 
167
            if _revno_regex is None:
 
168
                _revno_regex = re.compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
 
169
            if _revno_regex.match(spec) is not None:
 
170
                return RevisionSpec_revno(spec, _internal=True)
 
171
 
 
172
            raise errors.NoSuchRevisionSpec(spec)
177
173
 
178
174
    def __init__(self, spec, _internal=False):
179
175
        """Create a RevisionSpec referring to the Null revision.
183
179
            called directly. Only from RevisionSpec.from_string()
184
180
        """
185
181
        if not _internal:
 
182
            # XXX: Update this after 0.10 is released
186
183
            symbol_versioning.warn('Creating a RevisionSpec directly has'
187
184
                                   ' been deprecated in version 0.11. Use'
188
185
                                   ' RevisionSpec.from_string()'
270
267
        # this is mostly for helping with testing
271
268
        return '<%s %s>' % (self.__class__.__name__,
272
269
                              self.user_spec)
273
 
 
 
270
    
274
271
    def needs_branch(self):
275
272
        """Whether this revision spec needs a branch.
276
273
 
280
277
 
281
278
    def get_branch(self):
282
279
        """When the revision specifier contains a branch location, return it.
283
 
 
 
280
        
284
281
        Otherwise, return None.
285
282
        """
286
283
        return None
288
285
 
289
286
# private API
290
287
 
291
 
class RevisionSpec_dwim(RevisionSpec):
292
 
    """Provides a DWIMish revision specifier lookup.
293
 
 
294
 
    Note that this does not go in the revspec_registry because by definition
295
 
    there is no prefix to identify it.  It's solely called from
296
 
    RevisionSpec.from_string() because the DWIMification happen when _match_on
297
 
    is called so the string describing the revision is kept here until needed.
298
 
    """
299
 
 
300
 
    help_txt = None
301
 
    # We don't need to build the revision history ourself, that's delegated to
302
 
    # each revspec we try.
303
 
    wants_revision_history = False
304
 
 
305
 
    def _try_spectype(self, rstype, branch):
306
 
        rs = rstype(self.spec, _internal=True)
307
 
        # Hit in_history to find out if it exists, or we need to try the
308
 
        # next type.
309
 
        return rs.in_history(branch)
310
 
 
311
 
    def _match_on(self, branch, revs):
312
 
        """Run the lookup and see what we can get."""
313
 
 
314
 
        # First, see if it's a revno
315
 
        global _revno_regex
316
 
        if _revno_regex is None:
317
 
            _revno_regex = re.compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
318
 
        if _revno_regex.match(self.spec) is not None:
319
 
            try:
320
 
                return self._try_spectype(RevisionSpec_revno, branch)
321
 
            except RevisionSpec_revno.dwim_catchable_exceptions:
322
 
                pass
323
 
 
324
 
        # Next see what has been registered
325
 
        for rs_class in dwim_revspecs:
326
 
            try:
327
 
                return self._try_spectype(rs_class, branch)
328
 
            except rs_class.dwim_catchable_exceptions:
329
 
                pass
330
 
 
331
 
        # Well, I dunno what it is. Note that we don't try to keep track of the
332
 
        # first of last exception raised during the DWIM tries as none seems
333
 
        # really relevant.
334
 
        raise errors.InvalidRevisionSpec(self.spec, branch)
335
 
 
336
 
 
337
288
class RevisionSpec_revno(RevisionSpec):
338
289
    """Selects a revision using a number."""
339
290
 
340
291
    help_txt = """Selects a revision using a number.
341
292
 
342
293
    Use an integer to specify a revision in the history of the branch.
343
 
    Optionally a branch can be specified.  A negative number will count
344
 
    from the end of the branch (-1 is the last revision, -2 the previous
345
 
    one). If the negative number is larger than the branch's history, the
346
 
    first revision is returned.
 
294
    Optionally a branch can be specified. The 'revno:' prefix is optional.
 
295
    A negative number will count from the end of the branch (-1 is the
 
296
    last revision, -2 the previous one). If the negative number is larger
 
297
    than the branch's history, the first revision is returned.
347
298
    Examples::
348
299
 
349
300
      revno:1                   -> return the first revision of this branch
383
334
                dotted = False
384
335
            except ValueError:
385
336
                # dotted decimal. This arguably should not be here
386
 
                # but the from_string method is a little primitive
 
337
                # but the from_string method is a little primitive 
387
338
                # right now - RBC 20060928
388
339
                try:
389
340
                    match_revno = tuple((int(number) for number in revno_spec.split('.')))
401
352
            revs_or_none = None
402
353
 
403
354
        if dotted:
 
355
            branch.lock_read()
404
356
            try:
405
 
                revision_id = branch.dotted_revno_to_revision_id(match_revno,
406
 
                    _cache_reverse=True)
407
 
            except errors.NoSuchRevision:
408
 
                raise errors.InvalidRevisionSpec(self.user_spec, branch)
 
357
                revision_id_to_revno = branch.get_revision_id_to_revno_map()
 
358
                revisions = [revision_id for revision_id, revno
 
359
                             in revision_id_to_revno.iteritems()
 
360
                             if revno == match_revno]
 
361
            finally:
 
362
                branch.unlock()
 
363
            if len(revisions) != 1:
 
364
                return branch, None, None
409
365
            else:
410
366
                # there is no traditional 'revno' for dotted-decimal revnos.
411
367
                # so for  API compatability we return None.
412
 
                return branch, None, revision_id
 
368
                return branch, None, revisions[0]
413
369
        else:
414
370
            last_revno, last_revision_id = branch.last_revision_info()
415
371
            if revno < 0:
439
395
        else:
440
396
            return self.spec[self.spec.find(':')+1:]
441
397
 
442
 
# Old compatibility
 
398
# Old compatibility 
443
399
RevisionSpec_int = RevisionSpec_revno
444
400
 
 
401
SPEC_TYPES.append(RevisionSpec_revno)
445
402
 
446
403
 
447
404
class RevisionSpec_revid(RevisionSpec):
450
407
    help_txt = """Selects a revision using the revision id.
451
408
 
452
409
    Supply a specific revision id, that can be used to specify any
453
 
    revision id in the ancestry of the branch.
 
410
    revision id in the ancestry of the branch. 
454
411
    Including merges, and pending merges.
455
412
    Examples::
456
413
 
469
426
    def _as_revision_id(self, context_branch):
470
427
        return osutils.safe_revision_id(self.spec, warn=False)
471
428
 
 
429
SPEC_TYPES.append(RevisionSpec_revid)
472
430
 
473
431
 
474
432
class RevisionSpec_last(RevisionSpec):
520
478
        revno, revision_id = self._revno_and_revision_id(context_branch, None)
521
479
        return revision_id
522
480
 
 
481
SPEC_TYPES.append(RevisionSpec_last)
523
482
 
524
483
 
525
484
class RevisionSpec_before(RevisionSpec):
545
504
    """
546
505
 
547
506
    prefix = 'before:'
548
 
 
 
507
    
549
508
    def _match_on(self, branch, revs):
550
509
        r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
551
510
        if r.revno == 0:
594
553
                'No parents for revision.')
595
554
        return parents[0]
596
555
 
 
556
SPEC_TYPES.append(RevisionSpec_before)
597
557
 
598
558
 
599
559
class RevisionSpec_tag(RevisionSpec):
605
565
    """
606
566
 
607
567
    prefix = 'tag:'
608
 
    dwim_catchable_exceptions = (errors.NoSuchTag, errors.TagsNotSupported)
609
568
 
610
569
    def _match_on(self, branch, revs):
611
570
        # Can raise tags not supported, NoSuchTag, etc
616
575
    def _as_revision_id(self, context_branch):
617
576
        return context_branch.tags.lookup_tag(self.spec)
618
577
 
 
578
SPEC_TYPES.append(RevisionSpec_tag)
619
579
 
620
580
 
621
581
class _RevListToTimestamps(object):
656
616
      date:yesterday            -> select the first revision since yesterday
657
617
      date:2006-08-14,17:10:14  -> select the first revision after
658
618
                                   August 14th, 2006 at 5:10pm.
659
 
    """
 
619
    """    
660
620
    prefix = 'date:'
661
621
    _date_re = re.compile(
662
622
            r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
722
682
        else:
723
683
            return RevisionInfo(branch, rev + 1)
724
684
 
 
685
SPEC_TYPES.append(RevisionSpec_date)
725
686
 
726
687
 
727
688
class RevisionSpec_ancestor(RevisionSpec):
772
733
            revision_a = revision.ensure_null(branch.last_revision())
773
734
            if revision_a == revision.NULL_REVISION:
774
735
                raise errors.NoCommits(branch)
775
 
            if other_location == '':
776
 
                other_location = branch.get_parent()
777
736
            other_branch = Branch.open(other_location)
778
737
            other_branch.lock_read()
779
738
            try:
791
750
            branch.unlock()
792
751
 
793
752
 
 
753
SPEC_TYPES.append(RevisionSpec_ancestor)
794
754
 
795
755
 
796
756
class RevisionSpec_branch(RevisionSpec):
805
765
      branch:/path/to/branch
806
766
    """
807
767
    prefix = 'branch:'
808
 
    dwim_catchable_exceptions = (errors.NotBranchError,)
809
768
 
810
769
    def _match_on(self, branch, revs):
811
770
        from bzrlib.branch import Branch
840
799
            raise errors.NoCommits(other_branch)
841
800
        return other_branch.repository.revision_tree(last_revision)
842
801
 
 
802
SPEC_TYPES.append(RevisionSpec_branch)
843
803
 
844
804
 
845
805
class RevisionSpec_submit(RevisionSpec_ancestor):
884
844
            self._get_submit_location(context_branch))
885
845
 
886
846
 
887
 
# The order in which we want to DWIM a revision spec without any prefix.
888
 
# revno is always tried first and isn't listed here, this is used by
889
 
# RevisionSpec_dwim._match_on
890
 
dwim_revspecs = [
891
 
    RevisionSpec_tag, # Let's try for a tag
892
 
    RevisionSpec_revid, # Maybe it's a revid?
893
 
    RevisionSpec_date, # Perhaps a date?
894
 
    RevisionSpec_branch, # OK, last try, maybe it's a branch
895
 
    ]
896
 
 
897
 
 
898
 
revspec_registry = registry.Registry()
899
 
def _register_revspec(revspec):
900
 
    revspec_registry.register(revspec.prefix, revspec)
901
 
 
902
 
_register_revspec(RevisionSpec_revno)
903
 
_register_revspec(RevisionSpec_revid)
904
 
_register_revspec(RevisionSpec_last)
905
 
_register_revspec(RevisionSpec_before)
906
 
_register_revspec(RevisionSpec_tag)
907
 
_register_revspec(RevisionSpec_date)
908
 
_register_revspec(RevisionSpec_ancestor)
909
 
_register_revspec(RevisionSpec_branch)
910
 
_register_revspec(RevisionSpec_submit)
911
 
 
912
 
# classes in this list should have a "prefix" attribute, against which
913
 
# string specs are matched
914
 
SPEC_TYPES = symbol_versioning.deprecated_list(
915
 
    symbol_versioning.deprecated_in((1, 12, 0)), "SPEC_TYPES", [])
 
847
SPEC_TYPES.append(RevisionSpec_submit)