163
207
if start_revision is None:
164
208
start_revision = 1
165
elif start_revision < 1 or start_revision >= len(which_revs):
166
raise InvalidRevisionNumber(start_revision)
210
branch.check_real_revno(start_revision)
168
212
if end_revision is None:
169
213
end_revision = len(which_revs)
170
elif end_revision < 1 or end_revision >= len(which_revs):
171
raise InvalidRevisionNumber(end_revision)
215
branch.check_real_revno(end_revision)
173
217
# list indexes are 0-based; revisions are 1-based
174
218
cut_revs = which_revs[(start_revision-1):(end_revision)]
176
if direction == 'reverse':
178
elif direction == 'forward':
181
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)
222
# convert the revision history to a dictionary:
223
rev_nos = dict((k, v) for v, k in cut_revs)
225
# override the mainline to look like the revision history.
226
mainline_revs = [revision_id for index, revision_id in cut_revs]
227
if cut_revs[0][0] == 1:
228
mainline_revs.insert(0, None)
230
mainline_revs.insert(0, which_revs[start_revision-2][1])
231
legacy_lf = getattr(lf, 'log_revision', None) is None
233
# pre-0.17 formatters use show for mainline revisions.
234
# how should we show merged revisions ?
235
# pre-0.11 api: show_merge
236
# 0.11-0.16 api: show_merge_revno
237
show_merge_revno = getattr(lf, 'show_merge_revno', None)
238
show_merge = getattr(lf, 'show_merge', None)
239
if show_merge is None and show_merge_revno is None:
240
# no merged-revno support
241
generate_merge_revisions = False
243
generate_merge_revisions = True
244
# tell developers to update their code
245
symbol_versioning.warn('LogFormatters should provide log_revision '
246
'instead of show and show_merge_revno since bzr 0.17.',
247
DeprecationWarning, stacklevel=3)
249
generate_merge_revisions = getattr(lf, 'supports_merge_revisions',
251
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
252
direction, include_merges=generate_merge_revisions)
254
view_revisions = _get_revisions_touching_file_id(branch,
259
view_revisions = list(view_revs_iter)
262
generate_tags = getattr(lf, 'supports_tags', False)
264
if branch.supports_tags():
265
rev_tag_dict = branch.tags.get_reverse_tag_dict()
267
generate_delta = verbose and getattr(lf, 'supports_delta', False)
269
def iter_revisions():
270
# r = revision, n = revno, d = merge depth
271
revision_ids = [r for r, n, d in view_revisions]
273
repository = branch.repository
276
revisions = repository.get_revisions(revision_ids[:num])
278
deltas = repository.get_deltas_for_revisions(revisions)
279
cur_deltas = dict(izip((r.revision_id for r in revisions),
281
for revision in revisions:
282
yield revision, cur_deltas.get(revision.revision_id)
283
revision_ids = revision_ids[num:]
284
num = min(int(num * 1.5), 200)
286
# now we just print all the revisions
288
for ((rev_id, revno, merge_depth), (rev, delta)) in \
289
izip(view_revisions, iter_revisions()):
198
292
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())
296
lr = LogRevision(rev, revno, merge_depth, delta,
297
rev_tag_dict.get(rev_id))
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
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())
300
# support for legacy (pre-0.17) LogFormatters
303
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
305
lf.show(revno, rev, delta)
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
307
if show_merge_revno is None:
308
lf.show_merge(rev, merge_depth)
311
lf.show_merge_revno(rev, merge_depth, revno,
312
rev_tag_dict.get(rev_id))
314
lf.show_merge_revno(rev, merge_depth, revno)
317
if log_count >= limit:
321
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
323
"""Return the list of revision ids which touch a given file id.
325
This includes the revisions which directly change the file id,
326
and the revisions which merge these changes. So if the
334
And 'C' changes a file, then both C and D will be returned.
336
This will also can be restricted based on a subset of the mainline.
338
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
340
# find all the revisions that change the specific file
341
file_weave = branch.repository.weave_store.get_weave(file_id,
342
branch.repository.get_transaction())
343
weave_modifed_revisions = set(file_weave.versions())
344
# build the ancestry of each revision in the graph
345
# - only listing the ancestors that change the specific file.
346
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
347
sorted_rev_list = topo_sort(rev_graph)
349
for rev in sorted_rev_list:
350
parents = rev_graph[rev]
351
if rev not in weave_modifed_revisions and len(parents) == 1:
352
# We will not be adding anything new, so just use a reference to
353
# the parent ancestry.
354
rev_ancestry = ancestry[parents[0]]
357
if rev in weave_modifed_revisions:
358
rev_ancestry.add(rev)
359
for parent in parents:
360
rev_ancestry = rev_ancestry.union(ancestry[parent])
361
ancestry[rev] = rev_ancestry
363
def is_merging_rev(r):
364
parents = rev_graph[r]
366
leftparent = parents[0]
367
for rightparent in parents[1:]:
368
if not ancestry[leftparent].issuperset(
369
ancestry[rightparent]):
373
# filter from the view the revisions that did not change or merge
375
return [(r, n, d) for r, n, d in view_revs_iter
376
if r in weave_modifed_revisions or is_merging_rev(r)]
379
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
380
include_merges=True):
381
"""Produce an iterator of revisions to show
382
:return: an iterator of (revision_id, revno, merge_depth)
383
(if there is no revno for a revision, None is supplied)
385
if include_merges is False:
386
revision_ids = mainline_revs[1:]
387
if direction == 'reverse':
388
revision_ids.reverse()
389
for revision_id in revision_ids:
390
yield revision_id, str(rev_nos[revision_id]), 0
392
merge_sorted_revisions = merge_sort(
393
branch.repository.get_revision_graph(mainline_revs[-1]),
398
if direction == 'forward':
399
# forward means oldest first.
400
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
401
elif direction != 'reverse':
402
raise ValueError('invalid direction %r' % direction)
404
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
405
yield rev_id, '.'.join(map(str, revno)), merge_depth
408
def reverse_by_depth(merge_sorted_revisions, _depth=0):
409
"""Reverse revisions by depth.
411
Revisions with a different depth are sorted as a group with the previous
412
revision of that depth. There may be no topological justification for this,
413
but it looks much nicer.
416
for val in merge_sorted_revisions:
418
zd_revisions.append([val])
420
assert val[2] > _depth
421
zd_revisions[-1].append(val)
422
for revisions in zd_revisions:
423
if len(revisions) > 1:
424
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
425
zd_revisions.reverse()
427
for chunk in zd_revisions:
432
class LogRevision(object):
433
"""A revision to be logged (by LogFormatter.log_revision).
435
A simple wrapper for the attributes of a revision to be logged.
436
The attributes may or may not be populated, as determined by the
437
logging options and the log formatter capabilities.
440
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
444
self.merge_depth = merge_depth
287
449
class LogFormatter(object):
288
"""Abstract class to display log messages."""
450
"""Abstract class to display log messages.
452
At a minimum, a derived class must implement the log_revision method.
454
If the LogFormatter needs to be informed of the beginning or end of
455
a log it should implement the begin_log and/or end_log hook methods.
457
A LogFormatter should define the following supports_XXX flags
458
to indicate which LogRevision attributes it supports:
460
- supports_delta must be True if this log formatter supports delta.
461
Otherwise the delta attribute may not be populated.
462
- supports_merge_revisions must be True if this log formatter supports
463
merge revisions. If not, only revisions mainline revisions (those
464
with merge_depth == 0) will be passed to the formatter.
465
- supports_tags must be True if this log formatter supports tags.
466
Otherwise the tags attribute may not be populated.
289
469
def __init__(self, to_file, show_ids=False, show_timezone='original'):
290
470
self.to_file = to_file
291
471
self.show_ids = show_ids
292
472
self.show_timezone = show_timezone
474
# TODO: uncomment this block after show() has been removed.
475
# Until then defining log_revision would prevent _show_log calling show()
476
# in legacy formatters.
477
# def log_revision(self, revision):
480
# :param revision: The LogRevision to be logged.
482
# raise NotImplementedError('not implemented in abstract base')
484
@deprecated_method(zero_seventeen)
295
485
def show(self, revno, rev, delta):
296
486
raise NotImplementedError('not implemented in abstract base')
488
def short_committer(self, rev):
489
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
303
492
class LongLogFormatter(LogFormatter):
304
def show(self, revno, rev, delta):
305
from osutils import format_date
494
supports_merge_revisions = True
495
supports_delta = True
498
@deprecated_method(zero_seventeen)
499
def show(self, revno, rev, delta, tags=None):
500
lr = LogRevision(rev, revno, 0, delta, tags)
501
return self.log_revision(lr)
503
@deprecated_method(zero_eleven)
504
def show_merge(self, rev, merge_depth):
505
lr = LogRevision(rev, merge_depth=merge_depth)
506
return self.log_revision(lr)
508
@deprecated_method(zero_seventeen)
509
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
510
"""Show a merged revision rev, with merge_depth and a revno."""
511
lr = LogRevision(rev, revno, merge_depth, tags=tags)
512
return self.log_revision(lr)
514
def log_revision(self, revision):
515
"""Log a revision, either merged or not."""
516
from bzrlib.osutils import format_date
517
indent = ' '*revision.merge_depth
307
518
to_file = self.to_file
309
print >>to_file, '-' * 60
310
print >>to_file, 'revno:', revno
519
print >>to_file, indent+'-' * 60
520
if revision.revno is not None:
521
print >>to_file, indent+'revno:', revision.revno
523
print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
311
524
if self.show_ids:
312
print >>to_file, 'revision-id:', rev.revision_id
313
print >>to_file, 'committer:', rev.committer
525
print >>to_file, indent+'revision-id:', revision.rev.revision_id
526
for parent_id in revision.rev.parent_ids:
527
print >>to_file, indent+'parent:', parent_id
528
print >>to_file, indent+'committer:', revision.rev.committer
315
date_str = format_date(rev.timestamp,
531
print >>to_file, indent+'branch nick: %s' % \
532
revision.rev.properties['branch-nick']
535
date_str = format_date(revision.rev.timestamp,
536
revision.rev.timezone or 0,
317
537
self.show_timezone)
318
print >>to_file, 'timestamp: %s' % date_str
538
print >>to_file, indent+'timestamp: %s' % date_str
320
print >>to_file, 'message:'
322
print >>to_file, ' (no message)'
540
print >>to_file, indent+'message:'
541
if not revision.rev.message:
542
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)
544
message = revision.rev.message.rstrip('\r\n')
545
for l in message.split('\n'):
546
print >>to_file, indent+' ' + l
547
if revision.delta is not None:
548
revision.delta.show(to_file, self.show_ids, indent=indent)
332
551
class ShortLogFormatter(LogFormatter):
553
supports_delta = True
555
@deprecated_method(zero_seventeen)
333
556
def show(self, revno, rev, delta):
557
lr = LogRevision(rev, revno, 0, delta)
558
return self.log_revision(lr)
560
def log_revision(self, revision):
334
561
from bzrlib.osutils import format_date
336
563
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,
564
date_str = format_date(revision.rev.timestamp,
565
revision.rev.timezone or 0,
568
if len(revision.rev.parent_ids) > 1:
569
is_merge = ' [merge]'
570
print >>to_file, "%5s %s\t%s%s" % (revision.revno,
571
self.short_committer(revision.rev),
572
format_date(revision.rev.timestamp,
573
revision.rev.timezone or 0,
574
self.show_timezone, date_fmt="%Y-%m-%d",
341
577
if self.show_ids:
342
print >>to_file, ' revision-id:', rev.revision_id
578
print >>to_file, ' revision-id:', revision.rev.revision_id
579
if not revision.rev.message:
344
580
print >>to_file, ' (no message)'
346
for l in rev.message.split('\n'):
582
message = revision.rev.message.rstrip('\r\n')
583
for l in message.split('\n'):
347
584
print >>to_file, ' ' + l
349
586
# TODO: Why not show the modified files in a shorter form as
350
587
# well? rewrap them single lines of appropriate length
352
delta.show(to_file, self.show_ids)
357
FORMATTERS = {'long': LongLogFormatter,
358
'short': ShortLogFormatter,
588
if revision.delta is not None:
589
revision.delta.show(to_file, self.show_ids)
593
class LineLogFormatter(LogFormatter):
595
def __init__(self, *args, **kwargs):
596
from bzrlib.osutils import terminal_width
597
super(LineLogFormatter, self).__init__(*args, **kwargs)
598
self._max_chars = terminal_width() - 1
600
def truncate(self, str, max_len):
601
if len(str) <= max_len:
603
return str[:max_len-3]+'...'
605
def date_string(self, rev):
606
from bzrlib.osutils import format_date
607
return format_date(rev.timestamp, rev.timezone or 0,
608
self.show_timezone, date_fmt="%Y-%m-%d",
611
def message(self, rev):
613
return '(no message)'
617
@deprecated_method(zero_seventeen)
618
def show(self, revno, rev, delta):
619
from bzrlib.osutils import terminal_width
620
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
622
def log_revision(self, revision):
623
print >>self.to_file, self.log_string(revision.revno, revision.rev,
626
def log_string(self, revno, rev, max_chars):
627
"""Format log info into one string. Truncate tail of string
628
:param revno: revision number (int) or None.
629
Revision numbers counts from 1.
630
:param rev: revision info object
631
:param max_chars: maximum length of resulting string
632
:return: formatted truncated string
636
# show revno only when is not None
637
out.append("%s:" % revno)
638
out.append(self.truncate(self.short_committer(rev), 20))
639
out.append(self.date_string(rev))
640
out.append(rev.get_summary())
641
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
644
def line_log(rev, max_chars):
645
lf = LineLogFormatter(None)
646
return lf.log_string(None, rev, max_chars)
649
class LogFormatterRegistry(registry.Registry):
650
"""Registry for log formatters"""
652
def make_formatter(self, name, *args, **kwargs):
653
"""Construct a formatter from arguments.
655
:param name: Name of the formatter to construct. 'short', 'long' and
658
return self.get(name)(*args, **kwargs)
660
def get_default(self, branch):
661
return self.get(branch.get_config().log_format())
664
log_formatter_registry = LogFormatterRegistry()
667
log_formatter_registry.register('short', ShortLogFormatter,
668
'Moderately short log format')
669
log_formatter_registry.register('long', LongLogFormatter,
670
'Detailed log format')
671
log_formatter_registry.register('line', LineLogFormatter,
672
'Log format with one line per revision')
675
def register_formatter(name, formatter):
676
log_formatter_registry.register(name, formatter)
362
679
def log_formatter(name, *args, **kwargs):
680
"""Construct a formatter from arguments.
682
name -- Name of the formatter to construct; currently 'long', 'short' and
683
'line' are supported.
363
685
from bzrlib.errors import BzrCommandError
366
return FORMATTERS[name](*args, **kwargs)
687
return log_formatter_registry.make_formatter(name, *args, **kwargs)
368
689
raise BzrCommandError("unknown log formatter: %r" % name)
370
692
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
371
# deprecated; for compatability
693
# deprecated; for compatibility
372
694
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
373
695
lf.show(revno, rev, delta)
698
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
699
"""Show the change in revision history comparing the old revision history to the new one.
701
:param branch: The branch where the revisions exist
702
:param old_rh: The old revision history
703
:param new_rh: The new revision history
704
:param to_file: A file to write the results to. If None, stdout will be used
710
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
711
lf = log_formatter(log_format,
714
show_timezone='original')
716
# This is the first index which is different between
719
for i in xrange(max(len(new_rh),
723
or new_rh[i] != old_rh[i]):
728
to_file.write('Nothing seems to have changed\n')
730
## TODO: It might be nice to do something like show_log
731
## and show the merged entries. But since this is the
732
## removed revisions, it shouldn't be as important
733
if base_idx < len(old_rh):
734
to_file.write('*'*60)
735
to_file.write('\nRemoved Revisions:\n')
736
for i in range(base_idx, len(old_rh)):
737
rev = branch.repository.get_revision(old_rh[i])
738
lr = LogRevision(rev, i+1, 0, None)
740
to_file.write('*'*60)
741
to_file.write('\n\n')
742
if base_idx < len(new_rh):
743
to_file.write('Added Revisions:\n')
749
start_revision=base_idx+1,
750
end_revision=len(new_rh),
added
removed
bzrlib/log.py
