90
98
return '<bzrlib.revisionspec.RevisionInfo object %s, %s for %r>' % (
91
99
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
116
# classes in this list should have a "prefix" attribute, against which
95
117
# string specs are matched
97
118
_revno_regex = None
100
121
class RevisionSpec(object):
101
"""A parsed revision specification.
122
"""A parsed revision specification."""
124
help_txt = """A parsed revision specification.
103
126
A revision specification can be an integer, in which case it is
104
127
assumed to be a revno (though this will translate negative values
142
155
return RevisionSpec(None, _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)
156
match = revspec_registry.get_prefix(spec)
157
if match is not None:
158
spectype, specsuffix = match
159
trace.mutter('Returning RevisionSpec %s for %s',
160
spectype.__name__, spec)
161
return spectype(spec, _internal=True)
163
for spectype in SPEC_TYPES:
164
if spec.startswith(spectype.prefix):
165
trace.mutter('Returning RevisionSpec %s for %s',
166
spectype.__name__, spec)
167
return spectype(spec, _internal=True)
153
168
# RevisionSpec_revno is special cased, because it is the only
154
169
# one that directly handles plain integers
170
# TODO: This should not be special cased rather it should be
171
# a method invocation on spectype.canparse()
155
172
global _revno_regex
156
173
if _revno_regex is None:
157
_revno_regex = re.compile(r'-?\d+(:.*)?$')
174
_revno_regex = re.compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
158
175
if _revno_regex.match(spec) is not None:
159
176
return RevisionSpec_revno(spec, _internal=True)
211
232
# will do what you expect.
212
233
in_store = in_history
213
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)
215
271
def __repr__(self):
216
272
# this is mostly for helping with testing
217
273
return '<%s %s>' % (self.__class__.__name__,
220
276
def needs_branch(self):
221
277
"""Whether this revision spec needs a branch.
237
293
class RevisionSpec_revno(RevisionSpec):
294
"""Selects a revision using a number."""
296
help_txt = """Selects a revision using a number.
298
Use an integer to specify a revision in the history of the branch.
299
Optionally a branch can be specified. The 'revno:' prefix is optional.
300
A negative number will count from the end of the branch (-1 is the
301
last revision, -2 the previous one). If the negative number is larger
302
than the branch's history, the first revision is returned.
305
revno:1 -> return the first revision of this branch
306
revno:3:/path/to/branch -> return the 3rd revision of
307
the branch '/path/to/branch'
308
revno:-1 -> The last revision in a branch.
309
-2:http://other/branch -> The second to last revision in the
311
-1000000 -> Most likely the first revision, unless
312
your history is very long.
238
314
prefix = 'revno:'
315
wants_revision_history = False
240
317
def _match_on(self, branch, revs):
241
318
"""Lookup a revision by revision number"""
319
branch, revno, revision_id = self._lookup(branch, revs)
320
return RevisionInfo(branch, revno, revision_id)
322
def _lookup(self, branch, revs_or_none):
242
323
loc = self.spec.find(':')
244
325
revno_spec = self.spec
257
338
revno = int(revno_spec)
258
except ValueError, e:
259
raise errors.InvalidRevisionSpec(self.user_spec,
341
# dotted decimal. This arguably should not be here
342
# but the from_string method is a little primitive
343
# right now - RBC 20060928
345
match_revno = tuple((int(number) for number in revno_spec.split('.')))
346
except ValueError, e:
347
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
352
# the user has override the branch to look in.
353
# we need to refresh the revision_history map and
263
355
from bzrlib.branch import Branch
264
356
branch = Branch.open(branch_spec)
265
# Need to use a new revision history
266
# because we are using a specific branch
267
revs = branch.revision_history()
270
if (-revno) >= len(revs):
361
revision_id = branch.dotted_revno_to_revision_id(match_revno,
363
except errors.NoSuchRevision:
364
raise errors.InvalidRevisionSpec(self.user_spec, branch)
273
revno = len(revs) + revno + 1
275
revision_id = branch.get_rev_id(revno, revs)
276
except errors.NoSuchRevision:
277
raise errors.InvalidRevisionSpec(self.user_spec, branch)
278
return RevisionInfo(branch, revno, revision_id)
366
# there is no traditional 'revno' for dotted-decimal revnos.
367
# so for API compatability we return None.
368
return branch, None, revision_id
370
last_revno, last_revision_id = branch.last_revision_info()
372
# if get_rev_id supported negative revnos, there would not be a
373
# need for this special case.
374
if (-revno) >= last_revno:
377
revno = last_revno + revno + 1
379
revision_id = branch.get_rev_id(revno, revs_or_none)
380
except errors.NoSuchRevision:
381
raise errors.InvalidRevisionSpec(self.user_spec, branch)
382
return branch, revno, revision_id
384
def _as_revision_id(self, context_branch):
385
# We would have the revno here, but we don't really care
386
branch, revno, revision_id = self._lookup(context_branch, None)
280
389
def needs_branch(self):
281
390
return self.spec.find(':') == -1
287
396
return self.spec[self.spec.find(':')+1:]
290
399
RevisionSpec_int = RevisionSpec_revno
292
SPEC_TYPES.append(RevisionSpec_revno)
295
403
class RevisionSpec_revid(RevisionSpec):
404
"""Selects a revision using the revision id."""
406
help_txt = """Selects a revision using the revision id.
408
Supply a specific revision id, that can be used to specify any
409
revision id in the ancestry of the branch.
410
Including merges, and pending merges.
413
revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
296
416
prefix = 'revid:'
298
418
def _match_on(self, branch, revs):
300
revno = revs.index(self.spec) + 1
303
return RevisionInfo(branch, revno, self.spec)
305
SPEC_TYPES.append(RevisionSpec_revid)
419
# self.spec comes straight from parsing the command line arguments,
420
# so we expect it to be a Unicode string. Switch it to the internal
422
revision_id = osutils.safe_revision_id(self.spec, warn=False)
423
return RevisionInfo.from_revision_id(branch, revision_id, revs)
425
def _as_revision_id(self, context_branch):
426
return osutils.safe_revision_id(self.spec, warn=False)
308
430
class RevisionSpec_last(RevisionSpec):
431
"""Selects the nth revision from the end."""
433
help_txt = """Selects the nth revision from the end.
435
Supply a positive number to get the nth revision from the end.
436
This is the same as supplying negative numbers to the 'revno:' spec.
439
last:1 -> return the last revision
440
last:3 -> return the revision 2 before the end.
312
445
def _match_on(self, branch, revs):
446
revno, revision_id = self._revno_and_revision_id(branch, revs)
447
return RevisionInfo(branch, revno, revision_id)
449
def _revno_and_revision_id(self, context_branch, revs_or_none):
450
last_revno, last_revision_id = context_branch.last_revision_info()
313
452
if self.spec == '':
315
raise errors.NoCommits(branch)
316
return RevisionInfo(branch, len(revs), revs[-1])
454
raise errors.NoCommits(context_branch)
455
return last_revno, last_revision_id
319
458
offset = int(self.spec)
320
459
except ValueError, e:
321
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
460
raise errors.InvalidRevisionSpec(self.user_spec, context_branch, e)
324
raise errors.InvalidRevisionSpec(self.user_spec, branch,
463
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
325
464
'you must supply a positive value')
326
revno = len(revs) - offset + 1
466
revno = last_revno - offset + 1
328
revision_id = branch.get_rev_id(revno, revs)
468
revision_id = context_branch.get_rev_id(revno, revs_or_none)
329
469
except errors.NoSuchRevision:
330
raise errors.InvalidRevisionSpec(self.user_spec, branch)
331
return RevisionInfo(branch, revno, revision_id)
333
SPEC_TYPES.append(RevisionSpec_last)
470
raise errors.InvalidRevisionSpec(self.user_spec, context_branch)
471
return revno, revision_id
473
def _as_revision_id(self, context_branch):
474
# We compute the revno as part of the process, but we don't really care
476
revno, revision_id = self._revno_and_revision_id(context_branch, None)
336
481
class RevisionSpec_before(RevisionSpec):
482
"""Selects the parent of the revision specified."""
484
help_txt = """Selects the parent of the revision specified.
486
Supply any revision spec to return the parent of that revision. This is
487
mostly useful when inspecting revisions that are not in the revision history
490
It is an error to request the parent of the null revision (before:0).
494
before:1913 -> Return the parent of revno 1913 (revno 1912)
495
before:revid:aaaa@bbbb-1234567890 -> return the parent of revision
497
bzr diff -r before:1913..1913
498
-> Find the changes between revision 1913 and its parent (1912).
499
(What changes did revision 1913 introduce).
500
This is equivalent to: bzr diff -c 1913
338
503
prefix = 'before:'
340
505
def _match_on(self, branch, revs):
341
506
r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
364
529
return RevisionInfo(branch, revno, revision_id)
366
SPEC_TYPES.append(RevisionSpec_before)
531
def _as_revision_id(self, context_branch):
532
base_revspec = RevisionSpec.from_string(self.spec)
533
base_revision_id = base_revspec.as_revision_id(context_branch)
534
if base_revision_id == revision.NULL_REVISION:
535
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
536
'cannot go before the null: revision')
537
context_repo = context_branch.repository
538
context_repo.lock_read()
540
parent_map = context_repo.get_parent_map([base_revision_id])
542
context_repo.unlock()
543
if base_revision_id not in parent_map:
544
# Ghost, or unknown revision id
545
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
546
'cannot find the matching revision')
547
parents = parent_map[base_revision_id]
549
raise errors.InvalidRevisionSpec(self.user_spec, context_branch,
550
'No parents for revision.')
369
555
class RevisionSpec_tag(RevisionSpec):
556
"""Select a revision identified by tag name"""
558
help_txt = """Selects a revision identified by a tag name.
560
Tags are stored in the branch and created by the 'tag' command.
372
565
def _match_on(self, branch, revs):
373
raise errors.InvalidRevisionSpec(self.user_spec, branch,
374
'tag: namespace registered,'
375
' but not implemented')
377
SPEC_TYPES.append(RevisionSpec_tag)
566
# Can raise tags not supported, NoSuchTag, etc
567
return RevisionInfo.from_revision_id(branch,
568
branch.tags.lookup_tag(self.spec),
571
def _as_revision_id(self, context_branch):
572
return context_branch.tags.lookup_tag(self.spec)
380
576
class _RevListToTimestamps(object):
461
675
if rev == len(revs):
462
return RevisionInfo(branch, None)
676
raise errors.InvalidRevisionSpec(self.user_spec, branch)
464
678
return RevisionInfo(branch, rev + 1)
466
SPEC_TYPES.append(RevisionSpec_date)
469
682
class RevisionSpec_ancestor(RevisionSpec):
683
"""Selects a common ancestor with a second branch."""
685
help_txt = """Selects a common ancestor with a second branch.
687
Supply the path to a branch to select the common ancestor.
689
The common ancestor is the last revision that existed in both
690
branches. Usually this is the branch point, but it could also be
691
a revision that was merged.
693
This is frequently used with 'diff' to return all of the changes
694
that your branch introduces, while excluding the changes that you
695
have not merged from the remote branch.
699
ancestor:/path/to/branch
700
$ bzr diff -r ancestor:../../mainline/branch
470
702
prefix = 'ancestor:'
472
704
def _match_on(self, branch, revs):
473
from bzrlib.branch import Branch
475
705
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
476
other_branch = Branch.open(self.spec)
477
revision_a = branch.last_revision()
478
revision_b = other_branch.last_revision()
479
for r, b in ((revision_a, branch), (revision_b, other_branch)):
480
if r in (None, revision.NULL_REVISION):
481
raise errors.NoCommits(b)
482
revision_source = revision.MultipleRevisionSources(
483
branch.repository, other_branch.repository)
484
rev_id = revision.common_ancestor(revision_a, revision_b,
706
return self._find_revision_info(branch, self.spec)
708
def _as_revision_id(self, context_branch):
709
return self._find_revision_id(context_branch, self.spec)
712
def _find_revision_info(branch, other_location):
713
revision_id = RevisionSpec_ancestor._find_revision_id(branch,
487
revno = branch.revision_id_to_revno(rev_id)
716
revno = branch.revision_id_to_revno(revision_id)
488
717
except errors.NoSuchRevision:
490
return RevisionInfo(branch, revno, rev_id)
492
SPEC_TYPES.append(RevisionSpec_ancestor)
719
return RevisionInfo(branch, revno, revision_id)
722
def _find_revision_id(branch, other_location):
723
from bzrlib.branch import Branch
727
revision_a = revision.ensure_null(branch.last_revision())
728
if revision_a == revision.NULL_REVISION:
729
raise errors.NoCommits(branch)
730
if other_location == '':
731
other_location = branch.get_parent()
732
other_branch = Branch.open(other_location)
733
other_branch.lock_read()
735
revision_b = revision.ensure_null(other_branch.last_revision())
736
if revision_b == revision.NULL_REVISION:
737
raise errors.NoCommits(other_branch)
738
graph = branch.repository.get_graph(other_branch.repository)
739
rev_id = graph.find_unique_lca(revision_a, revision_b)
741
other_branch.unlock()
742
if rev_id == revision.NULL_REVISION:
743
raise errors.NoCommonAncestor(revision_a, revision_b)
495
751
class RevisionSpec_branch(RevisionSpec):
496
"""A branch: revision specifier.
498
This takes the path to a branch and returns its tip revision id.
752
"""Selects the last revision of a specified branch."""
754
help_txt = """Selects the last revision of a specified branch.
756
Supply the path to a branch to select its last revision.
760
branch:/path/to/branch
500
762
prefix = 'branch:'
512
774
except errors.NoSuchRevision:
514
776
return RevisionInfo(branch, revno, revision_b)
516
SPEC_TYPES.append(RevisionSpec_branch)
778
def _as_revision_id(self, context_branch):
779
from bzrlib.branch import Branch
780
other_branch = Branch.open(self.spec)
781
last_revision = other_branch.last_revision()
782
last_revision = revision.ensure_null(last_revision)
783
context_branch.fetch(other_branch, last_revision)
784
if last_revision == revision.NULL_REVISION:
785
raise errors.NoCommits(other_branch)
788
def _as_tree(self, context_branch):
789
from bzrlib.branch import Branch
790
other_branch = Branch.open(self.spec)
791
last_revision = other_branch.last_revision()
792
last_revision = revision.ensure_null(last_revision)
793
if last_revision == revision.NULL_REVISION:
794
raise errors.NoCommits(other_branch)
795
return other_branch.repository.revision_tree(last_revision)
799
class RevisionSpec_submit(RevisionSpec_ancestor):
800
"""Selects a common ancestor with a submit branch."""
802
help_txt = """Selects a common ancestor with the submit branch.
804
Diffing against this shows all the changes that were made in this branch,
805
and is a good predictor of what merge will do. The submit branch is
806
used by the bundle and merge directive commands. If no submit branch
807
is specified, the parent branch is used instead.
809
The common ancestor is the last revision that existed in both
810
branches. Usually this is the branch point, but it could also be
811
a revision that was merged.
815
$ bzr diff -r submit:
820
def _get_submit_location(self, branch):
821
submit_location = branch.get_submit_branch()
822
location_type = 'submit branch'
823
if submit_location is None:
824
submit_location = branch.get_parent()
825
location_type = 'parent branch'
826
if submit_location is None:
827
raise errors.NoSubmitBranch(branch)
828
trace.note('Using %s %s', location_type, submit_location)
829
return submit_location
831
def _match_on(self, branch, revs):
832
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
833
return self._find_revision_info(branch,
834
self._get_submit_location(branch))
836
def _as_revision_id(self, context_branch):
837
return self._find_revision_id(context_branch,
838
self._get_submit_location(context_branch))
841
revspec_registry = registry.Registry()
842
def _register_revspec(revspec):
843
revspec_registry.register(revspec.prefix, revspec)
845
_register_revspec(RevisionSpec_revno)
846
_register_revspec(RevisionSpec_revid)
847
_register_revspec(RevisionSpec_last)
848
_register_revspec(RevisionSpec_before)
849
_register_revspec(RevisionSpec_tag)
850
_register_revspec(RevisionSpec_date)
851
_register_revspec(RevisionSpec_ancestor)
852
_register_revspec(RevisionSpec_branch)
853
_register_revspec(RevisionSpec_submit)
855
SPEC_TYPES = symbol_versioning.deprecated_list(
856
symbol_versioning.deprecated_in((1, 12, 0)), "SPEC_TYPES", [])
added
removed
bzrlib/revisionspec.py
