← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Robert Collins
  • Date: 2005-08-25 01:13:32 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050825011331-6d549d5de7edcec1
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list

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
 
 
55
 
import bzrlib.errors as errors
56
53
from bzrlib.tree import EmptyTree
57
54
from bzrlib.delta import compare_trees
58
55
from bzrlib.trace import mutter
59
 
import re
 
56
from bzrlib.errors import InvalidRevisionNumber
60
57
 
61
58
 
62
59
def find_touching_revisions(branch, file_id):
74
71
    last_path = None
75
72
    revno = 1
76
73
    for revision_id in branch.revision_history():
77
 
        this_inv = branch.repository.get_revision_inventory(revision_id)
 
74
        this_inv = branch.get_revision_inventory(revision_id)
78
75
        if file_id in this_inv:
79
76
            this_ie = this_inv[file_id]
80
77
            this_path = this_inv.id2path(file_id)
113
110
    return rh
114
111
 
115
112
 
116
 
def _get_revision_delta(branch, revno):
117
 
    """Return the delta for a mainline revision.
118
 
    
119
 
    This is used to show summaries in verbose logs, and also for finding 
120
 
    revisions which touch a given file."""
121
 
    # XXX: What are we supposed to do when showing a summary for something 
122
 
    # other than a mainline revision.  The delta to it's first parent, or
123
 
    # (more useful) the delta to a nominated other revision.
124
 
    return branch.get_revision_delta(revno)
125
 
 
126
 
 
127
113
def show_log(branch,
128
114
             lf,
129
115
             specific_fileid=None,
154
140
    end_revision
155
141
        If not None, only show revisions <= end_revision
156
142
    """
157
 
    branch.lock_read()
158
 
    try:
159
 
        _show_log(branch, lf, specific_fileid, verbose, direction,
160
 
                  start_revision, end_revision, search)
161
 
    finally:
162
 
        branch.unlock()
163
 
    
164
 
def _show_log(branch,
165
 
             lf,
166
 
             specific_fileid=None,
167
 
             verbose=False,
168
 
             direction='reverse',
169
 
             start_revision=None,
170
 
             end_revision=None,
171
 
             search=None):
172
 
    """Worker function for show_log - see show_log."""
173
143
    from bzrlib.osutils import format_date
174
144
    from bzrlib.errors import BzrCheckError
175
145
    from bzrlib.textui import show_status
180
150
        warn("not a LogFormatter instance: %r" % lf)
181
151
 
182
152
    if specific_fileid:
183
 
        mutter('get log for file_id %r', specific_fileid)
 
153
        mutter('get log for file_id %r' % specific_fileid)
184
154
 
185
155
    if search is not None:
186
156
        import re
192
162
    
193
163
    if start_revision is None:
194
164
        start_revision = 1
195
 
    else:
196
 
        branch.check_real_revno(start_revision)
 
165
    elif start_revision < 1 or start_revision >= len(which_revs):
 
166
        raise InvalidRevisionNumber(start_revision)
197
167
    
198
168
    if end_revision is None:
199
169
        end_revision = len(which_revs)
200
 
    else:
201
 
        branch.check_real_revno(end_revision)
 
170
    elif end_revision < 1 or end_revision >= len(which_revs):
 
171
        raise InvalidRevisionNumber(end_revision)
202
172
 
203
173
    # list indexes are 0-based; revisions are 1-based
204
174
    cut_revs = which_revs[(start_revision-1):(end_revision)]
210
180
    else:
211
181
        raise ValueError('invalid direction %r' % direction)
212
182
 
213
 
    revision_history = branch.revision_history()
214
183
    for revno, rev_id in cut_revs:
215
184
        if verbose or specific_fileid:
216
 
            delta = _get_revision_delta(branch, revno)
 
185
            delta = branch.get_revision_delta(revno)
217
186
            
218
187
        if specific_fileid:
219
188
            if not delta.touches_file_id(specific_fileid):
223
192
            # although we calculated it, throw it away without display
224
193
            delta = None
225
194
 
226
 
        rev = branch.repository.get_revision(rev_id)
 
195
        rev = branch.get_revision(rev_id)
227
196
 
228
197
        if searchRE:
229
198
            if not searchRE.search(rev.message):
230
199
                continue
231
200
 
232
201
        lf.show(revno, rev, delta)
233
 
        if hasattr(lf, 'show_merge'):
234
 
            if revno == 1:
235
 
                excludes = set()
236
 
            else:
237
 
                # revno is 1 based, so -2 to get back 1 less.
238
 
                repository = branch.repository
239
 
                excludes = repository.get_ancestry(revision_history[revno - 2])
240
 
                excludes = set(excludes)
241
 
            pending = list(rev.parent_ids)
242
 
            while pending:
243
 
                rev_id = pending.pop()
244
 
                if rev_id in excludes:
245
 
                    continue
246
 
                # prevent showing merged revs twice if they multi-path.
247
 
                excludes.add(rev_id)
248
 
                try:
249
 
                    rev = branch.repository.get_revision(rev_id)
250
 
                except errors.NoSuchRevision:
251
 
                    continue
252
 
                pending.extend(rev.parent_ids)
253
 
                lf.show_merge(rev)
 
202
 
254
203
 
255
204
 
256
205
def deltas_for_log_dummy(branch, which_revs):
345
294
 
346
295
    def show(self, revno, rev, delta):
347
296
        raise NotImplementedError('not implemented in abstract base')
348
 
 
349
 
    def short_committer(self, rev):
350
 
        return re.sub('<.*@.*>', '', rev.committer).strip(' ')
351
 
    
352
 
    
 
297
        
 
298
 
 
299
 
 
300
 
 
301
 
 
302
 
353
303
class LongLogFormatter(LogFormatter):
354
304
    def show(self, revno, rev, delta):
355
 
        return self._show_helper(revno=revno, rev=rev, delta=delta)
356
 
 
357
 
    def show_merge(self, rev):
358
 
        return self._show_helper(rev=rev, indent='    ', merged=True, delta=None)
359
 
 
360
 
    def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
361
 
        """Show a revision, either merged or not."""
362
 
        from bzrlib.osutils import format_date
 
305
        from osutils import format_date
 
306
 
363
307
        to_file = self.to_file
364
 
        print >>to_file,  indent+'-' * 60
365
 
        if revno is not None:
366
 
            print >>to_file,  'revno:', revno
367
 
        if merged:
368
 
            print >>to_file,  indent+'merged:', rev.revision_id
369
 
        elif self.show_ids:
370
 
            print >>to_file,  indent+'revision-id:', rev.revision_id
 
308
 
 
309
        print >>to_file,  '-' * 60
 
310
        print >>to_file,  'revno:', revno
371
311
        if self.show_ids:
372
 
            for parent_id in rev.parent_ids:
373
 
                print >>to_file, indent+'parent:', parent_id
374
 
        print >>to_file,  indent+'committer:', rev.committer
375
 
        try:
376
 
            print >>to_file, indent+'branch nick: %s' % \
377
 
                rev.properties['branch-nick']
378
 
        except KeyError:
379
 
            pass
 
312
            print >>to_file,  'revision-id:', rev.revision_id
 
313
        print >>to_file,  'committer:', rev.committer
 
314
 
380
315
        date_str = format_date(rev.timestamp,
381
316
                               rev.timezone or 0,
382
317
                               self.show_timezone)
383
 
        print >>to_file,  indent+'timestamp: %s' % date_str
 
318
        print >>to_file,  'timestamp: %s' % date_str
384
319
 
385
 
        print >>to_file,  indent+'message:'
 
320
        print >>to_file,  'message:'
386
321
        if not rev.message:
387
 
            print >>to_file,  indent+'  (no message)'
 
322
            print >>to_file,  '  (no message)'
388
323
        else:
389
 
            message = rev.message.rstrip('\r\n')
390
 
            for l in message.split('\n'):
391
 
                print >>to_file,  indent+'  ' + l
 
324
            for l in rev.message.split('\n'):
 
325
                print >>to_file,  '  ' + l
 
326
 
392
327
        if delta != None:
393
328
            delta.show(to_file, self.show_ids)
394
329
 
395
330
 
 
331
 
396
332
class ShortLogFormatter(LogFormatter):
397
333
    def show(self, revno, rev, delta):
398
334
        from bzrlib.osutils import format_date
399
335
 
400
336
        to_file = self.to_file
401
 
        date_str = format_date(rev.timestamp, rev.timezone or 0,
402
 
                            self.show_timezone)
403
 
        print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
 
337
 
 
338
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
404
339
                format_date(rev.timestamp, rev.timezone or 0,
405
 
                            self.show_timezone, date_fmt="%Y-%m-%d",
406
 
                           show_offset=False))
 
340
                            self.show_timezone))
407
341
        if self.show_ids:
408
342
            print >>to_file,  '      revision-id:', rev.revision_id
409
343
        if not rev.message:
410
344
            print >>to_file,  '      (no message)'
411
345
        else:
412
 
            message = rev.message.rstrip('\r\n')
413
 
            for l in message.split('\n'):
 
346
            for l in rev.message.split('\n'):
414
347
                print >>to_file,  '      ' + l
415
348
 
416
349
        # TODO: Why not show the modified files in a shorter form as
417
350
        # well? rewrap them single lines of appropriate length
418
351
        if delta != None:
419
352
            delta.show(to_file, self.show_ids)
420
 
        print >>to_file, ''
421
 
 
422
 
class LineLogFormatter(LogFormatter):
423
 
    def truncate(self, str, max_len):
424
 
        if len(str) <= max_len:
425
 
            return str
426
 
        return str[:max_len-3]+'...'
427
 
 
428
 
    def date_string(self, rev):
429
 
        from bzrlib.osutils import format_date
430
 
        return format_date(rev.timestamp, rev.timezone or 0, 
431
 
                           self.show_timezone, date_fmt="%Y-%m-%d",
432
 
                           show_offset=False)
433
 
 
434
 
    def message(self, rev):
435
 
        if not rev.message:
436
 
            return '(no message)'
437
 
        else:
438
 
            return rev.message
439
 
 
440
 
    def show(self, revno, rev, delta):
441
 
        print >> self.to_file, self.log_string(rev, 79) 
442
 
 
443
 
    def log_string(self, rev, max_chars):
444
 
        out = [self.truncate(self.short_committer(rev), 20)]
445
 
        out.append(self.date_string(rev))
446
 
        out.append(self.message(rev).replace('\n', ' '))
447
 
        return self.truncate(" ".join(out).rstrip('\n'), max_chars)
448
 
 
449
 
def line_log(rev, max_chars):
450
 
    lf = LineLogFormatter(None)
451
 
    return lf.log_string(rev, max_chars)
 
353
        print
 
354
 
 
355
 
452
356
 
453
357
FORMATTERS = {'long': LongLogFormatter,
454
358
              'short': ShortLogFormatter,
455
 
              'line': LineLogFormatter,
456
359
              }
457
360
 
458
361
 
459
362
def log_formatter(name, *args, **kwargs):
460
 
    """Construct a formatter from arguments.
461
 
 
462
 
    name -- Name of the formatter to construct; currently 'long', 'short' and
463
 
        'line' are supported.
464
 
    """
465
363
    from bzrlib.errors import BzrCommandError
 
364
    
466
365
    try:
467
366
        return FORMATTERS[name](*args, **kwargs)
468
367
    except IndexError:
472
371
    # deprecated; for compatability
473
372
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
474
373
    lf.show(revno, rev, delta)
475
 
 
476
 
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
477
 
    """Show the change in revision history comparing the old revision history to the new one.
478
 
 
479
 
    :param branch: The branch where the revisions exist
480
 
    :param old_rh: The old revision history
481
 
    :param new_rh: The new revision history
482
 
    :param to_file: A file to write the results to. If None, stdout will be used
483
 
    """
484
 
    if to_file is None:
485
 
        import sys
486
 
        import codecs
487
 
        import bzrlib
488
 
        to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
489
 
    lf = log_formatter(log_format,
490
 
                       show_ids=False,
491
 
                       to_file=to_file,
492
 
                       show_timezone='original')
493
 
 
494
 
    # This is the first index which is different between
495
 
    # old and new
496
 
    base_idx = None
497
 
    for i in xrange(max(len(new_rh),
498
 
                        len(old_rh))):
499
 
        if (len(new_rh) <= i
500
 
            or len(old_rh) <= i
501
 
            or new_rh[i] != old_rh[i]):
502
 
            base_idx = i
503
 
            break
504
 
 
505
 
    if base_idx is None:
506
 
        to_file.write('Nothing seems to have changed\n')
507
 
        return
508
 
    ## TODO: It might be nice to do something like show_log
509
 
    ##       and show the merged entries. But since this is the
510
 
    ##       removed revisions, it shouldn't be as important
511
 
    if base_idx < len(old_rh):
512
 
        to_file.write('*'*60)
513
 
        to_file.write('\nRemoved Revisions:\n')
514
 
        for i in range(base_idx, len(old_rh)):
515
 
            rev = branch.repository.get_revision(old_rh[i])
516
 
            lf.show(i+1, rev, None)
517
 
        to_file.write('*'*60)
518
 
        to_file.write('\n\n')
519
 
    if base_idx < len(new_rh):
520
 
        to_file.write('Added Revisions:\n')
521
 
        show_log(branch,
522
 
                 lf,
523
 
                 None,
524
 
                 verbose=True,
525
 
                 direction='forward',
526
 
                 start_revision=base_idx+1,
527
 
                 end_revision=len(new_rh),
528
 
                 search=None)
529