112
def _enumerate_history(branch):
115
for rev_id in branch.revision_history():
116
rh.append((revno, rev_id))
69
121
def show_log(branch,
71
show_timezone='original',
123
specific_fileid=None,
75
129
"""Write out human-readable log of commits to this branch.
132
LogFormatter object to show the output.
78
135
If true, list only the commits affecting the specified
79
136
file, rather than all commits.
82
'original' (committer's timezone),
83
'utc' (universal time), or
84
'local' (local user's timezone)
87
139
If true show added/changed/deleted/renamed files.
90
If true, show revision and file ids.
93
File to send log to; by default stdout.
95
from osutils import format_date
96
from errors import BzrCheckError
97
from diff import compare_inventories
98
from textui import show_status
99
from inventory import Inventory
142
'reverse' (default) is latest to earliest;
143
'forward' is earliest to latest.
146
If not None, only show revisions >= start_revision
149
If not None, only show revisions <= end_revision
153
_show_log(branch, lf, specific_fileid, verbose, direction,
154
start_revision, end_revision, search)
158
def _show_log(branch,
160
specific_fileid=None,
166
"""Worker function for show_log - see show_log."""
167
from bzrlib.osutils import format_date
168
from bzrlib.errors import BzrCheckError
170
from warnings import warn
172
if not isinstance(lf, LogFormatter):
173
warn("not a LogFormatter instance: %r" % lf)
176
mutter('get log for file_id %r', specific_fileid)
178
if search is not None:
180
searchRE = re.compile(search, re.IGNORECASE)
184
which_revs = _enumerate_history(branch)
186
if start_revision is None:
189
branch.check_real_revno(start_revision)
191
if end_revision is None:
192
end_revision = len(which_revs)
194
branch.check_real_revno(end_revision)
196
# list indexes are 0-based; revisions are 1-based
197
cut_revs = which_revs[(start_revision-1):(end_revision)]
201
# convert the revision history to a dictionary:
202
rev_nos = dict((k, v) for v, k in cut_revs)
204
# override the mainline to look like the revision history.
205
mainline_revs = [revision_id for index, revision_id in cut_revs]
206
if cut_revs[0][0] == 1:
207
mainline_revs.insert(0, None)
209
mainline_revs.insert(0, which_revs[start_revision-2][1])
210
# how should we show merged revisions ?
211
# old api: show_merge. New api: show_merge_revno
212
show_merge_revno = getattr(lf, 'show_merge_revno', None)
213
show_merge = getattr(lf, 'show_merge', None)
214
if show_merge is None and show_merge_revno is None:
215
# no merged-revno support
216
include_merges = False
218
include_merges = True
219
if show_merge is not None and show_merge_revno is None:
220
# tell developers to update their code
221
symbol_versioning.warn('LogFormatters should provide show_merge_revno '
222
'instead of show_merge since bzr 0.11.',
223
DeprecationWarning, stacklevel=3)
224
view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
225
direction, include_merges=include_merges))
227
def iter_revisions():
228
# r = revision, n = revno, d = merge depth
229
revision_ids = [r for r, n, d in view_revisions]
230
zeros = set(r for r, n, d in view_revisions if d == 0)
232
repository = branch.repository
235
revisions = repository.get_revisions(revision_ids[:num])
236
if verbose or specific_fileid:
237
delta_revisions = [r for r in revisions if
238
r.revision_id in zeros]
239
deltas = repository.get_deltas_for_revisions(delta_revisions)
240
cur_deltas = dict(izip((r.revision_id for r in
241
delta_revisions), deltas))
242
for revision in revisions:
243
# The delta value will be None unless
244
# 1. verbose or specific_fileid is specified, and
245
# 2. the revision is a mainline revision
246
yield revision, cur_deltas.get(revision.revision_id)
247
revision_ids = revision_ids[num:]
250
# now we just print all the revisions
251
for ((rev_id, revno, merge_depth), (rev, delta)) in \
252
izip(view_revisions, iter_revisions()):
255
if not searchRE.search(rev.message):
259
# a mainline revision.
262
if not delta.touches_file_id(specific_fileid):
266
# although we calculated it, throw it away without display
269
lf.show(revno, rev, delta)
271
if show_merge_revno is None:
272
lf.show_merge(rev, merge_depth)
274
lf.show_merge_revno(rev, merge_depth, revno)
277
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
278
include_merges=True):
279
"""Produce an iterator of revisions to show
280
:return: an iterator of (revision_id, revno, merge_depth)
281
(if there is no revno for a revision, None is supplied)
283
if include_merges is False:
284
revision_ids = mainline_revs[1:]
285
if direction == 'reverse':
286
revision_ids.reverse()
287
for revision_id in revision_ids:
288
yield revision_id, str(rev_nos[revision_id]), 0
290
merge_sorted_revisions = merge_sort(
291
branch.repository.get_revision_graph(mainline_revs[-1]),
296
if direction == 'forward':
297
# forward means oldest first.
298
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
299
elif direction != 'reverse':
300
raise ValueError('invalid direction %r' % direction)
302
for sequence, rev_id, merge_depth, revno, end_of_merge in merge_sorted_revisions:
303
yield rev_id, '.'.join(map(str, revno)), merge_depth
306
def reverse_by_depth(merge_sorted_revisions, _depth=0):
307
"""Reverse revisions by depth.
309
Revisions with a different depth are sorted as a group with the previous
310
revision of that depth. There may be no topological justification for this,
311
but it looks much nicer.
314
for val in merge_sorted_revisions:
316
zd_revisions.append([val])
318
assert val[2] > _depth
319
zd_revisions[-1].append(val)
320
for revisions in zd_revisions:
321
if len(revisions) > 1:
322
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
323
zd_revisions.reverse()
325
for chunk in zd_revisions:
330
class LogFormatter(object):
331
"""Abstract class to display log messages."""
333
def __init__(self, to_file, show_ids=False, show_timezone='original'):
334
self.to_file = to_file
335
self.show_ids = show_ids
336
self.show_timezone = show_timezone
338
def show(self, revno, rev, delta):
339
raise NotImplementedError('not implemented in abstract base')
341
def short_committer(self, rev):
342
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
345
class LongLogFormatter(LogFormatter):
346
def show(self, revno, rev, delta):
347
return self._show_helper(revno=revno, rev=rev, delta=delta)
349
@deprecated_method(zero_eleven)
350
def show_merge(self, rev, merge_depth):
351
return self._show_helper(rev=rev, indent=' '*merge_depth, merged=True, delta=None)
353
def show_merge_revno(self, rev, merge_depth, revno):
354
"""Show a merged revision rev, with merge_depth and a revno."""
355
return self._show_helper(rev=rev, revno=revno,
356
indent=' '*merge_depth, merged=True, delta=None)
358
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
359
"""Show a revision, either merged or not."""
360
from bzrlib.osutils import format_date
361
to_file = self.to_file
362
print >>to_file, indent+'-' * 60
363
if revno is not None:
364
print >>to_file, indent+'revno:', revno
366
print >>to_file, indent+'merged:', rev.revision_id
368
print >>to_file, indent+'revision-id:', rev.revision_id
370
for parent_id in rev.parent_ids:
371
print >>to_file, indent+'parent:', parent_id
372
print >>to_file, indent+'committer:', rev.committer
374
print >>to_file, indent+'branch nick: %s' % \
375
rev.properties['branch-nick']
378
date_str = format_date(rev.timestamp,
381
print >>to_file, indent+'timestamp: %s' % date_str
383
print >>to_file, indent+'message:'
385
print >>to_file, indent+' (no message)'
387
message = rev.message.rstrip('\r\n')
388
for l in message.split('\n'):
389
print >>to_file, indent+' ' + l
390
if delta is not None:
391
delta.show(to_file, self.show_ids)
394
class ShortLogFormatter(LogFormatter):
395
def show(self, revno, rev, delta):
396
from bzrlib.osutils import format_date
398
to_file = self.to_file
399
date_str = format_date(rev.timestamp, rev.timezone or 0,
401
print >>to_file, "%5s %s\t%s" % (revno, self.short_committer(rev),
402
format_date(rev.timestamp, rev.timezone or 0,
403
self.show_timezone, date_fmt="%Y-%m-%d",
406
print >>to_file, ' revision-id:', rev.revision_id
408
print >>to_file, ' (no message)'
410
message = rev.message.rstrip('\r\n')
411
for l in message.split('\n'):
412
print >>to_file, ' ' + l
414
# TODO: Why not show the modified files in a shorter form as
415
# well? rewrap them single lines of appropriate length
416
if delta is not None:
417
delta.show(to_file, self.show_ids)
421
class LineLogFormatter(LogFormatter):
422
def truncate(self, str, max_len):
423
if len(str) <= max_len:
425
return str[:max_len-3]+'...'
427
def date_string(self, rev):
428
from bzrlib.osutils import format_date
429
return format_date(rev.timestamp, rev.timezone or 0,
430
self.show_timezone, date_fmt="%Y-%m-%d",
433
def message(self, rev):
435
return '(no message)'
439
def show(self, revno, rev, delta):
440
from bzrlib.osutils import terminal_width
441
print >> self.to_file, self.log_string(revno, rev, terminal_width()-1)
443
def log_string(self, revno, rev, max_chars):
444
"""Format log info into one string. Truncate tail of string
445
:param revno: revision number (int) or None.
446
Revision numbers counts from 1.
447
:param rev: revision info object
448
:param max_chars: maximum length of resulting string
449
:return: formatted truncated string
453
# show revno only when is not None
454
out.append("%s:" % revno)
455
out.append(self.truncate(self.short_committer(rev), 20))
456
out.append(self.date_string(rev))
457
out.append(rev.get_summary())
458
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
461
def line_log(rev, max_chars):
462
lf = LineLogFormatter(None)
463
return lf.log_string(None, rev, max_chars)
466
class LogFormatterRegistry(registry.Registry):
467
"""Registry for log formatters"""
469
def make_formatter(self, name, *args, **kwargs):
470
"""Construct a formatter from arguments.
472
:param name: Name of the formatter to construct. 'short', 'long' and
475
return self.get(name)(*args, **kwargs)
477
def get_default(self, branch):
478
return self.get(branch.get_config().log_format())
481
log_formatter_registry = LogFormatterRegistry()
484
log_formatter_registry.register('short', ShortLogFormatter,
485
'Moderately short log format')
486
log_formatter_registry.register('long', LongLogFormatter,
487
'Detailed log format')
488
log_formatter_registry.register('line', LineLogFormatter,
489
'Log format with one line per revision')
492
def register_formatter(name, formatter):
493
log_formatter_registry.register(name, formatter)
496
def log_formatter(name, *args, **kwargs):
497
"""Construct a formatter from arguments.
499
name -- Name of the formatter to construct; currently 'long', 'short' and
500
'line' are supported.
502
from bzrlib.errors import BzrCommandError
504
return log_formatter_registry.make_formatter(name, *args, **kwargs)
506
raise BzrCommandError("unknown log formatter: %r" % name)
509
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
510
# deprecated; for compatibility
511
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
512
lf.show(revno, rev, delta)
514
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
515
"""Show the change in revision history comparing the old revision history to the new one.
517
:param branch: The branch where the revisions exist
518
:param old_rh: The old revision history
519
:param new_rh: The new revision history
520
:param to_file: A file to write the results to. If None, stdout will be used
106
file_id = branch.read_working_inventory().path2id(filename)
108
for revno, revid, why in find_touching_revisions(branch, file_id):
112
for i, revid in enumerate(branch.revision_history()):
115
branch._need_readlock()
118
prev_inv = Inventory()
119
for revno, revision_id in which_revs():
120
print >>to_file, '-' * 60
121
print >>to_file, 'revno:', revno
122
rev = branch.get_revision(revision_id)
124
print >>to_file, 'revision-id:', revision_id
125
print >>to_file, 'committer:', rev.committer
126
print >>to_file, 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
129
if revision_id != rev.revision_id:
130
raise BzrCheckError("retrieved wrong revision: %r"
131
% (revision_id, rev.revision_id))
133
print >>to_file, 'message:'
135
print >>to_file, ' (no message)'
137
for l in rev.message.split('\n'):
138
print >>to_file, ' ' + l
140
# Don't show a list of changed files if we were asked about
143
if verbose and not filename:
144
this_inv = branch.get_inventory(rev.inventory_id)
145
delta = compare_inventories(prev_inv, this_inv)
148
print >>to_file, 'removed files:'
149
for path, fid in delta.removed:
151
print >>to_file, ' %-30s %s' % (path, fid)
153
print >>to_file, ' ', path
155
print >>to_file, 'added files:'
156
for path, fid in delta.added:
158
print >>to_file, ' %-30s %s' % (path, fid)
160
print >>to_file, ' ' + path
162
print >>to_file, 'renamed files:'
163
for oldpath, newpath, fid in delta.renamed:
165
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
167
print >>to_file, ' %s => %s' % (oldpath, newpath)
169
print >>to_file, 'modified files:'
170
for path, fid in delta.modified:
172
print >>to_file, ' %-30s %s' % (path, fid)
174
print >>to_file, ' ' + path
178
precursor = revision_id
526
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
527
lf = log_formatter(log_format,
530
show_timezone='original')
532
# This is the first index which is different between
535
for i in xrange(max(len(new_rh),
539
or new_rh[i] != old_rh[i]):
544
to_file.write('Nothing seems to have changed\n')
546
## TODO: It might be nice to do something like show_log
547
## and show the merged entries. But since this is the
548
## removed revisions, it shouldn't be as important
549
if base_idx < len(old_rh):
550
to_file.write('*'*60)
551
to_file.write('\nRemoved Revisions:\n')
552
for i in range(base_idx, len(old_rh)):
553
rev = branch.repository.get_revision(old_rh[i])
554
lf.show(i+1, rev, None)
555
to_file.write('*'*60)
556
to_file.write('\n\n')
557
if base_idx < len(new_rh):
558
to_file.write('Added Revisions:\n')
564
start_revision=base_idx+1,
565
end_revision=len(new_rh),
added
removed
bzrlib/log.py
