204
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
205
_get_mainline_revs(branch, start_revision, end_revision)
206
if not mainline_revs:
209
if direction == 'reverse':
210
start_rev_id, end_rev_id = end_rev_id, start_rev_id
212
legacy_lf = getattr(lf, 'log_revision', None) is None
214
# pre-0.17 formatters use show for mainline revisions.
215
# how should we show merged revisions ?
216
# pre-0.11 api: show_merge
217
# 0.11-0.16 api: show_merge_revno
218
show_merge_revno = getattr(lf, 'show_merge_revno', None)
219
show_merge = getattr(lf, 'show_merge', None)
220
if show_merge is None and show_merge_revno is None:
221
# no merged-revno support
222
generate_merge_revisions = False
224
generate_merge_revisions = True
225
# tell developers to update their code
226
symbol_versioning.warn('LogFormatters should provide log_revision '
227
'instead of show and show_merge_revno since bzr 0.17.',
228
DeprecationWarning, stacklevel=3)
230
generate_merge_revisions = getattr(lf, 'supports_merge_revisions',
232
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
233
direction, include_merges=generate_merge_revisions)
234
view_revisions = _filter_revision_range(list(view_revs_iter),
238
view_revisions = _filter_revisions_touching_file_id(branch,
243
# rebase merge_depth - unless there are no revisions or
244
# either the first or last revision have merge_depth = 0.
245
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
246
min_depth = min([d for r,n,d in view_revisions])
248
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
251
generate_tags = getattr(lf, 'supports_tags', False)
253
if branch.supports_tags():
254
rev_tag_dict = branch.tags.get_reverse_tag_dict()
256
generate_delta = verbose and getattr(lf, 'supports_delta', False)
258
def iter_revisions():
259
# r = revision, n = revno, d = merge depth
260
revision_ids = [r for r, n, d in view_revisions]
262
repository = branch.repository
265
revisions = repository.get_revisions(revision_ids[:num])
267
deltas = repository.get_deltas_for_revisions(revisions)
268
cur_deltas = dict(izip((r.revision_id for r in revisions),
270
for revision in revisions:
271
yield revision, cur_deltas.get(revision.revision_id)
272
revision_ids = revision_ids[num:]
273
num = min(int(num * 1.5), 200)
275
# now we just print all the revisions
277
for ((rev_id, revno, merge_depth), (rev, delta)) in \
278
izip(view_revisions, iter_revisions()):
281
if not searchRE.search(rev.message):
285
lr = LogRevision(rev, revno, merge_depth, delta,
286
rev_tag_dict.get(rev_id))
289
# support for legacy (pre-0.17) LogFormatters
292
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
294
lf.show(revno, rev, delta)
296
if show_merge_revno is None:
297
lf.show_merge(rev, merge_depth)
300
lf.show_merge_revno(rev, merge_depth, revno,
301
rev_tag_dict.get(rev_id))
303
lf.show_merge_revno(rev, merge_depth, revno)
306
if log_count >= limit:
310
def _get_mainline_revs(branch, start_revision, end_revision):
311
"""Get the mainline revisions from the branch.
313
Generates the list of mainline revisions for the branch.
315
:param branch: The branch containing the revisions.
317
:param start_revision: The first revision to be logged.
318
For backwards compatibility this may be a mainline integer revno,
319
but for merge revision support a RevisionInfo is expected.
321
:param end_revision: The last revision to be logged.
322
For backwards compatibility this may be a mainline integer revno,
323
but for merge revision support a RevisionInfo is expected.
325
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
161
327
which_revs = _enumerate_history(branch)
329
return None, None, None, None
331
# For mainline generation, map start_revision and end_revision to
332
# mainline revnos. If the revision is not on the mainline choose the
333
# appropriate extreme of the mainline instead - the extra will be
335
# Also map the revisions to rev_ids, to be used in the later filtering
163
338
if start_revision is None:
165
elif start_revision < 1 or start_revision >= len(which_revs):
166
raise InvalidRevisionNumber(start_revision)
341
if isinstance(start_revision,RevisionInfo):
342
start_rev_id = start_revision.rev_id
343
start_revno = start_revision.revno or 1
345
branch.check_real_revno(start_revision)
346
start_revno = start_revision
168
349
if end_revision is None:
169
end_revision = len(which_revs)
170
elif end_revision < 1 or end_revision >= len(which_revs):
171
raise InvalidRevisionNumber(end_revision)
350
end_revno = len(which_revs)
352
if isinstance(end_revision,RevisionInfo):
353
end_rev_id = end_revision.rev_id
354
end_revno = end_revision.revno or len(which_revs)
356
branch.check_real_revno(end_revision)
357
end_revno = end_revision
359
if start_revno > end_revno:
360
from bzrlib.errors import BzrCommandError
361
raise BzrCommandError("Start revision must be older than "
173
364
# list indexes are 0-based; revisions are 1-based
174
cut_revs = which_revs[(start_revision-1):(end_revision)]
176
if direction == 'reverse':
178
elif direction == 'forward':
365
cut_revs = which_revs[(start_revno-1):(end_revno)]
367
return None, None, None, None
369
# convert the revision history to a dictionary:
370
rev_nos = dict((k, v) for v, k in cut_revs)
372
# override the mainline to look like the revision history.
373
mainline_revs = [revision_id for index, revision_id in cut_revs]
374
if cut_revs[0][0] == 1:
375
mainline_revs.insert(0, None)
377
mainline_revs.insert(0, which_revs[start_revno-2][1])
378
return mainline_revs, rev_nos, start_rev_id, end_rev_id
381
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
382
"""Filter view_revisions based on revision ranges.
384
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
385
tuples to be filtered.
387
:param start_rev_id: If not NONE specifies the first revision to be logged.
388
If NONE then all revisions up to the end_rev_id are logged.
390
:param end_rev_id: If not NONE specifies the last revision to be logged.
391
If NONE then all revisions up to the end of the log are logged.
393
:return: The filtered view_revisions.
395
if start_rev_id or end_rev_id:
396
revision_ids = [r for r, n, d in view_revisions]
398
start_index = revision_ids.index(start_rev_id)
401
if start_rev_id == end_rev_id:
402
end_index = start_index
405
end_index = revision_ids.index(end_rev_id)
407
end_index = len(view_revisions) - 1
408
# To include the revisions merged into the last revision,
409
# extend end_rev_id down to, but not including, the next rev
410
# with the same or lesser merge_depth
411
end_merge_depth = view_revisions[end_index][2]
413
for index in xrange(end_index+1, len(view_revisions)+1):
414
if view_revisions[index][2] <= end_merge_depth:
415
end_index = index - 1
418
# if the search falls off the end then log to the end as well
419
end_index = len(view_revisions) - 1
420
view_revisions = view_revisions[start_index:end_index+1]
421
return view_revisions
424
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
426
"""Return the list of revision ids which touch a given file id.
428
The function filters view_revisions and returns a subset.
429
This includes the revisions which directly change the file id,
430
and the revisions which merge these changes. So if the
438
And 'C' changes a file, then both C and D will be returned.
440
This will also can be restricted based on a subset of the mainline.
442
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
444
# find all the revisions that change the specific file
445
file_weave = branch.repository.weave_store.get_weave(file_id,
446
branch.repository.get_transaction())
447
weave_modifed_revisions = set(file_weave.versions())
448
# build the ancestry of each revision in the graph
449
# - only listing the ancestors that change the specific file.
450
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
451
sorted_rev_list = topo_sort(rev_graph)
453
for rev in sorted_rev_list:
454
parents = rev_graph[rev]
455
if rev not in weave_modifed_revisions and len(parents) == 1:
456
# We will not be adding anything new, so just use a reference to
457
# the parent ancestry.
458
rev_ancestry = ancestry[parents[0]]
461
if rev in weave_modifed_revisions:
462
rev_ancestry.add(rev)
463
for parent in parents:
464
rev_ancestry = rev_ancestry.union(ancestry[parent])
465
ancestry[rev] = rev_ancestry
467
def is_merging_rev(r):
468
parents = rev_graph[r]
470
leftparent = parents[0]
471
for rightparent in parents[1:]:
472
if not ancestry[leftparent].issuperset(
473
ancestry[rightparent]):
477
# filter from the view the revisions that did not change or merge
479
return [(r, n, d) for r, n, d in view_revs_iter
480
if r in weave_modifed_revisions or is_merging_rev(r)]
483
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
484
include_merges=True):
485
"""Produce an iterator of revisions to show
486
:return: an iterator of (revision_id, revno, merge_depth)
487
(if there is no revno for a revision, None is supplied)
489
if include_merges is False:
490
revision_ids = mainline_revs[1:]
491
if direction == 'reverse':
492
revision_ids.reverse()
493
for revision_id in revision_ids:
494
yield revision_id, str(rev_nos[revision_id]), 0
496
merge_sorted_revisions = merge_sort(
497
branch.repository.get_revision_graph(mainline_revs[-1]),
502
if direction == 'forward':
503
# forward means oldest first.
504
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
505
elif direction != 'reverse':
181
506
raise ValueError('invalid direction %r' % direction)
183
for revno, rev_id in cut_revs:
184
if verbose or specific_fileid:
185
delta = branch.get_revision_delta(revno)
188
if not delta.touches_file_id(specific_fileid):
192
# although we calculated it, throw it away without display
195
rev = branch.get_revision(rev_id)
198
if not searchRE.search(rev.message):
201
lf.show(revno, rev, delta)
205
def deltas_for_log_dummy(branch, which_revs):
206
"""Return all the revisions without intermediate deltas.
208
Useful for log commands that won't need the delta information.
211
for revno, revision_id in which_revs:
212
yield revno, branch.get_revision(revision_id), None
215
def deltas_for_log_reverse(branch, which_revs):
216
"""Compute deltas for display in latest-to-earliest order.
222
Sequence of (revno, revision_id) for the subset of history to examine
225
Sequence of (revno, rev, delta)
227
The delta is from the given revision to the next one in the
228
sequence, which makes sense if the log is being displayed from
231
last_revno = last_revision_id = last_tree = None
232
for revno, revision_id in which_revs:
233
this_tree = branch.revision_tree(revision_id)
234
this_revision = branch.get_revision(revision_id)
237
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
239
this_tree = EmptyTree(branch.get_root_id())
242
last_revision = this_revision
243
last_tree = this_tree
247
this_tree = EmptyTree(branch.get_root_id())
508
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
509
yield rev_id, '.'.join(map(str, revno)), merge_depth
512
def reverse_by_depth(merge_sorted_revisions, _depth=0):
513
"""Reverse revisions by depth.
515
Revisions with a different depth are sorted as a group with the previous
516
revision of that depth. There may be no topological justification for this,
517
but it looks much nicer.
520
for val in merge_sorted_revisions:
522
zd_revisions.append([val])
249
this_revno = last_revno - 1
250
this_revision_id = branch.revision_history()[this_revno]
251
this_tree = branch.revision_tree(this_revision_id)
252
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
255
def deltas_for_log_forward(branch, which_revs):
256
"""Compute deltas for display in forward log.
258
Given a sequence of (revno, revision_id) pairs, return
261
The delta is from the given revision to the next one in the
262
sequence, which makes sense if the log is being displayed from
524
assert val[2] > _depth
525
zd_revisions[-1].append(val)
526
for revisions in zd_revisions:
527
if len(revisions) > 1:
528
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
529
zd_revisions.reverse()
531
for chunk in zd_revisions:
536
class LogRevision(object):
537
"""A revision to be logged (by LogFormatter.log_revision).
539
A simple wrapper for the attributes of a revision to be logged.
540
The attributes may or may not be populated, as determined by the
541
logging options and the log formatter capabilities.
265
last_revno = last_revision_id = last_tree = None
266
prev_tree = EmptyTree(branch.get_root_id())
268
for revno, revision_id in which_revs:
269
this_tree = branch.revision_tree(revision_id)
270
this_revision = branch.get_revision(revision_id)
274
last_tree = EmptyTree(branch.get_root_id())
276
last_revno = revno - 1
277
last_revision_id = branch.revision_history()[last_revno]
278
last_tree = branch.revision_tree(last_revision_id)
280
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
283
last_revision = this_revision
284
last_tree = this_tree
544
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
548
self.merge_depth = merge_depth
287
553
class LogFormatter(object):
288
"""Abstract class to display log messages."""
554
"""Abstract class to display log messages.
556
At a minimum, a derived class must implement the log_revision method.
558
If the LogFormatter needs to be informed of the beginning or end of
559
a log it should implement the begin_log and/or end_log hook methods.
561
A LogFormatter should define the following supports_XXX flags
562
to indicate which LogRevision attributes it supports:
564
- supports_delta must be True if this log formatter supports delta.
565
Otherwise the delta attribute may not be populated.
566
- supports_merge_revisions must be True if this log formatter supports
567
merge revisions. If not, only mainline revisions (those
568
with merge_depth == 0) will be passed to the formatter.
569
- supports_tags must be True if this log formatter supports tags.
570
Otherwise the tags attribute may not be populated.
289
573
def __init__(self, to_file, show_ids=False, show_timezone='original'):
290
574
self.to_file = to_file
291
575
self.show_ids = show_ids
292
576
self.show_timezone = show_timezone
578
# TODO: uncomment this block after show() has been removed.
579
# Until then defining log_revision would prevent _show_log calling show()
580
# in legacy formatters.
581
# def log_revision(self, revision):
584
# :param revision: The LogRevision to be logged.
586
# raise NotImplementedError('not implemented in abstract base')
588
@deprecated_method(zero_seventeen)
295
589
def show(self, revno, rev, delta):
296
590
raise NotImplementedError('not implemented in abstract base')
592
def short_committer(self, rev):
593
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
303
596
class LongLogFormatter(LogFormatter):
304
def show(self, revno, rev, delta):
305
from osutils import format_date
598
supports_merge_revisions = True
599
supports_delta = True
602
@deprecated_method(zero_seventeen)
603
def show(self, revno, rev, delta, tags=None):
604
lr = LogRevision(rev, revno, 0, delta, tags)
605
return self.log_revision(lr)
607
@deprecated_method(zero_seventeen)
608
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
609
"""Show a merged revision rev, with merge_depth and a revno."""
610
lr = LogRevision(rev, revno, merge_depth, tags=tags)
611
return self.log_revision(lr)
613
def log_revision(self, revision):
614
"""Log a revision, either merged or not."""
615
from bzrlib.osutils import format_date
616
indent = ' ' * revision.merge_depth
307
617
to_file = self.to_file
309
print >>to_file, '-' * 60
310
print >>to_file, 'revno:', revno
618
print >>to_file, indent + '-' * 60
619
if revision.revno is not None:
620
print >>to_file, indent + 'revno:', revision.revno
622
print >>to_file, indent + 'tags: %s' % (', '.join(revision.tags))
311
623
if self.show_ids:
312
print >>to_file, 'revision-id:', rev.revision_id
313
print >>to_file, 'committer:', rev.committer
315
date_str = format_date(rev.timestamp,
624
print >>to_file, indent + 'revision-id:', revision.rev.revision_id
625
for parent_id in revision.rev.parent_ids:
626
print >>to_file, indent + 'parent:', parent_id
627
print >>to_file, indent + 'committer:', revision.rev.committer
629
author = revision.rev.properties.get('author', None)
630
if author is not None:
631
print >>to_file, indent + 'author:', author
633
branch_nick = revision.rev.properties.get('branch-nick', None)
634
if branch_nick is not None:
635
print >>to_file, indent + 'branch nick:', branch_nick
637
date_str = format_date(revision.rev.timestamp,
638
revision.rev.timezone or 0,
317
639
self.show_timezone)
318
print >>to_file, 'timestamp: %s' % date_str
640
print >>to_file, indent + 'timestamp: %s' % date_str
320
print >>to_file, 'message:'
322
print >>to_file, ' (no message)'
642
print >>to_file, indent + 'message:'
643
if not revision.rev.message:
644
print >>to_file, indent + ' (no message)'
324
for l in rev.message.split('\n'):
325
print >>to_file, ' ' + l
328
delta.show(to_file, self.show_ids)
646
message = revision.rev.message.rstrip('\r\n')
647
for l in message.split('\n'):
648
print >>to_file, indent + ' ' + l
649
if revision.delta is not None:
650
revision.delta.show(to_file, self.show_ids, indent=indent)
332
653
class ShortLogFormatter(LogFormatter):
655
supports_delta = True
657
@deprecated_method(zero_seventeen)
333
658
def show(self, revno, rev, delta):
659
lr = LogRevision(rev, revno, 0, delta)
660
return self.log_revision(lr)
662
def log_revision(self, revision):
334
663
from bzrlib.osutils import format_date
336
665
to_file = self.to_file
338
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
339
format_date(rev.timestamp, rev.timezone or 0,
666
date_str = format_date(revision.rev.timestamp,
667
revision.rev.timezone or 0,
670
if len(revision.rev.parent_ids) > 1:
671
is_merge = ' [merge]'
672
print >>to_file, "%5s %s\t%s%s" % (revision.revno,
673
self.short_committer(revision.rev),
674
format_date(revision.rev.timestamp,
675
revision.rev.timezone or 0,
676
self.show_timezone, date_fmt="%Y-%m-%d",
341
679
if self.show_ids:
342
print >>to_file, ' revision-id:', rev.revision_id
680
print >>to_file, ' revision-id:', revision.rev.revision_id
681
if not revision.rev.message:
344
682
print >>to_file, ' (no message)'
346
for l in rev.message.split('\n'):
684
message = revision.rev.message.rstrip('\r\n')
685
for l in message.split('\n'):
347
686
print >>to_file, ' ' + l
349
688
# TODO: Why not show the modified files in a shorter form as
350
689
# well? rewrap them single lines of appropriate length
352
delta.show(to_file, self.show_ids)
357
FORMATTERS = {'long': LongLogFormatter,
358
'short': ShortLogFormatter,
690
if revision.delta is not None:
691
revision.delta.show(to_file, self.show_ids)
695
class LineLogFormatter(LogFormatter):
697
def __init__(self, *args, **kwargs):
698
from bzrlib.osutils import terminal_width
699
super(LineLogFormatter, self).__init__(*args, **kwargs)
700
self._max_chars = terminal_width() - 1
702
def truncate(self, str, max_len):
703
if len(str) <= max_len:
705
return str[:max_len-3]+'...'
707
def date_string(self, rev):
708
from bzrlib.osutils import format_date
709
return format_date(rev.timestamp, rev.timezone or 0,
710
self.show_timezone, date_fmt="%Y-%m-%d",
713
def message(self, rev):
715
return '(no message)'
719
@deprecated_method(zero_seventeen)
720
def show(self, revno, rev, delta):
721
from bzrlib.osutils import terminal_width
722
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
724
def log_revision(self, revision):
725
print >>self.to_file, self.log_string(revision.revno, revision.rev,
728
def log_string(self, revno, rev, max_chars):
729
"""Format log info into one string. Truncate tail of string
730
:param revno: revision number (int) or None.
731
Revision numbers counts from 1.
732
:param rev: revision info object
733
:param max_chars: maximum length of resulting string
734
:return: formatted truncated string
738
# show revno only when is not None
739
out.append("%s:" % revno)
740
out.append(self.truncate(self.short_committer(rev), 20))
741
out.append(self.date_string(rev))
742
out.append(rev.get_summary())
743
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
746
def line_log(rev, max_chars):
747
lf = LineLogFormatter(None)
748
return lf.log_string(None, rev, max_chars)
751
class LogFormatterRegistry(registry.Registry):
752
"""Registry for log formatters"""
754
def make_formatter(self, name, *args, **kwargs):
755
"""Construct a formatter from arguments.
757
:param name: Name of the formatter to construct. 'short', 'long' and
760
return self.get(name)(*args, **kwargs)
762
def get_default(self, branch):
763
return self.get(branch.get_config().log_format())
766
log_formatter_registry = LogFormatterRegistry()
769
log_formatter_registry.register('short', ShortLogFormatter,
770
'Moderately short log format')
771
log_formatter_registry.register('long', LongLogFormatter,
772
'Detailed log format')
773
log_formatter_registry.register('line', LineLogFormatter,
774
'Log format with one line per revision')
777
def register_formatter(name, formatter):
778
log_formatter_registry.register(name, formatter)
362
781
def log_formatter(name, *args, **kwargs):
782
"""Construct a formatter from arguments.
784
name -- Name of the formatter to construct; currently 'long', 'short' and
785
'line' are supported.
363
787
from bzrlib.errors import BzrCommandError
366
return FORMATTERS[name](*args, **kwargs)
789
return log_formatter_registry.make_formatter(name, *args, **kwargs)
368
791
raise BzrCommandError("unknown log formatter: %r" % name)
370
794
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
371
# deprecated; for compatability
795
# deprecated; for compatibility
372
796
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
373
797
lf.show(revno, rev, delta)
800
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
802
"""Show the change in revision history comparing the old revision history to the new one.
804
:param branch: The branch where the revisions exist
805
:param old_rh: The old revision history
806
:param new_rh: The new revision history
807
:param to_file: A file to write the results to. If None, stdout will be used
813
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout,
815
lf = log_formatter(log_format,
818
show_timezone='original')
820
# This is the first index which is different between
823
for i in xrange(max(len(new_rh),
827
or new_rh[i] != old_rh[i]):
832
to_file.write('Nothing seems to have changed\n')
834
## TODO: It might be nice to do something like show_log
835
## and show the merged entries. But since this is the
836
## removed revisions, it shouldn't be as important
837
if base_idx < len(old_rh):
838
to_file.write('*'*60)
839
to_file.write('\nRemoved Revisions:\n')
840
for i in range(base_idx, len(old_rh)):
841
rev = branch.repository.get_revision(old_rh[i])
842
lr = LogRevision(rev, i+1, 0, None)
844
to_file.write('*'*60)
845
to_file.write('\n\n')
846
if base_idx < len(new_rh):
847
to_file.write('Added Revisions:\n')
853
start_revision=base_idx+1,
854
end_revision=len(new_rh),
added
removed
bzrlib/log.py
