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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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(), """
22
26
from bzrlib import (
119
122
help_txt = """A parsed revision specification.
121
A revision specification can be an integer, in which case it is
122
assumed to be a revno (though this will translate negative values
123
into positive ones); or it can be a string, in which case it is
124
parsed for something like 'date:' or 'revid:' etc.
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
129
Revision specs are an UI element, and they have been moved out
127
130
of the branch class to leave "back-end" classes unaware of such
137
def __new__(cls, spec, _internal=False):
139
return object.__new__(cls, spec, _internal=_internal)
141
symbol_versioning.warn('Creating a RevisionSpec directly has'
142
' been deprecated in version 0.11. Use'
143
' RevisionSpec.from_string()'
145
DeprecationWarning, stacklevel=2)
146
return RevisionSpec.from_string(spec)
139
wants_revision_history = True
140
dwim_catchable_exceptions = (errors.InvalidRevisionSpec,)
141
"""Exceptions that RevisionSpec_dwim._match_on will catch.
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
149
150
def from_string(spec):
160
161
return RevisionSpec(None, _internal=True)
162
assert isinstance(spec, basestring), \
163
"You should only supply strings not %s" % (type(spec),)
165
for spectype in SPEC_TYPES:
166
if spec.startswith(spectype.prefix):
167
trace.mutter('Returning RevisionSpec %s for %s',
168
spectype.__name__, spec)
169
return spectype(spec, _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)
171
# RevisionSpec_revno is special cased, because it is the only
172
# 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()
176
if _revno_regex is None:
177
_revno_regex = re.compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
178
if _revno_regex.match(spec) is not None:
179
return RevisionSpec_revno(spec, _internal=True)
181
raise errors.NoSuchRevisionSpec(spec)
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)
183
178
def __init__(self, spec, _internal=False):
184
179
"""Create a RevisionSpec referring to the Null revision.
202
196
def _match_on(self, branch, revs):
203
197
trace.mutter('Returning RevisionSpec._match_on: None')
204
return RevisionInfo(branch, 0, None)
198
return RevisionInfo(branch, None, None)
206
200
def _match_on_and_check(self, branch, revs):
207
201
info = self._match_on(branch, revs)
210
elif info == (0, None):
211
# special case - the empty tree
204
elif info == (None, None):
205
# special case - nothing supplied
213
207
elif self.prefix:
214
208
raise errors.InvalidRevisionSpec(self.user_spec, branch)
233
230
# will do what you expect.
234
231
in_store = in_history
235
232
in_branch = in_store
234
def as_revision_id(self, context_branch):
235
"""Return just the revision_id for this revisions spec.
237
Some revision specs require a context_branch to be able to determine
238
their value. Not all specs will make use of it.
240
return self._as_revision_id(context_branch)
242
def _as_revision_id(self, context_branch):
243
"""Implementation of as_revision_id()
245
Classes should override this function to provide appropriate
246
functionality. The default is to just call '.in_history().rev_id'
248
return self.in_history(context_branch).rev_id
250
def as_tree(self, context_branch):
251
"""Return the tree object for this revisions spec.
253
Some revision specs require a context_branch to be able to determine
254
the revision id and access the repository. Not all specs will make
257
return self._as_tree(context_branch)
259
def _as_tree(self, context_branch):
260
"""Implementation of as_tree().
262
Classes should override this function to provide appropriate
263
functionality. The default is to just call '.as_revision_id()'
264
and get the revision tree from context_branch's repository.
266
revision_id = self.as_revision_id(context_branch)
267
return context_branch.repository.revision_tree(revision_id)
237
269
def __repr__(self):
238
270
# this is mostly for helping with testing
239
271
return '<%s %s>' % (self.__class__.__name__,
242
274
def needs_branch(self):
243
275
"""Whether this revision spec needs a branch.
291
class RevisionSpec_dwim(RevisionSpec):
292
"""Provides a DWIMish revision specifier lookup.
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.
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
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
309
return rs.in_history(branch)
311
def _match_on(self, branch, revs):
312
"""Run the lookup and see what we can get."""
314
# First, see if it's a revno
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:
320
return self._try_spectype(RevisionSpec_revno, branch)
321
except RevisionSpec_revno.dwim_catchable_exceptions:
324
# Next see what has been registered
325
for rs_class in dwim_revspecs:
327
return self._try_spectype(rs_class, branch)
328
except rs_class.dwim_catchable_exceptions:
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
334
raise errors.InvalidRevisionSpec(self.spec, branch)
259
337
class RevisionSpec_revno(RevisionSpec):
260
338
"""Selects a revision using a number."""
262
340
help_txt = """Selects a revision using a number.
264
342
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.
270
revno:1 -> return the first revision
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.
349
revno:1 -> return the first revision of this branch
271
350
revno:3:/path/to/branch -> return the 3rd revision of
272
351
the branch '/path/to/branch'
273
352
revno:-1 -> The last revision in a branch.
277
356
your history is very long.
279
358
prefix = 'revno:'
359
wants_revision_history = False
281
361
def _match_on(self, branch, revs):
282
362
"""Lookup a revision by revision number"""
363
branch, revno, revision_id = self._lookup(branch, revs)
364
return RevisionInfo(branch, revno, revision_id)
366
def _lookup(self, branch, revs_or_none):
283
367
loc = self.spec.find(':')
285
369
revno_spec = self.spec
314
398
# the branch object.
315
399
from bzrlib.branch import Branch
316
400
branch = Branch.open(branch_spec)
317
# Need to use a new revision history
318
# because we are using a specific branch
319
revs = branch.revision_history()
324
last_rev = branch.last_revision()
325
merge_sorted_revisions = tsort.merge_sort(
326
branch.repository.get_revision_graph(last_rev),
330
return item[3] == match_revno
331
revisions = filter(match, merge_sorted_revisions)
334
if len(revisions) != 1:
335
return RevisionInfo(branch, None, None)
405
revision_id = branch.dotted_revno_to_revision_id(match_revno,
407
except errors.NoSuchRevision:
408
raise errors.InvalidRevisionSpec(self.user_spec, branch)
337
410
# there is no traditional 'revno' for dotted-decimal revnos.
338
411
# so for API compatability we return None.
339
return RevisionInfo(branch, None, revisions[0][1])
412
return branch, None, revision_id
414
last_revno, last_revision_id = branch.last_revision_info()
342
416
# if get_rev_id supported negative revnos, there would not be a
343
417
# need for this special case.
344
if (-revno) >= len(revs):
418
if (-revno) >= last_revno:
347
revno = len(revs) + revno + 1
421
revno = last_revno + revno + 1
349
revision_id = branch.get_rev_id(revno, revs)
423
revision_id = branch.get_rev_id(revno, revs_or_none)
350
424
except errors.NoSuchRevision:
351
425
raise errors.InvalidRevisionSpec(self.user_spec, branch)
352
return RevisionInfo(branch, revno, revision_id)
426
return branch, revno, revision_id
428
def _as_revision_id(self, context_branch):
429
# We would have the revno here, but we don't really care
430
branch, revno, revision_id = self._lookup(context_branch, None)
354
433
def needs_branch(self):
355
434
return self.spec.find(':') == -1
372
450
help_txt = """Selects a revision using the revision id.
374
452
Supply a specific revision id, that can be used to specify any
375
revision id in the ancestry of the branch.
453
revision id in the ancestry of the branch.
376
454
Including merges, and pending merges.
378
457
revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
380
460
prefix = 'revid:'
382
462
def _match_on(self, branch, revs):
386
466
revision_id = osutils.safe_revision_id(self.spec, warn=False)
387
467
return RevisionInfo.from_revision_id(branch, revision_id, revs)
389
SPEC_TYPES.append(RevisionSpec_revid)
469
def _as_revision_id(self, context_branch):
470
return osutils.safe_revision_id(self.spec, warn=False)
392
474
class RevisionSpec_last(RevisionSpec):
397
479
Supply a positive number to get the nth revision from the end.
398
480
This is the same as supplying negative numbers to the 'revno:' spec.
400
483
last:1 -> return the last revision
401
484
last:3 -> return the revision 2 before the end.
406
489
def _match_on(self, branch, revs):
490
revno, revision_id = self._revno_and_revision_id(branch, revs)
491
return RevisionInfo(branch, revno, revision_id)
493
def _revno_and_revision_id(self, context_branch, revs_or_none):
494
last_revno, last_revision_id = context_branch.last_revision_info()
407
496
if self.spec == '':
409
raise errors.NoCommits(branch)
410
return RevisionInfo(branch, len(revs), revs[-1])
498
raise errors.NoCommits(context_branch)
499
return last_revno, last_revision_id
413
502
offset = int(self.spec)
414
503
except ValueError, e:
415
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
504
raise errors.InvalidRevisionSpec(self.user_spec, context_branch, e)
418
raise errors.InvalidRevisionSpec(self.user_spec, branch,
507
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
419
508
'you must supply a positive value')
420
revno = len(revs) - offset + 1
510
revno = last_revno - offset + 1
422
revision_id = branch.get_rev_id(revno, revs)
512
revision_id = context_branch.get_rev_id(revno, revs_or_none)
423
513
except errors.NoSuchRevision:
424
raise errors.InvalidRevisionSpec(self.user_spec, branch)
425
return RevisionInfo(branch, revno, revision_id)
427
SPEC_TYPES.append(RevisionSpec_last)
514
raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
515
return revno, revision_id
517
def _as_revision_id(self, context_branch):
518
# We compute the revno as part of the process, but we don't really care
520
revno, revision_id = self._revno_and_revision_id(context_branch, None)
430
525
class RevisionSpec_before(RevisionSpec):
433
528
help_txt = """Selects the parent of the revision specified.
435
Supply any revision spec to return the parent of that revision.
530
Supply any revision spec to return the parent of that revision. This is
531
mostly useful when inspecting revisions that are not in the revision history
436
534
It is an error to request the parent of the null revision (before:0).
437
This is mostly useful when inspecting revisions that are not in the
438
revision history of a branch.
441
538
before:1913 -> Return the parent of revno 1913 (revno 1912)
442
539
before:revid:aaaa@bbbb-1234567890 -> return the parent of revision
443
540
aaaa@bbbb-1234567890
444
bzr diff -r before:revid:aaaa..revid:aaaa
445
-> Find the changes between revision 'aaaa' and its parent.
446
(what changes did 'aaaa' introduce)
541
bzr diff -r before:1913..1913
542
-> Find the changes between revision 1913 and its parent (1912).
543
(What changes did revision 1913 introduce).
544
This is equivalent to: bzr diff -c 1913
449
547
prefix = 'before:'
451
549
def _match_on(self, branch, revs):
452
550
r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
475
573
return RevisionInfo(branch, revno, revision_id)
477
SPEC_TYPES.append(RevisionSpec_before)
575
def _as_revision_id(self, context_branch):
576
base_revspec = RevisionSpec.from_string(self.spec)
577
base_revision_id = base_revspec.as_revision_id(context_branch)
578
if base_revision_id == revision.NULL_REVISION:
579
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
580
'cannot go before the null: revision')
581
context_repo = context_branch.repository
582
context_repo.lock_read()
584
parent_map = context_repo.get_parent_map([base_revision_id])
586
context_repo.unlock()
587
if base_revision_id not in parent_map:
588
# Ghost, or unknown revision id
589
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
590
'cannot find the matching revision')
591
parents = parent_map[base_revision_id]
593
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
594
'No parents for revision.')
480
599
class RevisionSpec_tag(RevisionSpec):
525
647
Matches the first entry after a given date (either at midnight or
526
648
at a specified time).
528
One way to display all the changes since yesterday would be:
529
bzr log -r date:yesterday..-1
650
One way to display all the changes since yesterday would be::
652
bzr log -r date:yesterday..
532
656
date:yesterday -> select the first revision since yesterday
533
657
date:2006-08-14,17:10:14 -> select the first revision after
534
658
August 14th, 2006 at 5:10pm.
537
661
_date_re = re.compile(
538
662
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
626
750
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
627
751
return self._find_revision_info(branch, self.spec)
753
def _as_revision_id(self, context_branch):
754
return self._find_revision_id(context_branch, self.spec)
630
757
def _find_revision_info(branch, other_location):
631
from bzrlib.branch import Branch
633
other_branch = Branch.open(other_location)
634
revision_a = branch.last_revision()
635
revision_b = other_branch.last_revision()
636
for r, b in ((revision_a, branch), (revision_b, other_branch)):
637
if r in (None, revision.NULL_REVISION):
638
raise errors.NoCommits(b)
639
revision_source = revision.MultipleRevisionSources(
640
branch.repository, other_branch.repository)
641
rev_id = revision.common_ancestor(revision_a, revision_b,
758
revision_id = RevisionSpec_ancestor._find_revision_id(branch,
644
revno = branch.revision_id_to_revno(rev_id)
761
revno = branch.revision_id_to_revno(revision_id)
645
762
except errors.NoSuchRevision:
647
return RevisionInfo(branch, revno, rev_id)
650
SPEC_TYPES.append(RevisionSpec_ancestor)
764
return RevisionInfo(branch, revno, revision_id)
767
def _find_revision_id(branch, other_location):
768
from bzrlib.branch import Branch
772
revision_a = revision.ensure_null(branch.last_revision())
773
if revision_a == revision.NULL_REVISION:
774
raise errors.NoCommits(branch)
775
if other_location == '':
776
other_location = branch.get_parent()
777
other_branch = Branch.open(other_location)
778
other_branch.lock_read()
780
revision_b = revision.ensure_null(other_branch.last_revision())
781
if revision_b == revision.NULL_REVISION:
782
raise errors.NoCommits(other_branch)
783
graph = branch.repository.get_graph(other_branch.repository)
784
rev_id = graph.find_unique_lca(revision_a, revision_b)
786
other_branch.unlock()
787
if rev_id == revision.NULL_REVISION:
788
raise errors.NoCommonAncestor(revision_a, revision_b)
653
796
class RevisionSpec_branch(RevisionSpec):
675
820
except errors.NoSuchRevision:
677
822
return RevisionInfo(branch, revno, revision_b)
679
SPEC_TYPES.append(RevisionSpec_branch)
824
def _as_revision_id(self, context_branch):
825
from bzrlib.branch import Branch
826
other_branch = Branch.open(self.spec)
827
last_revision = other_branch.last_revision()
828
last_revision = revision.ensure_null(last_revision)
829
context_branch.fetch(other_branch, last_revision)
830
if last_revision == revision.NULL_REVISION:
831
raise errors.NoCommits(other_branch)
834
def _as_tree(self, context_branch):
835
from bzrlib.branch import Branch
836
other_branch = Branch.open(self.spec)
837
last_revision = other_branch.last_revision()
838
last_revision = revision.ensure_null(last_revision)
839
if last_revision == revision.NULL_REVISION:
840
raise errors.NoCommits(other_branch)
841
return other_branch.repository.revision_tree(last_revision)
682
845
class RevisionSpec_submit(RevisionSpec_ancestor):
687
850
Diffing against this shows all the changes that were made in this branch,
688
851
and is a good predictor of what merge will do. The submit branch is
689
used by the bundle and merge directive comands. If no submit branch
852
used by the bundle and merge directive commands. If no submit branch
690
853
is specified, the parent branch is used instead.
692
855
The common ancestor is the last revision that existed in both
693
856
branches. Usually this is the branch point, but it could also be
694
857
a revision that was merged.
697
861
$ bzr diff -r submit:
700
864
prefix = 'submit:'
702
def _match_on(self, branch, revs):
703
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
866
def _get_submit_location(self, branch):
704
867
submit_location = branch.get_submit_branch()
705
868
location_type = 'submit branch'
706
869
if submit_location is None:
709
872
if submit_location is None:
710
873
raise errors.NoSubmitBranch(branch)
711
874
trace.note('Using %s %s', location_type, submit_location)
712
return self._find_revision_info(branch, submit_location)
715
SPEC_TYPES.append(RevisionSpec_submit)
875
return submit_location
877
def _match_on(self, branch, revs):
878
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
879
return self._find_revision_info(branch,
880
self._get_submit_location(branch))
882
def _as_revision_id(self, context_branch):
883
return self._find_revision_id(context_branch,
884
self._get_submit_location(context_branch))
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
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
898
revspec_registry = registry.Registry()
899
def _register_revspec(revspec):
900
revspec_registry.register(revspec.prefix, revspec)
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)
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", [])