← 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-05-17 06:56:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050517065616-6f23381d6184a8aa
- add space for un-merged patches

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
 
* 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
36
 
"""
37
 
 
38
 
 
39
 
from trace import mutter
40
19
 
41
20
def find_touching_revisions(branch, file_id):
42
21
    """Yield a description of revisions which affect the file_id.
46
25
    This is the list of revisions where the file is either added,
47
26
    modified, renamed or deleted.
48
27
 
 
28
    Revisions are returned in chronological order.
 
29
 
49
30
    TODO: Perhaps some way to limit this to only particular revisions,
50
 
    or to traverse a non-mainline set of 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.
51
35
    """
52
36
    last_ie = None
53
37
    last_path = None
82
66
        revno += 1
83
67
 
84
68
 
85
 
 
86
69
def show_log(branch,
87
 
             lf,
88
 
             specific_fileid=None,
 
70
             filename=None,
 
71
             show_timezone='original',
89
72
             verbose=False,
90
 
             direction='reverse',
91
 
             start_revision=None,
92
 
             end_revision=None):
 
73
             show_ids=False,
 
74
             to_file=None):
93
75
    """Write out human-readable log of commits to this branch.
94
76
 
95
 
    lf
96
 
        LogFormatter object to show the output.
97
 
 
98
 
    specific_fileid
 
77
    filename
99
78
        If true, list only the commits affecting the specified
100
79
        file, rather than all commits.
101
80
 
 
81
    show_timezone
 
82
        'original' (committer's timezone),
 
83
        'utc' (universal time), or
 
84
        'local' (local user's timezone)
 
85
 
102
86
    verbose
103
87
        If true show added/changed/deleted/renamed files.
104
88
 
105
 
    direction
106
 
        'reverse' (default) is latest to earliest;
107
 
        'forward' is earliest to latest.
108
 
 
109
 
    start_revision
110
 
        If not None, only show revisions >= start_revision
111
 
 
112
 
    end_revision
113
 
        If not None, only show revisions <= end_revision
114
 
    """
115
 
    from bzrlib.osutils import format_date
116
 
    from bzrlib.errors import BzrCheckError
117
 
    from bzrlib.textui import show_status
118
 
    
119
 
    from warnings import warn
120
 
 
121
 
    if not isinstance(lf, LogFormatter):
122
 
        warn("not a LogFormatter instance: %r" % lf)
123
 
 
124
 
    if specific_fileid:
125
 
        mutter('get log for file_id %r' % specific_fileid)
126
 
 
127
 
    which_revs = branch.enum_history(direction)
128
 
 
129
 
    if not (verbose or specific_fileid):
130
 
        # no need to know what changed between revisions
131
 
        with_deltas = deltas_for_log_dummy(branch, which_revs)
132
 
    elif direction == 'reverse':
133
 
        with_deltas = deltas_for_log_reverse(branch, which_revs)
134
 
    else:        
135
 
        raise NotImplementedError("sorry, verbose forward logs not done yet")
136
 
 
137
 
    for revno, rev, delta in with_deltas:
138
 
        if specific_fileid:
139
 
            if not delta.touches_file_id(specific_fileid):
140
 
                continue
141
 
 
142
 
        if start_revision is not None and revno < start_revision:
143
 
            continue
144
 
 
145
 
        if end_revision is not None and revno > end_revision:
146
 
            continue
147
 
        
148
 
        if not verbose:
149
 
            # although we calculated it, throw it away without display
150
 
            delta = None
151
 
 
152
 
        lf.show(revno, rev, delta)
153
 
 
154
 
 
155
 
 
156
 
def deltas_for_log_dummy(branch, which_revs):
157
 
    for revno, revision_id in which_revs:
158
 
        yield revno, branch.get_revision(revision_id), None
159
 
 
160
 
 
161
 
def deltas_for_log_reverse(branch, which_revs):
162
 
    """Compute deltas for display in reverse log.
163
 
 
164
 
    Given a sequence of (revno, revision_id) pairs, return
165
 
    (revno, rev, delta).
166
 
 
167
 
    The delta is from the given revision to the next one in the
168
 
    sequence, which makes sense if the log is being displayed from
169
 
    newest to oldest.
170
 
    """
171
 
    from tree import EmptyTree
 
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
172
97
    from diff import compare_trees
173
 
    
174
 
    last_revno = last_revision_id = last_tree = None
175
 
    for revno, revision_id in which_revs:
176
 
        this_tree = branch.revision_tree(revision_id)
177
 
        this_revision = branch.get_revision(revision_id)
178
 
        
179
 
        if last_revno:
180
 
            yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
181
 
 
182
 
        last_revno = revno
183
 
        last_revision = this_revision
184
 
        last_tree = this_tree
185
 
 
186
 
    if last_revno:
187
 
        this_tree = EmptyTree()
188
 
        yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
189
 
 
190
 
 
191
 
 
192
 
 
193
 
class LogFormatter(object):
194
 
    """Abstract class to display log messages."""
195
 
    def __init__(self, to_file, show_ids=False, show_timezone=False):
196
 
        self.to_file = to_file
197
 
        self.show_ids = show_ids
198
 
        self.show_timezone = show_timezone
199
 
        
200
 
 
201
 
 
202
 
 
203
 
 
204
 
 
205
 
class LongLogFormatter(LogFormatter):
206
 
    def show(self, revno, rev, delta):
207
 
        from osutils import format_date
208
 
 
209
 
        to_file = self.to_file
210
 
 
 
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():
211
120
        print >>to_file,  '-' * 60
212
121
        print >>to_file,  'revno:', revno
213
 
        if self.show_ids:
214
 
            print >>to_file,  'revision-id:', rev.revision_id
 
122
        rev = branch.get_revision(revision_id)
 
123
        if show_ids:
 
124
            print >>to_file,  'revision-id:', revision_id
215
125
        print >>to_file,  'committer:', rev.committer
216
126
        print >>to_file,  'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
217
 
                                             self.show_timezone))
 
127
                                             show_timezone))
 
128
 
 
129
        if revision_id != rev.revision_id:
 
130
            raise BzrCheckError("retrieved wrong revision: %r"
 
131
                                % (revision_id, rev.revision_id))
218
132
 
219
133
        print >>to_file,  'message:'
220
134
        if not rev.message:
223
137
            for l in rev.message.split('\n'):
224
138
                print >>to_file,  '  ' + l
225
139
 
226
 
        if delta != None:
227
 
            delta.show(to_file, self.show_ids)
228
 
 
229
 
 
230
 
 
231
 
class ShortLogFormatter(LogFormatter):
232
 
    def show(self, revno, rev, delta):
233
 
        from bzrlib.osutils import format_date
234
 
 
235
 
        to_file = self.to_file
236
 
 
237
 
        print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
238
 
                format_date(rev.timestamp, rev.timezone or 0,
239
 
                            self.show_timezone))
240
 
        if self.show_ids:
241
 
            print >>to_file,  '      revision-id:', rev.revision_id
242
 
        if not rev.message:
243
 
            print >>to_file,  '      (no message)'
244
 
        else:
245
 
            for l in rev.message.split('\n'):
246
 
                print >>to_file,  '      ' + l
247
 
 
248
 
        if delta != None:
249
 
            delta.show(to_file, self.show_ids)
250
 
        print
251
 
 
252
 
 
253
 
 
254
 
FORMATTERS = {'long': LongLogFormatter,
255
 
              'short': ShortLogFormatter,
256
 
              }
257
 
 
258
 
 
259
 
def log_formatter(name, *args, **kwargs):
260
 
    from bzrlib.errors import BzrCommandError
261
 
    
262
 
    try:
263
 
        return FORMATTERS[name](*args, **kwargs)
264
 
    except IndexError:
265
 
        raise BzrCommandError("unknown log formatter: %r" % name)
 
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, want_unchanged=False)
 
146
            delta.show(to_file, show_ids)
 
147
            prev_tree = this_tree
 
148
 
 
149
        precursor = revision_id
 
150