← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

- refactor handling of short option names

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/log.py
50
50
"""
51
51
 
52
52
 
53
 
# TODO: option to show delta summaries for merged-in revisions
54
 
import re
55
 
 
 
53
import bzrlib.errors as errors
 
54
from bzrlib.tree import EmptyTree
56
55
from bzrlib.delta import compare_trees
57
 
import bzrlib.errors as errors
58
56
from bzrlib.trace import mutter
59
 
from bzrlib.tree import EmptyTree
60
 
from bzrlib.tsort import merge_sort
61
57
 
62
58
 
63
59
def find_touching_revisions(branch, file_id):
75
71
    last_path = None
76
72
    revno = 1
77
73
    for revision_id in branch.revision_history():
78
 
        this_inv = branch.repository.get_revision_inventory(revision_id)
 
74
        this_inv = branch.get_revision_inventory(revision_id)
79
75
        if file_id in this_inv:
80
76
            this_ie = this_inv[file_id]
81
77
            this_path = this_inv.id2path(file_id)
181
177
        warn("not a LogFormatter instance: %r" % lf)
182
178
 
183
179
    if specific_fileid:
184
 
        mutter('get log for file_id %r', specific_fileid)
 
180
        mutter('get log for file_id %r' % specific_fileid)
185
181
 
186
182
    if search is not None:
187
183
        import re
203
199
 
204
200
    # list indexes are 0-based; revisions are 1-based
205
201
    cut_revs = which_revs[(start_revision-1):(end_revision)]
206
 
    if not cut_revs:
207
 
        return
208
 
    # override the mainline to look like the revision history.
209
 
    mainline_revs = [revision_id for index, revision_id in cut_revs]
210
 
    if cut_revs[0][0] == 1:
211
 
        mainline_revs.insert(0, None)
212
 
    else:
213
 
        mainline_revs.insert(0, which_revs[start_revision-2][1])
214
 
 
215
 
    merge_sorted_revisions = merge_sort(
216
 
        branch.repository.get_revision_graph(mainline_revs[-1]),
217
 
        mainline_revs[-1],
218
 
        mainline_revs)
219
202
 
220
203
    if direction == 'reverse':
221
204
        cut_revs.reverse()
222
205
    elif direction == 'forward':
223
 
        # forward means oldest first.
224
 
        merge_sorted_revisions.reverse()
 
206
        pass
225
207
    else:
226
208
        raise ValueError('invalid direction %r' % direction)
227
209
 
228
210
    revision_history = branch.revision_history()
229
 
 
230
 
    # convert the revision history to a dictionary:
231
 
    rev_nos = {}
232
 
    for index, rev_id in cut_revs:
233
 
        rev_nos[rev_id] = index
234
 
 
235
 
    # now we just print all the revisions
236
 
    for sequence, rev_id, merge_depth, end_of_merge in merge_sorted_revisions:
237
 
        rev = branch.repository.get_revision(rev_id)
 
211
    for revno, rev_id in cut_revs:
 
212
        if verbose or specific_fileid:
 
213
            delta = _get_revision_delta(branch, revno)
 
214
            
 
215
        if specific_fileid:
 
216
            if not delta.touches_file_id(specific_fileid):
 
217
                continue
 
218
 
 
219
        if not verbose:
 
220
            # although we calculated it, throw it away without display
 
221
            delta = None
 
222
 
 
223
        rev = branch.get_revision(rev_id)
238
224
 
239
225
        if searchRE:
240
226
            if not searchRE.search(rev.message):
241
227
                continue
242
228
 
243
 
        if merge_depth == 0:
244
 
            # a mainline revision.
245
 
            if verbose or specific_fileid:
246
 
                delta = _get_revision_delta(branch, rev_nos[rev_id])
247
 
                
248
 
            if specific_fileid:
249
 
                if not delta.touches_file_id(specific_fileid):
250
 
                    continue
251
 
    
252
 
            if not verbose:
253
 
                # although we calculated it, throw it away without display
254
 
                delta = None
255
 
 
256
 
            lf.show(rev_nos[rev_id], rev, delta)
257
 
        elif hasattr(lf, 'show_merge'):
258
 
            lf.show_merge(rev, merge_depth)
 
229
        lf.show(revno, rev, delta)
 
230
        if revno == 1:
 
231
            excludes = set()
 
232
        else:
 
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)
 
236
        while pending:
 
237
            rev_id = pending.pop()
 
238
            if rev_id in excludes:
 
239
                continue
 
240
            # prevent showing merged revs twice if they multi-path.
 
241
            excludes.add(rev_id)
 
242
            try:
 
243
                rev = branch.get_revision(rev_id)
 
244
            except errors.NoSuchRevision:
 
245
                continue
 
246
            pending.extend(rev.parent_ids)
 
247
            lf.show_merge(rev)
259
248
 
260
249
 
261
250
def deltas_for_log_dummy(branch, which_revs):
351
340
    def show(self, revno, rev, delta):
352
341
        raise NotImplementedError('not implemented in abstract base')
353
342
 
354
 
    def short_committer(self, rev):
355
 
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
356
 
    
 
343
    def show_merge(self, rev):
 
344
        pass
 
345
 
357
346
    
358
347
class LongLogFormatter(LogFormatter):
359
348
    def show(self, revno, rev, delta):
360
 
        return self._show_helper(revno=revno, rev=rev, delta=delta)
361
 
 
362
 
    def show_merge(self, rev, merge_depth):
363
 
        return self._show_helper(rev=rev, indent='    '*merge_depth, merged=True, delta=None)
364
 
 
365
 
    def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
366
 
        """Show a revision, either merged or not."""
367
 
        from bzrlib.osutils import format_date
368
 
        to_file = self.to_file
 
349
        from osutils import format_date
 
350
 
 
351
        to_file = self.to_file
 
352
 
 
353
        print >>to_file,  '-' * 60
 
354
        print >>to_file,  'revno:', revno
 
355
        if self.show_ids:
 
356
            print >>to_file,  'revision-id:', rev.revision_id
 
357
 
 
358
            for parent_id in rev.parent_ids:
 
359
                print >>to_file, 'parent:', parent_id
 
360
            
 
361
        print >>to_file,  'committer:', rev.committer
 
362
 
 
363
        date_str = format_date(rev.timestamp,
 
364
                               rev.timezone or 0,
 
365
                               self.show_timezone)
 
366
        print >>to_file,  'timestamp: %s' % date_str
 
367
 
 
368
        print >>to_file,  'message:'
 
369
        if not rev.message:
 
370
            print >>to_file,  '  (no message)'
 
371
        else:
 
372
            for l in rev.message.split('\n'):
 
373
                print >>to_file,  '  ' + l
 
374
 
 
375
        if delta != None:
 
376
            delta.show(to_file, self.show_ids)
 
377
 
 
378
    def show_merge(self, rev):
 
379
        from osutils import format_date
 
380
 
 
381
        to_file = self.to_file
 
382
 
 
383
        indent = '    '
 
384
 
369
385
        print >>to_file,  indent+'-' * 60
370
 
        if revno is not None:
371
 
            print >>to_file,  'revno:', revno
372
 
        if merged:
373
 
            print >>to_file,  indent+'merged:', rev.revision_id
374
 
        elif self.show_ids:
375
 
            print >>to_file,  indent+'revision-id:', rev.revision_id
 
386
        print >>to_file,  indent+'merged:', rev.revision_id
376
387
        if self.show_ids:
377
388
            for parent_id in rev.parent_ids:
378
389
                print >>to_file, indent+'parent:', parent_id
 
390
            
379
391
        print >>to_file,  indent+'committer:', rev.committer
380
 
        try:
381
 
            print >>to_file, indent+'branch nick: %s' % \
382
 
                rev.properties['branch-nick']
383
 
        except KeyError:
384
 
            pass
 
392
 
385
393
        date_str = format_date(rev.timestamp,
386
394
                               rev.timezone or 0,
387
395
                               self.show_timezone)
391
399
        if not rev.message:
392
400
            print >>to_file,  indent+'  (no message)'
393
401
        else:
394
 
            message = rev.message.rstrip('\r\n')
395
 
            for l in message.split('\n'):
 
402
            for l in rev.message.split('\n'):
396
403
                print >>to_file,  indent+'  ' + l
397
 
        if delta != None:
398
 
            delta.show(to_file, self.show_ids)
399
404
 
400
405
 
401
406
class ShortLogFormatter(LogFormatter):
403
408
        from bzrlib.osutils import format_date
404
409
 
405
410
        to_file = self.to_file
406
 
        date_str = format_date(rev.timestamp, rev.timezone or 0,
407
 
                            self.show_timezone)
408
 
        print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
 
411
 
 
412
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
409
413
                format_date(rev.timestamp, rev.timezone or 0,
410
 
                            self.show_timezone, date_fmt="%Y-%m-%d",
411
 
                           show_offset=False))
 
414
                            self.show_timezone))
412
415
        if self.show_ids:
413
416
            print >>to_file,  '      revision-id:', rev.revision_id
414
417
        if not rev.message:
415
418
            print >>to_file,  '      (no message)'
416
419
        else:
417
 
            message = rev.message.rstrip('\r\n')
418
 
            for l in message.split('\n'):
 
420
            for l in rev.message.split('\n'):
419
421
                print >>to_file,  '      ' + l
420
422
 
421
423
        # TODO: Why not show the modified files in a shorter form as
422
424
        # well? rewrap them single lines of appropriate length
423
425
        if delta != None:
424
426
            delta.show(to_file, self.show_ids)
425
 
        print >>to_file, ''
426
 
 
427
 
class LineLogFormatter(LogFormatter):
428
 
    def truncate(self, str, max_len):
429
 
        if len(str) <= max_len:
430
 
            return str
431
 
        return str[:max_len-3]+'...'
432
 
 
433
 
    def date_string(self, rev):
434
 
        from bzrlib.osutils import format_date
435
 
        return format_date(rev.timestamp, rev.timezone or 0, 
436
 
                           self.show_timezone, date_fmt="%Y-%m-%d",
437
 
                           show_offset=False)
438
 
 
439
 
    def message(self, rev):
440
 
        if not rev.message:
441
 
            return '(no message)'
442
 
        else:
443
 
            return rev.message
444
 
 
445
 
    def show(self, revno, rev, delta):
446
 
        print >> self.to_file, self.log_string(rev, 79) 
447
 
 
448
 
    def log_string(self, rev, max_chars):
449
 
        out = [self.truncate(self.short_committer(rev), 20)]
450
 
        out.append(self.date_string(rev))
451
 
        out.append(self.message(rev).replace('\n', ' '))
452
 
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
453
 
 
454
 
def line_log(rev, max_chars):
455
 
    lf = LineLogFormatter(None)
456
 
    return lf.log_string(rev, max_chars)
457
 
 
458
 
FORMATTERS = {
459
 
              'long': LongLogFormatter,
 
427
        print
 
428
 
 
429
 
 
430
 
 
431
FORMATTERS = {'long': LongLogFormatter,
460
432
              'short': ShortLogFormatter,
461
 
              'line': LineLogFormatter,
462
433
              }
463
434
 
464
 
def register_formatter(name, formatter):
465
 
    FORMATTERS[name] = formatter
466
435
 
467
436
def log_formatter(name, *args, **kwargs):
468
437
    """Construct a formatter from arguments.
469
438
 
470
 
    name -- Name of the formatter to construct; currently 'long', 'short' and
471
 
        'line' are supported.
 
439
    name -- Name of the formatter to construct; currently 'long' and
 
440
        'short' are supported.
472
441
    """
473
442
    from bzrlib.errors import BzrCommandError
474
443
    try:
475
444
        return FORMATTERS[name](*args, **kwargs)
476
 
    except KeyError:
 
445
    except IndexError:
477
446
        raise BzrCommandError("unknown log formatter: %r" % name)
478
447
 
479
448
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
480
449
    # deprecated; for compatability
481
450
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
482
451
    lf.show(revno, rev, delta)
483
 
 
484
 
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
485
 
    """Show the change in revision history comparing the old revision history to the new one.
486
 
 
487
 
    :param branch: The branch where the revisions exist
488
 
    :param old_rh: The old revision history
489
 
    :param new_rh: The new revision history
490
 
    :param to_file: A file to write the results to. If None, stdout will be used
491
 
    """
492
 
    if to_file is None:
493
 
        import sys
494
 
        import codecs
495
 
        import bzrlib
496
 
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
497
 
    lf = log_formatter(log_format,
498
 
                       show_ids=False,
499
 
                       to_file=to_file,
500
 
                       show_timezone='original')
501
 
 
502
 
    # This is the first index which is different between
503
 
    # old and new
504
 
    base_idx = None
505
 
    for i in xrange(max(len(new_rh),
506
 
                        len(old_rh))):
507
 
        if (len(new_rh) <= i
508
 
            or len(old_rh) <= i
509
 
            or new_rh[i] != old_rh[i]):
510
 
            base_idx = i
511
 
            break
512
 
 
513
 
    if base_idx is None:
514
 
        to_file.write('Nothing seems to have changed\n')
515
 
        return
516
 
    ## TODO: It might be nice to do something like show_log
517
 
    ##       and show the merged entries. But since this is the
518
 
    ##       removed revisions, it shouldn't be as important
519
 
    if base_idx < len(old_rh):
520
 
        to_file.write('*'*60)
521
 
        to_file.write('\nRemoved Revisions:\n')
522
 
        for i in range(base_idx, len(old_rh)):
523
 
            rev = branch.repository.get_revision(old_rh[i])
524
 
            lf.show(i+1, rev, None)
525
 
        to_file.write('*'*60)
526
 
        to_file.write('\n\n')
527
 
    if base_idx < len(new_rh):
528
 
        to_file.write('Added Revisions:\n')
529
 
        show_log(branch,
530
 
                 lf,
531
 
                 None,
532
 
                 verbose=True,
533
 
                 direction='forward',
534
 
                 start_revision=base_idx+1,
535
 
                 end_revision=len(new_rh),
536
 
                 search=None)
537