98
90
return '<bzrlib.revisionspec.RevisionInfo object %s, %s for %r>' % (
99
91
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)
94
# classes in this list should have a "prefix" attribute, against which
95
# string specs are matched
116
97
_revno_regex = None
119
100
class RevisionSpec(object):
120
"""A parsed revision specification."""
122
help_txt = """A parsed revision specification.
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.
101
"""A parsed revision specification.
103
A revision specification can be an integer, in which case it is
104
assumed to be a revno (though this will translate negative values
105
into positive ones); or it can be a string, in which case it is
106
parsed for something like 'date:' or 'revid:' etc.
129
108
Revision specs are an UI element, and they have been moved out
130
109
of the branch class to leave "back-end" classes unaware of such
161
142
return RevisionSpec(None, _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)
144
assert isinstance(spec, basestring), \
145
"You should only supply strings not %s" % (type(spec),)
147
for spectype in SPEC_TYPES:
148
if spec.startswith(spectype.prefix):
149
trace.mutter('Returning RevisionSpec %s for %s',
150
spectype.__name__, spec)
151
return spectype(spec, _internal=True)
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)
153
# RevisionSpec_revno is special cased, because it is the only
154
# one that directly handles plain integers
156
if _revno_regex is None:
157
_revno_regex = re.compile(r'-?\d+(:.*)?$')
158
if _revno_regex.match(spec) is not None:
159
return RevisionSpec_revno(spec, _internal=True)
161
raise errors.NoSuchRevisionSpec(spec)
178
163
def __init__(self, spec, _internal=False):
179
164
"""Create a RevisionSpec referring to the Null revision.
230
211
# will do what you expect.
231
212
in_store = in_history
232
213
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)
269
215
def __repr__(self):
270
216
# this is mostly for helping with testing
271
217
return '<%s %s>' % (self.__class__.__name__,
274
220
def needs_branch(self):
275
221
"""Whether this revision spec needs a branch.
281
def get_branch(self):
282
"""When the revision specifier contains a branch location, return it.
284
Otherwise, return None.
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)
337
230
class RevisionSpec_revno(RevisionSpec):
338
"""Selects a revision using a number."""
340
help_txt = """Selects a revision using a number.
342
Use an integer to specify a revision in the history of the branch.
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
350
revno:3:/path/to/branch -> return the 3rd revision of
351
the branch '/path/to/branch'
352
revno:-1 -> The last revision in a branch.
353
-2:http://other/branch -> The second to last revision in the
355
-1000000 -> Most likely the first revision, unless
356
your history is very long.
358
231
prefix = 'revno:'
359
wants_revision_history = False
361
233
def _match_on(self, branch, revs):
362
234
"""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):
367
235
loc = self.spec.find(':')
369
237
revno_spec = self.spec
382
250
revno = int(revno_spec)
385
# dotted decimal. This arguably should not be here
386
# but the from_string method is a little primitive
387
# right now - RBC 20060928
389
match_revno = tuple((int(number) for number in revno_spec.split('.')))
390
except ValueError, e:
391
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
251
except ValueError, e:
252
raise errors.InvalidRevisionSpec(self.user_spec,
396
# the user has override the branch to look in.
397
# we need to refresh the revision_history map and
399
256
from bzrlib.branch import Branch
400
257
branch = Branch.open(branch_spec)
258
# Need to use a new revision history
259
# because we are using a specific branch
260
revs = branch.revision_history()
405
revision_id = branch.dotted_revno_to_revision_id(match_revno,
407
except errors.NoSuchRevision:
408
raise errors.InvalidRevisionSpec(self.user_spec, branch)
263
if (-revno) >= len(revs):
410
# there is no traditional 'revno' for dotted-decimal revnos.
411
# so for API compatability we return None.
412
return branch, None, revision_id
414
last_revno, last_revision_id = branch.last_revision_info()
416
# if get_rev_id supported negative revnos, there would not be a
417
# need for this special case.
418
if (-revno) >= last_revno:
421
revno = last_revno + revno + 1
423
revision_id = branch.get_rev_id(revno, revs_or_none)
424
except errors.NoSuchRevision:
425
raise errors.InvalidRevisionSpec(self.user_spec, branch)
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)
266
revno = len(revs) + revno + 1
268
revision_id = branch.get_rev_id(revno, revs)
269
except errors.NoSuchRevision:
270
raise errors.InvalidRevisionSpec(self.user_spec, branch)
271
return RevisionInfo(branch, revno, revision_id)
433
273
def needs_branch(self):
434
274
return self.spec.find(':') == -1
436
def get_branch(self):
437
if self.spec.find(':') == -1:
440
return self.spec[self.spec.find(':')+1:]
443
277
RevisionSpec_int = RevisionSpec_revno
279
SPEC_TYPES.append(RevisionSpec_revno)
447
282
class RevisionSpec_revid(RevisionSpec):
448
"""Selects a revision using the revision id."""
450
help_txt = """Selects a revision using the revision id.
452
Supply a specific revision id, that can be used to specify any
453
revision id in the ancestry of the branch.
454
Including merges, and pending merges.
457
revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
460
283
prefix = 'revid:'
462
285
def _match_on(self, branch, revs):
463
# self.spec comes straight from parsing the command line arguments,
464
# so we expect it to be a Unicode string. Switch it to the internal
466
revision_id = osutils.safe_revision_id(self.spec, warn=False)
467
return RevisionInfo.from_revision_id(branch, revision_id, revs)
469
def _as_revision_id(self, context_branch):
470
return osutils.safe_revision_id(self.spec, warn=False)
287
revno = revs.index(self.spec) + 1
290
return RevisionInfo(branch, revno, self.spec)
292
SPEC_TYPES.append(RevisionSpec_revid)
474
295
class RevisionSpec_last(RevisionSpec):
475
"""Selects the nth revision from the end."""
477
help_txt = """Selects the nth revision from the end.
479
Supply a positive number to get the nth revision from the end.
480
This is the same as supplying negative numbers to the 'revno:' spec.
483
last:1 -> return the last revision
484
last:3 -> return the revision 2 before the end.
489
299
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()
496
300
if self.spec == '':
498
raise errors.NoCommits(context_branch)
499
return last_revno, last_revision_id
302
raise errors.NoCommits(branch)
303
return RevisionInfo(branch, len(revs), revs[-1])
502
306
offset = int(self.spec)
503
307
except ValueError, e:
504
raise errors.InvalidRevisionSpec(self.user_spec, context_branch, e)
308
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
507
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
311
raise errors.InvalidRevisionSpec(self.user_spec, branch,
508
312
'you must supply a positive value')
510
revno = last_revno - offset + 1
313
revno = len(revs) - offset + 1
512
revision_id = context_branch.get_rev_id(revno, revs_or_none)
315
revision_id = branch.get_rev_id(revno, revs)
513
316
except errors.NoSuchRevision:
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)
317
raise errors.InvalidRevisionSpec(self.user_spec, branch)
318
return RevisionInfo(branch, revno, revision_id)
320
SPEC_TYPES.append(RevisionSpec_last)
525
323
class RevisionSpec_before(RevisionSpec):
526
"""Selects the parent of the revision specified."""
528
help_txt = """Selects the parent of the revision specified.
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
534
It is an error to request the parent of the null revision (before:0).
538
before:1913 -> Return the parent of revno 1913 (revno 1912)
539
before:revid:aaaa@bbbb-1234567890 -> return the parent of revision
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
547
325
prefix = 'before:'
549
327
def _match_on(self, branch, revs):
550
328
r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
573
351
return RevisionInfo(branch, revno, revision_id)
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.')
353
SPEC_TYPES.append(RevisionSpec_before)
599
356
class RevisionSpec_tag(RevisionSpec):
600
"""Select a revision identified by tag name"""
602
help_txt = """Selects a revision identified by a tag name.
604
Tags are stored in the branch and created by the 'tag' command.
608
dwim_catchable_exceptions = (errors.NoSuchTag, errors.TagsNotSupported)
610
359
def _match_on(self, branch, revs):
611
# Can raise tags not supported, NoSuchTag, etc
612
return RevisionInfo.from_revision_id(branch,
613
branch.tags.lookup_tag(self.spec),
616
def _as_revision_id(self, context_branch):
617
return context_branch.tags.lookup_tag(self.spec)
360
raise errors.InvalidRevisionSpec(self.user_spec, branch,
361
'tag: namespace registered,'
362
' but not implemented')
364
SPEC_TYPES.append(RevisionSpec_tag)
621
367
class _RevListToTimestamps(object):
720
448
if rev == len(revs):
721
raise errors.InvalidRevisionSpec(self.user_spec, branch)
449
return RevisionInfo(branch, None)
723
451
return RevisionInfo(branch, rev + 1)
453
SPEC_TYPES.append(RevisionSpec_date)
727
456
class RevisionSpec_ancestor(RevisionSpec):
728
"""Selects a common ancestor with a second branch."""
730
help_txt = """Selects a common ancestor with a second branch.
732
Supply the path to a branch to select the common ancestor.
734
The common ancestor is the last revision that existed in both
735
branches. Usually this is the branch point, but it could also be
736
a revision that was merged.
738
This is frequently used with 'diff' to return all of the changes
739
that your branch introduces, while excluding the changes that you
740
have not merged from the remote branch.
744
ancestor:/path/to/branch
745
$ bzr diff -r ancestor:../../mainline/branch
747
457
prefix = 'ancestor:'
749
459
def _match_on(self, branch, revs):
460
from bzrlib.branch import Branch
750
462
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
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)
757
def _find_revision_info(branch, other_location):
758
revision_id = RevisionSpec_ancestor._find_revision_id(branch,
463
other_branch = Branch.open(self.spec)
464
revision_a = branch.last_revision()
465
revision_b = other_branch.last_revision()
466
for r, b in ((revision_a, branch), (revision_b, other_branch)):
467
if r in (None, revision.NULL_REVISION):
468
raise errors.NoCommits(b)
469
revision_source = revision.MultipleRevisionSources(
470
branch.repository, other_branch.repository)
471
rev_id = revision.common_ancestor(revision_a, revision_b,
761
revno = branch.revision_id_to_revno(revision_id)
474
revno = branch.revision_id_to_revno(rev_id)
762
475
except errors.NoSuchRevision:
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)
477
return RevisionInfo(branch, revno, rev_id)
479
SPEC_TYPES.append(RevisionSpec_ancestor)
796
482
class RevisionSpec_branch(RevisionSpec):
797
"""Selects the last revision of a specified branch."""
799
help_txt = """Selects the last revision of a specified branch.
801
Supply the path to a branch to select its last revision.
805
branch:/path/to/branch
483
"""A branch: revision specifier.
485
This takes the path to a branch and returns its tip revision id.
807
487
prefix = 'branch:'
808
dwim_catchable_exceptions = (errors.NotBranchError,)
810
489
def _match_on(self, branch, revs):
811
490
from bzrlib.branch import Branch
813
492
revision_b = other_branch.last_revision()
814
493
if revision_b in (None, revision.NULL_REVISION):
815
494
raise errors.NoCommits(other_branch)
817
branch = other_branch
820
# pull in the remote revisions so we can diff
821
branch.fetch(other_branch, revision_b)
822
except errors.ReadOnlyError:
823
branch = other_branch
495
# pull in the remote revisions so we can diff
496
branch.fetch(other_branch, revision_b)
825
498
revno = branch.revision_id_to_revno(revision_b)
826
499
except errors.NoSuchRevision:
828
501
return RevisionInfo(branch, revno, revision_b)
830
def _as_revision_id(self, context_branch):
831
from bzrlib.branch import Branch
832
other_branch = Branch.open(self.spec)
833
last_revision = other_branch.last_revision()
834
last_revision = revision.ensure_null(last_revision)
835
context_branch.fetch(other_branch, last_revision)
836
if last_revision == revision.NULL_REVISION:
837
raise errors.NoCommits(other_branch)
840
def _as_tree(self, context_branch):
841
from bzrlib.branch import Branch
842
other_branch = Branch.open(self.spec)
843
last_revision = other_branch.last_revision()
844
last_revision = revision.ensure_null(last_revision)
845
if last_revision == revision.NULL_REVISION:
846
raise errors.NoCommits(other_branch)
847
return other_branch.repository.revision_tree(last_revision)
849
def needs_branch(self):
852
def get_branch(self):
857
class RevisionSpec_submit(RevisionSpec_ancestor):
858
"""Selects a common ancestor with a submit branch."""
860
help_txt = """Selects a common ancestor with the submit branch.
862
Diffing against this shows all the changes that were made in this branch,
863
and is a good predictor of what merge will do. The submit branch is
864
used by the bundle and merge directive commands. If no submit branch
865
is specified, the parent branch is used instead.
867
The common ancestor is the last revision that existed in both
868
branches. Usually this is the branch point, but it could also be
869
a revision that was merged.
873
$ bzr diff -r submit:
878
def _get_submit_location(self, branch):
879
submit_location = branch.get_submit_branch()
880
location_type = 'submit branch'
881
if submit_location is None:
882
submit_location = branch.get_parent()
883
location_type = 'parent branch'
884
if submit_location is None:
885
raise errors.NoSubmitBranch(branch)
886
trace.note('Using %s %s', location_type, submit_location)
887
return submit_location
889
def _match_on(self, branch, revs):
890
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
891
return self._find_revision_info(branch,
892
self._get_submit_location(branch))
894
def _as_revision_id(self, context_branch):
895
return self._find_revision_id(context_branch,
896
self._get_submit_location(context_branch))
899
# The order in which we want to DWIM a revision spec without any prefix.
900
# revno is always tried first and isn't listed here, this is used by
901
# RevisionSpec_dwim._match_on
903
RevisionSpec_tag, # Let's try for a tag
904
RevisionSpec_revid, # Maybe it's a revid?
905
RevisionSpec_date, # Perhaps a date?
906
RevisionSpec_branch, # OK, last try, maybe it's a branch
910
revspec_registry = registry.Registry()
911
def _register_revspec(revspec):
912
revspec_registry.register(revspec.prefix, revspec)
914
_register_revspec(RevisionSpec_revno)
915
_register_revspec(RevisionSpec_revid)
916
_register_revspec(RevisionSpec_last)
917
_register_revspec(RevisionSpec_before)
918
_register_revspec(RevisionSpec_tag)
919
_register_revspec(RevisionSpec_date)
920
_register_revspec(RevisionSpec_ancestor)
921
_register_revspec(RevisionSpec_branch)
922
_register_revspec(RevisionSpec_submit)
924
# classes in this list should have a "prefix" attribute, against which
925
# string specs are matched
926
SPEC_TYPES = symbol_versioning.deprecated_list(
927
symbol_versioning.deprecated_in((1, 12, 0)), "SPEC_TYPES", [])
503
SPEC_TYPES.append(RevisionSpec_branch)
added
removed
bzrlib/revisionspec.py
