141
wants_revision_history = True
142
dwim_catchable_exceptions = (errors.InvalidRevisionSpec,)
143
"""Exceptions that RevisionSpec_dwim._match_on will catch.
145
If the revspec is part of ``dwim_revspecs``, it may be tried with an
146
invalid revspec and raises some exception. The exceptions mentioned here
147
will not be reported to the user but simply ignored without stopping the
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)
152
149
def from_string(spec):
163
160
return RevisionSpec(None, _internal=True)
164
match = revspec_registry.get_prefix(spec)
165
if match is not None:
166
spectype, specsuffix = match
167
trace.mutter('Returning RevisionSpec %s for %s',
168
spectype.__name__, spec)
169
return spectype(spec, _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)
171
for spectype in SPEC_TYPES:
172
if spec.startswith(spectype.prefix):
173
trace.mutter('Returning RevisionSpec %s for %s',
174
spectype.__name__, spec)
175
return spectype(spec, _internal=True)
176
# Otherwise treat it as a DWIM, build the RevisionSpec object and
177
# wait for _match_on to be called.
178
return RevisionSpec_dwim(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)
180
183
def __init__(self, spec, _internal=False):
181
184
"""Create a RevisionSpec referring to the Null revision.
232
233
# will do what you expect.
233
234
in_store = in_history
234
235
in_branch = in_store
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)
271
237
def __repr__(self):
272
238
# this is mostly for helping with testing
273
239
return '<%s %s>' % (self.__class__.__name__,
276
242
def needs_branch(self):
277
243
"""Whether this revision spec needs a branch.
293
class RevisionSpec_dwim(RevisionSpec):
294
"""Provides a DWIMish revision specifier lookup.
296
Note that this does not go in the revspec_registry because by definition
297
there is no prefix to identify it. It's solely called from
298
RevisionSpec.from_string() because the DWIMification happen when _match_on
299
is called so the string describing the revision is kept here until needed.
303
# We don't need to build the revision history ourself, that's delegated to
304
# each revspec we try.
305
wants_revision_history = False
307
def _try_spectype(self, rstype, branch):
308
rs = rstype(self.spec, _internal=True)
309
# Hit in_history to find out if it exists, or we need to try the
311
return rs.in_history(branch)
313
def _match_on(self, branch, revs):
314
"""Run the lookup and see what we can get."""
316
# First, see if it's a revno
318
if _revno_regex is None:
319
_revno_regex = re.compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
320
if _revno_regex.match(self.spec) is not None:
322
return self._try_spectype(RevisionSpec_revno, branch)
323
except RevisionSpec_revno.dwim_catchable_exceptions:
326
# Next see what has been registered
327
for rs_class in dwim_revspecs:
329
return self._try_spectype(rs_class, branch)
330
except rs_class.dwim_catchable_exceptions:
333
# Well, I dunno what it is. Note that we don't try to keep track of the
334
# first of last exception raised during the DWIM tries as none seems
336
raise errors.InvalidRevisionSpec(self.spec, branch)
339
259
class RevisionSpec_revno(RevisionSpec):
340
260
"""Selects a revision using a number."""
342
262
help_txt = """Selects a revision using a number.
344
264
Use an integer to specify a revision in the history of the branch.
345
Optionally a branch can be specified. A negative number will count
346
from the end of the branch (-1 is the last revision, -2 the previous
347
one). If the negative number is larger than the branch's history, the
348
first revision is returned.
351
revno:1 -> return the first revision of this 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
352
271
revno:3:/path/to/branch -> return the 3rd revision of
353
272
the branch '/path/to/branch'
354
273
revno:-1 -> The last revision in a branch.
400
314
# the branch object.
401
315
from bzrlib.branch import Branch
402
316
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()
407
revision_id = branch.dotted_revno_to_revision_id(match_revno,
409
except errors.NoSuchRevision:
410
raise errors.InvalidRevisionSpec(self.user_spec, branch)
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)
412
337
# there is no traditional 'revno' for dotted-decimal revnos.
413
338
# so for API compatability we return None.
414
return branch, None, revision_id
339
return RevisionInfo(branch, None, revisions[0][1])
416
last_revno, last_revision_id = branch.last_revision_info()
418
342
# if get_rev_id supported negative revnos, there would not be a
419
343
# need for this special case.
420
if (-revno) >= last_revno:
344
if (-revno) >= len(revs):
423
revno = last_revno + revno + 1
347
revno = len(revs) + revno + 1
425
revision_id = branch.get_rev_id(revno, revs_or_none)
349
revision_id = branch.get_rev_id(revno, revs)
426
350
except errors.NoSuchRevision:
427
351
raise errors.InvalidRevisionSpec(self.user_spec, branch)
428
return branch, revno, revision_id
430
def _as_revision_id(self, context_branch):
431
# We would have the revno here, but we don't really care
432
branch, revno, revision_id = self._lookup(context_branch, None)
352
return RevisionInfo(branch, revno, revision_id)
435
354
def needs_branch(self):
436
355
return self.spec.find(':') == -1
442
361
return self.spec[self.spec.find(':')+1:]
445
364
RevisionSpec_int = RevisionSpec_revno
449
class RevisionIDSpec(RevisionSpec):
451
def _match_on(self, branch, revs):
452
revision_id = self.as_revision_id(branch)
453
return RevisionInfo.from_revision_id(branch, revision_id, revs)
456
class RevisionSpec_revid(RevisionIDSpec):
366
SPEC_TYPES.append(RevisionSpec_revno)
369
class RevisionSpec_revid(RevisionSpec):
457
370
"""Selects a revision using the revision id."""
459
372
help_txt = """Selects a revision using the revision id.
461
374
Supply a specific revision id, that can be used to specify any
462
revision id in the ancestry of the branch.
375
revision id in the ancestry of the branch.
463
376
Including merges, and pending merges.
466
378
revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
469
380
prefix = 'revid:'
471
def _as_revision_id(self, context_branch):
382
def _match_on(self, branch, revs):
472
383
# self.spec comes straight from parsing the command line arguments,
473
384
# so we expect it to be a Unicode string. Switch it to the internal
474
385
# representation.
475
return osutils.safe_revision_id(self.spec, warn=False)
386
revision_id = osutils.safe_revision_id(self.spec, warn=False)
387
return RevisionInfo.from_revision_id(branch, revision_id, revs)
389
SPEC_TYPES.append(RevisionSpec_revid)
479
392
class RevisionSpec_last(RevisionSpec):
484
397
Supply a positive number to get the nth revision from the end.
485
398
This is the same as supplying negative numbers to the 'revno:' spec.
488
400
last:1 -> return the last revision
489
401
last:3 -> return the revision 2 before the end.
494
406
def _match_on(self, branch, revs):
495
revno, revision_id = self._revno_and_revision_id(branch, revs)
496
return RevisionInfo(branch, revno, revision_id)
498
def _revno_and_revision_id(self, context_branch, revs_or_none):
499
last_revno, last_revision_id = context_branch.last_revision_info()
501
407
if self.spec == '':
503
raise errors.NoCommits(context_branch)
504
return last_revno, last_revision_id
409
raise errors.NoCommits(branch)
410
return RevisionInfo(branch, len(revs), revs[-1])
507
413
offset = int(self.spec)
508
414
except ValueError, e:
509
raise errors.InvalidRevisionSpec(self.user_spec, context_branch, e)
415
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
512
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
418
raise errors.InvalidRevisionSpec(self.user_spec, branch,
513
419
'you must supply a positive value')
515
revno = last_revno - offset + 1
420
revno = len(revs) - offset + 1
517
revision_id = context_branch.get_rev_id(revno, revs_or_none)
422
revision_id = branch.get_rev_id(revno, revs)
518
423
except errors.NoSuchRevision:
519
raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
520
return revno, revision_id
522
def _as_revision_id(self, context_branch):
523
# We compute the revno as part of the process, but we don't really care
525
revno, revision_id = self._revno_and_revision_id(context_branch, None)
424
raise errors.InvalidRevisionSpec(self.user_spec, branch)
425
return RevisionInfo(branch, revno, revision_id)
427
SPEC_TYPES.append(RevisionSpec_last)
530
430
class RevisionSpec_before(RevisionSpec):
533
433
help_txt = """Selects the parent of the revision specified.
535
Supply any revision spec to return the parent of that revision. This is
536
mostly useful when inspecting revisions that are not in the revision history
435
Supply any revision spec to return the parent of that revision.
539
436
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.
543
441
before:1913 -> Return the parent of revno 1913 (revno 1912)
544
442
before:revid:aaaa@bbbb-1234567890 -> return the parent of revision
545
443
aaaa@bbbb-1234567890
546
bzr diff -r before:1913..1913
547
-> Find the changes between revision 1913 and its parent (1912).
548
(What changes did revision 1913 introduce).
549
This is equivalent to: bzr diff -c 1913
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)
552
449
prefix = 'before:'
554
451
def _match_on(self, branch, revs):
555
452
r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
578
475
return RevisionInfo(branch, revno, revision_id)
580
def _as_revision_id(self, context_branch):
581
base_revspec = RevisionSpec.from_string(self.spec)
582
base_revision_id = base_revspec.as_revision_id(context_branch)
583
if base_revision_id == revision.NULL_REVISION:
584
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
585
'cannot go before the null: revision')
586
context_repo = context_branch.repository
587
context_repo.lock_read()
589
parent_map = context_repo.get_parent_map([base_revision_id])
591
context_repo.unlock()
592
if base_revision_id not in parent_map:
593
# Ghost, or unknown revision id
594
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
595
'cannot find the matching revision')
596
parents = parent_map[base_revision_id]
598
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
599
'No parents for revision.')
477
SPEC_TYPES.append(RevisionSpec_before)
604
480
class RevisionSpec_tag(RevisionSpec):
755
626
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
756
627
return self._find_revision_info(branch, self.spec)
758
def _as_revision_id(self, context_branch):
759
return self._find_revision_id(context_branch, self.spec)
762
630
def _find_revision_info(branch, other_location):
763
revision_id = RevisionSpec_ancestor._find_revision_id(branch,
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,
766
revno = branch.revision_id_to_revno(revision_id)
644
revno = branch.revision_id_to_revno(rev_id)
767
645
except errors.NoSuchRevision:
769
return RevisionInfo(branch, revno, revision_id)
772
def _find_revision_id(branch, other_location):
773
from bzrlib.branch import Branch
777
revision_a = revision.ensure_null(branch.last_revision())
778
if revision_a == revision.NULL_REVISION:
779
raise errors.NoCommits(branch)
780
if other_location == '':
781
other_location = branch.get_parent()
782
other_branch = Branch.open(other_location)
783
other_branch.lock_read()
785
revision_b = revision.ensure_null(other_branch.last_revision())
786
if revision_b == revision.NULL_REVISION:
787
raise errors.NoCommits(other_branch)
788
graph = branch.repository.get_graph(other_branch.repository)
789
rev_id = graph.find_unique_lca(revision_a, revision_b)
791
other_branch.unlock()
792
if rev_id == revision.NULL_REVISION:
793
raise errors.NoCommonAncestor(revision_a, revision_b)
647
return RevisionInfo(branch, revno, rev_id)
650
SPEC_TYPES.append(RevisionSpec_ancestor)
801
653
class RevisionSpec_branch(RevisionSpec):
818
668
revision_b = other_branch.last_revision()
819
669
if revision_b in (None, revision.NULL_REVISION):
820
670
raise errors.NoCommits(other_branch)
822
branch = other_branch
825
# pull in the remote revisions so we can diff
826
branch.fetch(other_branch, revision_b)
827
except errors.ReadOnlyError:
828
branch = other_branch
671
# pull in the remote revisions so we can diff
672
branch.fetch(other_branch, revision_b)
830
674
revno = branch.revision_id_to_revno(revision_b)
831
675
except errors.NoSuchRevision:
833
677
return RevisionInfo(branch, revno, revision_b)
835
def _as_revision_id(self, context_branch):
836
from bzrlib.branch import Branch
837
other_branch = Branch.open(self.spec)
838
last_revision = other_branch.last_revision()
839
last_revision = revision.ensure_null(last_revision)
840
context_branch.fetch(other_branch, last_revision)
841
if last_revision == revision.NULL_REVISION:
842
raise errors.NoCommits(other_branch)
845
def _as_tree(self, context_branch):
846
from bzrlib.branch import Branch
847
other_branch = Branch.open(self.spec)
848
last_revision = other_branch.last_revision()
849
last_revision = revision.ensure_null(last_revision)
850
if last_revision == revision.NULL_REVISION:
851
raise errors.NoCommits(other_branch)
852
return other_branch.repository.revision_tree(last_revision)
854
def needs_branch(self):
857
def get_branch(self):
679
SPEC_TYPES.append(RevisionSpec_branch)
862
682
class RevisionSpec_submit(RevisionSpec_ancestor):
867
687
Diffing against this shows all the changes that were made in this branch,
868
688
and is a good predictor of what merge will do. The submit branch is
869
used by the bundle and merge directive commands. If no submit branch
689
used by the bundle and merge directive comands. If no submit branch
870
690
is specified, the parent branch is used instead.
872
692
The common ancestor is the last revision that existed in both
873
693
branches. Usually this is the branch point, but it could also be
874
694
a revision that was merged.
878
697
$ bzr diff -r submit:
881
700
prefix = 'submit:'
883
def _get_submit_location(self, branch):
702
def _match_on(self, branch, revs):
703
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
884
704
submit_location = branch.get_submit_branch()
885
705
location_type = 'submit branch'
886
706
if submit_location is None:
889
709
if submit_location is None:
890
710
raise errors.NoSubmitBranch(branch)
891
711
trace.note('Using %s %s', location_type, submit_location)
892
return submit_location
894
def _match_on(self, branch, revs):
895
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
896
return self._find_revision_info(branch,
897
self._get_submit_location(branch))
899
def _as_revision_id(self, context_branch):
900
return self._find_revision_id(context_branch,
901
self._get_submit_location(context_branch))
904
class RevisionSpec_annotate(RevisionIDSpec):
908
help_txt = """Select the revision that last modified the specified line.
910
Select the revision that last modified the specified line. Line is
911
specified as path:number. Path is a relative path to the file. Numbers
912
start at 1, and are relative to the current version, not the last-
913
committed version of the file.
916
def _raise_invalid(self, numstring, context_branch):
917
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
918
'No such line: %s' % numstring)
920
def _as_revision_id(self, context_branch):
921
path, numstring = self.spec.rsplit(':', 1)
923
index = int(numstring) - 1
925
self._raise_invalid(numstring, context_branch)
926
tree, file_path = workingtree.WorkingTree.open_containing(path)
929
file_id = tree.path2id(file_path)
931
raise errors.InvalidRevisionSpec(self.user_spec,
932
context_branch, "File '%s' is not versioned." %
934
revision_ids = [r for (r, l) in tree.annotate_iter(file_id)]
938
revision_id = revision_ids[index]
940
self._raise_invalid(numstring, context_branch)
941
if revision_id == revision.CURRENT_REVISION:
942
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
943
'Line %s has not been committed.' % numstring)
947
class RevisionSpec_mainline(RevisionIDSpec):
949
help_txt = """Select mainline revision that merged the specified revision.
951
Select the revision that merged the specified revision into mainline.
956
def _as_revision_id(self, context_branch):
957
revspec = RevisionSpec.from_string(self.spec)
958
if revspec.get_branch() is None:
959
spec_branch = context_branch
961
spec_branch = _mod_branch.Branch.open(revspec.get_branch())
962
revision_id = revspec.as_revision_id(spec_branch)
963
graph = context_branch.repository.get_graph()
964
result = graph.find_lefthand_merger(revision_id,
965
context_branch.last_revision())
967
raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
971
# The order in which we want to DWIM a revision spec without any prefix.
972
# revno is always tried first and isn't listed here, this is used by
973
# RevisionSpec_dwim._match_on
975
RevisionSpec_tag, # Let's try for a tag
976
RevisionSpec_revid, # Maybe it's a revid?
977
RevisionSpec_date, # Perhaps a date?
978
RevisionSpec_branch, # OK, last try, maybe it's a branch
982
revspec_registry = registry.Registry()
983
def _register_revspec(revspec):
984
revspec_registry.register(revspec.prefix, revspec)
986
_register_revspec(RevisionSpec_revno)
987
_register_revspec(RevisionSpec_revid)
988
_register_revspec(RevisionSpec_last)
989
_register_revspec(RevisionSpec_before)
990
_register_revspec(RevisionSpec_tag)
991
_register_revspec(RevisionSpec_date)
992
_register_revspec(RevisionSpec_ancestor)
993
_register_revspec(RevisionSpec_branch)
994
_register_revspec(RevisionSpec_submit)
995
_register_revspec(RevisionSpec_annotate)
996
_register_revspec(RevisionSpec_mainline)
998
# classes in this list should have a "prefix" attribute, against which
999
# string specs are matched
1000
SPEC_TYPES = symbol_versioning.deprecated_list(
1001
symbol_versioning.deprecated_in((1, 12, 0)), "SPEC_TYPES", [])
712
return self._find_revision_info(branch, submit_location)
715
SPEC_TYPES.append(RevisionSpec_submit)
added
removed
bzrlib/revisionspec.py
