107
117
return RevisionInfo(branch, revno, revision_id)
110
# classes in this list should have a "prefix" attribute, against which
111
# string specs are matched
116
120
class RevisionSpec(object):
117
121
"""A parsed revision specification."""
119
123
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.
125
A revision specification is a string, which may be unambiguous about
126
what it represents by giving a prefix like 'date:' or 'revid:' etc,
127
or it may have no prefix, in which case it's tried against several
128
specifier types in sequence to determine what the user meant.
126
130
Revision specs are an UI element, and they have been moved out
127
131
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)
140
wants_revision_history = True
141
dwim_catchable_exceptions = (errors.InvalidRevisionSpec,)
142
"""Exceptions that RevisionSpec_dwim._match_on will catch.
144
If the revspec is part of ``dwim_revspecs``, it may be tried with an
145
invalid revspec and raises some exception. The exceptions mentioned here
146
will not be reported to the user but simply ignored without stopping the
149
151
def from_string(spec):
160
162
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)
163
match = revspec_registry.get_prefix(spec)
164
if match is not None:
165
spectype, specsuffix = match
166
trace.mutter('Returning RevisionSpec %s for %s',
167
spectype.__name__, spec)
168
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)
170
# Otherwise treat it as a DWIM, build the RevisionSpec object and
171
# wait for _match_on to be called.
172
return RevisionSpec_dwim(spec, _internal=True)
183
174
def __init__(self, spec, _internal=False):
184
175
"""Create a RevisionSpec referring to the Null revision.
202
192
def _match_on(self, branch, revs):
203
193
trace.mutter('Returning RevisionSpec._match_on: None')
204
return RevisionInfo(branch, 0, None)
194
return RevisionInfo(branch, None, None)
206
196
def _match_on_and_check(self, branch, revs):
207
197
info = self._match_on(branch, revs)
210
elif info == (0, None):
211
# special case - the empty tree
200
elif info == (None, None):
201
# special case - nothing supplied
213
203
elif self.prefix:
214
204
raise errors.InvalidRevisionSpec(self.user_spec, branch)
233
226
# will do what you expect.
234
227
in_store = in_history
235
228
in_branch = in_store
230
def as_revision_id(self, context_branch):
231
"""Return just the revision_id for this revisions spec.
233
Some revision specs require a context_branch to be able to determine
234
their value. Not all specs will make use of it.
236
return self._as_revision_id(context_branch)
238
def _as_revision_id(self, context_branch):
239
"""Implementation of as_revision_id()
241
Classes should override this function to provide appropriate
242
functionality. The default is to just call '.in_history().rev_id'
244
return self.in_history(context_branch).rev_id
246
def as_tree(self, context_branch):
247
"""Return the tree object for this revisions spec.
249
Some revision specs require a context_branch to be able to determine
250
the revision id and access the repository. Not all specs will make
253
return self._as_tree(context_branch)
255
def _as_tree(self, context_branch):
256
"""Implementation of as_tree().
258
Classes should override this function to provide appropriate
259
functionality. The default is to just call '.as_revision_id()'
260
and get the revision tree from context_branch's repository.
262
revision_id = self.as_revision_id(context_branch)
263
return context_branch.repository.revision_tree(revision_id)
237
265
def __repr__(self):
238
266
# this is mostly for helping with testing
239
267
return '<%s %s>' % (self.__class__.__name__,
242
270
def needs_branch(self):
243
271
"""Whether this revision spec needs a branch.
287
class RevisionSpec_dwim(RevisionSpec):
288
"""Provides a DWIMish revision specifier lookup.
290
Note that this does not go in the revspec_registry because by definition
291
there is no prefix to identify it. It's solely called from
292
RevisionSpec.from_string() because the DWIMification happen when _match_on
293
is called so the string describing the revision is kept here until needed.
297
# We don't need to build the revision history ourself, that's delegated to
298
# each revspec we try.
299
wants_revision_history = False
301
_revno_regex = lazy_regex.lazy_compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
303
# The revspecs to try
304
_possible_revspecs = []
306
def _try_spectype(self, rstype, branch):
307
rs = rstype(self.spec, _internal=True)
308
# Hit in_history to find out if it exists, or we need to try the
310
return rs.in_history(branch)
312
def _match_on(self, branch, revs):
313
"""Run the lookup and see what we can get."""
315
# First, see if it's a revno
316
if self._revno_regex.match(self.spec) is not None:
318
return self._try_spectype(RevisionSpec_revno, branch)
319
except RevisionSpec_revno.dwim_catchable_exceptions:
322
# Next see what has been registered
323
for objgetter in self._possible_revspecs:
324
rs_class = objgetter.get_obj()
326
return self._try_spectype(rs_class, branch)
327
except rs_class.dwim_catchable_exceptions:
330
# Try the old (deprecated) dwim list:
331
for rs_class in dwim_revspecs:
333
return self._try_spectype(rs_class, branch)
334
except rs_class.dwim_catchable_exceptions:
337
# Well, I dunno what it is. Note that we don't try to keep track of the
338
# first of last exception raised during the DWIM tries as none seems
340
raise errors.InvalidRevisionSpec(self.spec, branch)
343
def append_possible_revspec(cls, revspec):
344
"""Append a possible DWIM revspec.
346
:param revspec: Revision spec to try.
348
cls._possible_revspecs.append(registry._ObjectGetter(revspec))
351
def append_possible_lazy_revspec(cls, module_name, member_name):
352
"""Append a possible lazily loaded DWIM revspec.
354
:param module_name: Name of the module with the revspec
355
:param member_name: Name of the revspec within the module
357
cls._possible_revspecs.append(
358
registry._LazyObjectGetter(module_name, member_name))
259
361
class RevisionSpec_revno(RevisionSpec):
260
362
"""Selects a revision using a number."""
262
364
help_txt = """Selects a revision using a number.
264
366
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
367
Optionally a branch can be specified. A negative number will count
368
from the end of the branch (-1 is the last revision, -2 the previous
369
one). If the negative number is larger than the branch's history, the
370
first revision is returned.
373
revno:1 -> return the first revision of this branch
271
374
revno:3:/path/to/branch -> return the 3rd revision of
272
375
the branch '/path/to/branch'
273
376
revno:-1 -> The last revision in a branch.
314
422
# the branch object.
315
423
from bzrlib.branch import Branch
316
424
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
revision_id_to_revno = branch.get_revision_id_to_revno_map()
325
revisions = [revision_id for revision_id, revno
326
in revision_id_to_revno.iteritems()
327
if revno == match_revno]
330
if len(revisions) != 1:
331
return RevisionInfo(branch, None, None)
429
revision_id = branch.dotted_revno_to_revision_id(match_revno,
431
except errors.NoSuchRevision:
432
raise errors.InvalidRevisionSpec(self.user_spec, branch)
333
434
# there is no traditional 'revno' for dotted-decimal revnos.
334
435
# so for API compatability we return None.
335
return RevisionInfo(branch, None, revisions[0])
436
return branch, None, revision_id
438
last_revno, last_revision_id = branch.last_revision_info()
338
440
# if get_rev_id supported negative revnos, there would not be a
339
441
# need for this special case.
340
if (-revno) >= len(revs):
442
if (-revno) >= last_revno:
343
revno = len(revs) + revno + 1
445
revno = last_revno + revno + 1
345
revision_id = branch.get_rev_id(revno, revs)
447
revision_id = branch.get_rev_id(revno, revs_or_none)
346
448
except errors.NoSuchRevision:
347
449
raise errors.InvalidRevisionSpec(self.user_spec, branch)
348
return RevisionInfo(branch, revno, revision_id)
450
return branch, revno, revision_id
452
def _as_revision_id(self, context_branch):
453
# We would have the revno here, but we don't really care
454
branch, revno, revision_id = self._lookup(context_branch, None)
350
457
def needs_branch(self):
351
458
return self.spec.find(':') == -1
357
464
return self.spec[self.spec.find(':')+1:]
360
467
RevisionSpec_int = RevisionSpec_revno
362
SPEC_TYPES.append(RevisionSpec_revno)
365
class RevisionSpec_revid(RevisionSpec):
471
class RevisionIDSpec(RevisionSpec):
473
def _match_on(self, branch, revs):
474
revision_id = self.as_revision_id(branch)
475
return RevisionInfo.from_revision_id(branch, revision_id, revs)
478
class RevisionSpec_revid(RevisionIDSpec):
366
479
"""Selects a revision using the revision id."""
368
481
help_txt = """Selects a revision using the revision id.
370
483
Supply a specific revision id, that can be used to specify any
371
revision id in the ancestry of the branch.
484
revision id in the ancestry of the branch.
372
485
Including merges, and pending merges.
374
488
revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
376
491
prefix = 'revid:'
378
def _match_on(self, branch, revs):
493
def _as_revision_id(self, context_branch):
379
494
# self.spec comes straight from parsing the command line arguments,
380
495
# so we expect it to be a Unicode string. Switch it to the internal
381
496
# representation.
382
revision_id = osutils.safe_revision_id(self.spec, warn=False)
383
return RevisionInfo.from_revision_id(branch, revision_id, revs)
497
return osutils.safe_revision_id(self.spec, warn=False)
385
SPEC_TYPES.append(RevisionSpec_revid)
388
501
class RevisionSpec_last(RevisionSpec):
393
506
Supply a positive number to get the nth revision from the end.
394
507
This is the same as supplying negative numbers to the 'revno:' spec.
396
510
last:1 -> return the last revision
397
511
last:3 -> return the revision 2 before the end.
402
516
def _match_on(self, branch, revs):
517
revno, revision_id = self._revno_and_revision_id(branch, revs)
518
return RevisionInfo(branch, revno, revision_id)
520
def _revno_and_revision_id(self, context_branch, revs_or_none):
521
last_revno, last_revision_id = context_branch.last_revision_info()
403
523
if self.spec == '':
405
raise errors.NoCommits(branch)
406
return RevisionInfo(branch, len(revs), revs[-1])
525
raise errors.NoCommits(context_branch)
526
return last_revno, last_revision_id
409
529
offset = int(self.spec)
410
530
except ValueError, e:
411
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
531
raise errors.InvalidRevisionSpec(self.user_spec, context_branch, e)
414
raise errors.InvalidRevisionSpec(self.user_spec, branch,
534
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
415
535
'you must supply a positive value')
416
revno = len(revs) - offset + 1
537
revno = last_revno - offset + 1
418
revision_id = branch.get_rev_id(revno, revs)
539
revision_id = context_branch.get_rev_id(revno, revs_or_none)
419
540
except errors.NoSuchRevision:
420
raise errors.InvalidRevisionSpec(self.user_spec, branch)
421
return RevisionInfo(branch, revno, revision_id)
423
SPEC_TYPES.append(RevisionSpec_last)
541
raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
542
return revno, revision_id
544
def _as_revision_id(self, context_branch):
545
# We compute the revno as part of the process, but we don't really care
547
revno, revision_id = self._revno_and_revision_id(context_branch, None)
426
552
class RevisionSpec_before(RevisionSpec):
429
555
help_txt = """Selects the parent of the revision specified.
431
Supply any revision spec to return the parent of that revision.
557
Supply any revision spec to return the parent of that revision. This is
558
mostly useful when inspecting revisions that are not in the revision history
432
561
It is an error to request the parent of the null revision (before:0).
433
This is mostly useful when inspecting revisions that are not in the
434
revision history of a branch.
437
565
before:1913 -> Return the parent of revno 1913 (revno 1912)
438
566
before:revid:aaaa@bbbb-1234567890 -> return the parent of revision
439
567
aaaa@bbbb-1234567890
440
bzr diff -r before:revid:aaaa..revid:aaaa
441
-> Find the changes between revision 'aaaa' and its parent.
442
(what changes did 'aaaa' introduce)
568
bzr diff -r before:1913..1913
569
-> Find the changes between revision 1913 and its parent (1912).
570
(What changes did revision 1913 introduce).
571
This is equivalent to: bzr diff -c 1913
445
574
prefix = 'before:'
447
576
def _match_on(self, branch, revs):
448
577
r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
471
600
return RevisionInfo(branch, revno, revision_id)
473
SPEC_TYPES.append(RevisionSpec_before)
602
def _as_revision_id(self, context_branch):
603
base_revspec = RevisionSpec.from_string(self.spec)
604
base_revision_id = base_revspec.as_revision_id(context_branch)
605
if base_revision_id == revision.NULL_REVISION:
606
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
607
'cannot go before the null: revision')
608
context_repo = context_branch.repository
609
context_repo.lock_read()
611
parent_map = context_repo.get_parent_map([base_revision_id])
613
context_repo.unlock()
614
if base_revision_id not in parent_map:
615
# Ghost, or unknown revision id
616
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
617
'cannot find the matching revision')
618
parents = parent_map[base_revision_id]
620
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
621
'No parents for revision.')
476
626
class RevisionSpec_tag(RevisionSpec):
622
777
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
623
778
return self._find_revision_info(branch, self.spec)
780
def _as_revision_id(self, context_branch):
781
return self._find_revision_id(context_branch, self.spec)
626
784
def _find_revision_info(branch, other_location):
785
revision_id = RevisionSpec_ancestor._find_revision_id(branch,
788
revno = branch.revision_id_to_revno(revision_id)
789
except errors.NoSuchRevision:
791
return RevisionInfo(branch, revno, revision_id)
794
def _find_revision_id(branch, other_location):
627
795
from bzrlib.branch import Branch
629
other_branch = Branch.open(other_location)
630
revision_a = branch.last_revision()
631
revision_b = other_branch.last_revision()
632
for r, b in ((revision_a, branch), (revision_b, other_branch)):
633
if r in (None, revision.NULL_REVISION):
634
raise errors.NoCommits(b)
635
revision_source = revision.MultipleRevisionSources(
636
branch.repository, other_branch.repository)
637
graph = branch.repository.get_graph(other_branch.repository)
638
revision_a = revision.ensure_null(revision_a)
639
revision_b = revision.ensure_null(revision_b)
640
if revision.NULL_REVISION in (revision_a, revision_b):
641
rev_id = revision.NULL_REVISION
643
rev_id = graph.find_unique_lca(revision_a, revision_b)
799
revision_a = revision.ensure_null(branch.last_revision())
800
if revision_a == revision.NULL_REVISION:
801
raise errors.NoCommits(branch)
802
if other_location == '':
803
other_location = branch.get_parent()
804
other_branch = Branch.open(other_location)
805
other_branch.lock_read()
807
revision_b = revision.ensure_null(other_branch.last_revision())
808
if revision_b == revision.NULL_REVISION:
809
raise errors.NoCommits(other_branch)
810
graph = branch.repository.get_graph(other_branch.repository)
811
rev_id = graph.find_unique_lca(revision_a, revision_b)
813
other_branch.unlock()
644
814
if rev_id == revision.NULL_REVISION:
645
815
raise errors.NoCommonAncestor(revision_a, revision_b)
647
revno = branch.revision_id_to_revno(rev_id)
648
except errors.NoSuchRevision:
650
return RevisionInfo(branch, revno, rev_id)
653
SPEC_TYPES.append(RevisionSpec_ancestor)
656
823
class RevisionSpec_branch(RevisionSpec):
671
840
revision_b = other_branch.last_revision()
672
841
if revision_b in (None, revision.NULL_REVISION):
673
842
raise errors.NoCommits(other_branch)
674
# pull in the remote revisions so we can diff
675
branch.fetch(other_branch, revision_b)
844
branch = other_branch
847
# pull in the remote revisions so we can diff
848
branch.fetch(other_branch, revision_b)
849
except errors.ReadOnlyError:
850
branch = other_branch
677
852
revno = branch.revision_id_to_revno(revision_b)
678
853
except errors.NoSuchRevision:
680
855
return RevisionInfo(branch, revno, revision_b)
682
SPEC_TYPES.append(RevisionSpec_branch)
857
def _as_revision_id(self, context_branch):
858
from bzrlib.branch import Branch
859
other_branch = Branch.open(self.spec)
860
last_revision = other_branch.last_revision()
861
last_revision = revision.ensure_null(last_revision)
862
context_branch.fetch(other_branch, last_revision)
863
if last_revision == revision.NULL_REVISION:
864
raise errors.NoCommits(other_branch)
867
def _as_tree(self, context_branch):
868
from bzrlib.branch import Branch
869
other_branch = Branch.open(self.spec)
870
last_revision = other_branch.last_revision()
871
last_revision = revision.ensure_null(last_revision)
872
if last_revision == revision.NULL_REVISION:
873
raise errors.NoCommits(other_branch)
874
return other_branch.repository.revision_tree(last_revision)
876
def needs_branch(self):
879
def get_branch(self):
685
884
class RevisionSpec_submit(RevisionSpec_ancestor):
690
889
Diffing against this shows all the changes that were made in this branch,
691
890
and is a good predictor of what merge will do. The submit branch is
692
used by the bundle and merge directive comands. If no submit branch
891
used by the bundle and merge directive commands. If no submit branch
693
892
is specified, the parent branch is used instead.
695
894
The common ancestor is the last revision that existed in both
696
895
branches. Usually this is the branch point, but it could also be
697
896
a revision that was merged.
700
900
$ bzr diff -r submit:
703
903
prefix = 'submit:'
705
def _match_on(self, branch, revs):
706
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
905
def _get_submit_location(self, branch):
707
906
submit_location = branch.get_submit_branch()
708
907
location_type = 'submit branch'
709
908
if submit_location is None:
712
911
if submit_location is None:
713
912
raise errors.NoSubmitBranch(branch)
714
913
trace.note('Using %s %s', location_type, submit_location)
715
return self._find_revision_info(branch, submit_location)
718
SPEC_TYPES.append(RevisionSpec_submit)
914
return submit_location
916
def _match_on(self, branch, revs):
917
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
918
return self._find_revision_info(branch,
919
self._get_submit_location(branch))
921
def _as_revision_id(self, context_branch):
922
return self._find_revision_id(context_branch,
923
self._get_submit_location(context_branch))
926
class RevisionSpec_annotate(RevisionIDSpec):
930
help_txt = """Select the revision that last modified the specified line.
932
Select the revision that last modified the specified line. Line is
933
specified as path:number. Path is a relative path to the file. Numbers
934
start at 1, and are relative to the current version, not the last-
935
committed version of the file.
938
def _raise_invalid(self, numstring, context_branch):
939
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
940
'No such line: %s' % numstring)
942
def _as_revision_id(self, context_branch):
943
path, numstring = self.spec.rsplit(':', 1)
945
index = int(numstring) - 1
947
self._raise_invalid(numstring, context_branch)
948
tree, file_path = workingtree.WorkingTree.open_containing(path)
951
file_id = tree.path2id(file_path)
953
raise errors.InvalidRevisionSpec(self.user_spec,
954
context_branch, "File '%s' is not versioned." %
956
revision_ids = [r for (r, l) in tree.annotate_iter(file_id)]
960
revision_id = revision_ids[index]
962
self._raise_invalid(numstring, context_branch)
963
if revision_id == revision.CURRENT_REVISION:
964
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
965
'Line %s has not been committed.' % numstring)
969
class RevisionSpec_mainline(RevisionIDSpec):
971
help_txt = """Select mainline revision that merged the specified revision.
973
Select the revision that merged the specified revision into mainline.
978
def _as_revision_id(self, context_branch):
979
revspec = RevisionSpec.from_string(self.spec)
980
if revspec.get_branch() is None:
981
spec_branch = context_branch
983
spec_branch = _mod_branch.Branch.open(revspec.get_branch())
984
revision_id = revspec.as_revision_id(spec_branch)
985
graph = context_branch.repository.get_graph()
986
result = graph.find_lefthand_merger(revision_id,
987
context_branch.last_revision())
989
raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
993
# The order in which we want to DWIM a revision spec without any prefix.
994
# revno is always tried first and isn't listed here, this is used by
995
# RevisionSpec_dwim._match_on
996
dwim_revspecs = symbol_versioning.deprecated_list(
997
symbol_versioning.deprecated_in((2, 4, 0)), "dwim_revspecs", [])
999
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_tag)
1000
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_revid)
1001
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_date)
1002
RevisionSpec_dwim.append_possible_revspec(RevisionSpec_branch)
1004
revspec_registry = registry.Registry()
1005
def _register_revspec(revspec):
1006
revspec_registry.register(revspec.prefix, revspec)
1008
_register_revspec(RevisionSpec_revno)
1009
_register_revspec(RevisionSpec_revid)
1010
_register_revspec(RevisionSpec_last)
1011
_register_revspec(RevisionSpec_before)
1012
_register_revspec(RevisionSpec_tag)
1013
_register_revspec(RevisionSpec_date)
1014
_register_revspec(RevisionSpec_ancestor)
1015
_register_revspec(RevisionSpec_branch)
1016
_register_revspec(RevisionSpec_submit)
1017
_register_revspec(RevisionSpec_annotate)
1018
_register_revspec(RevisionSpec_mainline)