~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Martin Pool
  • Date: 2005-07-22 23:31:09 UTC
  • Revision ID: mbp@sourcefrog.net-20050722233109-7b030502e5311685
- selftest is less verbose by default, and takes a -v option if you want it

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
 
from bzrlib.errors import InvalidRevisionNumber
57
 
 
 
39
from trace import mutter
58
40
 
59
41
def find_touching_revisions(branch, file_id):
60
42
    """Yield a description of revisions which affect the file_id.
101
83
 
102
84
 
103
85
 
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
 
 
113
86
def show_log(branch,
114
87
             lf,
115
88
             specific_fileid=None,
158
131
    else:
159
132
        searchRE = None
160
133
 
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
 
            
 
134
    which_revs = branch.enum_history(direction)
 
135
    which_revs = [x for x in which_revs if (
 
136
            (start_revision is None or x[0] >= start_revision)
 
137
            and (end_revision is None or x[0] <= end_revision))]
 
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
        with_deltas = deltas_for_log_forward(branch, which_revs)
 
146
 
 
147
    for revno, rev, delta in with_deltas:
187
148
        if specific_fileid:
188
149
            if not delta.touches_file_id(specific_fileid):
189
150
                continue
192
153
            # although we calculated it, throw it away without display
193
154
            delta = None
194
155
 
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)
 
156
        if searchRE is None or searchRE.search(rev.message):
 
157
            lf.show(revno, rev, delta)
202
158
 
203
159
 
204
160
 
205
161
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
162
    for revno, revision_id in which_revs:
212
163
        yield revno, branch.get_revision(revision_id), None
213
164
 
214
165
 
215
166
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)
 
167
    """Compute deltas for display in reverse log.
 
168
 
 
169
    Given a sequence of (revno, revision_id) pairs, return
 
170
    (revno, rev, delta).
226
171
 
227
172
    The delta is from the given revision to the next one in the
228
173
    sequence, which makes sense if the log is being displayed from
229
174
    newest to oldest.
230
175
    """
 
176
    from tree import EmptyTree
 
177
    from diff import compare_trees
 
178
    
231
179
    last_revno = last_revision_id = last_tree = None
232
180
    for revno, revision_id in which_revs:
233
181
        this_tree = branch.revision_tree(revision_id)
262
210
    sequence, which makes sense if the log is being displayed from
263
211
    newest to oldest.
264
212
    """
 
213
    from tree import EmptyTree
 
214
    from diff import compare_trees
 
215
 
265
216
    last_revno = last_revision_id = last_tree = None
266
217
    prev_tree = EmptyTree(branch.get_root_id())
267
218
 
286
237
 
287
238
class LogFormatter(object):
288
239
    """Abstract class to display log messages."""
289
 
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
 
240
    def __init__(self, to_file, show_ids=False, show_timezone=False):
290
241
        self.to_file = to_file
291
242
        self.show_ids = show_ids
292
243
        self.show_timezone = show_timezone
293
 
 
294
 
 
295
 
    def show(self, revno, rev, delta):
296
 
        raise NotImplementedError('not implemented in abstract base')
297
244
        
298
245
 
299
246
 
311
258
        if self.show_ids:
312
259
            print >>to_file,  'revision-id:', rev.revision_id
313
260
        print >>to_file,  'committer:', rev.committer
314
 
 
315
 
        date_str = format_date(rev.timestamp,
316
 
                               rev.timezone or 0,
317
 
                               self.show_timezone)
318
 
        print >>to_file,  'timestamp: %s' % date_str
 
261
        print >>to_file,  'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
262
                                             self.show_timezone))
319
263
 
320
264
        print >>to_file,  'message:'
321
265
        if not rev.message:
346
290
            for l in rev.message.split('\n'):
347
291
                print >>to_file,  '      ' + l
348
292
 
349
 
        # TODO: Why not show the modified files in a shorter form as
350
 
        # well? rewrap them single lines of appropriate length
351
293
        if delta != None:
352
294
            delta.show(to_file, self.show_ids)
353
295
        print
366
308
        return FORMATTERS[name](*args, **kwargs)
367
309
    except IndexError:
368
310
        raise BzrCommandError("unknown log formatter: %r" % name)
369
 
 
370
 
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
371
 
    # deprecated; for compatability
372
 
    lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
373
 
    lf.show(revno, rev, delta)