← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Martin Pool
  • Date: 2005-09-01 02:39:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050901023902-2f1efa0ec064118a
- add note in old docs that they're out of date

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/log.py
16
16
 
17
17
 
18
18
 
 
19
"""Code to show logs of changes.
 
20
 
 
21
Various flavors of log can be produced:
 
22
 
 
23
* for one file, or the whole tree, and (not done yet) for
 
24
  files in a given directory
 
25
 
 
26
* in "verbose" mode with a description of what changed from one
 
27
  version to the next
 
28
 
 
29
* with file-ids and revision-ids shown
 
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.
 
50
"""
 
51
 
 
52
 
 
53
from bzrlib.tree import EmptyTree
 
54
from bzrlib.delta import compare_trees
 
55
from bzrlib.trace import mutter
 
56
from bzrlib.errors import InvalidRevisionNumber
 
57
 
19
58
 
20
59
def find_touching_revisions(branch, file_id):
21
60
    """Yield a description of revisions which affect the file_id.
25
64
    This is the list of revisions where the file is either added,
26
65
    modified, renamed or deleted.
27
66
 
28
 
    Revisions are returned in chronological order.
29
 
 
30
67
    TODO: Perhaps some way to limit this to only particular revisions,
31
 
    or to traverse a non-branch set of revisions?
32
 
 
33
 
    TODO: If a directory is given, then by default look for all
34
 
    changes under that directory.
 
68
    or to traverse a non-mainline set of revisions?
35
69
    """
36
70
    last_ie = None
37
71
    last_path = None
66
100
        revno += 1
67
101
 
68
102
 
 
103
 
 
104
def _enumerate_history(branch):
 
105
    rh = []
 
106
    revno = 1
 
107
    for rev_id in branch.revision_history():
 
108
        rh.append((revno, rev_id))
 
109
        revno += 1
 
110
    return rh
 
111
 
 
112
 
69
113
def show_log(branch,
70
 
             filename=None,
71
 
             show_timezone='original',
 
114
             lf,
 
115
             specific_fileid=None,
72
116
             verbose=False,
73
 
             show_ids=False,
74
 
             to_file=None):
 
117
             direction='reverse',
 
118
             start_revision=None,
 
119
             end_revision=None,
 
120
             search=None):
75
121
    """Write out human-readable log of commits to this branch.
76
122
 
77
 
    filename
 
123
    lf
 
124
        LogFormatter object to show the output.
 
125
 
 
126
    specific_fileid
78
127
        If true, list only the commits affecting the specified
79
128
        file, rather than all commits.
80
129
 
81
 
    show_timezone
82
 
        'original' (committer's timezone),
83
 
        'utc' (universal time), or
84
 
        'local' (local user's timezone)
85
 
 
86
130
    verbose
87
131
        If true show added/changed/deleted/renamed files.
88
132
 
89
 
    show_ids
90
 
        If true, show revision and file ids.
91
 
 
92
 
    to_file
93
 
        File to send log to; by default stdout.
94
 
    """
95
 
    from osutils import format_date
96
 
    from errors import BzrCheckError
97
 
    from diff import compare_trees
98
 
    from textui import show_status
99
 
 
100
 
    if to_file == None:
101
 
        import sys
102
 
        to_file = sys.stdout
103
 
 
104
 
    if filename:
105
 
        file_id = branch.read_working_inventory().path2id(filename)
106
 
        def which_revs():
107
 
            for revno, revid, why in find_touching_revisions(branch, file_id):
108
 
                yield revno, revid
109
 
    else:
110
 
        def which_revs():
111
 
            for i, revid in enumerate(branch.revision_history()):
112
 
                yield i+1, revid
113
 
        
114
 
    branch._need_readlock()
115
 
    precursor = None
116
 
    if verbose:
117
 
        from tree import EmptyTree
118
 
        prev_tree = EmptyTree()
119
 
    for revno, revision_id in which_revs():
 
133
    direction
 
134
        'reverse' (default) is latest to earliest;
 
135
        'forward' is earliest to latest.
 
136
 
 
137
    start_revision
 
138
        If not None, only show revisions >= start_revision
 
139
 
 
140
    end_revision
 
141
        If not None, only show revisions <= end_revision
 
142
    """
 
143
    from bzrlib.osutils import format_date
 
144
    from bzrlib.errors import BzrCheckError
 
145
    from bzrlib.textui import show_status
 
146
    
 
147
    from warnings import warn
 
148
 
 
149
    if not isinstance(lf, LogFormatter):
 
150
        warn("not a LogFormatter instance: %r" % lf)
 
151
 
 
152
    if specific_fileid:
 
153
        mutter('get log for file_id %r' % specific_fileid)
 
154
 
 
155
    if search is not None:
 
156
        import re
 
157
        searchRE = re.compile(search, re.IGNORECASE)
 
158
    else:
 
159
        searchRE = None
 
160
 
 
161
    which_revs = _enumerate_history(branch)
 
162
    
 
163
    if start_revision is None:
 
164
        start_revision = 1
 
165
    elif start_revision < 1 or start_revision >= len(which_revs):
 
166
        raise InvalidRevisionNumber(start_revision)
 
167
    
 
168
    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)
 
172
 
 
173
    # list indexes are 0-based; revisions are 1-based
 
174
    cut_revs = which_revs[(start_revision-1):(end_revision)]
 
175
 
 
176
    if direction == 'reverse':
 
177
        cut_revs.reverse()
 
178
    elif direction == 'forward':
 
179
        pass
 
180
    else:
 
181
        raise ValueError('invalid direction %r' % direction)
 
182
 
 
183
    for revno, rev_id in cut_revs:
 
184
        if verbose or specific_fileid:
 
185
            delta = branch.get_revision_delta(revno)
 
186
            
 
187
        if specific_fileid:
 
188
            if not delta.touches_file_id(specific_fileid):
 
189
                continue
 
190
 
 
191
        if not verbose:
 
192
            # although we calculated it, throw it away without display
 
193
            delta = None
 
194
 
 
195
        rev = branch.get_revision(rev_id)
 
196
 
 
197
        if searchRE:
 
198
            if not searchRE.search(rev.message):
 
199
                continue
 
200
 
 
201
        lf.show(revno, rev, delta)
 
202
 
 
203
 
 
204
 
 
205
def deltas_for_log_dummy(branch, which_revs):
 
206
    """Return all the revisions without intermediate deltas.
 
207
 
 
208
    Useful for log commands that won't need the delta information.
 
209
    """
 
210
    
 
211
    for revno, revision_id in which_revs:
 
212
        yield revno, branch.get_revision(revision_id), None
 
213
 
 
214
 
 
215
def deltas_for_log_reverse(branch, which_revs):
 
216
    """Compute deltas for display in latest-to-earliest order.
 
217
 
 
218
    branch
 
219
        Branch to traverse
 
220
 
 
221
    which_revs
 
222
        Sequence of (revno, revision_id) for the subset of history to examine
 
223
 
 
224
    returns 
 
225
        Sequence of (revno, rev, delta)
 
226
 
 
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
 
229
    newest to oldest.
 
230
    """
 
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)
 
235
        
 
236
        if last_revno:
 
237
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
 
238
 
 
239
        this_tree = EmptyTree(branch.get_root_id())
 
240
 
 
241
        last_revno = revno
 
242
        last_revision = this_revision
 
243
        last_tree = this_tree
 
244
 
 
245
    if last_revno:
 
246
        if last_revno == 1:
 
247
            this_tree = EmptyTree(branch.get_root_id())
 
248
        else:
 
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)
 
253
 
 
254
 
 
255
def deltas_for_log_forward(branch, which_revs):
 
256
    """Compute deltas for display in forward log.
 
257
 
 
258
    Given a sequence of (revno, revision_id) pairs, return
 
259
    (revno, rev, delta).
 
260
 
 
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
 
263
    newest to oldest.
 
264
    """
 
265
    last_revno = last_revision_id = last_tree = None
 
266
    prev_tree = EmptyTree(branch.get_root_id())
 
267
 
 
268
    for revno, revision_id in which_revs:
 
269
        this_tree = branch.revision_tree(revision_id)
 
270
        this_revision = branch.get_revision(revision_id)
 
271
 
 
272
        if not last_revno:
 
273
            if revno == 1:
 
274
                last_tree = EmptyTree(branch.get_root_id())
 
275
            else:
 
276
                last_revno = revno - 1
 
277
                last_revision_id = branch.revision_history()[last_revno]
 
278
                last_tree = branch.revision_tree(last_revision_id)
 
279
 
 
280
        yield revno, this_revision, compare_trees(last_tree, this_tree, False)
 
281
 
 
282
        last_revno = revno
 
283
        last_revision = this_revision
 
284
        last_tree = this_tree
 
285
 
 
286
 
 
287
class LogFormatter(object):
 
288
    """Abstract class to display log messages."""
 
289
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
 
290
        self.to_file = to_file
 
291
        self.show_ids = show_ids
 
292
        self.show_timezone = show_timezone
 
293
 
 
294
 
 
295
    def show(self, revno, rev, delta):
 
296
        raise NotImplementedError('not implemented in abstract base')
 
297
        
 
298
 
 
299
 
 
300
 
 
301
 
 
302
 
 
303
class LongLogFormatter(LogFormatter):
 
304
    def show(self, revno, rev, delta):
 
305
        from osutils import format_date
 
306
 
 
307
        to_file = self.to_file
 
308
 
120
309
        print >>to_file,  '-' * 60
121
310
        print >>to_file,  'revno:', revno
122
 
        rev = branch.get_revision(revision_id)
123
 
        if show_ids:
124
 
            print >>to_file,  'revision-id:', revision_id
 
311
        if self.show_ids:
 
312
            print >>to_file,  'revision-id:', rev.revision_id
 
313
 
 
314
            for parent in rev.parents:
 
315
                print >>to_file, 'parent:', parent.revision_id
 
316
            
125
317
        print >>to_file,  'committer:', rev.committer
126
 
        print >>to_file,  'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
127
 
                                             show_timezone))
128
318
 
129
 
        if revision_id != rev.revision_id:
130
 
            raise BzrCheckError("retrieved wrong revision: %r"
131
 
                                % (revision_id, rev.revision_id))
 
319
        date_str = format_date(rev.timestamp,
 
320
                               rev.timezone or 0,
 
321
                               self.show_timezone)
 
322
        print >>to_file,  'timestamp: %s' % date_str
132
323
 
133
324
        print >>to_file,  'message:'
134
325
        if not rev.message:
137
328
            for l in rev.message.split('\n'):
138
329
                print >>to_file,  '  ' + l
139
330
 
140
 
        # Don't show a list of changed files if we were asked about
141
 
        # one specific file.
142
 
 
143
 
        if verbose:
144
 
            this_tree = branch.revision_tree(revision_id)
145
 
            delta = compare_trees(prev_tree, this_tree)
146
 
            delta.show(to_file, show_ids)
147
 
            prev_tree = this_tree
148
 
 
149
 
        precursor = revision_id
150
 
 
 
331
        if delta != None:
 
332
            delta.show(to_file, self.show_ids)
 
333
 
 
334
 
 
335
 
 
336
class ShortLogFormatter(LogFormatter):
 
337
    def show(self, revno, rev, delta):
 
338
        from bzrlib.osutils import format_date
 
339
 
 
340
        to_file = self.to_file
 
341
 
 
342
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
 
343
                format_date(rev.timestamp, rev.timezone or 0,
 
344
                            self.show_timezone))
 
345
        if self.show_ids:
 
346
            print >>to_file,  '      revision-id:', rev.revision_id
 
347
        if not rev.message:
 
348
            print >>to_file,  '      (no message)'
 
349
        else:
 
350
            for l in rev.message.split('\n'):
 
351
                print >>to_file,  '      ' + l
 
352
 
 
353
        # TODO: Why not show the modified files in a shorter form as
 
354
        # well? rewrap them single lines of appropriate length
 
355
        if delta != None:
 
356
            delta.show(to_file, self.show_ids)
 
357
        print
 
358
 
 
359
 
 
360
 
 
361
FORMATTERS = {'long': LongLogFormatter,
 
362
              'short': ShortLogFormatter,
 
363
              }
 
364
 
 
365
 
 
366
def log_formatter(name, *args, **kwargs):
 
367
    from bzrlib.errors import BzrCommandError
 
368
    
 
369
    try:
 
370
        return FORMATTERS[name](*args, **kwargs)
 
371
    except IndexError:
 
372
        raise BzrCommandError("unknown log formatter: %r" % name)
 
373
 
 
374
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
 
375
    # deprecated; for compatability
 
376
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
 
377
    lf.show(revno, rev, delta)