~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: Martin Pool
  • Date: 2005-07-07 10:22:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050707102201-2d2a13a25098b101
- rearrange and clear up merged weave

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,
116
89
             verbose=False,
117
90
             direction='reverse',
118
91
             start_revision=None,
119
 
             end_revision=None,
120
 
             search=None):
 
92
             end_revision=None):
121
93
    """Write out human-readable log of commits to this branch.
122
94
 
123
95
    lf
152
124
    if specific_fileid:
153
125
        mutter('get log for file_id %r' % specific_fileid)
154
126
 
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
 
            
 
127
    which_revs = branch.enum_history(direction)
 
128
    which_revs = [x for x in which_revs if (
 
129
            (start_revision is None or x[0] >= start_revision)
 
130
            and (end_revision is None or x[0] <= end_revision))]
 
131
 
 
132
    if not (verbose or specific_fileid):
 
133
        # no need to know what changed between revisions
 
134
        with_deltas = deltas_for_log_dummy(branch, which_revs)
 
135
    elif direction == 'reverse':
 
136
        with_deltas = deltas_for_log_reverse(branch, which_revs)
 
137
    else:        
 
138
        with_deltas = deltas_for_log_forward(branch, which_revs)
 
139
 
 
140
    for revno, rev, delta in with_deltas:
187
141
        if specific_fileid:
188
142
            if not delta.touches_file_id(specific_fileid):
189
143
                continue
192
146
            # although we calculated it, throw it away without display
193
147
            delta = None
194
148
 
195
 
        rev = branch.get_revision(rev_id)
196
 
 
197
 
        if searchRE:
198
 
            if not searchRE.search(rev.message):
199
 
                continue
200
 
 
201
149
        lf.show(revno, rev, delta)
202
150
 
203
151
 
204
152
 
205
153
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
154
    for revno, revision_id in which_revs:
212
155
        yield revno, branch.get_revision(revision_id), None
213
156
 
214
157
 
215
158
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)
 
159
    """Compute deltas for display in reverse log.
 
160
 
 
161
    Given a sequence of (revno, revision_id) pairs, return
 
162
    (revno, rev, delta).
226
163
 
227
164
    The delta is from the given revision to the next one in the
228
165
    sequence, which makes sense if the log is being displayed from
229
166
    newest to oldest.
230
167
    """
 
168
    from tree import EmptyTree
 
169
    from diff import compare_trees
 
170
    
231
171
    last_revno = last_revision_id = last_tree = None
232
172
    for revno, revision_id in which_revs:
233
173
        this_tree = branch.revision_tree(revision_id)
236
176
        if last_revno:
237
177
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
238
178
 
239
 
        this_tree = EmptyTree(branch.get_root_id())
240
 
 
241
179
        last_revno = revno
242
180
        last_revision = this_revision
243
181
        last_tree = this_tree
244
182
 
245
183
    if last_revno:
246
184
        if last_revno == 1:
247
 
            this_tree = EmptyTree(branch.get_root_id())
 
185
            this_tree = EmptyTree()
248
186
        else:
249
187
            this_revno = last_revno - 1
250
188
            this_revision_id = branch.revision_history()[this_revno]
262
200
    sequence, which makes sense if the log is being displayed from
263
201
    newest to oldest.
264
202
    """
 
203
    from tree import EmptyTree
 
204
    from diff import compare_trees
 
205
 
265
206
    last_revno = last_revision_id = last_tree = None
266
 
    prev_tree = EmptyTree(branch.get_root_id())
267
 
 
268
207
    for revno, revision_id in which_revs:
269
208
        this_tree = branch.revision_tree(revision_id)
270
209
        this_revision = branch.get_revision(revision_id)
271
210
 
272
211
        if not last_revno:
273
212
            if revno == 1:
274
 
                last_tree = EmptyTree(branch.get_root_id())
 
213
                last_tree = EmptyTree()
275
214
            else:
276
215
                last_revno = revno - 1
277
216
                last_revision_id = branch.revision_history()[last_revno]
286
225
 
287
226
class LogFormatter(object):
288
227
    """Abstract class to display log messages."""
289
 
    def __init__(self, to_file, show_ids=False, show_timezone='original'):
 
228
    def __init__(self, to_file, show_ids=False, show_timezone=False):
290
229
        self.to_file = to_file
291
230
        self.show_ids = show_ids
292
231
        self.show_timezone = show_timezone
293
 
 
294
 
 
295
 
    def show(self, revno, rev, delta):
296
 
        raise NotImplementedError('not implemented in abstract base')
297
232
        
298
233
 
299
234
 
311
246
        if self.show_ids:
312
247
            print >>to_file,  'revision-id:', rev.revision_id
313
248
        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
 
249
        print >>to_file,  'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
250
                                             self.show_timezone))
319
251
 
320
252
        print >>to_file,  'message:'
321
253
        if not rev.message:
346
278
            for l in rev.message.split('\n'):
347
279
                print >>to_file,  '      ' + l
348
280
 
349
 
        # TODO: Why not show the modified files in a shorter form as
350
 
        # well? rewrap them single lines of appropriate length
351
281
        if delta != None:
352
282
            delta.show(to_file, self.show_ids)
353
283
        print
366
296
        return FORMATTERS[name](*args, **kwargs)
367
297
    except IndexError:
368
298
        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)