← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Martin Pool
  • Date: 2006-06-05 18:00:36 UTC
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: mbp@sourcefrog.net-20060605180036-04f5d0cea94ed999
clean up test kipple

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# This program is free software; you can redistribute it and/or modify
2
 
# it under the terms of the GNU General Public License as published by
3
 
# the Free Software Foundation; either version 2 of the License, or
4
 
# (at your option) any later version.
5
 
 
6
 
# This program is distributed in the hope that it will be useful,
7
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9
 
# GNU General Public License for more details.
10
 
 
11
 
# You should have received a copy of the GNU General Public License
12
 
# along with this program; if not, write to the Free Software
13
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
14
 
 
15
 
 
16
 
 
17
 
# TODO: Could probably replace this with something based on Python logging
18
 
# module.
19
 
 
20
 
 
21
 
 
22
 
 
23
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
24
 
__author__ = "Martin Pool <mbp@canonical.com>"
25
 
 
26
 
 
27
 
"""Messages and logging for bazaar-ng
28
 
 
29
 
Nothing is actually logged unless you call bzrlib.open_tracefile().
 
1
# Copyright (C) 2005, Canonical Ltd
 
2
 
 
3
"""Messages and logging for bazaar-ng.
 
4
 
 
5
Messages are supplied by callers as a string-formatting template, plus values
 
6
to be inserted into it.  The actual %-formatting is deferred to the log
 
7
library so that it doesn't need to be done for messages that won't be emitted.
 
8
 
 
9
Messages are classified by severity levels: critical, error, warning, info,
 
10
and debug.
 
11
 
 
12
They can be sent to two places: to stderr, and to ~/.bzr.log.  For purposes
 
13
such as running the test suite, they can also be redirected away from both of
 
14
those two places to another location.
 
15
 
 
16
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
 
17
This trace file is always in UTF-8, regardless of the user's default encoding,
 
18
so that we can always rely on writing any message.
 
19
 
 
20
Output to stderr depends on the mode chosen by the user.  By default, messages
 
21
of info and above are sent out, which results in progress messages such as the
 
22
list of files processed by add and commit.  In quiet mode, only warnings and
 
23
above are shown.  In debug mode, stderr gets debug messages too.
 
24
 
 
25
Errors that terminate an operation are generally passed back as exceptions;
 
26
others may be just emitted as messages.
 
27
 
 
28
Exceptions are reported in a brief form to stderr so as not to look scary.
 
29
BzrErrors are required to be able to format themselves into a properly
 
30
explanatory message.  This is not true for builtin excexceptions such as
 
31
KeyError, which typically just str to "0".  They're printed in a different
 
32
form.
30
33
"""
31
34
 
32
 
 
33
 
import sys, os
34
 
 
35
 
######################################################################
36
 
# messages and logging
37
 
 
38
 
global _tracefile, _starttime
39
 
_tracefile = None
40
 
 
41
 
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
42
 
_starttime = None
43
 
 
44
 
# If false, notes also go to stdout; should replace this with --silent
45
 
# at some point.
46
 
silent = False
47
 
 
48
 
 
49
 
# fix this if we ever fork within python
50
 
_mypid = os.getpid()
51
 
_logprefix = '[%d] ' % _mypid
52
 
 
53
 
 
54
 
def _write_trace(msg):
55
 
    if 0:
56
 
        if _tracefile:
57
 
            _tracefile.write(_logprefix + msg + '\n')
58
 
 
59
 
 
60
 
def warning(msg):
61
 
    sys.stderr.write('bzr: warning: ' + msg + '\n')
62
 
    _write_trace('warning: ' + msg)
63
 
 
64
 
 
65
 
mutter = _write_trace
66
 
 
67
 
 
68
 
def note(msg):
69
 
    b = '* ' + str(msg) + '\n'
70
 
    if not silent:
71
 
        sys.stderr.write(b)
72
 
    _write_trace('note: ' + msg)
73
 
 
74
 
 
75
 
def log_error(msg):
76
 
    sys.stderr.write(msg + '\n')
77
 
    _write_trace(msg)
 
35
# TODO: in debug mode, stderr should get full tracebacks and also
 
36
# debug messages.  (Is this really needed?)
 
37
 
 
38
# FIXME: Unfortunately it turns out that python's logging module
 
39
# is quite expensive, even when the message is not printed by any handlers.
 
40
# We should perhaps change back to just simply doing it here.
 
41
 
 
42
 
 
43
import sys
 
44
import os
 
45
import logging
 
46
 
 
47
import bzrlib
 
48
from bzrlib.errors import BzrError, BzrNewError
 
49
 
 
50
 
 
51
_file_handler = None
 
52
_stderr_handler = None
 
53
_stderr_quiet = False
 
54
_trace_file = None
 
55
_bzr_log_file = None
 
56
 
 
57
 
 
58
class QuietFormatter(logging.Formatter):
 
59
    """Formatter that supresses the details of errors.
 
60
 
 
61
    This is used by default on stderr so as not to scare the user.
 
62
    """
 
63
    # At first I tried overriding formatException to suppress the
 
64
    # exception details, but that has global effect: no loggers
 
65
    # can get the exception details is we suppress them here.
 
66
 
 
67
    def format(self, record):
 
68
        if record.levelno >= logging.WARNING:
 
69
            s = 'bzr: ' + record.levelname + ': '
 
70
        else:
 
71
            s = ''
 
72
        s += record.getMessage()
 
73
        if record.exc_info:
 
74
            s += '\n' + format_exception_short(record.exc_info)
 
75
        return s
 
76
        
 
77
# configure convenient aliases for output routines
 
78
 
 
79
_bzr_logger = logging.getLogger('bzr')
 
80
 
 
81
def note(*args, **kwargs):
 
82
    import bzrlib.ui
 
83
    bzrlib.ui.ui_factory.clear_term()
 
84
    _bzr_logger.info(*args, **kwargs)
 
85
 
 
86
def warning(*args, **kwargs):
 
87
    import bzrlib.ui
 
88
    bzrlib.ui.ui_factory.clear_term()
 
89
    _bzr_logger.warning(*args, **kwargs)
 
90
 
 
91
info = note
 
92
log_error = _bzr_logger.error
 
93
error =     _bzr_logger.error
 
94
 
 
95
 
 
96
def mutter(fmt, *args):
 
97
    if _trace_file is None:
 
98
        return
 
99
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
 
100
        return
 
101
    if len(args) > 0:
 
102
        # It seems that if we do ascii % (unicode, ascii) we can
 
103
        # get a unicode cannot encode ascii error, so make sure that "fmt"
 
104
        # is a unicode string
 
105
        out = unicode(fmt) % args
 
106
    else:
 
107
        out = fmt
 
108
    out += '\n'
 
109
    try:
 
110
        _trace_file.write(out)
 
111
    except UnicodeError, e:
 
112
        warning('UnicodeError: %s', e)
 
113
        _trace_file.write(repr(out))
 
114
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
115
    #_trace_file.flush()
 
116
debug = mutter
78
117
 
79
118
 
80
119
def _rollover_trace_maybe(trace_fname):
84
123
        if size <= 4 << 20:
85
124
            return
86
125
        old_fname = trace_fname + '.old'
87
 
 
88
 
        try:
89
 
            # must remove before rename on windows
90
 
            os.remove(old_fname)
91
 
        except OSError:
92
 
            pass
93
 
 
94
 
        try:
95
 
            # might fail if in use on windows
96
 
            os.rename(trace_fname, old_fname)
97
 
        except OSError:
98
 
            pass
 
126
        from osutils import rename
 
127
        rename(trace_fname, old_fname)
99
128
    except OSError:
100
129
        return
101
130
 
102
131
 
103
 
 
104
 
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
 
132
def open_tracefile(tracefilename='~/.bzr.log'):
105
133
    # Messages are always written to here, so that we have some
106
134
    # information if something goes wrong.  In a future version this
107
135
    # file will be removed on successful completion.
108
 
    global _starttime, _tracefile
 
136
    global _file_handler, _bzr_log_file
109
137
    import stat, codecs
110
138
 
111
 
    _starttime = os.times()[4]
112
 
 
113
139
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
114
140
    _rollover_trace_maybe(trace_fname)
115
 
 
116
 
    # buffering=1 means line buffered
117
141
    try:
118
 
        _tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
119
 
        t = _tracefile
120
 
 
121
 
        if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
122
 
            t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
123
 
            t.write("you can delete or truncate this file, or include sections in\n")
124
 
            t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
125
 
 
126
 
        import bzrlib
127
 
        _write_trace('bzr %s invoked on python %s (%s)'
128
 
                     % (bzrlib.__version__,
129
 
                        '.'.join(map(str, sys.version_info)),
130
 
                        sys.platform))
131
 
 
132
 
        _write_trace('  arguments: %r' % argv)
133
 
        _write_trace('  working dir: ' + os.getcwdu())
 
142
        LINE_BUFFERED = 1
 
143
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
144
        _bzr_log_file = tf
 
145
        if tf.tell() == 0:
 
146
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
147
            tf.write("you can delete or truncate this file, or include sections in\n")
 
148
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
149
        _file_handler = logging.StreamHandler(tf)
 
150
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
151
        datefmt = r'%a %H:%M:%S'
 
152
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
153
        _file_handler.setLevel(logging.DEBUG)
 
154
        logging.getLogger('').addHandler(_file_handler)
134
155
    except IOError, e:
135
156
        warning("failed to open trace file: %s" % (e))
136
157
 
137
 
def close_trace():
138
 
    times = os.times()
139
 
    mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
140
 
           % (times[:4] + ((times[4] - _starttime),)))
141
 
 
142
 
 
143
 
 
144
 
def log_exception():
145
 
    """Log the last exception into the trace file."""
146
 
    import cgitb
147
 
    s = cgitb.text(sys.exc_info())
148
 
    for l in s.split('\n'):
149
 
        _write_trace(l)
150
 
        
151
 
    
 
158
 
 
159
def log_startup(argv):
 
160
    debug('\n\nbzr %s invoked on python %s (%s)',
 
161
          bzrlib.__version__,
 
162
          '.'.join(map(str, sys.version_info)),
 
163
          sys.platform)
 
164
    debug('  arguments: %r', argv)
 
165
    debug('  working dir: %r', os.getcwdu())
 
166
 
 
167
 
 
168
def log_exception(msg=None):
 
169
    """Log the last exception to stderr and the trace file.
 
170
 
 
171
    The exception string representation is used as the error
 
172
    summary, unless msg is given.
 
173
    """
 
174
    if msg:
 
175
        error(msg)
 
176
    else:
 
177
        exc_str = format_exception_short(sys.exc_info())
 
178
        error(exc_str)
 
179
    log_exception_quietly()
 
180
 
 
181
 
 
182
def log_exception_quietly():
 
183
    """Log the last exception to the trace file only.
 
184
 
 
185
    Used for exceptions that occur internally and that may be 
 
186
    interesting to developers but not to users.  For example, 
 
187
    errors loading plugins.
 
188
    """
 
189
    import traceback
 
190
    debug(traceback.format_exc())
 
191
 
 
192
 
 
193
def enable_default_logging():
 
194
    """Configure default logging to stderr and .bzr.log"""
 
195
    # FIXME: if this is run twice, things get confused
 
196
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
197
    _stderr_handler = logging.StreamHandler()
 
198
    _stderr_handler.setFormatter(QuietFormatter())
 
199
    logging.getLogger('').addHandler(_stderr_handler)
 
200
    _stderr_handler.setLevel(logging.INFO)
 
201
    if not _file_handler:
 
202
        open_tracefile()
 
203
    _trace_file = _bzr_log_file
 
204
    if _file_handler:
 
205
        _file_handler.setLevel(logging.DEBUG)
 
206
    _bzr_logger.setLevel(logging.DEBUG) 
 
207
 
 
208
 
 
209
 
 
210
def be_quiet(quiet=True):
 
211
    global _stderr_handler, _stderr_quiet
 
212
    
 
213
    _stderr_quiet = quiet
 
214
    if quiet:
 
215
        _stderr_handler.setLevel(logging.WARNING)
 
216
    else:
 
217
        _stderr_handler.setLevel(logging.INFO)
 
218
 
 
219
 
 
220
def is_quiet():
 
221
    global _stderr_quiet
 
222
    return _stderr_quiet
 
223
 
 
224
 
 
225
def disable_default_logging():
 
226
    """Turn off default log handlers.
 
227
 
 
228
    This is intended to be used by the test framework, which doesn't
 
229
    want leakage from the code-under-test into the main logs.
 
230
    """
 
231
 
 
232
    l = logging.getLogger('')
 
233
    l.removeHandler(_stderr_handler)
 
234
    if _file_handler:
 
235
        l.removeHandler(_file_handler)
 
236
    _trace_file = None
 
237
 
 
238
 
 
239
def enable_test_log(to_file):
 
240
    """Redirect logging to a temporary file for a test
 
241
    
 
242
    returns an opaque reference that should be passed to disable_test_log
 
243
    after the test complete.
 
244
    """
 
245
    disable_default_logging()
 
246
    global _trace_file
 
247
    hdlr = logging.StreamHandler(to_file)
 
248
    hdlr.setLevel(logging.DEBUG)
 
249
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
250
    _bzr_logger.addHandler(hdlr)
 
251
    _bzr_logger.setLevel(logging.DEBUG)
 
252
    result = hdlr, _trace_file
 
253
    _trace_file = to_file
 
254
    return result
 
255
 
 
256
 
 
257
def disable_test_log((test_log_hdlr, old_trace_file)):
 
258
    _bzr_logger.removeHandler(test_log_hdlr)
 
259
    test_log_hdlr.close()
 
260
    _trace_file = old_trace_file
 
261
    enable_default_logging()
 
262
 
 
263
 
 
264
def format_exception_short(exc_info):
 
265
    """Make a short string form of an exception.
 
266
 
 
267
    This is used for display to stderr.  It specially handles exception
 
268
    classes without useful string methods.
 
269
 
 
270
    The result has no trailing newline.
 
271
 
 
272
    exc_info - typically an exception from sys.exc_info()
 
273
    """
 
274
    exc_type, exc_object, exc_tb = exc_info
 
275
    try:
 
276
        if exc_type is None:
 
277
            return '(no exception)'
 
278
        if isinstance(exc_object, (BzrError, BzrNewError)):
 
279
            return str(exc_object)
 
280
        else:
 
281
            import traceback
 
282
            tb = traceback.extract_tb(exc_tb)
 
283
            msg = '%s: %s' % (exc_type, exc_object)
 
284
            if msg[-1] == '\n':
 
285
                msg = msg[:-1]
 
286
            if tb:
 
287
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
 
288
            return msg
 
289
    except Exception, formatting_exc:
 
290
        # XXX: is this really better than just letting it run up?
 
291
        return '(error formatting exception of type %s: %s)' \
 
292
                % (exc_type, formatting_exc)