202
228
mainline_revs.insert(0, None)
204
230
mainline_revs.insert(0, which_revs[start_revision-2][1])
205
if getattr(lf, 'show_merge', None) is not None:
206
include_merges = True
208
include_merges = False
209
view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
210
direction, include_merges=include_merges))
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)
212
269
def iter_revisions():
213
270
# r = revision, n = revno, d = merge depth
240
298
if not searchRE.search(rev.message):
244
# a mainline revision.
247
if not delta.touches_file_id(specific_fileid):
251
# although we calculated it, throw it away without display
254
lf.show(revno, rev, delta)
256
lf.show_merge(rev, merge_depth)
302
lr = LogRevision(rev, revno, merge_depth, delta,
303
rev_tag_dict.get(rev_id))
306
# support for legacy (pre-0.17) LogFormatters
309
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
311
lf.show(revno, rev, delta)
313
if show_merge_revno is None:
314
lf.show_merge(rev, merge_depth)
317
lf.show_merge_revno(rev, merge_depth, revno,
318
rev_tag_dict.get(rev_id))
320
lf.show_merge_revno(rev, merge_depth, revno)
323
if log_count >= limit:
327
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
329
"""Return the list of revision ids which touch a given file id.
331
This includes the revisions which directly change the file id,
332
and the revisions which merge these changes. So if the
340
And 'C' changes a file, then both C and D will be returned.
342
This will also can be restricted based on a subset of the mainline.
344
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
346
# find all the revisions that change the specific file
347
file_weave = branch.repository.weave_store.get_weave(file_id,
348
branch.repository.get_transaction())
349
weave_modifed_revisions = set(file_weave.versions())
350
# build the ancestry of each revision in the graph
351
# - only listing the ancestors that change the specific file.
352
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
353
sorted_rev_list = topo_sort(rev_graph)
355
for rev in sorted_rev_list:
356
parents = rev_graph[rev]
357
if rev not in weave_modifed_revisions and len(parents) == 1:
358
# We will not be adding anything new, so just use a reference to
359
# the parent ancestry.
360
rev_ancestry = ancestry[parents[0]]
363
if rev in weave_modifed_revisions:
364
rev_ancestry.add(rev)
365
for parent in parents:
366
rev_ancestry = rev_ancestry.union(ancestry[parent])
367
ancestry[rev] = rev_ancestry
369
def is_merging_rev(r):
370
parents = rev_graph[r]
372
leftparent = parents[0]
373
for rightparent in parents[1:]:
374
if not ancestry[leftparent].issuperset(
375
ancestry[rightparent]):
379
# filter from the view the revisions that did not change or merge
381
return [(r, n, d) for r, n, d in view_revs_iter
382
if r in weave_modifed_revisions or is_merging_rev(r)]
259
385
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
438
class LogRevision(object):
439
"""A revision to be logged (by LogFormatter.log_revision).
441
A simple wrapper for the attributes of a revision to be logged.
442
The attributes may or may not be populated, as determined by the
443
logging options and the log formatter capabilities.
446
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
450
self.merge_depth = merge_depth
313
455
class LogFormatter(object):
314
"""Abstract class to display log messages."""
456
"""Abstract class to display log messages.
458
At a minimum, a derived class must implement the log_revision method.
460
If the LogFormatter needs to be informed of the beginning or end of
461
a log it should implement the begin_log and/or end_log hook methods.
463
A LogFormatter should define the following supports_XXX flags
464
to indicate which LogRevision attributes it supports:
466
- supports_delta must be True if this log formatter supports delta.
467
Otherwise the delta attribute may not be populated.
468
- supports_merge_revisions must be True if this log formatter supports
469
merge revisions. If not, only revisions mainline revisions (those
470
with merge_depth == 0) will be passed to the formatter.
471
- supports_tags must be True if this log formatter supports tags.
472
Otherwise the tags attribute may not be populated.
316
475
def __init__(self, to_file, show_ids=False, show_timezone='original'):
317
476
self.to_file = to_file
318
477
self.show_ids = show_ids
319
478
self.show_timezone = show_timezone
480
# TODO: uncomment this block after show() has been removed.
481
# Until then defining log_revision would prevent _show_log calling show()
482
# in legacy formatters.
483
# def log_revision(self, revision):
486
# :param revision: The LogRevision to be logged.
488
# raise NotImplementedError('not implemented in abstract base')
490
@deprecated_method(zero_seventeen)
321
491
def show(self, revno, rev, delta):
322
492
raise NotImplementedError('not implemented in abstract base')
324
494
def short_committer(self, rev):
325
495
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
328
498
class LongLogFormatter(LogFormatter):
329
def show(self, revno, rev, delta):
330
return self._show_helper(revno=revno, rev=rev, delta=delta)
500
supports_merge_revisions = True
501
supports_delta = True
504
@deprecated_method(zero_seventeen)
505
def show(self, revno, rev, delta, tags=None):
506
lr = LogRevision(rev, revno, 0, delta, tags)
507
return self.log_revision(lr)
509
@deprecated_method(zero_eleven)
332
510
def show_merge(self, rev, merge_depth):
333
return self._show_helper(rev=rev, indent=' '*merge_depth, merged=True, delta=None)
335
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
336
"""Show a revision, either merged or not."""
511
lr = LogRevision(rev, merge_depth=merge_depth)
512
return self.log_revision(lr)
514
@deprecated_method(zero_seventeen)
515
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
516
"""Show a merged revision rev, with merge_depth and a revno."""
517
lr = LogRevision(rev, revno, merge_depth, tags=tags)
518
return self.log_revision(lr)
520
def log_revision(self, revision):
521
"""Log a revision, either merged or not."""
337
522
from bzrlib.osutils import format_date
523
indent = ' '*revision.merge_depth
338
524
to_file = self.to_file
339
525
print >>to_file, indent+'-' * 60
340
if revno is not None:
341
print >>to_file, 'revno:', revno
343
print >>to_file, indent+'merged:', rev.revision_id
345
print >>to_file, indent+'revision-id:', rev.revision_id
526
if revision.revno is not None:
527
print >>to_file, indent+'revno:', revision.revno
529
print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
346
530
if self.show_ids:
347
for parent_id in rev.parent_ids:
531
print >>to_file, indent+'revision-id:', revision.rev.revision_id
532
for parent_id in revision.rev.parent_ids:
348
533
print >>to_file, indent+'parent:', parent_id
349
print >>to_file, indent+'committer:', rev.committer
534
print >>to_file, indent+'committer:', revision.rev.committer
351
537
print >>to_file, indent+'branch nick: %s' % \
352
rev.properties['branch-nick']
538
revision.rev.properties['branch-nick']
355
date_str = format_date(rev.timestamp,
541
date_str = format_date(revision.rev.timestamp,
542
revision.rev.timezone or 0,
357
543
self.show_timezone)
358
544
print >>to_file, indent+'timestamp: %s' % date_str
360
546
print >>to_file, indent+'message:'
547
if not revision.rev.message:
362
548
print >>to_file, indent+' (no message)'
364
message = rev.message.rstrip('\r\n')
550
message = revision.rev.message.rstrip('\r\n')
365
551
for l in message.split('\n'):
366
552
print >>to_file, indent+' ' + l
367
if delta is not None:
368
delta.show(to_file, self.show_ids)
553
if revision.delta is not None:
554
revision.delta.show(to_file, self.show_ids)
371
557
class ShortLogFormatter(LogFormatter):
559
supports_delta = True
561
@deprecated_method(zero_seventeen)
372
562
def show(self, revno, rev, delta):
563
lr = LogRevision(rev, revno, 0, delta)
564
return self.log_revision(lr)
566
def log_revision(self, revision):
373
567
from bzrlib.osutils import format_date
375
569
to_file = self.to_file
376
date_str = format_date(rev.timestamp, rev.timezone or 0,
378
print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
379
format_date(rev.timestamp, rev.timezone or 0,
570
date_str = format_date(revision.rev.timestamp,
571
revision.rev.timezone or 0,
574
if len(revision.rev.parent_ids) > 1:
575
is_merge = ' [merge]'
576
print >>to_file, "%5s %s\t%s%s" % (revision.revno,
577
self.short_committer(revision.rev),
578
format_date(revision.rev.timestamp,
579
revision.rev.timezone or 0,
380
580
self.show_timezone, date_fmt="%Y-%m-%d",
382
583
if self.show_ids:
383
print >>to_file, ' revision-id:', rev.revision_id
584
print >>to_file, ' revision-id:', revision.rev.revision_id
585
if not revision.rev.message:
385
586
print >>to_file, ' (no message)'
387
message = rev.message.rstrip('\r\n')
588
message = revision.rev.message.rstrip('\r\n')
388
589
for l in message.split('\n'):
389
590
print >>to_file, ' ' + l
391
592
# TODO: Why not show the modified files in a shorter form as
392
593
# well? rewrap them single lines of appropriate length
393
if delta is not None:
394
delta.show(to_file, self.show_ids)
594
if revision.delta is not None:
595
revision.delta.show(to_file, self.show_ids)
395
596
print >>to_file, ''
398
599
class LineLogFormatter(LogFormatter):
601
def __init__(self, *args, **kwargs):
602
from bzrlib.osutils import terminal_width
603
super(LineLogFormatter, self).__init__(*args, **kwargs)
604
self._max_chars = terminal_width() - 1
399
606
def truncate(self, str, max_len):
400
607
if len(str) <= max_len:
439
651
lf = LineLogFormatter(None)
440
652
return lf.log_string(None, rev, max_chars)
443
'long': LongLogFormatter,
444
'short': ShortLogFormatter,
445
'line': LineLogFormatter,
655
class LogFormatterRegistry(registry.Registry):
656
"""Registry for log formatters"""
658
def make_formatter(self, name, *args, **kwargs):
659
"""Construct a formatter from arguments.
661
:param name: Name of the formatter to construct. 'short', 'long' and
664
return self.get(name)(*args, **kwargs)
666
def get_default(self, branch):
667
return self.get(branch.get_config().log_format())
670
log_formatter_registry = LogFormatterRegistry()
673
log_formatter_registry.register('short', ShortLogFormatter,
674
'Moderately short log format')
675
log_formatter_registry.register('long', LongLogFormatter,
676
'Detailed log format')
677
log_formatter_registry.register('line', LineLogFormatter,
678
'Log format with one line per revision')
448
681
def register_formatter(name, formatter):
449
FORMATTERS[name] = formatter
682
log_formatter_registry.register(name, formatter)
451
685
def log_formatter(name, *args, **kwargs):
452
686
"""Construct a formatter from arguments.
added
removed
bzrlib/log.py
