← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

Don't ignore bzrlib/plugins -- really bad idea because they can have bad 
old plugins lying around!

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005, 2006 by 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
 
1
# Copyright (C) 2005, Canonical Ltd
16
2
 
17
3
"""Messages and logging for bazaar-ng.
18
4
 
41
27
 
42
28
Exceptions are reported in a brief form to stderr so as not to look scary.
43
29
BzrErrors are required to be able to format themselves into a properly
44
 
explanatory message.  This is not true for builtin exceptions such as
 
30
explanatory message.  This is not true for builtin excexceptions such as
45
31
KeyError, which typically just str to "0".  They're printed in a different
46
32
form.
47
33
"""
48
34
 
 
35
# TODO: in debug mode, stderr should get full tracebacks and also
 
36
# debug messages.  (Is this really needed?)
 
37
 
49
38
# FIXME: Unfortunately it turns out that python's logging module
50
39
# is quite expensive, even when the message is not printed by any handlers.
51
40
# We should perhaps change back to just simply doing it here.
52
41
 
53
42
 
54
 
import errno
 
43
import sys
55
44
import os
56
 
import sys
57
45
import logging
58
46
 
59
47
import bzrlib
60
 
from bzrlib.errors import BzrError, BzrNewError
61
 
from bzrlib.symbol_versioning import (deprecated_function,
62
 
        zero_nine,
63
 
        )
 
48
from bzrlib.errors import BzrNewError
 
49
 
64
50
 
65
51
_file_handler = None
66
52
_stderr_handler = None
67
53
_stderr_quiet = False
68
54
_trace_file = None
69
 
_trace_depth = 0
70
55
_bzr_log_file = None
71
56
 
72
 
 
 
57
class QuietFormatter(logging.Formatter):
 
58
    """Formatter that supresses the details of errors.
 
59
 
 
60
    This is used by default on stderr so as not to scare the user.
 
61
    """
 
62
    # At first I tried overriding formatException to suppress the
 
63
    # exception details, but that has global effect: no loggers
 
64
    # can get the exception details is we suppress them here.
 
65
 
 
66
    def format(self, record):
 
67
        if record.levelno >= logging.WARNING:
 
68
            s = 'bzr: ' + record.levelname + ': '
 
69
        else:
 
70
            s = ''
 
71
        s += record.getMessage()
 
72
        if record.exc_info:
 
73
            s += '\n' + format_exception_short(record.exc_info)
 
74
        return s
 
75
        
73
76
# configure convenient aliases for output routines
74
77
 
75
78
_bzr_logger = logging.getLogger('bzr')
76
79
 
77
 
def note(*args, **kwargs):
78
 
    # FIXME note always emits utf-8, regardless of the terminal encoding
79
 
    import bzrlib.ui
80
 
    bzrlib.ui.ui_factory.clear_term()
81
 
    _bzr_logger.info(*args, **kwargs)
82
 
 
83
 
def warning(*args, **kwargs):
84
 
    import bzrlib.ui
85
 
    bzrlib.ui.ui_factory.clear_term()
86
 
    _bzr_logger.warning(*args, **kwargs)
87
 
 
88
 
info = note
 
80
info = note = _bzr_logger.info
 
81
warning =   _bzr_logger.warning
89
82
log_error = _bzr_logger.error
90
83
error =     _bzr_logger.error
91
84
 
93
86
def mutter(fmt, *args):
94
87
    if _trace_file is None:
95
88
        return
96
 
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
 
89
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
97
90
        return
98
 
 
99
 
    if isinstance(fmt, unicode):
100
 
        fmt = fmt.encode('utf8')
101
 
 
102
91
    if len(args) > 0:
103
 
        # It seems that if we do ascii % (unicode, ascii) we can
104
 
        # get a unicode cannot encode ascii error, so make sure that "fmt"
105
 
        # is a unicode string
106
 
        real_args = []
107
 
        for arg in args:
108
 
            if isinstance(arg, unicode):
109
 
                arg = arg.encode('utf8')
110
 
            real_args.append(arg)
111
 
        out = fmt % tuple(real_args)
 
92
        out = fmt % args
112
93
    else:
113
94
        out = fmt
114
95
    out += '\n'
 
96
    if isinstance(out, unicode):
 
97
        out = out.encode('utf-8')
115
98
    _trace_file.write(out)
116
 
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
117
 
    #_trace_file.flush()
118
99
debug = mutter
119
100
 
120
101
 
136
117
    # information if something goes wrong.  In a future version this
137
118
    # file will be removed on successful completion.
138
119
    global _file_handler, _bzr_log_file
139
 
    import codecs
 
120
    import stat, codecs
140
121
 
141
122
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
142
123
    _rollover_trace_maybe(trace_fname)
143
124
    try:
144
125
        LINE_BUFFERED = 1
145
 
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
146
 
        tf = open(trace_fname, 'at', LINE_BUFFERED)
 
126
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
147
127
        _bzr_log_file = tf
148
128
        if tf.tell() == 0:
149
129
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
159
139
        warning("failed to open trace file: %s" % (e))
160
140
 
161
141
 
162
 
@deprecated_function(zero_nine)
 
142
def log_startup(argv):
 
143
    debug('\n\nbzr %s invoked on python %s (%s)',
 
144
          bzrlib.__version__,
 
145
          '.'.join(map(str, sys.version_info)),
 
146
          sys.platform)
 
147
    debug('  arguments: %r', argv)
 
148
    debug('  working dir: %r', os.getcwdu())
 
149
 
 
150
 
163
151
def log_exception(msg=None):
164
152
    """Log the last exception to stderr and the trace file.
165
153
 
190
178
    # FIXME: if this is run twice, things get confused
191
179
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
192
180
    _stderr_handler = logging.StreamHandler()
 
181
    _stderr_handler.setFormatter(QuietFormatter())
193
182
    logging.getLogger('').addHandler(_stderr_handler)
194
183
    _stderr_handler.setLevel(logging.INFO)
195
184
    if not _file_handler:
197
186
    _trace_file = _bzr_log_file
198
187
    if _file_handler:
199
188
        _file_handler.setLevel(logging.DEBUG)
200
 
    _bzr_logger.setLevel(logging.DEBUG)
 
189
    _bzr_logger.setLevel(logging.DEBUG) 
 
190
 
201
191
 
202
192
 
203
193
def be_quiet(quiet=True):
230
220
 
231
221
 
232
222
def enable_test_log(to_file):
233
 
    """Redirect logging to a temporary file for a test
234
 
    
235
 
    returns an opaque reference that should be passed to disable_test_log
236
 
    after the test completes.
237
 
    """
 
223
    """Redirect logging to a temporary file for a test"""
238
224
    disable_default_logging()
239
 
    global _trace_file
240
 
    global _trace_depth
 
225
    global _test_log_hdlr, _trace_file
241
226
    hdlr = logging.StreamHandler(to_file)
242
227
    hdlr.setLevel(logging.DEBUG)
243
228
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
244
229
    _bzr_logger.addHandler(hdlr)
245
230
    _bzr_logger.setLevel(logging.DEBUG)
246
 
    result = hdlr, _trace_file, _trace_depth
 
231
    _test_log_hdlr = hdlr
247
232
    _trace_file = to_file
248
 
    _trace_depth += 1
249
 
    return result
250
 
 
251
 
 
252
 
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
253
 
    _bzr_logger.removeHandler(test_log_hdlr)
254
 
    test_log_hdlr.close()
255
 
    global _trace_file
256
 
    global _trace_depth
257
 
    _trace_file = old_trace_file
258
 
    _trace_depth = old_trace_depth
259
 
    if not _trace_depth:
260
 
        enable_default_logging()
261
 
 
262
 
 
263
 
def report_exception(exc_info, err_file):
264
 
    exc_type, exc_object, exc_tb = exc_info
265
 
    # Log the full traceback to ~/.bzr.log
266
 
    log_exception_quietly()
267
 
    if (isinstance(exc_object, IOError)
268
 
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
269
 
        print >>err_file, "bzr: broken pipe"
270
 
    elif isinstance(exc_object, KeyboardInterrupt):
271
 
        print >>err_file, "bzr: interrupted"
272
 
    elif getattr(exc_object, 'is_user_error', False):
273
 
        report_user_error(exc_info, err_file)
274
 
    elif isinstance(exc_object, (OSError, IOError)):
275
 
        # Might be nice to catch all of these and show them as something more
276
 
        # specific, but there are too many cases at the moment.
277
 
        report_user_error(exc_info, err_file)
278
 
    else:
279
 
        report_bug(exc_info, err_file)
280
 
 
281
 
 
282
 
# TODO: Should these be specially encoding the output?
283
 
def report_user_error(exc_info, err_file):
284
 
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
285
 
 
286
 
 
287
 
def report_bug(exc_info, err_file):
288
 
    """Report an exception that probably indicates a bug in bzr"""
289
 
    import traceback
290
 
    exc_type, exc_object, exc_tb = exc_info
291
 
    print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
292
 
    print >>err_file
293
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
294
 
    print >>err_file
295
 
    print >>err_file, 'bzr %s on python %s (%s)' % \
296
 
                       (bzrlib.__version__,
297
 
                        '.'.join(map(str, sys.version_info)),
298
 
                        sys.platform)
299
 
    print >>err_file, 'arguments: %r' % sys.argv
300
 
    print >>err_file
301
 
    print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
 
233
 
 
234
 
 
235
def disable_test_log():
 
236
    _bzr_logger.removeHandler(_test_log_hdlr)
 
237
    _trace_file = None
 
238
    enable_default_logging()
 
239
 
 
240
 
 
241
def format_exception_short(exc_info):
 
242
    """Make a short string form of an exception.
 
243
 
 
244
    This is used for display to stderr.  It specially handles exception
 
245
    classes without useful string methods.
 
246
 
 
247
    The result has no trailing newline.
 
248
 
 
249
    exc_info - typically an exception from sys.exc_info()
 
250
    """
 
251
    exc_type, exc_object, exc_tb = exc_info
 
252
    try:
 
253
        if exc_type is None:
 
254
            return '(no exception)'
 
255
        if isinstance(exc_object, BzrNewError):
 
256
            return str(exc_object)
 
257
        else:
 
258
            import traceback
 
259
            tb = traceback.extract_tb(exc_tb)
 
260
            msg = '%s: %s' % (exc_type, exc_object)
 
261
            if msg[-1] == '\n':
 
262
                msg = msg[:-1]
 
263
            if tb:
 
264
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
 
265
            return msg
 
266
    except:
 
267
        return '(error formatting exception of type %s)' % exc_type