1
# Copyright (C) 2005, 2006 by Canonical Ltd
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.
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.
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
17
3
"""Messages and logging for bazaar-ng.
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
35
# TODO: in debug mode, stderr should get full tracebacks and also
36
# debug messages. (Is this really needed?)
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.
60
48
from bzrlib.errors import BzrError, BzrNewError
61
from bzrlib.symbol_versioning import (deprecated_function,
65
51
_file_handler = None
66
52
_stderr_handler = None
67
53
_stderr_quiet = False
70
55
_bzr_log_file = None
58
class QuietFormatter(logging.Formatter):
59
"""Formatter that supresses the details of errors.
61
This is used by default on stderr so as not to scare the user.
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.
67
def format(self, record):
68
if record.levelno >= logging.WARNING:
69
s = 'bzr: ' + record.levelname + ': '
72
s += record.getMessage()
74
s += '\n' + format_exception_short(record.exc_info)
73
77
# configure convenient aliases for output routines
75
79
_bzr_logger = logging.getLogger('bzr')
77
81
def note(*args, **kwargs):
78
# FIXME note always emits utf-8, regardless of the terminal encoding
80
83
bzrlib.ui.ui_factory.clear_term()
81
84
_bzr_logger.info(*args, **kwargs)
227
231
"""Redirect logging to a temporary file for a test
229
233
returns an opaque reference that should be passed to disable_test_log
230
after the test completes.
234
after the test complete.
232
236
disable_default_logging()
233
237
global _trace_file
235
238
hdlr = logging.StreamHandler(to_file)
236
239
hdlr.setLevel(logging.DEBUG)
237
240
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
238
241
_bzr_logger.addHandler(hdlr)
239
242
_bzr_logger.setLevel(logging.DEBUG)
240
result = hdlr, _trace_file, _trace_depth
243
result = hdlr, _trace_file
241
244
_trace_file = to_file
246
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
248
def disable_test_log((test_log_hdlr, old_trace_file)):
247
249
_bzr_logger.removeHandler(test_log_hdlr)
248
250
test_log_hdlr.close()
251
251
_trace_file = old_trace_file
252
_trace_depth = old_trace_depth
254
enable_default_logging()
257
def report_exception(exc_info, err_file):
258
exc_type, exc_object, exc_tb = exc_info
259
# Log the full traceback to ~/.bzr.log
260
log_exception_quietly()
261
if (isinstance(exc_object, IOError)
262
and getattr(exc_object, 'errno', None) == errno.EPIPE):
263
print >>err_file, "bzr: broken pipe"
264
elif isinstance(exc_object, KeyboardInterrupt):
265
print >>err_file, "bzr: interrupted"
266
elif getattr(exc_object, 'is_user_error', False):
267
report_user_error(exc_info, err_file)
268
elif isinstance(exc_object, (OSError, IOError)):
269
# Might be nice to catch all of these and show them as something more
270
# specific, but there are too many cases at the moment.
271
report_user_error(exc_info, err_file)
273
report_bug(exc_info, err_file)
276
# TODO: Should these be specially encoding the output?
277
def report_user_error(exc_info, err_file):
278
print >>err_file, "bzr: ERROR:", str(exc_info[1])
281
def report_bug(exc_info, err_file):
282
"""Report an exception that probably indicates a bug in bzr"""
284
exc_type, exc_object, exc_tb = exc_info
285
print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
287
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
289
print >>err_file, 'bzr %s on python %s (%s)' % \
291
'.'.join(map(str, sys.version_info)),
293
print >>err_file, 'arguments: %r' % sys.argv
295
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
252
enable_default_logging()
255
def format_exception_short(exc_info):
256
"""Make a short string form of an exception.
258
This is used for display to stderr. It specially handles exception
259
classes without useful string methods.
261
The result has no trailing newline.
263
exc_info - typically an exception from sys.exc_info()
265
exc_type, exc_object, exc_tb = exc_info
268
return '(no exception)'
269
if isinstance(exc_object, (BzrError, BzrNewError)):
270
return str(exc_object)
273
tb = traceback.extract_tb(exc_tb)
274
msg = '%s: %s' % (exc_type, exc_object)
278
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
280
except Exception, formatting_exc:
281
# XXX: is this really better than just letting it run up?
282
return '(error formatting exception of type %s: %s)' \
283
% (exc_type, formatting_exc)