193
200
# list indexes are 0-based; revisions are 1-based
194
201
cut_revs = which_revs[(start_revision-1):(end_revision)]
198
# convert the revision history to a dictionary:
199
rev_nos = dict((k, v) for v, k in cut_revs)
201
# override the mainline to look like the revision history.
202
mainline_revs = [revision_id for index, revision_id in cut_revs]
203
if cut_revs[0][0] == 1:
204
mainline_revs.insert(0, None)
206
mainline_revs.insert(0, which_revs[start_revision-2][1])
207
# how should we show merged revisions ?
208
# old api: show_merge. New api: show_merge_revno
209
show_merge_revno = getattr(lf, 'show_merge_revno', None)
210
show_merge = getattr(lf, 'show_merge', None)
211
if show_merge is None and show_merge_revno is None:
212
# no merged-revno support
213
include_merges = False
215
include_merges = True
216
if show_merge is not None and show_merge_revno is None:
217
# tell developers to update their code
218
symbol_versioning.warn('LogFormatters should provide show_merge_revno '
219
'instead of show_merge since bzr 0.11.',
220
DeprecationWarning, stacklevel=3)
221
view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
222
direction, include_merges=include_merges))
224
def iter_revisions():
225
# r = revision, n = revno, d = merge depth
226
revision_ids = [r for r, n, d in view_revisions]
227
zeros = set(r for r, n, d in view_revisions if d == 0)
229
repository = branch.repository
232
revisions = repository.get_revisions(revision_ids[:num])
233
if verbose or specific_fileid:
234
delta_revisions = [r for r in revisions if
235
r.revision_id in zeros]
236
deltas = repository.get_deltas_for_revisions(delta_revisions)
237
cur_deltas = dict(izip((r.revision_id for r in
238
delta_revisions), deltas))
239
for revision in revisions:
240
# The delta value will be None unless
241
# 1. verbose or specific_fileid is specified, and
242
# 2. the revision is a mainline revision
243
yield revision, cur_deltas.get(revision.revision_id)
244
revision_ids = revision_ids[num:]
203
if direction == 'reverse':
205
elif direction == 'forward':
208
raise ValueError('invalid direction %r' % direction)
210
revision_history = branch.revision_history()
211
for revno, rev_id in cut_revs:
212
if verbose or specific_fileid:
213
delta = _get_revision_delta(branch, revno)
247
# now we just print all the revisions
248
for ((rev_id, revno, merge_depth), (rev, delta)) in \
249
izip(view_revisions, iter_revisions()):
216
if not delta.touches_file_id(specific_fileid):
220
# although we calculated it, throw it away without display
223
rev = branch.get_revision(rev_id)
252
226
if not searchRE.search(rev.message):
256
# a mainline revision.
259
if not delta.touches_file_id(specific_fileid):
229
lf.show(revno, rev, delta)
233
# revno is 1 based, so -2 to get back 1 less.
234
excludes = set(branch.get_ancestry(revision_history[revno - 2]))
235
pending = list(rev.parent_ids)
237
rev_id = pending.pop()
238
if rev_id in excludes:
240
# prevent showing merged revs twice if they multi-path.
243
rev = branch.get_revision(rev_id)
244
except errors.NoSuchRevision:
246
pending.extend(rev.parent_ids)
250
def deltas_for_log_dummy(branch, which_revs):
251
"""Return all the revisions without intermediate deltas.
253
Useful for log commands that won't need the delta information.
263
# although we calculated it, throw it away without display
266
lf.show(revno, rev, delta)
256
for revno, revision_id in which_revs:
257
yield revno, branch.get_revision(revision_id), None
260
def deltas_for_log_reverse(branch, which_revs):
261
"""Compute deltas for display in latest-to-earliest order.
267
Sequence of (revno, revision_id) for the subset of history to examine
270
Sequence of (revno, rev, delta)
272
The delta is from the given revision to the next one in the
273
sequence, which makes sense if the log is being displayed from
276
last_revno = last_revision_id = last_tree = None
277
for revno, revision_id in which_revs:
278
this_tree = branch.revision_tree(revision_id)
279
this_revision = branch.get_revision(revision_id)
282
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
284
this_tree = EmptyTree(branch.get_root_id())
287
last_revision = this_revision
288
last_tree = this_tree
292
this_tree = EmptyTree(branch.get_root_id())
268
if show_merge_revno is None:
269
lf.show_merge(rev, merge_depth)
294
this_revno = last_revno - 1
295
this_revision_id = branch.revision_history()[this_revno]
296
this_tree = branch.revision_tree(this_revision_id)
297
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
300
def deltas_for_log_forward(branch, which_revs):
301
"""Compute deltas for display in forward log.
303
Given a sequence of (revno, revision_id) pairs, return
306
The delta is from the given revision to the next one in the
307
sequence, which makes sense if the log is being displayed from
310
last_revno = last_revision_id = last_tree = None
311
prev_tree = EmptyTree(branch.get_root_id())
313
for revno, revision_id in which_revs:
314
this_tree = branch.revision_tree(revision_id)
315
this_revision = branch.get_revision(revision_id)
319
last_tree = EmptyTree(branch.get_root_id())
271
lf.show_merge_revno(rev, merge_depth, revno)
274
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
275
include_merges=True):
276
"""Produce an iterator of revisions to show
277
:return: an iterator of (revision_id, revno, merge_depth)
278
(if there is no revno for a revision, None is supplied)
280
if include_merges is False:
281
revision_ids = mainline_revs[1:]
282
if direction == 'reverse':
283
revision_ids.reverse()
284
for revision_id in revision_ids:
285
yield revision_id, str(rev_nos[revision_id]), 0
287
merge_sorted_revisions = merge_sort(
288
branch.repository.get_revision_graph(mainline_revs[-1]),
293
if direction == 'forward':
294
# forward means oldest first.
295
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
296
elif direction != 'reverse':
297
raise ValueError('invalid direction %r' % direction)
299
revision_history = branch.revision_history()
301
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
302
yield rev_id, '.'.join(map(str, revno)), merge_depth
305
def reverse_by_depth(merge_sorted_revisions, _depth=0):
306
"""Reverse revisions by depth.
308
Revisions with a different depth are sorted as a group with the previous
309
revision of that depth. There may be no topological justification for this,
310
but it looks much nicer.
313
for val in merge_sorted_revisions:
315
zd_revisions.append([val])
317
assert val[2] > _depth
318
zd_revisions[-1].append(val)
319
for revisions in zd_revisions:
320
if len(revisions) > 1:
321
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
322
zd_revisions.reverse()
324
for chunk in zd_revisions:
321
last_revno = revno - 1
322
last_revision_id = branch.revision_history()[last_revno]
323
last_tree = branch.revision_tree(last_revision_id)
325
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
328
last_revision = this_revision
329
last_tree = this_tree
329
332
class LogFormatter(object):
330
333
"""Abstract class to display log messages."""
332
334
def __init__(self, to_file, show_ids=False, show_timezone='original'):
333
335
self.to_file = to_file
334
336
self.show_ids = show_ids
335
337
self.show_timezone = show_timezone
337
340
def show(self, revno, rev, delta):
338
341
raise NotImplementedError('not implemented in abstract base')
340
def short_committer(self, rev):
341
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
343
def show_merge(self, rev):
344
347
class LongLogFormatter(LogFormatter):
345
348
def show(self, revno, rev, delta):
346
return self._show_helper(revno=revno, rev=rev, delta=delta)
348
@deprecated_method(zero_eleven)
349
def show_merge(self, rev, merge_depth):
350
return self._show_helper(rev=rev, indent=' '*merge_depth, merged=True, delta=None)
352
def show_merge_revno(self, rev, merge_depth, revno):
353
"""Show a merged revision rev, with merge_depth and a revno."""
354
return self._show_helper(rev=rev, revno=revno,
355
indent=' '*merge_depth, merged=True, delta=None)
357
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
358
"""Show a revision, either merged or not."""
359
from bzrlib.osutils import format_date
360
to_file = self.to_file
349
from osutils import format_date
351
to_file = self.to_file
353
print >>to_file, '-' * 60
354
print >>to_file, 'revno:', revno
356
print >>to_file, 'revision-id:', rev.revision_id
358
for parent_id in rev.parent_ids:
359
print >>to_file, 'parent:', parent_id
361
print >>to_file, 'committer:', rev.committer
363
date_str = format_date(rev.timestamp,
366
print >>to_file, 'timestamp: %s' % date_str
368
print >>to_file, 'message:'
370
print >>to_file, ' (no message)'
372
for l in rev.message.split('\n'):
373
print >>to_file, ' ' + l
376
delta.show(to_file, self.show_ids)
378
def show_merge(self, rev):
379
from osutils import format_date
381
to_file = self.to_file
361
385
print >>to_file, indent+'-' * 60
362
if revno is not None:
363
print >>to_file, indent+'revno:', revno
365
print >>to_file, indent+'merged:', rev.revision_id
367
print >>to_file, indent+'revision-id:', rev.revision_id
386
print >>to_file, indent+'merged:', rev.revision_id
368
387
if self.show_ids:
369
388
for parent_id in rev.parent_ids:
370
389
print >>to_file, indent+'parent:', parent_id
371
391
print >>to_file, indent+'committer:', rev.committer
373
print >>to_file, indent+'branch nick: %s' % \
374
rev.properties['branch-nick']
377
393
date_str = format_date(rev.timestamp,
378
394
rev.timezone or 0,
379
395
self.show_timezone)
395
408
from bzrlib.osutils import format_date
397
410
to_file = self.to_file
398
date_str = format_date(rev.timestamp, rev.timezone or 0,
400
print >>to_file, "%5s %s\t%s" % (revno, self.short_committer(rev),
412
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
401
413
format_date(rev.timestamp, rev.timezone or 0,
402
self.show_timezone, date_fmt="%Y-%m-%d",
404
415
if self.show_ids:
405
416
print >>to_file, ' revision-id:', rev.revision_id
406
417
if not rev.message:
407
418
print >>to_file, ' (no message)'
409
message = rev.message.rstrip('\r\n')
410
for l in message.split('\n'):
420
for l in rev.message.split('\n'):
411
421
print >>to_file, ' ' + l
413
423
# TODO: Why not show the modified files in a shorter form as
414
424
# well? rewrap them single lines of appropriate length
415
if delta is not None:
416
426
delta.show(to_file, self.show_ids)
420
class LineLogFormatter(LogFormatter):
421
def truncate(self, str, max_len):
422
if len(str) <= max_len:
424
return str[:max_len-3]+'...'
426
def date_string(self, rev):
427
from bzrlib.osutils import format_date
428
return format_date(rev.timestamp, rev.timezone or 0,
429
self.show_timezone, date_fmt="%Y-%m-%d",
432
def message(self, rev):
434
return '(no message)'
438
def show(self, revno, rev, delta):
439
from bzrlib.osutils import terminal_width
440
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
442
def log_string(self, revno, rev, max_chars):
443
"""Format log info into one string. Truncate tail of string
444
:param revno: revision number (int) or None.
445
Revision numbers counts from 1.
446
:param rev: revision info object
447
:param max_chars: maximum length of resulting string
448
:return: formatted truncated string
452
# show revno only when is not None
453
out.append("%s:" % revno)
454
out.append(self.truncate(self.short_committer(rev), 20))
455
out.append(self.date_string(rev))
456
out.append(rev.get_summary())
457
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
460
def line_log(rev, max_chars):
461
lf = LineLogFormatter(None)
462
return lf.log_string(None, rev, max_chars)
465
'long': LongLogFormatter,
431
FORMATTERS = {'long': LongLogFormatter,
466
432
'short': ShortLogFormatter,
467
'line': LineLogFormatter,
470
def register_formatter(name, formatter):
471
FORMATTERS[name] = formatter
473
436
def log_formatter(name, *args, **kwargs):
474
437
"""Construct a formatter from arguments.
476
name -- Name of the formatter to construct; currently 'long', 'short' and
477
'line' are supported.
439
name -- Name of the formatter to construct; currently 'long' and
440
'short' are supported.
479
442
from bzrlib.errors import BzrCommandError
481
444
return FORMATTERS[name](*args, **kwargs)
483
446
raise BzrCommandError("unknown log formatter: %r" % name)
485
448
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
486
# deprecated; for compatibility
449
# deprecated; for compatability
487
450
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
488
451
lf.show(revno, rev, delta)
490
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
491
"""Show the change in revision history comparing the old revision history to the new one.
493
:param branch: The branch where the revisions exist
494
:param old_rh: The old revision history
495
:param new_rh: The new revision history
496
:param to_file: A file to write the results to. If None, stdout will be used
502
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
503
lf = log_formatter(log_format,
506
show_timezone='original')
508
# This is the first index which is different between
511
for i in xrange(max(len(new_rh),
515
or new_rh[i] != old_rh[i]):
520
to_file.write('Nothing seems to have changed\n')
522
## TODO: It might be nice to do something like show_log
523
## and show the merged entries. But since this is the
524
## removed revisions, it shouldn't be as important
525
if base_idx < len(old_rh):
526
to_file.write('*'*60)
527
to_file.write('\nRemoved Revisions:\n')
528
for i in range(base_idx, len(old_rh)):
529
rev = branch.repository.get_revision(old_rh[i])
530
lf.show(i+1, rev, None)
531
to_file.write('*'*60)
532
to_file.write('\n\n')
533
if base_idx < len(new_rh):
534
to_file.write('Added Revisions:\n')
540
start_revision=base_idx+1,
541
end_revision=len(new_rh),
added
removed
bzrlib/log.py
