1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
39
class RevisionInfo(object):
40
"""The results of applying a revision specification to a branch."""
42
help_txt = """The results of applying a revision specification to a branch.
44
An instance has two useful attributes: revno, and rev_id.
46
They can also be accessed as spec[0] and spec[1] respectively,
47
so that you can write code like:
48
revno, rev_id = RevisionSpec(branch, spec)
49
although this is probably going to be deprecated later.
51
This class exists mostly to be the return value of a RevisionSpec,
52
so that you can access the member you're interested in (number or id)
53
or treat the result as a tuple.
56
def __init__(self, branch, revno, rev_id=_marker):
60
# allow caller to be lazy
61
if self.revno is None:
64
self.rev_id = branch.get_rev_id(self.revno)
68
def __nonzero__(self):
69
# first the easy ones...
70
if self.rev_id is None:
72
if self.revno is not None:
74
# TODO: otherwise, it should depend on how I was built -
75
# if it's in_history(branch), then check revision_history(),
76
# if it's in_store(branch), do the check below
77
return self.branch.repository.has_revision(self.rev_id)
82
def __getitem__(self, index):
83
if index == 0: return self.revno
84
if index == 1: return self.rev_id
85
raise IndexError(index)
88
return self.branch.repository.get_revision(self.rev_id)
90
def __eq__(self, other):
91
if type(other) not in (tuple, list, type(self)):
93
if type(other) is type(self) and self.branch is not other.branch:
95
return tuple(self) == tuple(other)
98
return '<bzrlib.revisionspec.RevisionInfo object %s, %s for %r>' % (
99
self.revno, self.rev_id, self.branch)
102
def from_revision_id(branch, revision_id, revs):
103
"""Construct a RevisionInfo given just the id.
105
Use this if you don't know or care what the revno is.
107
if revision_id == revision.NULL_REVISION:
108
return RevisionInfo(branch, 0, revision_id)
110
revno = revs.index(revision_id) + 1
113
return RevisionInfo(branch, revno, revision_id)
116
# classes in this list should have a "prefix" attribute, against which
117
# string specs are matched
121
class RevisionSpec(object):
122
"""A parsed revision specification."""
124
help_txt = """A parsed revision specification.
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.
131
Revision specs are an UI element, and they have been moved out
132
of the branch class to leave "back-end" classes unaware of such
133
details. Code that gets a revno or rev_id from other code should
134
not be using revision specs - revnos and revision ids are the
135
accepted ways to refer to revisions internally.
137
(Equivalent to the old Branch method get_revision_info())
141
wants_revision_history = True
144
def from_string(spec):
145
"""Parse a revision spec string into a RevisionSpec object.
147
:param spec: A string specified by the user
148
:return: A RevisionSpec object that understands how to parse the
151
if not isinstance(spec, (type(None), basestring)):
152
raise TypeError('error')
155
return RevisionSpec(None, _internal=True)
156
match = revspec_registry.get_prefix(spec)
157
if match is not None:
158
spectype, specsuffix = match
159
trace.mutter('Returning RevisionSpec %s for %s',
160
spectype.__name__, spec)
161
return spectype(spec, _internal=True)
163
for spectype in SPEC_TYPES:
164
if spec.startswith(spectype.prefix):
165
trace.mutter('Returning RevisionSpec %s for %s',
166
spectype.__name__, spec)
167
return spectype(spec, _internal=True)
168
# RevisionSpec_revno is special cased, because it is the only
169
# one that directly handles plain integers
170
# TODO: This should not be special cased rather it should be
171
# a method invocation on spectype.canparse()
173
if _revno_regex is None:
174
_revno_regex = re.compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
175
if _revno_regex.match(spec) is not None:
176
return RevisionSpec_revno(spec, _internal=True)
178
raise errors.NoSuchRevisionSpec(spec)
180
def __init__(self, spec, _internal=False):
181
"""Create a RevisionSpec referring to the Null revision.
183
:param spec: The original spec supplied by the user
184
:param _internal: Used to ensure that RevisionSpec is not being
185
called directly. Only from RevisionSpec.from_string()
188
symbol_versioning.warn('Creating a RevisionSpec directly has'
189
' been deprecated in version 0.11. Use'
190
' RevisionSpec.from_string()'
192
DeprecationWarning, stacklevel=2)
193
self.user_spec = spec
194
if self.prefix and spec.startswith(self.prefix):
195
spec = spec[len(self.prefix):]
198
def _match_on(self, branch, revs):
199
trace.mutter('Returning RevisionSpec._match_on: None')
200
return RevisionInfo(branch, None, None)
202
def _match_on_and_check(self, branch, revs):
203
info = self._match_on(branch, revs)
206
elif info == (None, None):
207
# special case - nothing supplied
210
raise errors.InvalidRevisionSpec(self.user_spec, branch)
212
raise errors.InvalidRevisionSpec(self.spec, branch)
214
def in_history(self, branch):
216
if self.wants_revision_history:
217
revs = branch.revision_history()
221
# this should never trigger.
222
# TODO: make it a deprecated code path. RBC 20060928
224
return self._match_on_and_check(branch, revs)
226
# FIXME: in_history is somewhat broken,
227
# it will return non-history revisions in many
228
# circumstances. The expected facility is that
229
# in_history only returns revision-history revs,
230
# in_store returns any rev. RBC 20051010
231
# aliases for now, when we fix the core logic, then they
232
# will do what you expect.
233
in_store = in_history
236
def as_revision_id(self, context_branch):
237
"""Return just the revision_id for this revisions spec.
239
Some revision specs require a context_branch to be able to determine
240
their value. Not all specs will make use of it.
242
return self._as_revision_id(context_branch)
244
def _as_revision_id(self, context_branch):
245
"""Implementation of as_revision_id()
247
Classes should override this function to provide appropriate
248
functionality. The default is to just call '.in_history().rev_id'
250
return self.in_history(context_branch).rev_id
252
def as_tree(self, context_branch):
253
"""Return the tree object for this revisions spec.
255
Some revision specs require a context_branch to be able to determine
256
the revision id and access the repository. Not all specs will make
259
return self._as_tree(context_branch)
261
def _as_tree(self, context_branch):
262
"""Implementation of as_tree().
264
Classes should override this function to provide appropriate
265
functionality. The default is to just call '.as_revision_id()'
266
and get the revision tree from context_branch's repository.
268
revision_id = self.as_revision_id(context_branch)
269
return context_branch.repository.revision_tree(revision_id)
272
# this is mostly for helping with testing
273
return '<%s %s>' % (self.__class__.__name__,
276
def needs_branch(self):
277
"""Whether this revision spec needs a branch.
279
Set this to False the branch argument of _match_on is not used.
283
def get_branch(self):
284
"""When the revision specifier contains a branch location, return it.
286
Otherwise, return None.
293
class RevisionSpec_revno(RevisionSpec):
294
"""Selects a revision using a number."""
296
help_txt = """Selects a revision using a number.
298
Use an integer to specify a revision in the history of the branch.
299
Optionally a branch can be specified. The 'revno:' prefix is optional.
300
A negative number will count from the end of the branch (-1 is the
301
last revision, -2 the previous one). If the negative number is larger
302
than the branch's history, the first revision is returned.
305
revno:1 -> return the first revision of this branch
306
revno:3:/path/to/branch -> return the 3rd revision of
307
the branch '/path/to/branch'
308
revno:-1 -> The last revision in a branch.
309
-2:http://other/branch -> The second to last revision in the
311
-1000000 -> Most likely the first revision, unless
312
your history is very long.
315
wants_revision_history = False
317
def _match_on(self, branch, revs):
318
"""Lookup a revision by revision number"""
319
branch, revno, revision_id = self._lookup(branch, revs)
320
return RevisionInfo(branch, revno, revision_id)
322
def _lookup(self, branch, revs_or_none):
323
loc = self.spec.find(':')
325
revno_spec = self.spec
328
revno_spec = self.spec[:loc]
329
branch_spec = self.spec[loc+1:]
333
raise errors.InvalidRevisionSpec(self.user_spec,
334
branch, 'cannot have an empty revno and no branch')
338
revno = int(revno_spec)
341
# dotted decimal. This arguably should not be here
342
# but the from_string method is a little primitive
343
# right now - RBC 20060928
345
match_revno = tuple((int(number) for number in revno_spec.split('.')))
346
except ValueError, e:
347
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
352
# the user has override the branch to look in.
353
# we need to refresh the revision_history map and
355
from bzrlib.branch import Branch
356
branch = Branch.open(branch_spec)
361
revision_id = branch.dotted_revno_to_revision_id(match_revno,
363
except errors.NoSuchRevision:
364
raise errors.InvalidRevisionSpec(self.user_spec, branch)
366
# there is no traditional 'revno' for dotted-decimal revnos.
367
# so for API compatability we return None.
368
return branch, None, revision_id
370
last_revno, last_revision_id = branch.last_revision_info()
372
# if get_rev_id supported negative revnos, there would not be a
373
# need for this special case.
374
if (-revno) >= last_revno:
377
revno = last_revno + revno + 1
379
revision_id = branch.get_rev_id(revno, revs_or_none)
380
except errors.NoSuchRevision:
381
raise errors.InvalidRevisionSpec(self.user_spec, branch)
382
return branch, revno, revision_id
384
def _as_revision_id(self, context_branch):
385
# We would have the revno here, but we don't really care
386
branch, revno, revision_id = self._lookup(context_branch, None)
389
def needs_branch(self):
390
return self.spec.find(':') == -1
392
def get_branch(self):
393
if self.spec.find(':') == -1:
396
return self.spec[self.spec.find(':')+1:]
399
RevisionSpec_int = RevisionSpec_revno
403
class RevisionSpec_revid(RevisionSpec):
404
"""Selects a revision using the revision id."""
406
help_txt = """Selects a revision using the revision id.
408
Supply a specific revision id, that can be used to specify any
409
revision id in the ancestry of the branch.
410
Including merges, and pending merges.
413
revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
418
def _match_on(self, branch, revs):
419
# self.spec comes straight from parsing the command line arguments,
420
# so we expect it to be a Unicode string. Switch it to the internal
422
revision_id = osutils.safe_revision_id(self.spec, warn=False)
423
return RevisionInfo.from_revision_id(branch, revision_id, revs)
425
def _as_revision_id(self, context_branch):
426
return osutils.safe_revision_id(self.spec, warn=False)
430
class RevisionSpec_last(RevisionSpec):
431
"""Selects the nth revision from the end."""
433
help_txt = """Selects the nth revision from the end.
435
Supply a positive number to get the nth revision from the end.
436
This is the same as supplying negative numbers to the 'revno:' spec.
439
last:1 -> return the last revision
440
last:3 -> return the revision 2 before the end.
445
def _match_on(self, branch, revs):
446
revno, revision_id = self._revno_and_revision_id(branch, revs)
447
return RevisionInfo(branch, revno, revision_id)
449
def _revno_and_revision_id(self, context_branch, revs_or_none):
450
last_revno, last_revision_id = context_branch.last_revision_info()
454
raise errors.NoCommits(context_branch)
455
return last_revno, last_revision_id
458
offset = int(self.spec)
459
except ValueError, e:
460
raise errors.InvalidRevisionSpec(self.user_spec, context_branch, e)
463
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
464
'you must supply a positive value')
466
revno = last_revno - offset + 1
468
revision_id = context_branch.get_rev_id(revno, revs_or_none)
469
except errors.NoSuchRevision:
470
raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
471
return revno, revision_id
473
def _as_revision_id(self, context_branch):
474
# We compute the revno as part of the process, but we don't really care
476
revno, revision_id = self._revno_and_revision_id(context_branch, None)
481
class RevisionSpec_before(RevisionSpec):
482
"""Selects the parent of the revision specified."""
484
help_txt = """Selects the parent of the revision specified.
486
Supply any revision spec to return the parent of that revision. This is
487
mostly useful when inspecting revisions that are not in the revision history
490
It is an error to request the parent of the null revision (before:0).
494
before:1913 -> Return the parent of revno 1913 (revno 1912)
495
before:revid:aaaa@bbbb-1234567890 -> return the parent of revision
497
bzr diff -r before:1913..1913
498
-> Find the changes between revision 1913 and its parent (1912).
499
(What changes did revision 1913 introduce).
500
This is equivalent to: bzr diff -c 1913
505
def _match_on(self, branch, revs):
506
r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
508
raise errors.InvalidRevisionSpec(self.user_spec, branch,
509
'cannot go before the null: revision')
511
# We need to use the repository history here
512
rev = branch.repository.get_revision(r.rev_id)
513
if not rev.parent_ids:
515
revision_id = revision.NULL_REVISION
517
revision_id = rev.parent_ids[0]
519
revno = revs.index(revision_id) + 1
525
revision_id = branch.get_rev_id(revno, revs)
526
except errors.NoSuchRevision:
527
raise errors.InvalidRevisionSpec(self.user_spec,
529
return RevisionInfo(branch, revno, revision_id)
531
def _as_revision_id(self, context_branch):
532
base_revspec = RevisionSpec.from_string(self.spec)
533
base_revision_id = base_revspec.as_revision_id(context_branch)
534
if base_revision_id == revision.NULL_REVISION:
535
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
536
'cannot go before the null: revision')
537
context_repo = context_branch.repository
538
context_repo.lock_read()
540
parent_map = context_repo.get_parent_map([base_revision_id])
542
context_repo.unlock()
543
if base_revision_id not in parent_map:
544
# Ghost, or unknown revision id
545
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
546
'cannot find the matching revision')
547
parents = parent_map[base_revision_id]
549
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
550
'No parents for revision.')
555
class RevisionSpec_tag(RevisionSpec):
556
"""Select a revision identified by tag name"""
558
help_txt = """Selects a revision identified by a tag name.
560
Tags are stored in the branch and created by the 'tag' command.
565
def _match_on(self, branch, revs):
566
# Can raise tags not supported, NoSuchTag, etc
567
return RevisionInfo.from_revision_id(branch,
568
branch.tags.lookup_tag(self.spec),
571
def _as_revision_id(self, context_branch):
572
return context_branch.tags.lookup_tag(self.spec)
576
class _RevListToTimestamps(object):
577
"""This takes a list of revisions, and allows you to bisect by date"""
579
__slots__ = ['revs', 'branch']
581
def __init__(self, revs, branch):
585
def __getitem__(self, index):
586
"""Get the date of the index'd item"""
587
r = self.branch.repository.get_revision(self.revs[index])
588
# TODO: Handle timezone.
589
return datetime.datetime.fromtimestamp(r.timestamp)
592
return len(self.revs)
595
class RevisionSpec_date(RevisionSpec):
596
"""Selects a revision on the basis of a datestamp."""
598
help_txt = """Selects a revision on the basis of a datestamp.
600
Supply a datestamp to select the first revision that matches the date.
601
Date can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
602
Matches the first entry after a given date (either at midnight or
603
at a specified time).
605
One way to display all the changes since yesterday would be::
607
bzr log -r date:yesterday..
611
date:yesterday -> select the first revision since yesterday
612
date:2006-08-14,17:10:14 -> select the first revision after
613
August 14th, 2006 at 5:10pm.
616
_date_re = re.compile(
617
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
619
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
622
def _match_on(self, branch, revs):
623
"""Spec for date revisions:
625
value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
626
matches the first entry after a given date (either at midnight or
627
at a specified time).
629
# XXX: This doesn't actually work
630
# So the proper way of saying 'give me all entries for today' is:
631
# -r date:yesterday..date:today
632
today = datetime.datetime.fromordinal(datetime.date.today().toordinal())
633
if self.spec.lower() == 'yesterday':
634
dt = today - datetime.timedelta(days=1)
635
elif self.spec.lower() == 'today':
637
elif self.spec.lower() == 'tomorrow':
638
dt = today + datetime.timedelta(days=1)
640
m = self._date_re.match(self.spec)
641
if not m or (not m.group('date') and not m.group('time')):
642
raise errors.InvalidRevisionSpec(self.user_spec,
643
branch, 'invalid date')
647
year = int(m.group('year'))
648
month = int(m.group('month'))
649
day = int(m.group('day'))
656
hour = int(m.group('hour'))
657
minute = int(m.group('minute'))
658
if m.group('second'):
659
second = int(m.group('second'))
663
hour, minute, second = 0,0,0
665
raise errors.InvalidRevisionSpec(self.user_spec,
666
branch, 'invalid date')
668
dt = datetime.datetime(year=year, month=month, day=day,
669
hour=hour, minute=minute, second=second)
672
rev = bisect.bisect(_RevListToTimestamps(revs, branch), dt)
676
raise errors.InvalidRevisionSpec(self.user_spec, branch)
678
return RevisionInfo(branch, rev + 1)
682
class RevisionSpec_ancestor(RevisionSpec):
683
"""Selects a common ancestor with a second branch."""
685
help_txt = """Selects a common ancestor with a second branch.
687
Supply the path to a branch to select the common ancestor.
689
The common ancestor is the last revision that existed in both
690
branches. Usually this is the branch point, but it could also be
691
a revision that was merged.
693
This is frequently used with 'diff' to return all of the changes
694
that your branch introduces, while excluding the changes that you
695
have not merged from the remote branch.
699
ancestor:/path/to/branch
700
$ bzr diff -r ancestor:../../mainline/branch
704
def _match_on(self, branch, revs):
705
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
706
return self._find_revision_info(branch, self.spec)
708
def _as_revision_id(self, context_branch):
709
return self._find_revision_id(context_branch, self.spec)
712
def _find_revision_info(branch, other_location):
713
revision_id = RevisionSpec_ancestor._find_revision_id(branch,
716
revno = branch.revision_id_to_revno(revision_id)
717
except errors.NoSuchRevision:
719
return RevisionInfo(branch, revno, revision_id)
722
def _find_revision_id(branch, other_location):
723
from bzrlib.branch import Branch
727
revision_a = revision.ensure_null(branch.last_revision())
728
if revision_a == revision.NULL_REVISION:
729
raise errors.NoCommits(branch)
730
if other_location == '':
731
other_location = branch.get_parent()
732
other_branch = Branch.open(other_location)
733
other_branch.lock_read()
735
revision_b = revision.ensure_null(other_branch.last_revision())
736
if revision_b == revision.NULL_REVISION:
737
raise errors.NoCommits(other_branch)
738
graph = branch.repository.get_graph(other_branch.repository)
739
rev_id = graph.find_unique_lca(revision_a, revision_b)
741
other_branch.unlock()
742
if rev_id == revision.NULL_REVISION:
743
raise errors.NoCommonAncestor(revision_a, revision_b)
751
class RevisionSpec_branch(RevisionSpec):
752
"""Selects the last revision of a specified branch."""
754
help_txt = """Selects the last revision of a specified branch.
756
Supply the path to a branch to select its last revision.
760
branch:/path/to/branch
764
def _match_on(self, branch, revs):
765
from bzrlib.branch import Branch
766
other_branch = Branch.open(self.spec)
767
revision_b = other_branch.last_revision()
768
if revision_b in (None, revision.NULL_REVISION):
769
raise errors.NoCommits(other_branch)
770
# pull in the remote revisions so we can diff
771
branch.fetch(other_branch, revision_b)
773
revno = branch.revision_id_to_revno(revision_b)
774
except errors.NoSuchRevision:
776
return RevisionInfo(branch, revno, revision_b)
778
def _as_revision_id(self, context_branch):
779
from bzrlib.branch import Branch
780
other_branch = Branch.open(self.spec)
781
last_revision = other_branch.last_revision()
782
last_revision = revision.ensure_null(last_revision)
783
context_branch.fetch(other_branch, last_revision)
784
if last_revision == revision.NULL_REVISION:
785
raise errors.NoCommits(other_branch)
788
def _as_tree(self, context_branch):
789
from bzrlib.branch import Branch
790
other_branch = Branch.open(self.spec)
791
last_revision = other_branch.last_revision()
792
last_revision = revision.ensure_null(last_revision)
793
if last_revision == revision.NULL_REVISION:
794
raise errors.NoCommits(other_branch)
795
return other_branch.repository.revision_tree(last_revision)
799
class RevisionSpec_submit(RevisionSpec_ancestor):
800
"""Selects a common ancestor with a submit branch."""
802
help_txt = """Selects a common ancestor with the submit branch.
804
Diffing against this shows all the changes that were made in this branch,
805
and is a good predictor of what merge will do. The submit branch is
806
used by the bundle and merge directive commands. If no submit branch
807
is specified, the parent branch is used instead.
809
The common ancestor is the last revision that existed in both
810
branches. Usually this is the branch point, but it could also be
811
a revision that was merged.
815
$ bzr diff -r submit:
820
def _get_submit_location(self, branch):
821
submit_location = branch.get_submit_branch()
822
location_type = 'submit branch'
823
if submit_location is None:
824
submit_location = branch.get_parent()
825
location_type = 'parent branch'
826
if submit_location is None:
827
raise errors.NoSubmitBranch(branch)
828
trace.note('Using %s %s', location_type, submit_location)
829
return submit_location
831
def _match_on(self, branch, revs):
832
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
833
return self._find_revision_info(branch,
834
self._get_submit_location(branch))
836
def _as_revision_id(self, context_branch):
837
return self._find_revision_id(context_branch,
838
self._get_submit_location(context_branch))
841
revspec_registry = registry.Registry()
842
def _register_revspec(revspec):
843
revspec_registry.register(revspec.prefix, revspec)
845
_register_revspec(RevisionSpec_revno)
846
_register_revspec(RevisionSpec_revid)
847
_register_revspec(RevisionSpec_last)
848
_register_revspec(RevisionSpec_before)
849
_register_revspec(RevisionSpec_tag)
850
_register_revspec(RevisionSpec_date)
851
_register_revspec(RevisionSpec_ancestor)
852
_register_revspec(RevisionSpec_branch)
853
_register_revspec(RevisionSpec_submit)
855
SPEC_TYPES = symbol_versioning.deprecated_list(
856
symbol_versioning.deprecated_in((1, 12, 0)), "SPEC_TYPES", [])
added
removed
bzrlib/revisionspec.py
