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)
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
149
152
def from_string(spec):
160
163
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)
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)
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)
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)
183
180
def __init__(self, spec, _internal=False):
184
181
"""Create a RevisionSpec referring to the Null revision.
233
232
# will do what you expect.
234
233
in_store = in_history
235
234
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)
237
271
def __repr__(self):
238
272
# this is mostly for helping with testing
239
273
return '<%s %s>' % (self.__class__.__name__,
242
276
def needs_branch(self):
243
277
"""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)
259
339
class RevisionSpec_revno(RevisionSpec):
260
340
"""Selects a revision using a number."""
262
342
help_txt = """Selects a revision using a number.
264
344
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.
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.
271
revno:1 -> return the first revision
351
revno:1 -> return the first revision of this branch
272
352
revno:3:/path/to/branch -> return the 3rd revision of
273
353
the branch '/path/to/branch'
274
354
revno:-1 -> The last revision in a branch.
315
400
# the branch object.
316
401
from bzrlib.branch import Branch
317
402
branch = Branch.open(branch_spec)
318
# Need to use a new revision history
319
# because we are using a specific branch
320
revs = branch.revision_history()
325
revision_id_to_revno = branch.get_revision_id_to_revno_map()
326
revisions = [revision_id for revision_id, revno
327
in revision_id_to_revno.iteritems()
328
if revno == match_revno]
331
if len(revisions) != 1:
332
return RevisionInfo(branch, None, None)
407
revision_id = branch.dotted_revno_to_revision_id(match_revno,
409
except errors.NoSuchRevision:
410
raise errors.InvalidRevisionSpec(self.user_spec, branch)
334
412
# there is no traditional 'revno' for dotted-decimal revnos.
335
413
# so for API compatability we return None.
336
return RevisionInfo(branch, None, revisions[0])
414
return branch, None, revision_id
416
last_revno, last_revision_id = branch.last_revision_info()
339
418
# if get_rev_id supported negative revnos, there would not be a
340
419
# need for this special case.
341
if (-revno) >= len(revs):
420
if (-revno) >= last_revno:
344
revno = len(revs) + revno + 1
423
revno = last_revno + revno + 1
346
revision_id = branch.get_rev_id(revno, revs)
425
revision_id = branch.get_rev_id(revno, revs_or_none)
347
426
except errors.NoSuchRevision:
348
427
raise errors.InvalidRevisionSpec(self.user_spec, branch)
349
return RevisionInfo(branch, revno, revision_id)
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)
351
435
def needs_branch(self):
352
436
return self.spec.find(':') == -1
358
442
return self.spec[self.spec.find(':')+1:]
361
445
RevisionSpec_int = RevisionSpec_revno
363
SPEC_TYPES.append(RevisionSpec_revno)
366
class RevisionSpec_revid(RevisionSpec):
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):
367
457
"""Selects a revision using the revision id."""
369
459
help_txt = """Selects a revision using the revision id.
371
461
Supply a specific revision id, that can be used to specify any
372
revision id in the ancestry of the branch.
462
revision id in the ancestry of the branch.
373
463
Including merges, and pending merges.
376
466
revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
378
469
prefix = 'revid:'
380
def _match_on(self, branch, revs):
471
def _as_revision_id(self, context_branch):
381
472
# self.spec comes straight from parsing the command line arguments,
382
473
# so we expect it to be a Unicode string. Switch it to the internal
383
474
# representation.
384
revision_id = osutils.safe_revision_id(self.spec, warn=False)
385
return RevisionInfo.from_revision_id(branch, revision_id, revs)
475
return osutils.safe_revision_id(self.spec, warn=False)
387
SPEC_TYPES.append(RevisionSpec_revid)
390
479
class RevisionSpec_last(RevisionSpec):
399
488
last:1 -> return the last revision
400
489
last:3 -> return the revision 2 before the end.
405
494
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()
406
501
if self.spec == '':
408
raise errors.NoCommits(branch)
409
return RevisionInfo(branch, len(revs), revs[-1])
503
raise errors.NoCommits(context_branch)
504
return last_revno, last_revision_id
412
507
offset = int(self.spec)
413
508
except ValueError, e:
414
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
509
raise errors.InvalidRevisionSpec(self.user_spec, context_branch, e)
417
raise errors.InvalidRevisionSpec(self.user_spec, branch,
512
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
418
513
'you must supply a positive value')
419
revno = len(revs) - offset + 1
515
revno = last_revno - offset + 1
421
revision_id = branch.get_rev_id(revno, revs)
517
revision_id = context_branch.get_rev_id(revno, revs_or_none)
422
518
except errors.NoSuchRevision:
423
raise errors.InvalidRevisionSpec(self.user_spec, branch)
424
return RevisionInfo(branch, revno, revision_id)
426
SPEC_TYPES.append(RevisionSpec_last)
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)
429
530
class RevisionSpec_before(RevisionSpec):
432
533
help_txt = """Selects the parent of the revision specified.
434
Supply any revision spec to return the parent of that revision.
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
539
It is an error to request the parent of the null revision (before:0).
436
This is mostly useful when inspecting revisions that are not in the
437
revision history of a branch.
441
543
before:1913 -> Return the parent of revno 1913 (revno 1912)
442
544
before:revid:aaaa@bbbb-1234567890 -> return the parent of revision
443
545
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)
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
449
552
prefix = 'before:'
451
554
def _match_on(self, branch, revs):
452
555
r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
475
578
return RevisionInfo(branch, revno, revision_id)
477
SPEC_TYPES.append(RevisionSpec_before)
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.')
480
604
class RevisionSpec_tag(RevisionSpec):
629
755
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
630
756
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)
633
762
def _find_revision_info(branch, other_location):
763
revision_id = RevisionSpec_ancestor._find_revision_id(branch,
766
revno = branch.revision_id_to_revno(revision_id)
767
except errors.NoSuchRevision:
769
return RevisionInfo(branch, revno, revision_id)
772
def _find_revision_id(branch, other_location):
634
773
from bzrlib.branch import Branch
636
other_branch = Branch.open(other_location)
637
revision_a = branch.last_revision()
638
revision_b = other_branch.last_revision()
639
for r, b in ((revision_a, branch), (revision_b, other_branch)):
640
if r in (None, revision.NULL_REVISION):
641
raise errors.NoCommits(b)
642
revision_source = revision.MultipleRevisionSources(
643
branch.repository, other_branch.repository)
644
graph = branch.repository.get_graph(other_branch.repository)
645
revision_a = revision.ensure_null(revision_a)
646
revision_b = revision.ensure_null(revision_b)
647
if revision.NULL_REVISION in (revision_a, revision_b):
648
rev_id = revision.NULL_REVISION
650
rev_id = graph.find_unique_lca(revision_a, revision_b)
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()
651
792
if rev_id == revision.NULL_REVISION:
652
793
raise errors.NoCommonAncestor(revision_a, revision_b)
654
revno = branch.revision_id_to_revno(rev_id)
655
except errors.NoSuchRevision:
657
return RevisionInfo(branch, revno, rev_id)
660
SPEC_TYPES.append(RevisionSpec_ancestor)
663
801
class RevisionSpec_branch(RevisionSpec):
679
818
revision_b = other_branch.last_revision()
680
819
if revision_b in (None, revision.NULL_REVISION):
681
820
raise errors.NoCommits(other_branch)
682
# pull in the remote revisions so we can diff
683
branch.fetch(other_branch, revision_b)
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
685
830
revno = branch.revision_id_to_revno(revision_b)
686
831
except errors.NoSuchRevision:
688
833
return RevisionInfo(branch, revno, revision_b)
690
SPEC_TYPES.append(RevisionSpec_branch)
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):
693
862
class RevisionSpec_submit(RevisionSpec_ancestor):
721
889
if submit_location is None:
722
890
raise errors.NoSubmitBranch(branch)
723
891
trace.note('Using %s %s', location_type, submit_location)
724
return self._find_revision_info(branch, submit_location)
727
SPEC_TYPES.append(RevisionSpec_submit)
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", [])
added
removed
bzrlib/revisionspec.py
