207
mainline_revs, rev_nos, start_rev_id, end_rev_id = \
208
_get_mainline_revs(branch, start_revision, end_revision)
209
if not mainline_revs:
212
if direction == 'reverse':
213
start_rev_id, end_rev_id = end_rev_id, start_rev_id
215
legacy_lf = getattr(lf, 'log_revision', None) is None
217
# pre-0.17 formatters use show for mainline revisions.
218
# how should we show merged revisions ?
219
# pre-0.11 api: show_merge
220
# 0.11-0.16 api: show_merge_revno
221
show_merge_revno = getattr(lf, 'show_merge_revno', None)
222
show_merge = getattr(lf, 'show_merge', None)
223
if show_merge is None and show_merge_revno is None:
224
# no merged-revno support
225
generate_merge_revisions = False
227
generate_merge_revisions = True
228
# tell developers to update their code
229
symbol_versioning.warn('LogFormatters should provide log_revision '
230
'instead of show and show_merge_revno since bzr 0.17.',
231
DeprecationWarning, stacklevel=3)
233
generate_merge_revisions = getattr(lf, 'supports_merge_revisions',
235
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
236
direction, include_merges=generate_merge_revisions)
237
view_revisions = _filter_revision_range(list(view_revs_iter),
241
view_revisions = _filter_revisions_touching_file_id(branch,
247
generate_tags = getattr(lf, 'supports_tags', False)
249
if branch.supports_tags():
250
rev_tag_dict = branch.tags.get_reverse_tag_dict()
252
generate_delta = verbose and getattr(lf, 'supports_delta', False)
254
def iter_revisions():
255
# r = revision, n = revno, d = merge depth
256
revision_ids = [r for r, n, d in view_revisions]
258
repository = branch.repository
261
revisions = repository.get_revisions(revision_ids[:num])
263
deltas = repository.get_deltas_for_revisions(revisions)
264
cur_deltas = dict(izip((r.revision_id for r in revisions),
266
for revision in revisions:
267
yield revision, cur_deltas.get(revision.revision_id)
268
revision_ids = revision_ids[num:]
269
num = min(int(num * 1.5), 200)
271
# now we just print all the revisions
273
for ((rev_id, revno, merge_depth), (rev, delta)) in \
274
izip(view_revisions, iter_revisions()):
277
if not searchRE.search(rev.message):
281
lr = LogRevision(rev, revno, merge_depth, delta,
282
rev_tag_dict.get(rev_id))
285
# support for legacy (pre-0.17) LogFormatters
288
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
290
lf.show(revno, rev, delta)
292
if show_merge_revno is None:
293
lf.show_merge(rev, merge_depth)
296
lf.show_merge_revno(rev, merge_depth, revno,
297
rev_tag_dict.get(rev_id))
299
lf.show_merge_revno(rev, merge_depth, revno)
302
if log_count >= limit:
306
def _get_mainline_revs(branch, start_revision, end_revision):
307
"""Get the mainline revisions from the branch.
309
Generates the list of mainline revisions for the branch.
311
:param branch: The branch containing the revisions.
313
:param start_revision: The first revision to be logged.
314
For backwards compatibility this may be a mainline integer revno,
315
but for merge revision support a RevisionInfo is expected.
317
:param end_revision: The last 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
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
323
161
which_revs = _enumerate_history(branch)
325
return None, None, None, None
327
# For mainline generation, map start_revision and end_revision to
328
# mainline revnos. If the revision is not on the mainline choose the
329
# appropriate extreme of the mainline instead - the extra will be
331
# Also map the revisions to rev_ids, to be used in the later filtering
334
163
if start_revision is None:
337
if isinstance(start_revision,RevisionInfo):
338
start_rev_id = start_revision.rev_id
339
start_revno = start_revision.revno or 1
341
branch.check_real_revno(start_revision)
342
start_revno = start_revision
165
elif start_revision < 1 or start_revision >= len(which_revs):
166
raise InvalidRevisionNumber(start_revision)
345
168
if end_revision is None:
346
end_revno = len(which_revs)
348
if isinstance(end_revision,RevisionInfo):
349
end_rev_id = end_revision.rev_id
350
end_revno = end_revision.revno or len(which_revs)
352
branch.check_real_revno(end_revision)
353
end_revno = end_revision
355
if start_revno > end_revno:
356
from bzrlib.errors import BzrCommandError
357
raise BzrCommandError("Start revision must be older than "
169
end_revision = len(which_revs)
170
elif end_revision < 1 or end_revision >= len(which_revs):
171
raise InvalidRevisionNumber(end_revision)
360
173
# list indexes are 0-based; revisions are 1-based
361
cut_revs = which_revs[(start_revno-1):(end_revno)]
363
return None, None, None, None
365
# convert the revision history to a dictionary:
366
rev_nos = dict((k, v) for v, k in cut_revs)
368
# override the mainline to look like the revision history.
369
mainline_revs = [revision_id for index, revision_id in cut_revs]
370
if cut_revs[0][0] == 1:
371
mainline_revs.insert(0, None)
174
cut_revs = which_revs[(start_revision-1):(end_revision)]
176
if direction == 'reverse':
178
elif direction == 'forward':
373
mainline_revs.insert(0, which_revs[start_revno-2][1])
374
return mainline_revs, rev_nos, start_rev_id, end_rev_id
377
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
378
"""Filter view_revisions based on revision ranges.
380
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
381
tuples to be filtered.
383
:param start_rev_id: If not NONE specifies the first revision to be logged.
384
If NONE then all revisions up to the end_rev_id are logged.
386
:param end_rev_id: If not NONE specifies the last revision to be logged.
387
If NONE then all revisions up to the end of the log are logged.
389
:return: The filtered view_revisions.
391
if start_rev_id or end_rev_id:
392
revision_ids = [r for r, n, d in view_revisions]
394
start_index = revision_ids.index(start_rev_id)
397
if start_rev_id == end_rev_id:
398
end_index = start_index
401
end_index = revision_ids.index(end_rev_id)
403
end_index = len(view_revisions) - 1
404
# To include the revisions merged into the last revision,
405
# extend end_rev_id down to, but not including, the next rev
406
# with the same or lesser merge_depth
407
end_merge_depth = view_revisions[end_index][2]
409
for index in xrange(end_index+1, len(view_revisions)+1):
410
if view_revisions[index][2] <= end_merge_depth:
411
end_index = index - 1
414
# if the search falls off the end then log to the end as well
415
end_index = len(view_revisions) - 1
416
view_revisions = view_revisions[start_index:end_index+1]
417
return view_revisions
420
def _filter_revisions_touching_file_id(branch, file_id, mainline_revisions,
422
"""Return the list of revision ids which touch a given file id.
424
The function filters view_revisions and returns a subset.
425
This includes the revisions which directly change the file id,
426
and the revisions which merge these changes. So if the
434
And 'C' changes a file, then both C and D will be returned.
436
This will also can be restricted based on a subset of the mainline.
438
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
440
# find all the revisions that change the specific file
441
file_weave = branch.repository.weave_store.get_weave(file_id,
442
branch.repository.get_transaction())
443
weave_modifed_revisions = set(file_weave.versions())
444
# build the ancestry of each revision in the graph
445
# - only listing the ancestors that change the specific file.
446
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
447
sorted_rev_list = topo_sort(rev_graph)
449
for rev in sorted_rev_list:
450
parents = rev_graph[rev]
451
if rev not in weave_modifed_revisions and len(parents) == 1:
452
# We will not be adding anything new, so just use a reference to
453
# the parent ancestry.
454
rev_ancestry = ancestry[parents[0]]
457
if rev in weave_modifed_revisions:
458
rev_ancestry.add(rev)
459
for parent in parents:
460
rev_ancestry = rev_ancestry.union(ancestry[parent])
461
ancestry[rev] = rev_ancestry
463
def is_merging_rev(r):
464
parents = rev_graph[r]
466
leftparent = parents[0]
467
for rightparent in parents[1:]:
468
if not ancestry[leftparent].issuperset(
469
ancestry[rightparent]):
473
# filter from the view the revisions that did not change or merge
475
return [(r, n, d) for r, n, d in view_revs_iter
476
if r in weave_modifed_revisions or is_merging_rev(r)]
479
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
480
include_merges=True):
481
"""Produce an iterator of revisions to show
482
:return: an iterator of (revision_id, revno, merge_depth)
483
(if there is no revno for a revision, None is supplied)
485
if include_merges is False:
486
revision_ids = mainline_revs[1:]
487
if direction == 'reverse':
488
revision_ids.reverse()
489
for revision_id in revision_ids:
490
yield revision_id, str(rev_nos[revision_id]), 0
492
merge_sorted_revisions = merge_sort(
493
branch.repository.get_revision_graph(mainline_revs[-1]),
498
if direction == 'forward':
499
# forward means oldest first.
500
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
501
elif direction != 'reverse':
502
181
raise ValueError('invalid direction %r' % direction)
504
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
505
yield rev_id, '.'.join(map(str, revno)), merge_depth
508
def reverse_by_depth(merge_sorted_revisions, _depth=0):
509
"""Reverse revisions by depth.
511
Revisions with a different depth are sorted as a group with the previous
512
revision of that depth. There may be no topological justification for this,
513
but it looks much nicer.
516
for val in merge_sorted_revisions:
518
zd_revisions.append([val])
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())
520
assert val[2] > _depth
521
zd_revisions[-1].append(val)
522
for revisions in zd_revisions:
523
if len(revisions) > 1:
524
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
525
zd_revisions.reverse()
527
for chunk in zd_revisions:
532
class LogRevision(object):
533
"""A revision to be logged (by LogFormatter.log_revision).
535
A simple wrapper for the attributes of a revision to be logged.
536
The attributes may or may not be populated, as determined by the
537
logging options and the log formatter capabilities.
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
540
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
544
self.merge_depth = merge_depth
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
549
287
class LogFormatter(object):
550
"""Abstract class to display log messages.
552
At a minimum, a derived class must implement the log_revision method.
554
If the LogFormatter needs to be informed of the beginning or end of
555
a log it should implement the begin_log and/or end_log hook methods.
557
A LogFormatter should define the following supports_XXX flags
558
to indicate which LogRevision attributes it supports:
560
- supports_delta must be True if this log formatter supports delta.
561
Otherwise the delta attribute may not be populated.
562
- supports_merge_revisions must be True if this log formatter supports
563
merge revisions. If not, only revisions mainline revisions (those
564
with merge_depth == 0) will be passed to the formatter.
565
- supports_tags must be True if this log formatter supports tags.
566
Otherwise the tags attribute may not be populated.
288
"""Abstract class to display log messages."""
569
289
def __init__(self, to_file, show_ids=False, show_timezone='original'):
570
290
self.to_file = to_file
571
291
self.show_ids = show_ids
572
292
self.show_timezone = show_timezone
574
# TODO: uncomment this block after show() has been removed.
575
# Until then defining log_revision would prevent _show_log calling show()
576
# in legacy formatters.
577
# def log_revision(self, revision):
580
# :param revision: The LogRevision to be logged.
582
# raise NotImplementedError('not implemented in abstract base')
584
@deprecated_method(zero_seventeen)
585
295
def show(self, revno, rev, delta):
586
296
raise NotImplementedError('not implemented in abstract base')
588
def short_committer(self, rev):
589
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
592
303
class LongLogFormatter(LogFormatter):
594
supports_merge_revisions = True
595
supports_delta = True
598
@deprecated_method(zero_seventeen)
599
def show(self, revno, rev, delta, tags=None):
600
lr = LogRevision(rev, revno, 0, delta, tags)
601
return self.log_revision(lr)
603
@deprecated_method(zero_eleven)
604
def show_merge(self, rev, merge_depth):
605
lr = LogRevision(rev, merge_depth=merge_depth)
606
return self.log_revision(lr)
608
@deprecated_method(zero_seventeen)
609
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
610
"""Show a merged revision rev, with merge_depth and a revno."""
611
lr = LogRevision(rev, revno, merge_depth, tags=tags)
612
return self.log_revision(lr)
614
def log_revision(self, revision):
615
"""Log a revision, either merged or not."""
616
from bzrlib.osutils import format_date
617
indent = ' '*revision.merge_depth
304
def show(self, revno, rev, delta):
305
from osutils import format_date
618
307
to_file = self.to_file
619
print >>to_file, indent+'-' * 60
620
if revision.revno is not None:
621
print >>to_file, indent+'revno:', revision.revno
623
print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
309
print >>to_file, '-' * 60
310
print >>to_file, 'revno:', revno
624
311
if self.show_ids:
625
print >>to_file, indent+'revision-id:', revision.rev.revision_id
626
for parent_id in revision.rev.parent_ids:
627
print >>to_file, indent+'parent:', parent_id
628
print >>to_file, indent+'committer:', revision.rev.committer
312
print >>to_file, 'revision-id:', rev.revision_id
313
print >>to_file, 'committer:', rev.committer
631
print >>to_file, indent+'branch nick: %s' % \
632
revision.rev.properties['branch-nick']
635
date_str = format_date(revision.rev.timestamp,
636
revision.rev.timezone or 0,
315
date_str = format_date(rev.timestamp,
637
317
self.show_timezone)
638
print >>to_file, indent+'timestamp: %s' % date_str
318
print >>to_file, 'timestamp: %s' % date_str
640
print >>to_file, indent+'message:'
641
if not revision.rev.message:
642
print >>to_file, indent+' (no message)'
320
print >>to_file, 'message:'
322
print >>to_file, ' (no message)'
644
message = revision.rev.message.rstrip('\r\n')
645
for l in message.split('\n'):
646
print >>to_file, indent+' ' + l
647
if revision.delta is not None:
648
revision.delta.show(to_file, self.show_ids, indent=indent)
324
for l in rev.message.split('\n'):
325
print >>to_file, ' ' + l
328
delta.show(to_file, self.show_ids)
651
332
class ShortLogFormatter(LogFormatter):
653
supports_delta = True
655
@deprecated_method(zero_seventeen)
656
333
def show(self, revno, rev, delta):
657
lr = LogRevision(rev, revno, 0, delta)
658
return self.log_revision(lr)
660
def log_revision(self, revision):
661
334
from bzrlib.osutils import format_date
663
336
to_file = self.to_file
664
date_str = format_date(revision.rev.timestamp,
665
revision.rev.timezone or 0,
668
if len(revision.rev.parent_ids) > 1:
669
is_merge = ' [merge]'
670
print >>to_file, "%5s %s\t%s%s" % (revision.revno,
671
self.short_committer(revision.rev),
672
format_date(revision.rev.timestamp,
673
revision.rev.timezone or 0,
674
self.show_timezone, date_fmt="%Y-%m-%d",
338
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
339
format_date(rev.timestamp, rev.timezone or 0,
677
341
if self.show_ids:
678
print >>to_file, ' revision-id:', revision.rev.revision_id
679
if not revision.rev.message:
342
print >>to_file, ' revision-id:', rev.revision_id
680
344
print >>to_file, ' (no message)'
682
message = revision.rev.message.rstrip('\r\n')
683
for l in message.split('\n'):
346
for l in rev.message.split('\n'):
684
347
print >>to_file, ' ' + l
686
349
# TODO: Why not show the modified files in a shorter form as
687
350
# well? rewrap them single lines of appropriate length
688
if revision.delta is not None:
689
revision.delta.show(to_file, self.show_ids)
693
class LineLogFormatter(LogFormatter):
695
def __init__(self, *args, **kwargs):
696
from bzrlib.osutils import terminal_width
697
super(LineLogFormatter, self).__init__(*args, **kwargs)
698
self._max_chars = terminal_width() - 1
700
def truncate(self, str, max_len):
701
if len(str) <= max_len:
703
return str[:max_len-3]+'...'
705
def date_string(self, rev):
706
from bzrlib.osutils import format_date
707
return format_date(rev.timestamp, rev.timezone or 0,
708
self.show_timezone, date_fmt="%Y-%m-%d",
711
def message(self, rev):
713
return '(no message)'
717
@deprecated_method(zero_seventeen)
718
def show(self, revno, rev, delta):
719
from bzrlib.osutils import terminal_width
720
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
722
def log_revision(self, revision):
723
print >>self.to_file, self.log_string(revision.revno, revision.rev,
726
def log_string(self, revno, rev, max_chars):
727
"""Format log info into one string. Truncate tail of string
728
:param revno: revision number (int) or None.
729
Revision numbers counts from 1.
730
:param rev: revision info object
731
:param max_chars: maximum length of resulting string
732
:return: formatted truncated string
736
# show revno only when is not None
737
out.append("%s:" % revno)
738
out.append(self.truncate(self.short_committer(rev), 20))
739
out.append(self.date_string(rev))
740
out.append(rev.get_summary())
741
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
744
def line_log(rev, max_chars):
745
lf = LineLogFormatter(None)
746
return lf.log_string(None, rev, max_chars)
749
class LogFormatterRegistry(registry.Registry):
750
"""Registry for log formatters"""
752
def make_formatter(self, name, *args, **kwargs):
753
"""Construct a formatter from arguments.
755
:param name: Name of the formatter to construct. 'short', 'long' and
758
return self.get(name)(*args, **kwargs)
760
def get_default(self, branch):
761
return self.get(branch.get_config().log_format())
764
log_formatter_registry = LogFormatterRegistry()
767
log_formatter_registry.register('short', ShortLogFormatter,
768
'Moderately short log format')
769
log_formatter_registry.register('long', LongLogFormatter,
770
'Detailed log format')
771
log_formatter_registry.register('line', LineLogFormatter,
772
'Log format with one line per revision')
775
def register_formatter(name, formatter):
776
log_formatter_registry.register(name, formatter)
352
delta.show(to_file, self.show_ids)
357
FORMATTERS = {'long': LongLogFormatter,
358
'short': ShortLogFormatter,
779
362
def log_formatter(name, *args, **kwargs):
780
"""Construct a formatter from arguments.
782
name -- Name of the formatter to construct; currently 'long', 'short' and
783
'line' are supported.
785
363
from bzrlib.errors import BzrCommandError
787
return log_formatter_registry.make_formatter(name, *args, **kwargs)
366
return FORMATTERS[name](*args, **kwargs)
789
368
raise BzrCommandError("unknown log formatter: %r" % name)
792
370
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
793
# deprecated; for compatibility
371
# deprecated; for compatability
794
372
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
795
373
lf.show(revno, rev, delta)
798
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
799
"""Show the change in revision history comparing the old revision history to the new one.
801
:param branch: The branch where the revisions exist
802
:param old_rh: The old revision history
803
:param new_rh: The new revision history
804
:param to_file: A file to write the results to. If None, stdout will be used
810
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
811
lf = log_formatter(log_format,
814
show_timezone='original')
816
# This is the first index which is different between
819
for i in xrange(max(len(new_rh),
823
or new_rh[i] != old_rh[i]):
828
to_file.write('Nothing seems to have changed\n')
830
## TODO: It might be nice to do something like show_log
831
## and show the merged entries. But since this is the
832
## removed revisions, it shouldn't be as important
833
if base_idx < len(old_rh):
834
to_file.write('*'*60)
835
to_file.write('\nRemoved Revisions:\n')
836
for i in range(base_idx, len(old_rh)):
837
rev = branch.repository.get_revision(old_rh[i])
838
lr = LogRevision(rev, i+1, 0, None)
840
to_file.write('*'*60)
841
to_file.write('\n\n')
842
if base_idx < len(new_rh):
843
to_file.write('Added Revisions:\n')
849
start_revision=base_idx+1,
850
end_revision=len(new_rh),
added
removed
bzrlib/log.py
