117
143
direction='reverse',
118
144
start_revision=None,
119
145
end_revision=None,
121
148
"""Write out human-readable log of commits to this branch.
124
LogFormatter object to show the output.
127
If true, list only the commits affecting the specified
128
file, rather than all commits.
131
If true show added/changed/deleted/renamed files.
134
'reverse' (default) is latest to earliest;
135
'forward' is earliest to latest.
138
If not None, only show revisions >= start_revision
141
If not None, only show revisions <= end_revision
150
:param lf: The LogFormatter object showing the output.
152
:param specific_fileid: If not None, list only the commits affecting the
153
specified file, rather than all commits.
155
:param verbose: If True show added/changed/deleted/renamed files.
157
:param direction: 'reverse' (default) is latest to earliest; 'forward' is
160
:param start_revision: If not None, only show revisions >= start_revision
162
:param end_revision: If not None, only show revisions <= end_revision
164
:param search: If not None, only show revisions with matching commit
167
:param limit: If set, shows only 'limit' revisions, all revisions are shown
143
from bzrlib.osutils import format_date
144
from bzrlib.errors import BzrCheckError
145
from bzrlib.textui import show_status
147
from warnings import warn
172
if getattr(lf, 'begin_log', None):
175
_show_log(branch, lf, specific_fileid, verbose, direction,
176
start_revision, end_revision, search, limit)
178
if getattr(lf, 'end_log', None):
184
def _show_log(branch,
186
specific_fileid=None,
193
"""Worker function for show_log - see show_log."""
149
194
if not isinstance(lf, LogFormatter):
150
195
warn("not a LogFormatter instance: %r" % lf)
152
197
if specific_fileid:
153
mutter('get log for file_id %r' % specific_fileid)
155
if search is not None:
157
searchRE = re.compile(search, re.IGNORECASE)
198
trace.mutter('get log for file_id %r', specific_fileid)
199
generate_merge_revisions = getattr(lf, 'supports_merge_revisions', False)
200
allow_single_merge_revision = getattr(lf,
201
'supports_single_merge_revision', False)
202
view_revisions = calculate_view_revisions(branch, start_revision,
203
end_revision, direction,
205
generate_merge_revisions,
206
allow_single_merge_revision)
208
generate_tags = getattr(lf, 'supports_tags', False)
210
if branch.supports_tags():
211
rev_tag_dict = branch.tags.get_reverse_tag_dict()
213
generate_delta = verbose and getattr(lf, 'supports_delta', False)
215
# now we just print all the revisions
217
revision_iterator = make_log_rev_iterator(branch, view_revisions,
218
generate_delta, search)
219
for revs in revision_iterator:
220
for (rev_id, revno, merge_depth), rev, delta in revs:
221
lr = LogRevision(rev, revno, merge_depth, delta,
222
rev_tag_dict.get(rev_id))
226
if log_count >= limit:
230
def calculate_view_revisions(branch, start_revision, end_revision, direction,
231
specific_fileid, generate_merge_revisions,
232
allow_single_merge_revision):
233
if ( not generate_merge_revisions
234
and start_revision is end_revision is None
235
and direction == 'reverse'
236
and specific_fileid is None):
237
return _linear_view_revisions(branch)
239
mainline_revs, rev_nos, start_rev_id, end_rev_id = _get_mainline_revs(
240
branch, start_revision, end_revision)
241
if not mainline_revs:
244
generate_single_revision = False
245
if ((not generate_merge_revisions)
246
and ((start_rev_id and (start_rev_id not in rev_nos))
247
or (end_rev_id and (end_rev_id not in rev_nos)))):
248
generate_single_revision = ((start_rev_id == end_rev_id)
249
and allow_single_merge_revision)
250
if not generate_single_revision:
251
raise errors.BzrCommandError('Selected log formatter only supports'
252
' mainline revisions.')
253
generate_merge_revisions = generate_single_revision
254
include_merges = generate_merge_revisions or specific_fileid
255
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
256
direction, include_merges=include_merges)
258
if direction == 'reverse':
259
start_rev_id, end_rev_id = end_rev_id, start_rev_id
260
view_revisions = _filter_revision_range(list(view_revs_iter),
263
if view_revisions and generate_single_revision:
264
view_revisions = view_revisions[0:1]
266
view_revisions = _filter_revisions_touching_file_id(branch,
267
specific_fileid, view_revisions,
268
include_merges=generate_merge_revisions)
270
# rebase merge_depth - unless there are no revisions or
271
# either the first or last revision have merge_depth = 0.
272
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
273
min_depth = min([d for r,n,d in view_revisions])
275
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
276
return view_revisions
279
def _linear_view_revisions(branch):
280
start_revno, start_revision_id = branch.last_revision_info()
281
repo = branch.repository
282
revision_ids = repo.iter_reverse_revision_history(start_revision_id)
283
for num, revision_id in enumerate(revision_ids):
284
yield revision_id, str(start_revno - num), 0
287
def make_log_rev_iterator(branch, view_revisions, generate_delta, search):
288
"""Create a revision iterator for log.
290
:param branch: The branch being logged.
291
:param view_revisions: The revisions being viewed.
292
:param generate_delta: Whether to generate a delta for each revision.
293
:param search: A user text search string.
294
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
297
# Convert view_revisions into (view, None, None) groups to fit with
298
# the standard interface here.
299
if type(view_revisions) == list:
300
# A single batch conversion is faster than many incremental ones.
301
# As we have all the data, do a batch conversion.
302
nones = [None] * len(view_revisions)
303
log_rev_iterator = iter([zip(view_revisions, nones, nones)])
161
which_revs = _enumerate_history(branch)
306
for view in view_revisions:
307
yield (view, None, None)
308
log_rev_iterator = iter([_convert()])
309
for adapter in log_adapters:
310
log_rev_iterator = adapter(branch, generate_delta, search,
312
return log_rev_iterator
315
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
316
"""Create a filtered iterator of log_rev_iterator matching on a regex.
318
:param branch: The branch being logged.
319
:param generate_delta: Whether to generate a delta for each revision.
320
:param search: A user text search string.
321
:param log_rev_iterator: An input iterator containing all revisions that
322
could be displayed, in lists.
323
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
327
return log_rev_iterator
328
# Compile the search now to get early errors.
329
searchRE = re.compile(search, re.IGNORECASE)
330
return _filter_message_re(searchRE, log_rev_iterator)
333
def _filter_message_re(searchRE, log_rev_iterator):
334
for revs in log_rev_iterator:
336
for (rev_id, revno, merge_depth), rev, delta in revs:
337
if searchRE.search(rev.message):
338
new_revs.append(((rev_id, revno, merge_depth), rev, delta))
342
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator):
343
"""Add revision deltas to a log iterator if needed.
345
:param branch: The branch being logged.
346
:param generate_delta: Whether to generate a delta for each revision.
347
:param search: A user text search string.
348
:param log_rev_iterator: An input iterator containing all revisions that
349
could be displayed, in lists.
350
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
353
if not generate_delta:
354
return log_rev_iterator
355
return _generate_deltas(branch.repository, log_rev_iterator)
358
def _generate_deltas(repository, log_rev_iterator):
359
"""Create deltas for each batch of revisions in log_rev_iterator."""
360
for revs in log_rev_iterator:
361
revisions = [rev[1] for rev in revs]
362
deltas = repository.get_deltas_for_revisions(revisions)
363
revs = [(rev[0], rev[1], delta) for rev, delta in izip(revs, deltas)]
367
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
368
"""Extract revision objects from the repository
370
:param branch: The branch being logged.
371
:param generate_delta: Whether to generate a delta for each revision.
372
:param search: A user text search string.
373
:param log_rev_iterator: An input iterator containing all revisions that
374
could be displayed, in lists.
375
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
378
repository = branch.repository
379
for revs in log_rev_iterator:
380
# r = revision_id, n = revno, d = merge depth
381
revision_ids = [view[0] for view, _, _ in revs]
382
revisions = repository.get_revisions(revision_ids)
383
revs = [(rev[0], revision, rev[2]) for rev, revision in
384
izip(revs, revisions)]
388
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
389
"""Group up a single large batch into smaller ones.
391
:param branch: The branch being logged.
392
:param generate_delta: Whether to generate a delta for each revision.
393
:param search: A user text search string.
394
:param log_rev_iterator: An input iterator containing all revisions that
395
could be displayed, in lists.
396
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
399
repository = branch.repository
401
for batch in log_rev_iterator:
404
step = [detail for _, detail in zip(range(num), batch)]
408
num = min(int(num * 1.5), 200)
411
def _get_mainline_revs(branch, start_revision, end_revision):
412
"""Get the mainline revisions from the branch.
414
Generates the list of mainline revisions for the branch.
416
:param branch: The branch containing the revisions.
418
:param start_revision: The first revision to be logged.
419
For backwards compatibility this may be a mainline integer revno,
420
but for merge revision support a RevisionInfo is expected.
422
:param end_revision: The last revision to be logged.
423
For backwards compatibility this may be a mainline integer revno,
424
but for merge revision support a RevisionInfo is expected.
426
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
428
branch_revno, branch_last_revision = branch.last_revision_info()
429
if branch_revno == 0:
430
return None, None, None, None
432
# For mainline generation, map start_revision and end_revision to
433
# mainline revnos. If the revision is not on the mainline choose the
434
# appropriate extreme of the mainline instead - the extra will be
436
# Also map the revisions to rev_ids, to be used in the later filtering
163
439
if start_revision is None:
165
elif start_revision < 1 or start_revision >= len(which_revs):
166
raise InvalidRevisionNumber(start_revision)
442
if isinstance(start_revision, revisionspec.RevisionInfo):
443
start_rev_id = start_revision.rev_id
444
start_revno = start_revision.revno or 1
446
branch.check_real_revno(start_revision)
447
start_revno = start_revision
168
450
if end_revision is None:
169
end_revision = len(which_revs)
170
elif end_revision < 1 or end_revision >= len(which_revs):
171
raise InvalidRevisionNumber(end_revision)
173
# list indexes are 0-based; revisions are 1-based
174
cut_revs = which_revs[(start_revision-1):(end_revision)]
176
if direction == 'reverse':
178
elif direction == 'forward':
451
end_revno = branch_revno
453
if isinstance(end_revision, revisionspec.RevisionInfo):
454
end_rev_id = end_revision.rev_id
455
end_revno = end_revision.revno or branch_revno
457
branch.check_real_revno(end_revision)
458
end_revno = end_revision
460
if ((start_rev_id == _mod_revision.NULL_REVISION)
461
or (end_rev_id == _mod_revision.NULL_REVISION)):
462
raise errors.BzrCommandError('Logging revision 0 is invalid.')
463
if start_revno > end_revno:
464
raise errors.BzrCommandError("Start revision must be older than "
467
if end_revno < start_revno:
468
return None, None, None, None
469
cur_revno = branch_revno
472
for revision_id in branch.repository.iter_reverse_revision_history(
473
branch_last_revision):
474
if cur_revno < start_revno:
475
# We have gone far enough, but we always add 1 more revision
476
rev_nos[revision_id] = cur_revno
477
mainline_revs.append(revision_id)
479
if cur_revno <= end_revno:
480
rev_nos[revision_id] = cur_revno
481
mainline_revs.append(revision_id)
484
# We walked off the edge of all revisions, so we add a 'None' marker
485
mainline_revs.append(None)
487
mainline_revs.reverse()
489
# override the mainline to look like the revision history.
490
return mainline_revs, rev_nos, start_rev_id, end_rev_id
493
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
494
"""Filter view_revisions based on revision ranges.
496
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
497
tuples to be filtered.
499
:param start_rev_id: If not NONE specifies the first revision to be logged.
500
If NONE then all revisions up to the end_rev_id are logged.
502
:param end_rev_id: If not NONE specifies the last revision to be logged.
503
If NONE then all revisions up to the end of the log are logged.
505
:return: The filtered view_revisions.
507
if start_rev_id or end_rev_id:
508
revision_ids = [r for r, n, d in view_revisions]
510
start_index = revision_ids.index(start_rev_id)
513
if start_rev_id == end_rev_id:
514
end_index = start_index
517
end_index = revision_ids.index(end_rev_id)
519
end_index = len(view_revisions) - 1
520
# To include the revisions merged into the last revision,
521
# extend end_rev_id down to, but not including, the next rev
522
# with the same or lesser merge_depth
523
end_merge_depth = view_revisions[end_index][2]
525
for index in xrange(end_index+1, len(view_revisions)+1):
526
if view_revisions[index][2] <= end_merge_depth:
527
end_index = index - 1
530
# if the search falls off the end then log to the end as well
531
end_index = len(view_revisions) - 1
532
view_revisions = view_revisions[start_index:end_index+1]
533
return view_revisions
536
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
537
include_merges=True):
538
r"""Return the list of revision ids which touch a given file id.
540
The function filters view_revisions and returns a subset.
541
This includes the revisions which directly change the file id,
542
and the revisions which merge these changes. So if the
554
And 'C' changes a file, then both C and D will be returned. F will not be
555
returned even though it brings the changes to C into the branch starting
556
with E. (Note that if we were using F as the tip instead of G, then we
559
This will also be restricted based on a subset of the mainline.
561
:param branch: The branch where we can get text revision information.
563
:param file_id: Filter out revisions that do not touch file_id.
565
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
566
tuples. This is the list of revisions which will be filtered. It is
567
assumed that view_revisions is in merge_sort order (i.e. newest
570
:param include_merges: include merge revisions in the result or not
572
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
574
# Lookup all possible text keys to determine which ones actually modified
576
text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
577
# Looking up keys in batches of 1000 can cut the time in half, as well as
578
# memory consumption. GraphIndex *does* like to look for a few keys in
579
# parallel, it just doesn't like looking for *lots* of keys in parallel.
580
# TODO: This code needs to be re-evaluated periodically as we tune the
581
# indexing layer. We might consider passing in hints as to the known
582
# access pattern (sparse/clustered, high success rate/low success
583
# rate). This particular access is clustered with a low success rate.
584
get_parent_map = branch.repository.texts.get_parent_map
585
modified_text_revisions = set()
587
for start in xrange(0, len(text_keys), chunk_size):
588
next_keys = text_keys[start:start + chunk_size]
589
# Only keep the revision_id portion of the key
590
modified_text_revisions.update(
591
[k[1] for k in get_parent_map(next_keys)])
592
del text_keys, next_keys
595
# Track what revisions will merge the current revision, replace entries
596
# with 'None' when they have been added to result
597
current_merge_stack = [None]
598
for info in view_revisions:
599
rev_id, revno, depth = info
600
if depth == len(current_merge_stack):
601
current_merge_stack.append(info)
603
del current_merge_stack[depth + 1:]
604
current_merge_stack[-1] = info
606
if rev_id in modified_text_revisions:
607
# This needs to be logged, along with the extra revisions
608
for idx in xrange(len(current_merge_stack)):
609
node = current_merge_stack[idx]
611
if include_merges or node[2] == 0:
613
current_merge_stack[idx] = None
617
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
618
include_merges=True):
619
"""Produce an iterator of revisions to show
620
:return: an iterator of (revision_id, revno, merge_depth)
621
(if there is no revno for a revision, None is supplied)
623
if not include_merges:
624
revision_ids = mainline_revs[1:]
625
if direction == 'reverse':
626
revision_ids.reverse()
627
for revision_id in revision_ids:
628
yield revision_id, str(rev_nos[revision_id]), 0
630
graph = branch.repository.get_graph()
631
# This asks for all mainline revisions, which means we only have to spider
632
# sideways, rather than depth history. That said, its still size-of-history
633
# and should be addressed.
634
# mainline_revisions always includes an extra revision at the beginning, so
636
parent_map = dict(((key, value) for key, value in
637
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
638
# filter out ghosts; merge_sort errors on ghosts.
639
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
640
merge_sorted_revisions = tsort.merge_sort(
646
if direction == 'forward':
647
# forward means oldest first.
648
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
649
elif direction != 'reverse':
181
650
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)
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())
652
for (sequence, rev_id, merge_depth, revno, end_of_merge
653
) in merge_sorted_revisions:
654
yield rev_id, '.'.join(map(str, revno)), merge_depth
657
def reverse_by_depth(merge_sorted_revisions, _depth=0):
658
"""Reverse revisions by depth.
660
Revisions with a different depth are sorted as a group with the previous
661
revision of that depth. There may be no topological justification for this,
662
but it looks much nicer.
664
# Add a fake revision at start so that we can always attach sub revisions
665
merge_sorted_revisions = [(None, None, _depth)] + merge_sorted_revisions
667
for val in merge_sorted_revisions:
669
# Each revision at the current depth becomes a chunk grouping all
670
# higher depth revisions.
671
zd_revisions.append([val])
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
673
zd_revisions[-1].append(val)
674
for revisions in zd_revisions:
675
if len(revisions) > 1:
676
# We have higher depth revisions, let reverse them locally
677
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
678
zd_revisions.reverse()
680
for chunk in zd_revisions:
683
# Top level call, get rid of the fake revisions that have been added
684
result = [r for r in result if r[0] is not None and r[1] is not None]
688
class LogRevision(object):
689
"""A revision to be logged (by LogFormatter.log_revision).
691
A simple wrapper for the attributes of a revision to be logged.
692
The attributes may or may not be populated, as determined by the
693
logging options and the log formatter capabilities.
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
696
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
700
self.merge_depth = merge_depth
287
705
class LogFormatter(object):
288
"""Abstract class to display log messages."""
289
def __init__(self, to_file, show_ids=False, show_timezone='original'):
706
"""Abstract class to display log messages.
708
At a minimum, a derived class must implement the log_revision method.
710
If the LogFormatter needs to be informed of the beginning or end of
711
a log it should implement the begin_log and/or end_log hook methods.
713
A LogFormatter should define the following supports_XXX flags
714
to indicate which LogRevision attributes it supports:
716
- supports_delta must be True if this log formatter supports delta.
717
Otherwise the delta attribute may not be populated. The 'delta_format'
718
attribute describes whether the 'short_status' format (1) or the long
719
one (2) sould be used.
721
- supports_merge_revisions must be True if this log formatter supports
722
merge revisions. If not, and if supports_single_merge_revisions is
723
also not True, then only mainline revisions will be passed to the
725
- supports_single_merge_revision must be True if this log formatter
726
supports logging only a single merge revision. This flag is
727
only relevant if supports_merge_revisions is not True.
728
- supports_tags must be True if this log formatter supports tags.
729
Otherwise the tags attribute may not be populated.
731
Plugins can register functions to show custom revision properties using
732
the properties_handler_registry. The registered function
733
must respect the following interface description:
734
def my_show_properties(properties_dict):
735
# code that returns a dict {'name':'value'} of the properties
739
def __init__(self, to_file, show_ids=False, show_timezone='original',
290
741
self.to_file = to_file
291
742
self.show_ids = show_ids
292
743
self.show_timezone = show_timezone
295
def show(self, revno, rev, delta):
296
raise NotImplementedError('not implemented in abstract base')
744
if delta_format is None:
745
# Ensures backward compatibility
746
delta_format = 2 # long format
747
self.delta_format = delta_format
749
# TODO: uncomment this block after show() has been removed.
750
# Until then defining log_revision would prevent _show_log calling show()
751
# in legacy formatters.
752
# def log_revision(self, revision):
755
# :param revision: The LogRevision to be logged.
757
# raise NotImplementedError('not implemented in abstract base')
759
def short_committer(self, rev):
760
name, address = config.parse_username(rev.committer)
765
def short_author(self, rev):
766
name, address = config.parse_username(rev.get_apparent_author())
771
def show_properties(self, revision, indent):
772
"""Displays the custom properties returned by each registered handler.
774
If a registered handler raises an error it is propagated.
776
for key, handler in properties_handler_registry.iteritems():
777
for key, value in handler(revision).items():
778
self.to_file.write(indent + key + ': ' + value + '\n')
303
781
class LongLogFormatter(LogFormatter):
304
def show(self, revno, rev, delta):
305
from osutils import format_date
783
supports_merge_revisions = True
784
supports_delta = True
787
def log_revision(self, revision):
788
"""Log a revision, either merged or not."""
789
indent = ' ' * revision.merge_depth
307
790
to_file = self.to_file
309
print >>to_file, '-' * 60
310
print >>to_file, 'revno:', revno
791
to_file.write(indent + '-' * 60 + '\n')
792
if revision.revno is not None:
793
to_file.write(indent + 'revno: %s\n' % (revision.revno,))
795
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
311
796
if self.show_ids:
312
print >>to_file, 'revision-id:', rev.revision_id
313
print >>to_file, 'committer:', rev.committer
315
date_str = format_date(rev.timestamp,
797
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
799
for parent_id in revision.rev.parent_ids:
800
to_file.write(indent + 'parent: %s\n' % (parent_id,))
801
self.show_properties(revision.rev, indent)
803
author = revision.rev.properties.get('author', None)
804
if author is not None:
805
to_file.write(indent + 'author: %s\n' % (author,))
806
to_file.write(indent + 'committer: %s\n' % (revision.rev.committer,))
808
branch_nick = revision.rev.properties.get('branch-nick', None)
809
if branch_nick is not None:
810
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
812
date_str = format_date(revision.rev.timestamp,
813
revision.rev.timezone or 0,
317
814
self.show_timezone)
318
print >>to_file, 'timestamp: %s' % date_str
815
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
320
print >>to_file, 'message:'
322
print >>to_file, ' (no message)'
817
to_file.write(indent + 'message:\n')
818
if not revision.rev.message:
819
to_file.write(indent + ' (no message)\n')
324
for l in rev.message.split('\n'):
325
print >>to_file, ' ' + l
328
delta.show(to_file, self.show_ids)
821
message = revision.rev.message.rstrip('\r\n')
822
for l in message.split('\n'):
823
to_file.write(indent + ' %s\n' % (l,))
824
if revision.delta is not None:
825
# We don't respect delta_format for compatibility
826
revision.delta.show(to_file, self.show_ids, indent=indent,
332
830
class ShortLogFormatter(LogFormatter):
333
def show(self, revno, rev, delta):
334
from bzrlib.osutils import format_date
832
supports_delta = True
834
supports_single_merge_revision = True
836
def log_revision(self, revision):
336
837
to_file = self.to_file
839
if len(revision.rev.parent_ids) > 1:
840
is_merge = ' [merge]'
843
tags = ' {%s}' % (', '.join(revision.tags))
338
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
339
format_date(rev.timestamp, rev.timezone or 0,
845
to_file.write("%5s %s\t%s%s%s\n" % (revision.revno,
846
self.short_author(revision.rev),
847
format_date(revision.rev.timestamp,
848
revision.rev.timezone or 0,
849
self.show_timezone, date_fmt="%Y-%m-%d",
341
852
if self.show_ids:
342
print >>to_file, ' revision-id:', rev.revision_id
853
to_file.write(' revision-id:%s\n'
854
% (revision.rev.revision_id,))
855
if not revision.rev.message:
856
to_file.write(' (no message)\n')
858
message = revision.rev.message.rstrip('\r\n')
859
for l in message.split('\n'):
860
to_file.write(' %s\n' % (l,))
862
if revision.delta is not None:
863
revision.delta.show(to_file, self.show_ids,
864
short_status=self.delta_format==1)
868
class LineLogFormatter(LogFormatter):
871
supports_single_merge_revision = True
873
def __init__(self, *args, **kwargs):
874
super(LineLogFormatter, self).__init__(*args, **kwargs)
875
self._max_chars = terminal_width() - 1
877
def truncate(self, str, max_len):
878
if len(str) <= max_len:
880
return str[:max_len-3]+'...'
882
def date_string(self, rev):
883
return format_date(rev.timestamp, rev.timezone or 0,
884
self.show_timezone, date_fmt="%Y-%m-%d",
887
def message(self, rev):
343
888
if not rev.message:
344
print >>to_file, ' (no message)'
889
return '(no message)'
346
for l in rev.message.split('\n'):
347
print >>to_file, ' ' + l
349
# TODO: Why not show the modified files in a shorter form as
350
# well? rewrap them single lines of appropriate length
352
delta.show(to_file, self.show_ids)
357
FORMATTERS = {'long': LongLogFormatter,
358
'short': ShortLogFormatter,
893
def log_revision(self, revision):
894
self.to_file.write(self.log_string(revision.revno, revision.rev,
895
self._max_chars, revision.tags))
896
self.to_file.write('\n')
898
def log_string(self, revno, rev, max_chars, tags=None):
899
"""Format log info into one string. Truncate tail of string
900
:param revno: revision number or None.
901
Revision numbers counts from 1.
902
:param rev: revision object
903
:param max_chars: maximum length of resulting string
904
:param tags: list of tags or None
905
:return: formatted truncated string
909
# show revno only when is not None
910
out.append("%s:" % revno)
911
out.append(self.truncate(self.short_author(rev), 20))
912
out.append(self.date_string(rev))
914
tag_str = '{%s}' % (', '.join(tags))
916
out.append(rev.get_summary())
917
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
920
def line_log(rev, max_chars):
921
lf = LineLogFormatter(None)
922
return lf.log_string(None, rev, max_chars)
925
class LogFormatterRegistry(registry.Registry):
926
"""Registry for log formatters"""
928
def make_formatter(self, name, *args, **kwargs):
929
"""Construct a formatter from arguments.
931
:param name: Name of the formatter to construct. 'short', 'long' and
934
return self.get(name)(*args, **kwargs)
936
def get_default(self, branch):
937
return self.get(branch.get_config().log_format())
940
log_formatter_registry = LogFormatterRegistry()
943
log_formatter_registry.register('short', ShortLogFormatter,
944
'Moderately short log format')
945
log_formatter_registry.register('long', LongLogFormatter,
946
'Detailed log format')
947
log_formatter_registry.register('line', LineLogFormatter,
948
'Log format with one line per revision')
951
def register_formatter(name, formatter):
952
log_formatter_registry.register(name, formatter)
362
955
def log_formatter(name, *args, **kwargs):
363
from bzrlib.errors import BzrCommandError
956
"""Construct a formatter from arguments.
958
name -- Name of the formatter to construct; currently 'long', 'short' and
959
'line' are supported.
366
return FORMATTERS[name](*args, **kwargs)
368
raise BzrCommandError("unknown log formatter: %r" % name)
962
return log_formatter_registry.make_formatter(name, *args, **kwargs)
964
raise errors.BzrCommandError("unknown log formatter: %r" % name)
370
967
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
371
# deprecated; for compatability
968
# deprecated; for compatibility
372
969
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
373
970
lf.show(revno, rev, delta)
973
def show_changed_revisions(branch, old_rh, new_rh, to_file=None,
975
"""Show the change in revision history comparing the old revision history to the new one.
977
:param branch: The branch where the revisions exist
978
:param old_rh: The old revision history
979
:param new_rh: The new revision history
980
:param to_file: A file to write the results to. If None, stdout will be used
983
to_file = codecs.getwriter(get_terminal_encoding())(sys.stdout,
985
lf = log_formatter(log_format,
988
show_timezone='original')
990
# This is the first index which is different between
993
for i in xrange(max(len(new_rh),
997
or new_rh[i] != old_rh[i]):
1001
if base_idx is None:
1002
to_file.write('Nothing seems to have changed\n')
1004
## TODO: It might be nice to do something like show_log
1005
## and show the merged entries. But since this is the
1006
## removed revisions, it shouldn't be as important
1007
if base_idx < len(old_rh):
1008
to_file.write('*'*60)
1009
to_file.write('\nRemoved Revisions:\n')
1010
for i in range(base_idx, len(old_rh)):
1011
rev = branch.repository.get_revision(old_rh[i])
1012
lr = LogRevision(rev, i+1, 0, None)
1014
to_file.write('*'*60)
1015
to_file.write('\n\n')
1016
if base_idx < len(new_rh):
1017
to_file.write('Added Revisions:\n')
1022
direction='forward',
1023
start_revision=base_idx+1,
1024
end_revision=len(new_rh),
1028
def get_history_change(old_revision_id, new_revision_id, repository):
1029
"""Calculate the uncommon lefthand history between two revisions.
1031
:param old_revision_id: The original revision id.
1032
:param new_revision_id: The new revision id.
1033
:param repository: The repository to use for the calculation.
1035
return old_history, new_history
1038
old_revisions = set()
1040
new_revisions = set()
1041
new_iter = repository.iter_reverse_revision_history(new_revision_id)
1042
old_iter = repository.iter_reverse_revision_history(old_revision_id)
1043
stop_revision = None
1046
while do_new or do_old:
1049
new_revision = new_iter.next()
1050
except StopIteration:
1053
new_history.append(new_revision)
1054
new_revisions.add(new_revision)
1055
if new_revision in old_revisions:
1056
stop_revision = new_revision
1060
old_revision = old_iter.next()
1061
except StopIteration:
1064
old_history.append(old_revision)
1065
old_revisions.add(old_revision)
1066
if old_revision in new_revisions:
1067
stop_revision = old_revision
1069
new_history.reverse()
1070
old_history.reverse()
1071
if stop_revision is not None:
1072
new_history = new_history[new_history.index(stop_revision) + 1:]
1073
old_history = old_history[old_history.index(stop_revision) + 1:]
1074
return old_history, new_history
1077
def show_branch_change(branch, output, old_revno, old_revision_id):
1078
"""Show the changes made to a branch.
1080
:param branch: The branch to show changes about.
1081
:param output: A file-like object to write changes to.
1082
:param old_revno: The revno of the old tip.
1083
:param old_revision_id: The revision_id of the old tip.
1085
new_revno, new_revision_id = branch.last_revision_info()
1086
old_history, new_history = get_history_change(old_revision_id,
1089
if old_history == [] and new_history == []:
1090
output.write('Nothing seems to have changed\n')
1093
log_format = log_formatter_registry.get_default(branch)
1094
lf = log_format(show_ids=False, to_file=output, show_timezone='original')
1095
if old_history != []:
1096
output.write('*'*60)
1097
output.write('\nRemoved Revisions:\n')
1098
show_flat_log(branch.repository, old_history, old_revno, lf)
1099
output.write('*'*60)
1100
output.write('\n\n')
1101
if new_history != []:
1102
output.write('Added Revisions:\n')
1103
start_revno = new_revno - len(new_history) + 1
1104
show_log(branch, lf, None, verbose=False, direction='forward',
1105
start_revision=start_revno,)
1108
def show_flat_log(repository, history, last_revno, lf):
1109
"""Show a simple log of the specified history.
1111
:param repository: The repository to retrieve revisions from.
1112
:param history: A list of revision_ids indicating the lefthand history.
1113
:param last_revno: The revno of the last revision_id in the history.
1114
:param lf: The log formatter to use.
1116
start_revno = last_revno - len(history) + 1
1117
revisions = repository.get_revisions(history)
1118
for i, rev in enumerate(revisions):
1119
lr = LogRevision(rev, i + last_revno, 0, None)
1123
properties_handler_registry = registry.Registry()
1124
properties_handler_registry.register_lazy("foreign",
1126
"show_foreign_properties")
1129
# adapters which revision ids to log are filtered. When log is called, the
1130
# log_rev_iterator is adapted through each of these factory methods.
1131
# Plugins are welcome to mutate this list in any way they like - as long
1132
# as the overall behaviour is preserved. At this point there is no extensible
1133
# mechanism for getting parameters to each factory method, and until there is
1134
# this won't be considered a stable api.
1138
# read revision objects
1139
_make_revision_objects,
1140
# filter on log messages
1141
_make_search_filter,
1142
# generate deltas for things we will show
added
removed
bzrlib/log.py
