1
# Copyright (C) 2005, Canonical Ltd
1
# Copyright (C) 2005, 2006 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(), """
48
from bzrlib.errors import BzrError, BzrNewError
64
from bzrlib.symbol_versioning import (deprecated_function,
68
lazy_import(globals(), """
69
from bzrlib import debug
51
72
_file_handler = None
52
73
_stderr_handler = None
56
77
_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
80
# configure convenient aliases for output routines
80
82
_bzr_logger = logging.getLogger('bzr')
82
84
def note(*args, **kwargs):
85
# FIXME note always emits utf-8, regardless of the terminal encoding
84
87
bzrlib.ui.ui_factory.clear_term()
85
88
_bzr_logger.info(*args, **kwargs)
97
100
def mutter(fmt, *args):
98
101
if _trace_file is None:
100
if hasattr(_trace_file, 'closed') and _trace_file.closed:
103
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
106
if isinstance(fmt, unicode):
107
fmt = fmt.encode('utf8')
102
109
if len(args) > 0:
110
# It seems that if we do ascii % (unicode, ascii) we can
111
# get a unicode cannot encode ascii error, so make sure that "fmt"
112
# is a unicode string
115
if isinstance(arg, unicode):
116
arg = arg.encode('utf8')
117
real_args.append(arg)
118
out = fmt % tuple(real_args)
107
122
_trace_file.write(out)
123
# TODO: jam 20051227 Consider flushing the trace file to help debugging
111
127
def _rollover_trace_maybe(trace_fname):
124
def open_tracefile(tracefilename='~/.bzr.log'):
140
def open_tracefile(tracefilename=None):
125
141
# Messages are always written to here, so that we have some
126
142
# information if something goes wrong. In a future version this
127
143
# file will be removed on successful completion.
128
144
global _file_handler, _bzr_log_file
131
trace_fname = os.path.join(os.path.expanduser(tracefilename))
147
if tracefilename is None:
148
if sys.platform == 'win32':
149
from bzrlib import win32utils
150
home = win32utils.get_home_location()
152
home = os.path.expanduser('~')
153
tracefilename = os.path.join(home, '.bzr.log')
155
trace_fname = os.path.expanduser(tracefilename)
132
156
_rollover_trace_maybe(trace_fname)
134
158
LINE_BUFFERED = 1
135
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
159
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
160
tf = open(trace_fname, 'at', LINE_BUFFERED)
136
161
_bzr_log_file = tf
138
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
162
# tf.tell() on windows always return 0 until some writing done
165
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
139
166
tf.write("you can delete or truncate this file, or include sections in\n")
140
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
167
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
141
168
_file_handler = logging.StreamHandler(tf)
142
169
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
143
170
datefmt = r'%a %H:%M:%S'
148
175
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())
178
@deprecated_function(zero_nine)
160
179
def log_exception(msg=None):
161
180
"""Log the last exception to stderr and the trace file.
163
182
The exception string representation is used as the error
164
183
summary, unless msg is given.
185
Please see log_exception_quietly() for the replacement API.
169
exc_str = format_exception_short(sys.exc_info())
171
189
log_exception_quietly()
259
275
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()
278
def report_exception(exc_info, err_file):
279
exc_type, exc_object, exc_tb = exc_info
280
# Log the full traceback to ~/.bzr.log
281
log_exception_quietly()
282
if (isinstance(exc_object, IOError)
283
and getattr(exc_object, 'errno', None) == errno.EPIPE):
284
print >>err_file, "bzr: broken pipe"
285
elif isinstance(exc_object, KeyboardInterrupt):
286
print >>err_file, "bzr: interrupted"
287
elif not getattr(exc_object, 'internal_error', True):
288
report_user_error(exc_info, err_file)
289
elif isinstance(exc_object, (OSError, IOError)):
290
# Might be nice to catch all of these and show them as something more
291
# specific, but there are too many cases at the moment.
292
report_user_error(exc_info, err_file)
294
report_bug(exc_info, err_file)
297
# TODO: Should these be specially encoding the output?
298
def report_user_error(exc_info, err_file):
299
"""Report to err_file an error that's not an internal error.
301
These don't get a traceback unless -Derror was given.
303
if 'error' in debug.debug_flags:
304
report_bug(exc_info, err_file)
306
print >>err_file, "bzr: ERROR:", str(exc_info[1])
309
def report_bug(exc_info, err_file):
310
"""Report an exception that probably indicates a bug in bzr"""
272
312
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)
313
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
314
exc_type.__module__, exc_type.__name__, exc_object)
316
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
318
print >>err_file, 'bzr %s on python %s (%s)' % \
320
'.'.join(map(str, sys.version_info)),
322
print >>err_file, 'arguments: %r' % sys.argv
324
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
added
removed
bzrlib/trace.py
