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
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.
57
from bzrlib.lazy_import import lazy_import
58
lazy_import(globals(), """
64
from bzrlib.symbol_versioning import (deprecated_function,
48
from bzrlib.errors import BzrError, BzrNewError
68
lazy_import(globals(), """
69
from bzrlib import debug
72
51
_file_handler = None
73
52
_stderr_handler = None
77
56
_bzr_log_file = None
78
_bzr_log_filename = 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)
81
78
# configure convenient aliases for output routines
83
80
_bzr_logger = logging.getLogger('bzr')
85
82
def note(*args, **kwargs):
86
# FIXME note always emits utf-8, regardless of the terminal encoding
88
84
bzrlib.ui.ui_factory.clear_term()
89
85
_bzr_logger.info(*args, **kwargs)
101
97
def mutter(fmt, *args):
102
98
if _trace_file is None:
104
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
100
if hasattr(_trace_file, 'closed') and _trace_file.closed:
107
if isinstance(fmt, unicode):
108
fmt = fmt.encode('utf8')
110
102
if len(args) > 0:
111
103
# It seems that if we do ascii % (unicode, ascii) we can
112
104
# get a unicode cannot encode ascii error, so make sure that "fmt"
113
105
# is a unicode string
116
if isinstance(arg, unicode):
117
arg = arg.encode('utf8')
118
real_args.append(arg)
119
out = fmt % tuple(real_args)
106
out = unicode(fmt) % args
123
_trace_file.write(out)
111
_trace_file.write(out)
112
except UnicodeError, e:
113
warning('UnicodeError: %s', e)
114
_trace_file.write(repr(out))
124
115
# TODO: jam 20051227 Consider flushing the trace file to help debugging
125
116
#_trace_file.flush()
128
120
def _rollover_trace_maybe(trace_fname):
141
def open_tracefile(tracefilename=None):
133
def open_tracefile(tracefilename='~/.bzr.log'):
142
134
# Messages are always written to here, so that we have some
143
135
# information if something goes wrong. In a future version this
144
136
# file will be removed on successful completion.
145
global _file_handler, _bzr_log_file, _bzr_log_filename
148
if tracefilename is None:
149
if sys.platform == 'win32':
150
from bzrlib import win32utils
151
home = win32utils.get_home_location()
153
home = os.path.expanduser('~')
154
_bzr_log_filename = os.path.join(home, '.bzr.log')
156
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
157
_rollover_trace_maybe(_bzr_log_filename)
137
global _file_handler, _bzr_log_file
140
trace_fname = os.path.join(os.path.expanduser(tracefilename))
141
_rollover_trace_maybe(trace_fname)
159
143
LINE_BUFFERED = 1
160
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
161
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
144
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
162
145
_bzr_log_file = tf
163
# tf.tell() on windows always return 0 until some writing done
166
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
147
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
167
148
tf.write("you can delete or truncate this file, or include sections in\n")
168
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
149
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
169
150
_file_handler = logging.StreamHandler(tf)
170
151
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
171
152
datefmt = r'%a %H:%M:%S'
176
157
warning("failed to open trace file: %s" % (e))
179
@deprecated_function(zero_nine)
160
def log_startup(argv):
161
debug('\n\nbzr %s invoked on python %s (%s)',
163
'.'.join(map(str, sys.version_info)),
165
debug(' arguments: %r', argv)
166
debug(' working dir: %r', os.getcwdu())
180
169
def log_exception(msg=None):
181
170
"""Log the last exception to stderr and the trace file.
183
172
The exception string representation is used as the error
184
173
summary, unless msg is given.
186
Please see log_exception_quietly() for the replacement API.
178
exc_str = format_exception_short(sys.exc_info())
190
180
log_exception_quietly()
276
268
enable_default_logging()
279
def report_exception(exc_info, err_file):
280
exc_type, exc_object, exc_tb = exc_info
281
# Log the full traceback to ~/.bzr.log
282
log_exception_quietly()
283
if (isinstance(exc_object, IOError)
284
and getattr(exc_object, 'errno', None) == errno.EPIPE):
285
print >>err_file, "bzr: broken pipe"
286
elif isinstance(exc_object, KeyboardInterrupt):
287
print >>err_file, "bzr: interrupted"
288
elif not getattr(exc_object, 'internal_error', True):
289
report_user_error(exc_info, err_file)
290
elif isinstance(exc_object, (OSError, IOError)):
291
# Might be nice to catch all of these and show them as something more
292
# specific, but there are too many cases at the moment.
293
report_user_error(exc_info, err_file)
295
report_bug(exc_info, err_file)
298
# TODO: Should these be specially encoding the output?
299
def report_user_error(exc_info, err_file):
300
"""Report to err_file an error that's not an internal error.
302
These don't get a traceback unless -Derror was given.
271
def format_exception_short(exc_info):
272
"""Make a short string form of an exception.
274
This is used for display to stderr. It specially handles exception
275
classes without useful string methods.
277
The result has no trailing newline.
279
exc_info - typically an exception from sys.exc_info()
304
if 'error' in debug.debug_flags:
305
report_bug(exc_info, err_file)
307
print >>err_file, "bzr: ERROR:", str(exc_info[1])
310
def report_bug(exc_info, err_file):
311
"""Report an exception that probably indicates a bug in bzr"""
313
281
exc_type, exc_object, exc_tb = exc_info
314
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
315
exc_type.__module__, exc_type.__name__, exc_object)
317
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
319
print >>err_file, 'bzr %s on python %s (%s)' % \
321
'.'.join(map(str, sys.version_info)),
323
print >>err_file, 'arguments: %r' % sys.argv
325
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
284
return '(no exception)'
285
if isinstance(exc_object, (BzrError, BzrNewError)):
286
return str(exc_object)
289
tb = traceback.extract_tb(exc_tb)
290
msg = '%s: %s' % (exc_type, exc_object)
294
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
296
except Exception, formatting_exc:
297
# XXX: is this really better than just letting it run up?
298
return '(error formatting exception of type %s: %s)' \
299
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
