1
# Copyright (C) 2005, Canonical Ltd
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
3
17
"""Messages and logging for bazaar-ng.
28
42
Exceptions are reported in a brief form to stderr so as not to look scary.
29
43
BzrErrors are required to be able to format themselves into a properly
30
explanatory message. This is not true for builtin excexceptions such as
44
explanatory message. This is not true for builtin exceptions such as
31
45
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?)
38
49
# FIXME: Unfortunately it turns out that python's logging module
39
50
# is quite expensive, even when the message is not printed by any handlers.
40
51
# We should perhaps change back to just simply doing it here.
48
60
from bzrlib.errors import BzrError, BzrNewError
61
from bzrlib.symbol_versioning import (deprecated_function,
51
65
_file_handler = None
52
66
_stderr_handler = None
56
70
_bzr_log_file = None
59
class QuietFormatter(logging.Formatter):
60
"""Formatter that supresses the details of errors.
62
This is used by default on stderr so as not to scare the user.
64
# At first I tried overriding formatException to suppress the
65
# exception details, but that has global effect: no loggers
66
# can get the exception details is we suppress them here.
68
def format(self, record):
69
if record.levelno >= logging.WARNING:
70
s = 'bzr: ' + record.levelname + ': '
73
s += record.getMessage()
75
s += '\n' + format_exception_short(record.exc_info)
78
73
# configure convenient aliases for output routines
80
75
_bzr_logger = logging.getLogger('bzr')
82
77
def note(*args, **kwargs):
78
# FIXME note always emits utf-8, regardless of the terminal encoding
84
80
bzrlib.ui.ui_factory.clear_term()
85
81
_bzr_logger.info(*args, **kwargs)
100
96
if hasattr(_trace_file, 'closed') and _trace_file.closed:
99
# It seems that if we do ascii % (unicode, ascii) we can
100
# get a unicode cannot encode ascii error, so make sure that "fmt"
101
# is a unicode string
102
out = unicode(fmt) % args
107
_trace_file.write(out)
107
_trace_file.write(out)
108
except UnicodeError, e:
109
warning('UnicodeError: %s', e)
110
_trace_file.write(repr(out))
111
# TODO: jam 20051227 Consider flushing the trace file to help debugging
148
153
warning("failed to open trace file: %s" % (e))
151
def log_startup(argv):
152
debug('\n\nbzr %s invoked on python %s (%s)',
154
'.'.join(map(str, sys.version_info)),
156
debug(' arguments: %r', argv)
157
debug(' working dir: %r', os.getcwdu())
156
@deprecated_function(zero_nine)
160
157
def log_exception(msg=None):
161
158
"""Log the last exception to stderr and the trace file.
259
254
enable_default_logging()
262
def format_exception_short(exc_info):
263
"""Make a short string form of an exception.
265
This is used for display to stderr. It specially handles exception
266
classes without useful string methods.
268
The result has no trailing newline.
270
exc_info - typically an exception from sys.exc_info()
272
exc_type, exc_object, exc_tb = exc_info
275
return '(no exception)'
276
if isinstance(exc_object, (BzrError, BzrNewError)):
277
return str(exc_object)
280
tb = traceback.extract_tb(exc_tb)
281
msg = '%s: %s' % (exc_type, exc_object)
285
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
287
except Exception, formatting_exc:
288
# XXX: is this really better than just letting it run up?
289
return '(error formatting exception of type %s: %s)' \
290
% (exc_type, formatting_exc)
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"
added
removed
bzrlib/trace.py
