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.
61
48
from bzrlib.errors import BzrError, BzrNewError
62
from bzrlib.symbol_versioning import (deprecated_function,
66
51
_file_handler = None
67
52
_stderr_handler = None
68
53
_stderr_quiet = False
71
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)
74
77
# configure convenient aliases for output routines
76
79
_bzr_logger = logging.getLogger('bzr')
78
def note(*args, **kwargs):
79
# FIXME note always emits utf-8, regardless of the terminal encoding
81
bzrlib.ui.ui_factory.clear_term()
82
_bzr_logger.info(*args, **kwargs)
84
def warning(*args, **kwargs):
86
bzrlib.ui.ui_factory.clear_term()
87
_bzr_logger.warning(*args, **kwargs)
81
info = note = _bzr_logger.info
82
warning = _bzr_logger.warning
90
83
log_error = _bzr_logger.error
91
84
error = _bzr_logger.error
94
87
def mutter(fmt, *args):
95
88
if _trace_file is None:
97
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
90
if hasattr(_trace_file, 'closed') and _trace_file.closed:
100
if isinstance(fmt, unicode):
101
fmt = fmt.encode('utf8')
104
# It seems that if we do ascii % (unicode, ascii) we can
105
# get a unicode cannot encode ascii error, so make sure that "fmt"
106
# is a unicode string
109
if isinstance(arg, unicode):
110
arg = arg.encode('utf8')
111
real_args.append(arg)
112
out = fmt % tuple(real_args)
97
if isinstance(out, unicode):
98
out = out.encode('utf-8')
116
99
_trace_file.write(out)
117
# TODO: jam 20051227 Consider flushing the trace file to help debugging
137
118
# information if something goes wrong. In a future version this
138
119
# file will be removed on successful completion.
139
120
global _file_handler, _bzr_log_file
142
123
trace_fname = os.path.join(os.path.expanduser(tracefilename))
143
124
_rollover_trace_maybe(trace_fname)
145
126
LINE_BUFFERED = 1
146
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
147
tf = open(trace_fname, 'at', LINE_BUFFERED)
127
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
148
128
_bzr_log_file = tf
149
129
if tf.tell() == 0:
150
130
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
230
223
def enable_test_log(to_file):
231
"""Redirect logging to a temporary file for a test
233
returns an opaque reference that should be passed to disable_test_log
234
after the test completes.
224
"""Redirect logging to a temporary file for a test"""
236
225
disable_default_logging()
226
global _test_log_hdlr, _trace_file
239
227
hdlr = logging.StreamHandler(to_file)
240
228
hdlr.setLevel(logging.DEBUG)
241
229
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
242
230
_bzr_logger.addHandler(hdlr)
243
231
_bzr_logger.setLevel(logging.DEBUG)
244
result = hdlr, _trace_file, _trace_depth
232
_test_log_hdlr = hdlr
245
233
_trace_file = to_file
250
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
251
_bzr_logger.removeHandler(test_log_hdlr)
252
test_log_hdlr.close()
255
_trace_file = old_trace_file
256
_trace_depth = old_trace_depth
258
enable_default_logging()
261
def report_exception(exc_info, err_file):
262
exc_type, exc_object, exc_tb = exc_info
263
# Log the full traceback to ~/.bzr.log
264
log_exception_quietly()
265
if (isinstance(exc_object, IOError)
266
and getattr(exc_object, 'errno', None) == errno.EPIPE):
267
print >>err_file, "bzr: broken pipe"
268
elif isinstance(exc_object, KeyboardInterrupt):
269
print >>err_file, "bzr: interrupted"
270
elif getattr(exc_object, 'is_user_error', False):
271
report_user_error(exc_info, err_file)
272
elif isinstance(exc_object, (OSError, IOError)):
273
# Might be nice to catch all of these and show them as something more
274
# specific, but there are too many cases at the moment.
275
report_user_error(exc_info, err_file)
277
report_bug(exc_info, err_file)
280
# TODO: Should these be specially encoding the output?
281
def report_user_error(exc_info, err_file):
282
print >>err_file, "bzr: ERROR:", str(exc_info[1])
285
def report_bug(exc_info, err_file):
286
"""Report an exception that probably indicates a bug in bzr"""
288
exc_type, exc_object, exc_tb = exc_info
289
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
290
exc_type.__module__, exc_type.__name__, exc_object)
292
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
294
print >>err_file, 'bzr %s on python %s (%s)' % \
296
'.'.join(map(str, sys.version_info)),
298
print >>err_file, 'arguments: %r' % sys.argv
300
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
236
def disable_test_log():
237
_bzr_logger.removeHandler(_test_log_hdlr)
239
enable_default_logging()
242
def format_exception_short(exc_info):
243
"""Make a short string form of an exception.
245
This is used for display to stderr. It specially handles exception
246
classes without useful string methods.
248
The result has no trailing newline.
250
exc_info - typically an exception from sys.exc_info()
252
exc_type, exc_object, exc_tb = exc_info
255
return '(no exception)'
256
if isinstance(exc_object, (BzrError, BzrNewError)):
257
return str(exc_object)
260
tb = traceback.extract_tb(exc_tb)
261
msg = '%s: %s' % (exc_type, exc_object)
265
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
267
except Exception, formatting_exc:
268
# XXX: is this really better than just letting it run up?
269
return '(error formatting exception of type %s: %s)' \
270
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
