1
# Copyright (C) 2005, Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007 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.
57
from bzrlib.lazy_import import lazy_import
58
lazy_import(globals(), """
59
from cStringIO import StringIO
48
from bzrlib.errors import BzrError, BzrNewError
68
lazy_import(globals(), """
51
77
_file_handler = None
52
78
_stderr_handler = None
55
82
_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)
83
_bzr_log_filename = None
77
86
# configure convenient aliases for output routines
79
88
_bzr_logger = logging.getLogger('bzr')
81
90
def note(*args, **kwargs):
91
# FIXME note always emits utf-8, regardless of the terminal encoding
83
93
bzrlib.ui.ui_factory.clear_term()
84
94
_bzr_logger.info(*args, **kwargs)
96
106
def mutter(fmt, *args):
97
107
if _trace_file is None:
99
if hasattr(_trace_file, 'closed') and _trace_file.closed:
109
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
112
if isinstance(fmt, unicode):
113
fmt = fmt.encode('utf8')
101
115
if len(args) > 0:
116
# It seems that if we do ascii % (unicode, ascii) we can
117
# get a unicode cannot encode ascii error, so make sure that "fmt"
118
# is a unicode string
121
if isinstance(arg, unicode):
122
arg = arg.encode('utf8')
123
real_args.append(arg)
124
out = fmt % tuple(real_args)
106
128
_trace_file.write(out)
129
# TODO: jam 20051227 Consider flushing the trace file to help debugging
133
def mutter_callsite(stacklevel, fmt, *args):
134
"""Perform a mutter of fmt and args, logging the call trace.
136
:param stacklevel: The number of frames to show. None will show all
138
:param fmt: The format string to pass to mutter.
139
:param args: A list of substitution variables.
142
traceback.print_stack(limit=stacklevel + 1, file=outf)
143
formatted_lines = outf.getvalue().splitlines()
144
formatted_stack = '\n'.join(formatted_lines[:-2])
145
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
110
148
def _rollover_trace_maybe(trace_fname):
114
152
if size <= 4 << 20:
116
154
old_fname = trace_fname + '.old'
117
from osutils import rename
118
rename(trace_fname, old_fname)
155
osutils.rename(trace_fname, old_fname)
123
def open_tracefile(tracefilename='~/.bzr.log'):
160
def open_tracefile(tracefilename=None):
124
161
# Messages are always written to here, so that we have some
125
162
# information if something goes wrong. In a future version this
126
163
# file will be removed on successful completion.
127
global _file_handler, _bzr_log_file
130
trace_fname = os.path.join(os.path.expanduser(tracefilename))
131
_rollover_trace_maybe(trace_fname)
164
global _file_handler, _bzr_log_file, _bzr_log_filename
167
if tracefilename is None:
168
if sys.platform == 'win32':
169
from bzrlib import win32utils
170
home = win32utils.get_home_location()
172
home = os.path.expanduser('~')
173
_bzr_log_filename = os.path.join(home, '.bzr.log')
175
_bzr_log_filename = tracefilename
177
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
178
_rollover_trace_maybe(_bzr_log_filename)
133
180
LINE_BUFFERED = 1
134
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
181
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
182
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
135
183
_bzr_log_file = tf
137
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
184
# tf.tell() on windows always return 0 until some writing done
187
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
138
188
tf.write("you can delete or truncate this file, or include sections in\n")
139
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
189
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
140
190
_file_handler = logging.StreamHandler(tf)
141
191
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
142
192
datefmt = r'%a %H:%M:%S'
194
220
_trace_file = _bzr_log_file
195
221
if _file_handler:
196
222
_file_handler.setLevel(logging.DEBUG)
197
_bzr_logger.setLevel(logging.DEBUG)
223
_bzr_logger.setLevel(logging.DEBUG)
226
def set_verbosity_level(level):
227
"""Set the verbosity level.
229
:param level: -ve for quiet, 0 for normal, +ve for verbose
231
global _verbosity_level
232
_verbosity_level = level
233
_update_logging_level(level < 0)
236
def get_verbosity_level():
237
"""Get the verbosity level.
239
See set_verbosity_level() for values.
241
return _verbosity_level
201
244
def be_quiet(quiet=True):
202
global _stderr_handler, _stderr_quiet
204
_stderr_quiet = quiet
245
# Perhaps this could be deprecated now ...
247
set_verbosity_level(-1)
249
set_verbosity_level(0)
252
def _update_logging_level(quiet=True):
253
"""Hide INFO messages if quiet."""
206
255
_stderr_handler.setLevel(logging.WARNING)
231
285
"""Redirect logging to a temporary file for a test
233
287
returns an opaque reference that should be passed to disable_test_log
234
after the test complete.
288
after the test completes.
236
290
disable_default_logging()
237
291
global _trace_file
238
293
hdlr = logging.StreamHandler(to_file)
239
294
hdlr.setLevel(logging.DEBUG)
240
295
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
241
296
_bzr_logger.addHandler(hdlr)
242
297
_bzr_logger.setLevel(logging.DEBUG)
243
result = hdlr, _trace_file
298
result = hdlr, _trace_file, _trace_depth
244
299
_trace_file = to_file
248
def disable_test_log((test_log_hdlr, old_trace_file)):
304
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
249
305
_bzr_logger.removeHandler(test_log_hdlr)
250
306
test_log_hdlr.close()
251
309
_trace_file = old_trace_file
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)
310
_trace_depth = old_trace_depth
312
enable_default_logging()
315
def report_exception(exc_info, err_file):
316
"""Report an exception to err_file (typically stderr) and to .bzr.log.
318
This will show either a full traceback or a short message as appropriate.
320
:return: The appropriate exit code for this error.
322
exc_type, exc_object, exc_tb = exc_info
323
# Log the full traceback to ~/.bzr.log
324
log_exception_quietly()
325
if (isinstance(exc_object, IOError)
326
and getattr(exc_object, 'errno', None) == errno.EPIPE):
327
print >>err_file, "bzr: broken pipe"
328
return errors.EXIT_ERROR
329
elif isinstance(exc_object, KeyboardInterrupt):
330
print >>err_file, "bzr: interrupted"
331
return errors.EXIT_ERROR
332
elif not getattr(exc_object, 'internal_error', True):
333
report_user_error(exc_info, err_file)
334
return errors.EXIT_ERROR
335
elif isinstance(exc_object, (OSError, IOError)):
336
# Might be nice to catch all of these and show them as something more
337
# specific, but there are too many cases at the moment.
338
report_user_error(exc_info, err_file)
339
return errors.EXIT_ERROR
341
report_bug(exc_info, err_file)
342
return errors.EXIT_INTERNAL_ERROR
345
# TODO: Should these be specially encoding the output?
346
def report_user_error(exc_info, err_file):
347
"""Report to err_file an error that's not an internal error.
349
These don't get a traceback unless -Derror was given.
351
if 'error' in debug.debug_flags:
352
report_bug(exc_info, err_file)
354
print >>err_file, "bzr: ERROR:", str(exc_info[1])
357
def report_bug(exc_info, err_file):
358
"""Report an exception that probably indicates a bug in bzr"""
360
exc_type, exc_object, exc_tb = exc_info
361
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
362
exc_type.__module__, exc_type.__name__, exc_object)
364
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
366
print >>err_file, 'bzr %s on python %s (%s)' % \
368
'.'.join(map(str, sys.version_info)),
370
print >>err_file, 'arguments: %r' % sys.argv
372
'encoding: %r, fsenc: %r, lang: %r\n' % (
373
osutils.get_user_encoding(), sys.getfilesystemencoding(),
374
os.environ.get('LANG')))
375
err_file.write("plugins:\n")
376
for name, a_plugin in sorted(plugin.plugins().items()):
377
err_file.write(" %-20s %s [%s]\n" %
378
(name, a_plugin.path(), a_plugin.__version__))
381
"** Please send this report to bazaar@lists.ubuntu.com\n"
382
" with a description of what you were doing when the\n"
added
removed
bzrlib/trace.py
