~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/log.py

  • Committer: aaron.bentley at utoronto
  • Date: 2005-08-18 02:24:28 UTC
  • mto: (1092.1.41) (1185.3.4) (974.1.47)
  • mto: This revision was merged to the branch mainline in revision 1110.
  • Revision ID: aaron.bentley@utoronto.ca-20050818022428-4c0bf84005f4dba8
mergedĀ mbp@sourcefrog.net-20050817233101-0939da1cf91f2472

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