~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Martin Pool
  • Date: 2005-06-15 04:24:01 UTC
  • Revision ID: mbp@sourcefrog.net-20050615042401-02a29d106bece661
add-bzr-to-baz allows multiple arguments

Show diffs side-by-side

added added

removed removed

Lines of Context:
28
28
 
29
29
* with file-ids and revision-ids shown
30
30
 
31
 
Logs are actually written out through an abstract LogFormatter
32
 
interface, which allows for different preferred formats.  Plugins can
33
 
register formats too.
34
 
 
35
 
Logs can be produced in either forward (oldest->newest) or reverse
36
 
(newest->oldest) order.
37
 
 
38
 
Logs can be filtered to show only revisions matching a particular
39
 
search string, or within a particular range of revisions.  The range
40
 
can be given as date/times, which are reduced to revisions before
41
 
calling in here.
42
 
 
43
 
In verbose mode we show a summary of what changed in each particular
44
 
revision.  Note that this is the delta for changes in that revision
45
 
relative to its mainline parent, not the delta relative to the last
46
 
logged revision.  So for example if you ask for a verbose log of
47
 
changes touching hello.c you will get a list of those revisions also
48
 
listing other things that were changed in the same revision, but not
49
 
all the changes since the previous revision that touched hello.c.
 
31
* from last to first or (not anymore) from first to last;
 
32
  the default is "reversed" because it shows the likely most
 
33
  relevant and interesting information first
 
34
 
 
35
* (not yet) in XML format
50
36
"""
51
37
 
52
38
 
53
 
from bzrlib.tree import EmptyTree
54
 
from bzrlib.delta import compare_trees
55
 
from bzrlib.trace import mutter
56
 
 
 
39
from trace import mutter
57
40
 
58
41
def find_touching_revisions(branch, file_id):
59
42
    """Yield a description of revisions which affect the file_id.
100
83
 
101
84
 
102
85
 
103
 
def _enumerate_history(branch):
104
 
    rh = []
105
 
    revno = 1
106
 
    for rev_id in branch.revision_history():
107
 
        rh.append((revno, rev_id))
108
 
        revno += 1
109
 
    return rh
110
 
 
111
 
 
112
86
def show_log(branch,
113
 
             lf,
114
87
             specific_fileid=None,
 
88
             show_timezone='original',
115
89
             verbose=False,
 
90
             show_ids=False,
 
91
             to_file=None,
116
92
             direction='reverse',
117
93
             start_revision=None,
118
 
             end_revision=None,
119
 
             search=None):
 
94
             end_revision=None):
120
95
    """Write out human-readable log of commits to this branch.
121
96
 
122
 
    lf
123
 
        LogFormatter object to show the output.
124
 
 
125
97
    specific_fileid
126
98
        If true, list only the commits affecting the specified
127
99
        file, rather than all commits.
128
100
 
 
101
    show_timezone
 
102
        'original' (committer's timezone),
 
103
        'utc' (universal time), or
 
104
        'local' (local user's timezone)
 
105
 
129
106
    verbose
130
107
        If true show added/changed/deleted/renamed files.
131
108
 
 
109
    show_ids
 
110
        If true, show revision and file ids.
 
111
 
 
112
    to_file
 
113
        File to send log to; by default stdout.
 
114
 
132
115
    direction
133
116
        'reverse' (default) is latest to earliest;
134
117
        'forward' is earliest to latest.
139
122
    end_revision
140
123
        If not None, only show revisions <= end_revision
141
124
    """
142
 
    from bzrlib.osutils import format_date
143
 
    from bzrlib.errors import BzrCheckError
144
 
    from bzrlib.textui import show_status
145
 
    
146
 
    from warnings import warn
 
125
    from osutils import format_date
 
126
    from errors import BzrCheckError
 
127
    from textui import show_status
147
128
 
148
 
    if not isinstance(lf, LogFormatter):
149
 
        warn("not a LogFormatter instance: %r" % lf)
150
129
 
151
130
    if specific_fileid:
152
131
        mutter('get log for file_id %r' % specific_fileid)
153
132
 
154
 
    if search is not None:
155
 
        import re
156
 
        searchRE = re.compile(search, re.IGNORECASE)
157
 
    else:
158
 
        searchRE = None
159
 
 
160
 
    which_revs = _enumerate_history(branch)
161
 
    
162
 
    if start_revision is None:
163
 
        start_revision = 1
164
 
    else:
165
 
        branch.check_real_revno(start_revision)
166
 
    
167
 
    if end_revision is None:
168
 
        end_revision = len(which_revs)
169
 
    else:
170
 
        branch.check_real_revno(end_revision)
171
 
 
172
 
    # list indexes are 0-based; revisions are 1-based
173
 
    cut_revs = which_revs[(start_revision-1):(end_revision)]
174
 
 
175
 
    if direction == 'reverse':
176
 
        cut_revs.reverse()
177
 
    elif direction == 'forward':
178
 
        pass
179
 
    else:
180
 
        raise ValueError('invalid direction %r' % direction)
181
 
 
182
 
    for revno, rev_id in cut_revs:
183
 
        if verbose or specific_fileid:
184
 
            delta = branch.get_revision_delta(revno)
185
 
            
 
133
    if to_file == None:
 
134
        import sys
 
135
        to_file = sys.stdout
 
136
 
 
137
    which_revs = branch.enum_history(direction)
 
138
 
 
139
    if not (verbose or specific_fileid):
 
140
        # no need to know what changed between revisions
 
141
        with_deltas = deltas_for_log_dummy(branch, which_revs)
 
142
    elif direction == 'reverse':
 
143
        with_deltas = deltas_for_log_reverse(branch, which_revs)
 
144
    else:        
 
145
        raise NotImplementedError("sorry, verbose forward logs not done yet")
 
146
 
 
147
    for revno, rev, delta in with_deltas:
186
148
        if specific_fileid:
187
149
            if not delta.touches_file_id(specific_fileid):
188
150
                continue
189
151
 
 
152
        if start_revision is not None and revno < start_revision:
 
153
            continue
 
154
 
 
155
        if end_revision is not None and revno > end_revision:
 
156
            continue
 
157
        
190
158
        if not verbose:
191
159
            # although we calculated it, throw it away without display
192
160
            delta = None
193
 
 
194
 
        rev = branch.get_revision(rev_id)
195
 
 
196
 
        if searchRE:
197
 
            if not searchRE.search(rev.message):
198
 
                continue
199
 
 
200
 
        lf.show(revno, rev, delta)
 
161
            
 
162
        show_one_log(revno, rev, delta, show_ids, to_file, show_timezone)
201
163
 
202
164
 
203
165
 
204
166
def deltas_for_log_dummy(branch, which_revs):
205
 
    """Return all the revisions without intermediate deltas.
206
 
 
207
 
    Useful for log commands that won't need the delta information.
208
 
    """
209
 
    
210
167
    for revno, revision_id in which_revs:
211
168
        yield revno, branch.get_revision(revision_id), None
212
169
 
213
170
 
214
171
def deltas_for_log_reverse(branch, which_revs):
215
 
    """Compute deltas for display in latest-to-earliest order.
216
 
 
217
 
    branch
218
 
        Branch to traverse
219
 
 
220
 
    which_revs
221
 
        Sequence of (revno, revision_id) for the subset of history to examine
222
 
 
223
 
    returns 
224
 
        Sequence of (revno, rev, delta)
 
172
    """Compute deltas for display in reverse log.
 
173
 
 
174
    Given a sequence of (revno, revision_id) pairs, return
 
175
    (revno, rev, delta).
225
176
 
226
177
    The delta is from the given revision to the next one in the
227
178
    sequence, which makes sense if the log is being displayed from
228
179
    newest to oldest.
229
180
    """
 
181
    from tree import EmptyTree
 
182
    from diff import compare_trees
 
183
    
230
184
    last_revno = last_revision_id = last_tree = None
231
185
    for revno, revision_id in which_revs:
232
186
        this_tree = branch.revision_tree(revision_id)
235
189
        if last_revno:
236
190
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
237
191
 
238
 
        this_tree = EmptyTree(branch.get_root_id())
239
 
 
240
192
        last_revno = revno
241
193
        last_revision = this_revision
242
194
        last_tree = this_tree
243
195
 
244
196
    if last_revno:
245
 
        if last_revno == 1:
246
 
            this_tree = EmptyTree(branch.get_root_id())
247
 
        else:
248
 
            this_revno = last_revno - 1
249
 
            this_revision_id = branch.revision_history()[this_revno]
250
 
            this_tree = branch.revision_tree(this_revision_id)
 
197
        this_tree = EmptyTree()
251
198
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
252
199
 
253
200
 
254
 
def deltas_for_log_forward(branch, which_revs):
255
 
    """Compute deltas for display in forward log.
256
 
 
257
 
    Given a sequence of (revno, revision_id) pairs, return
258
 
    (revno, rev, delta).
259
 
 
260
 
    The delta is from the given revision to the next one in the
261
 
    sequence, which makes sense if the log is being displayed from
262
 
    newest to oldest.
263
 
    """
264
 
    last_revno = last_revision_id = last_tree = None
265
 
    prev_tree = EmptyTree(branch.get_root_id())
266
 
 
 
201
 
 
202
def junk():
 
203
    precursor = None
 
204
    if verbose:
 
205
        from tree import EmptyTree
 
206
        prev_tree = EmptyTree()
267
207
    for revno, revision_id in which_revs:
 
208
        precursor = revision_id
 
209
 
 
210
    if revision_id != rev.revision_id:
 
211
        raise BzrCheckError("retrieved wrong revision: %r"
 
212
                            % (revision_id, rev.revision_id))
 
213
 
 
214
    if verbose:
268
215
        this_tree = branch.revision_tree(revision_id)
269
 
        this_revision = branch.get_revision(revision_id)
270
 
 
271
 
        if not last_revno:
272
 
            if revno == 1:
273
 
                last_tree = EmptyTree(branch.get_root_id())
274
 
            else:
275
 
                last_revno = revno - 1
276
 
                last_revision_id = branch.revision_history()[last_revno]
277
 
                last_tree = branch.revision_tree(last_revision_id)
278
 
 
279
 
        yield revno, this_revision, compare_trees(last_tree, this_tree, False)
280
 
 
281
 
        last_revno = revno
282
 
        last_revision = this_revision
283
 
        last_tree = this_tree
284
 
 
285
 
 
286
 
class LogFormatter(object):
287
 
    """Abstract class to display log messages."""
288
 
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
289
 
        self.to_file = to_file
290
 
        self.show_ids = show_ids
291
 
        self.show_timezone = show_timezone
292
 
 
293
 
 
294
 
    def show(self, revno, rev, delta):
295
 
        raise NotImplementedError('not implemented in abstract base')
296
 
        
297
 
 
298
 
 
299
 
 
300
 
 
301
 
 
302
 
class LongLogFormatter(LogFormatter):
303
 
    def show(self, revno, rev, delta):
304
 
        from osutils import format_date
305
 
 
306
 
        to_file = self.to_file
307
 
 
308
 
        print >>to_file,  '-' * 60
309
 
        print >>to_file,  'revno:', revno
310
 
        if self.show_ids:
311
 
            print >>to_file,  'revision-id:', rev.revision_id
312
 
 
313
 
            for parent in rev.parents:
314
 
                print >>to_file, 'parent:', parent.revision_id
315
 
            
316
 
        print >>to_file,  'committer:', rev.committer
317
 
 
318
 
        date_str = format_date(rev.timestamp,
319
 
                               rev.timezone or 0,
320
 
                               self.show_timezone)
321
 
        print >>to_file,  'timestamp: %s' % date_str
322
 
 
323
 
        print >>to_file,  'message:'
324
 
        if not rev.message:
325
 
            print >>to_file,  '  (no message)'
326
 
        else:
327
 
            for l in rev.message.split('\n'):
328
 
                print >>to_file,  '  ' + l
329
 
 
330
 
        if delta != None:
331
 
            delta.show(to_file, self.show_ids)
332
 
 
333
 
 
334
 
 
335
 
class ShortLogFormatter(LogFormatter):
336
 
    def show(self, revno, rev, delta):
337
 
        from bzrlib.osutils import format_date
338
 
 
339
 
        to_file = self.to_file
340
 
 
341
 
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
342
 
                format_date(rev.timestamp, rev.timezone or 0,
343
 
                            self.show_timezone))
344
 
        if self.show_ids:
345
 
            print >>to_file,  '      revision-id:', rev.revision_id
346
 
        if not rev.message:
347
 
            print >>to_file,  '      (no message)'
348
 
        else:
349
 
            for l in rev.message.split('\n'):
350
 
                print >>to_file,  '      ' + l
351
 
 
352
 
        # TODO: Why not show the modified files in a shorter form as
353
 
        # well? rewrap them single lines of appropriate length
354
 
        if delta != None:
355
 
            delta.show(to_file, self.show_ids)
356
 
        print
357
 
 
358
 
 
359
 
 
360
 
FORMATTERS = {'long': LongLogFormatter,
361
 
              'short': ShortLogFormatter,
362
 
              }
363
 
 
364
 
 
365
 
def log_formatter(name, *args, **kwargs):
366
 
    from bzrlib.errors import BzrCommandError
 
216
        delta = compare_trees(prev_tree, this_tree, want_unchanged=False)
 
217
        prev_tree = this_tree
 
218
    else:
 
219
        delta = None    
 
220
 
 
221
 
 
222
 
 
223
def show_one_log(revno, rev, delta, show_ids, to_file, show_timezone):
 
224
    from osutils import format_date
367
225
    
368
 
    try:
369
 
        return FORMATTERS[name](*args, **kwargs)
370
 
    except IndexError:
371
 
        raise BzrCommandError("unknown log formatter: %r" % name)
372
 
 
373
 
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
374
 
    # deprecated; for compatability
375
 
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
376
 
    lf.show(revno, rev, delta)
 
226
    print >>to_file,  '-' * 60
 
227
    print >>to_file,  'revno:', revno
 
228
    if show_ids:
 
229
        print >>to_file,  'revision-id:', rev.revision_id
 
230
    print >>to_file,  'committer:', rev.committer
 
231
    print >>to_file,  'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
232
                                         show_timezone))
 
233
 
 
234
    print >>to_file,  'message:'
 
235
    if not rev.message:
 
236
        print >>to_file,  '  (no message)'
 
237
    else:
 
238
        for l in rev.message.split('\n'):
 
239
            print >>to_file,  '  ' + l
 
240
 
 
241
    if delta != None:
 
242
        delta.show(to_file, show_ids)