1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34
class RevisionInfo(object):
35
"""The results of applying a revision specification to a branch."""
37
help_txt = """The results of applying a revision specification to a branch.
39
An instance has two useful attributes: revno, and rev_id.
41
They can also be accessed as spec[0] and spec[1] respectively,
42
so that you can write code like:
43
revno, rev_id = RevisionSpec(branch, spec)
44
although this is probably going to be deprecated later.
46
This class exists mostly to be the return value of a RevisionSpec,
47
so that you can access the member you're interested in (number or id)
48
or treat the result as a tuple.
51
def __init__(self, branch, revno, rev_id=_marker):
55
# allow caller to be lazy
56
if self.revno is None:
59
self.rev_id = branch.get_rev_id(self.revno)
63
def __nonzero__(self):
64
# first the easy ones...
65
if self.rev_id is None:
67
if self.revno is not None:
69
# TODO: otherwise, it should depend on how I was built -
70
# if it's in_history(branch), then check revision_history(),
71
# if it's in_store(branch), do the check below
72
return self.branch.repository.has_revision(self.rev_id)
77
def __getitem__(self, index):
78
if index == 0: return self.revno
79
if index == 1: return self.rev_id
80
raise IndexError(index)
83
return self.branch.repository.get_revision(self.rev_id)
85
def __eq__(self, other):
86
if type(other) not in (tuple, list, type(self)):
88
if type(other) is type(self) and self.branch is not other.branch:
90
return tuple(self) == tuple(other)
93
return '<bzrlib.revisionspec.RevisionInfo object %s, %s for %r>' % (
94
self.revno, self.rev_id, self.branch)
97
def from_revision_id(branch, revision_id, revs):
98
"""Construct a RevisionInfo given just the id.
100
Use this if you don't know or care what the revno is.
103
revno = revs.index(revision_id) + 1
106
return RevisionInfo(branch, revno, revision_id)
109
# classes in this list should have a "prefix" attribute, against which
110
# string specs are matched
115
class RevisionSpec(object):
116
"""A parsed revision specification."""
118
help_txt = """A parsed revision specification.
120
A revision specification can be an integer, in which case it is
121
assumed to be a revno (though this will translate negative values
122
into positive ones); or it can be a string, in which case it is
123
parsed for something like 'date:' or 'revid:' etc.
125
Revision specs are an UI element, and they have been moved out
126
of the branch class to leave "back-end" classes unaware of such
127
details. Code that gets a revno or rev_id from other code should
128
not be using revision specs - revnos and revision ids are the
129
accepted ways to refer to revisions internally.
131
(Equivalent to the old Branch method get_revision_info())
136
def __new__(cls, spec, _internal=False):
138
return object.__new__(cls, spec, _internal=_internal)
140
symbol_versioning.warn('Creating a RevisionSpec directly has'
141
' been deprecated in version 0.11. Use'
142
' RevisionSpec.from_string()'
144
DeprecationWarning, stacklevel=2)
145
return RevisionSpec.from_string(spec)
148
def from_string(spec):
149
"""Parse a revision spec string into a RevisionSpec object.
151
:param spec: A string specified by the user
152
:return: A RevisionSpec object that understands how to parse the
155
if not isinstance(spec, (type(None), basestring)):
156
raise TypeError('error')
159
return RevisionSpec(None, _internal=True)
161
assert isinstance(spec, basestring), \
162
"You should only supply strings not %s" % (type(spec),)
164
for spectype in SPEC_TYPES:
165
if spec.startswith(spectype.prefix):
166
trace.mutter('Returning RevisionSpec %s for %s',
167
spectype.__name__, spec)
168
return spectype(spec, _internal=True)
170
# RevisionSpec_revno is special cased, because it is the only
171
# one that directly handles plain integers
172
# TODO: This should not be special cased rather it should be
173
# a method invocation on spectype.canparse()
175
if _revno_regex is None:
176
_revno_regex = re.compile(r'^(?:(\d+(\.\d+)*)|-\d+)(:.*)?$')
177
if _revno_regex.match(spec) is not None:
178
return RevisionSpec_revno(spec, _internal=True)
180
raise errors.NoSuchRevisionSpec(spec)
182
def __init__(self, spec, _internal=False):
183
"""Create a RevisionSpec referring to the Null revision.
185
:param spec: The original spec supplied by the user
186
:param _internal: Used to ensure that RevisionSpec is not being
187
called directly. Only from RevisionSpec.from_string()
190
# XXX: Update this after 0.10 is released
191
symbol_versioning.warn('Creating a RevisionSpec directly has'
192
' been deprecated in version 0.11. Use'
193
' RevisionSpec.from_string()'
195
DeprecationWarning, stacklevel=2)
196
self.user_spec = spec
197
if self.prefix and spec.startswith(self.prefix):
198
spec = spec[len(self.prefix):]
201
def _match_on(self, branch, revs):
202
trace.mutter('Returning RevisionSpec._match_on: None')
203
return RevisionInfo(branch, 0, None)
205
def _match_on_and_check(self, branch, revs):
206
info = self._match_on(branch, revs)
209
elif info == (0, None):
210
# special case - the empty tree
213
raise errors.InvalidRevisionSpec(self.user_spec, branch)
215
raise errors.InvalidRevisionSpec(self.spec, branch)
217
def in_history(self, branch):
219
revs = branch.revision_history()
221
# this should never trigger.
222
# TODO: make it a deprecated code path. RBC 20060928
224
return self._match_on_and_check(branch, revs)
226
# FIXME: in_history is somewhat broken,
227
# it will return non-history revisions in many
228
# circumstances. The expected facility is that
229
# in_history only returns revision-history revs,
230
# in_store returns any rev. RBC 20051010
231
# aliases for now, when we fix the core logic, then they
232
# will do what you expect.
233
in_store = in_history
237
# this is mostly for helping with testing
238
return '<%s %s>' % (self.__class__.__name__,
241
def needs_branch(self):
242
"""Whether this revision spec needs a branch.
244
Set this to False the branch argument of _match_on is not used.
248
def get_branch(self):
249
"""When the revision specifier contains a branch location, return it.
251
Otherwise, return None.
258
class RevisionSpec_revno(RevisionSpec):
259
"""Selects a revision using a number."""
261
help_txt = """Selects a revision using a number.
263
Use an integer to specify a revision in the history of the branch.
264
Optionally a branch can be specified. The 'revno:' prefix is optional.
265
A negative number will count from the end of the branch (-1 is the
266
last revision, -2 the previous one). If the negative number is larger
267
than the branch's history, the first revision is returned.
269
revno:1 -> return the first revision
270
revno:3:/path/to/branch -> return the 3rd revision of
271
the branch '/path/to/branch'
272
revno:-1 -> The last revision in a branch.
273
-2:http://other/branch -> The second to last revision in the
275
-1000000 -> Most likely the first revision, unless
276
your history is very long.
280
def _match_on(self, branch, revs):
281
"""Lookup a revision by revision number"""
282
loc = self.spec.find(':')
284
revno_spec = self.spec
287
revno_spec = self.spec[:loc]
288
branch_spec = self.spec[loc+1:]
292
raise errors.InvalidRevisionSpec(self.user_spec,
293
branch, 'cannot have an empty revno and no branch')
297
revno = int(revno_spec)
300
# dotted decimal. This arguably should not be here
301
# but the from_string method is a little primitive
302
# right now - RBC 20060928
304
match_revno = tuple((int(number) for number in revno_spec.split('.')))
305
except ValueError, e:
306
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
311
# the user has override the branch to look in.
312
# we need to refresh the revision_history map and
314
from bzrlib.branch import Branch
315
branch = Branch.open(branch_spec)
316
# Need to use a new revision history
317
# because we are using a specific branch
318
revs = branch.revision_history()
323
last_rev = branch.last_revision()
324
merge_sorted_revisions = tsort.merge_sort(
325
branch.repository.get_revision_graph(last_rev),
329
return item[3] == match_revno
330
revisions = filter(match, merge_sorted_revisions)
333
if len(revisions) != 1:
334
return RevisionInfo(branch, None, None)
336
# there is no traditional 'revno' for dotted-decimal revnos.
337
# so for API compatability we return None.
338
return RevisionInfo(branch, None, revisions[0][1])
341
if (-revno) >= len(revs):
344
revno = len(revs) + revno + 1
346
revision_id = branch.get_rev_id(revno, revs)
347
except errors.NoSuchRevision:
348
raise errors.InvalidRevisionSpec(self.user_spec, branch)
349
return RevisionInfo(branch, revno, revision_id)
351
def needs_branch(self):
352
return self.spec.find(':') == -1
354
def get_branch(self):
355
if self.spec.find(':') == -1:
358
return self.spec[self.spec.find(':')+1:]
361
RevisionSpec_int = RevisionSpec_revno
363
SPEC_TYPES.append(RevisionSpec_revno)
366
class RevisionSpec_revid(RevisionSpec):
367
"""Selects a revision using the revision id."""
369
help_txt = """Selects a revision using the revision id.
371
Supply a specific revision id, that can be used to specify any
372
revision id in the ancestry of the branch.
373
Including merges, and pending merges.
375
revid:aaaa@bbbb-123456789 -> Select revision 'aaaa@bbbb-123456789'
379
def _match_on(self, branch, revs):
380
return RevisionInfo.from_revision_id(branch, self.spec, revs)
382
SPEC_TYPES.append(RevisionSpec_revid)
385
class RevisionSpec_last(RevisionSpec):
386
"""Selects the nth revision from the end."""
388
help_txt = """Selects the nth revision from the end.
390
Supply a positive number to get the nth revision from the end.
391
This is the same as supplying negative numbers to the 'revno:' spec.
393
last:1 -> return the last revision
394
last:3 -> return the revision 2 before the end.
399
def _match_on(self, branch, revs):
402
raise errors.NoCommits(branch)
403
return RevisionInfo(branch, len(revs), revs[-1])
406
offset = int(self.spec)
407
except ValueError, e:
408
raise errors.InvalidRevisionSpec(self.user_spec, branch, e)
411
raise errors.InvalidRevisionSpec(self.user_spec, branch,
412
'you must supply a positive value')
413
revno = len(revs) - offset + 1
415
revision_id = branch.get_rev_id(revno, revs)
416
except errors.NoSuchRevision:
417
raise errors.InvalidRevisionSpec(self.user_spec, branch)
418
return RevisionInfo(branch, revno, revision_id)
420
SPEC_TYPES.append(RevisionSpec_last)
423
class RevisionSpec_before(RevisionSpec):
424
"""Selects the parent of the revision specified."""
426
help_txt = """Selects the parent of the revision specified.
428
Supply any revision spec to return the parent of that revision.
429
It is an error to request the parent of the null revision (before:0).
430
This is mostly useful when inspecting revisions that are not in the
431
revision history of a branch.
434
before:1913 -> Return the parent of revno 1913 (revno 1912)
435
before:revid:aaaa@bbbb-1234567890 -> return the parent of revision
437
bzr diff -r before:revid:aaaa..revid:aaaa
438
-> Find the changes between revision 'aaaa' and its parent.
439
(what changes did 'aaaa' introduce)
444
def _match_on(self, branch, revs):
445
r = RevisionSpec.from_string(self.spec)._match_on(branch, revs)
447
raise errors.InvalidRevisionSpec(self.user_spec, branch,
448
'cannot go before the null: revision')
450
# We need to use the repository history here
451
rev = branch.repository.get_revision(r.rev_id)
452
if not rev.parent_ids:
456
revision_id = rev.parent_ids[0]
458
revno = revs.index(revision_id) + 1
464
revision_id = branch.get_rev_id(revno, revs)
465
except errors.NoSuchRevision:
466
raise errors.InvalidRevisionSpec(self.user_spec,
468
return RevisionInfo(branch, revno, revision_id)
470
SPEC_TYPES.append(RevisionSpec_before)
473
class RevisionSpec_tag(RevisionSpec):
474
"""Select a revision identified by tag name"""
476
help_txt = """Selects a revision identified by a tag name.
478
Tags are stored in the repository and created by the 'tag'
484
def _match_on(self, branch, revs):
485
# Can raise tags not supported, NoSuchTag, etc
486
return RevisionInfo.from_revision_id(branch,
487
branch.repository.lookup_tag(self.spec),
490
SPEC_TYPES.append(RevisionSpec_tag)
493
class _RevListToTimestamps(object):
494
"""This takes a list of revisions, and allows you to bisect by date"""
496
__slots__ = ['revs', 'branch']
498
def __init__(self, revs, branch):
502
def __getitem__(self, index):
503
"""Get the date of the index'd item"""
504
r = self.branch.repository.get_revision(self.revs[index])
505
# TODO: Handle timezone.
506
return datetime.datetime.fromtimestamp(r.timestamp)
509
return len(self.revs)
512
class RevisionSpec_date(RevisionSpec):
513
"""Selects a revision on the basis of a datestamp."""
515
help_txt = """Selects a revision on the basis of a datestamp.
517
Supply a datestamp to select the first revision that matches the date.
518
Date can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
519
Matches the first entry after a given date (either at midnight or
520
at a specified time).
522
One way to display all the changes since yesterday would be:
523
bzr log -r date:yesterday..-1
526
date:yesterday -> select the first revision since yesterday
527
date:2006-08-14,17:10:14 -> select the first revision after
528
August 14th, 2006 at 5:10pm.
531
_date_re = re.compile(
532
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
534
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
537
def _match_on(self, branch, revs):
538
"""Spec for date revisions:
540
value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
541
matches the first entry after a given date (either at midnight or
542
at a specified time).
544
# XXX: This doesn't actually work
545
# So the proper way of saying 'give me all entries for today' is:
546
# -r date:yesterday..date:today
547
today = datetime.datetime.fromordinal(datetime.date.today().toordinal())
548
if self.spec.lower() == 'yesterday':
549
dt = today - datetime.timedelta(days=1)
550
elif self.spec.lower() == 'today':
552
elif self.spec.lower() == 'tomorrow':
553
dt = today + datetime.timedelta(days=1)
555
m = self._date_re.match(self.spec)
556
if not m or (not m.group('date') and not m.group('time')):
557
raise errors.InvalidRevisionSpec(self.user_spec,
558
branch, 'invalid date')
562
year = int(m.group('year'))
563
month = int(m.group('month'))
564
day = int(m.group('day'))
571
hour = int(m.group('hour'))
572
minute = int(m.group('minute'))
573
if m.group('second'):
574
second = int(m.group('second'))
578
hour, minute, second = 0,0,0
580
raise errors.InvalidRevisionSpec(self.user_spec,
581
branch, 'invalid date')
583
dt = datetime.datetime(year=year, month=month, day=day,
584
hour=hour, minute=minute, second=second)
587
rev = bisect.bisect(_RevListToTimestamps(revs, branch), dt)
591
return RevisionInfo(branch, None)
593
return RevisionInfo(branch, rev + 1)
595
SPEC_TYPES.append(RevisionSpec_date)
598
class RevisionSpec_ancestor(RevisionSpec):
599
"""Selects a common ancestor with a second branch."""
601
help_txt = """Selects a common ancestor with a second branch.
603
Supply the path to a branch to select the common ancestor.
605
The common ancestor is the last revision that existed in both
606
branches. Usually this is the branch point, but it could also be
607
a revision that was merged.
609
This is frequently used with 'diff' to return all of the changes
610
that your branch introduces, while excluding the changes that you
611
have not merged from the remote branch.
614
ancestor:/path/to/branch
615
$ bzr diff -r ancestor:../../mainline/branch
619
def _match_on(self, branch, revs):
620
from bzrlib.branch import Branch
622
trace.mutter('matching ancestor: on: %s, %s', self.spec, branch)
623
other_branch = Branch.open(self.spec)
624
revision_a = branch.last_revision()
625
revision_b = other_branch.last_revision()
626
for r, b in ((revision_a, branch), (revision_b, other_branch)):
627
if r in (None, revision.NULL_REVISION):
628
raise errors.NoCommits(b)
629
revision_source = revision.MultipleRevisionSources(
630
branch.repository, other_branch.repository)
631
rev_id = revision.common_ancestor(revision_a, revision_b,
634
revno = branch.revision_id_to_revno(rev_id)
635
except errors.NoSuchRevision:
637
return RevisionInfo(branch, revno, rev_id)
639
SPEC_TYPES.append(RevisionSpec_ancestor)
642
class RevisionSpec_branch(RevisionSpec):
643
"""Selects the last revision of a specified branch."""
645
help_txt = """Selects the last revision of a specified branch.
647
Supply the path to a branch to select its last revision.
650
branch:/path/to/branch
654
def _match_on(self, branch, revs):
655
from bzrlib.branch import Branch
656
other_branch = Branch.open(self.spec)
657
revision_b = other_branch.last_revision()
658
if revision_b in (None, revision.NULL_REVISION):
659
raise errors.NoCommits(other_branch)
660
# pull in the remote revisions so we can diff
661
branch.fetch(other_branch, revision_b)
663
revno = branch.revision_id_to_revno(revision_b)
664
except errors.NoSuchRevision:
666
return RevisionInfo(branch, revno, revision_b)
668
SPEC_TYPES.append(RevisionSpec_branch)
added
removed
bzrlib/revisionspec.py
