/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/log.py

Fix syntax errors.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/log.py
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
 
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
 
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
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
 
 
58
 
 
59
 
def find_touching_revisions(branch, file_id):
60
 
    """Yield a description of revisions which affect the file_id.
61
 
 
62
 
    Each returned element is (revno, revision_id, description)
63
 
 
64
 
    This is the list of revisions where the file is either added,
65
 
    modified, renamed or deleted.
66
 
 
67
 
    TODO: Perhaps some way to limit this to only particular revisions,
68
 
    or to traverse a non-mainline set of revisions?
69
 
    """
70
 
    last_ie = None
71
 
    last_path = None
72
 
    revno = 1
73
 
    for revision_id in branch.revision_history():
74
 
        this_inv = branch.get_revision_inventory(revision_id)
75
 
        if file_id in this_inv:
76
 
            this_ie = this_inv[file_id]
77
 
            this_path = this_inv.id2path(file_id)
78
 
        else:
79
 
            this_ie = this_path = None
80
 
 
81
 
        # now we know how it was last time, and how it is in this revision.
82
 
        # are those two states effectively the same or not?
83
 
 
84
 
        if not this_ie and not last_ie:
85
 
            # not present in either
86
 
            pass
87
 
        elif this_ie and not last_ie:
88
 
            yield revno, revision_id, "added " + this_path
89
 
        elif not this_ie and last_ie:
90
 
            # deleted here
91
 
            yield revno, revision_id, "deleted " + last_path
92
 
        elif this_path != last_path:
93
 
            yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
94
 
        elif (this_ie.text_size != last_ie.text_size
95
 
              or this_ie.text_sha1 != last_ie.text_sha1):
96
 
            yield revno, revision_id, "modified " + this_path
97
 
 
98
 
        last_ie = this_ie
99
 
        last_path = this_path
100
 
        revno += 1
101
 
 
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
 
 
113
 
def show_log(branch,
114
 
             lf,
115
 
             specific_fileid=None,
116
 
             verbose=False,
117
 
             direction='reverse',
118
 
             start_revision=None,
119
 
             end_revision=None,
120
 
             search=None):
121
 
    """Write out human-readable log of commits to this branch.
122
 
 
123
 
    lf
124
 
        LogFormatter object to show the output.
125
 
 
126
 
    specific_fileid
127
 
        If true, list only the commits affecting the specified
128
 
        file, rather than all commits.
129
 
 
130
 
    verbose
131
 
        If true show added/changed/deleted/renamed files.
132
 
 
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
 
 
309
 
        print >>to_file,  '-' * 60
310
 
        print >>to_file,  'revno:', revno
311
 
        if self.show_ids:
312
 
            print >>to_file,  'revision-id:', rev.revision_id
313
 
        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
319
 
 
320
 
        print >>to_file,  'message:'
321
 
        if not rev.message:
322
 
            print >>to_file,  '  (no message)'
323
 
        else:
324
 
            for l in rev.message.split('\n'):
325
 
                print >>to_file,  '  ' + l
326
 
 
327
 
        if delta != None:
328
 
            delta.show(to_file, self.show_ids)
329
 
 
330
 
 
331
 
 
332
 
class ShortLogFormatter(LogFormatter):
333
 
    def show(self, revno, rev, delta):
334
 
        from bzrlib.osutils import format_date
335
 
 
336
 
        to_file = self.to_file
337
 
 
338
 
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
339
 
                format_date(rev.timestamp, rev.timezone or 0,
340
 
                            self.show_timezone))
341
 
        if self.show_ids:
342
 
            print >>to_file,  '      revision-id:', rev.revision_id
343
 
        if not rev.message:
344
 
            print >>to_file,  '      (no message)'
345
 
        else:
346
 
            for l in rev.message.split('\n'):
347
 
                print >>to_file,  '      ' + l
348
 
 
349
 
        # TODO: Why not show the modified files in a shorter form as
350
 
        # well? rewrap them single lines of appropriate length
351
 
        if delta != None:
352
 
            delta.show(to_file, self.show_ids)
353
 
        print
354
 
 
355
 
 
356
 
 
357
 
FORMATTERS = {'long': LongLogFormatter,
358
 
              'short': ShortLogFormatter,
359
 
              }
360
 
 
361
 
 
362
 
def log_formatter(name, *args, **kwargs):
363
 
    from bzrlib.errors import BzrCommandError
364
 
    
365
 
    try:
366
 
        return FORMATTERS[name](*args, **kwargs)
367
 
    except IndexError:
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)