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(), """
59
from cStringIO import StringIO
48
from bzrlib.errors import BzrError, BzrNewError
67
lazy_import(globals(), """
68
from bzrlib import debug
51
71
_file_handler = None
52
72
_stderr_handler = None
56
76
_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)
77
_bzr_log_filename = None
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
127
def mutter_callsite(stacklevel, fmt, *args):
128
"""Perform a mutter of fmt and args, logging the call trace.
130
:param stacklevel: The number of frames to show. None will show all
132
:param fmt: The format string to pass to mutter.
133
:param args: A list of substitution variables.
136
traceback.print_stack(limit=stacklevel + 1, file=outf)
137
formatted_lines = outf.getvalue().splitlines()
138
formatted_stack = '\n'.join(formatted_lines[:-2])
139
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
111
142
def _rollover_trace_maybe(trace_fname):
124
def open_tracefile(tracefilename='~/.bzr.log'):
155
def open_tracefile(tracefilename=None):
125
156
# Messages are always written to here, so that we have some
126
157
# information if something goes wrong. In a future version this
127
158
# file will be removed on successful completion.
128
global _file_handler, _bzr_log_file
131
trace_fname = os.path.join(os.path.expanduser(tracefilename))
132
_rollover_trace_maybe(trace_fname)
159
global _file_handler, _bzr_log_file, _bzr_log_filename
162
if tracefilename is None:
163
if sys.platform == 'win32':
164
from bzrlib import win32utils
165
home = win32utils.get_home_location()
167
home = os.path.expanduser('~')
168
_bzr_log_filename = os.path.join(home, '.bzr.log')
170
_bzr_log_filename = tracefilename
172
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
173
_rollover_trace_maybe(_bzr_log_filename)
134
175
LINE_BUFFERED = 1
135
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
176
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
177
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
136
178
_bzr_log_file = tf
138
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
179
# tf.tell() on windows always return 0 until some writing done
182
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
139
183
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")
184
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
141
185
_file_handler = logging.StreamHandler(tf)
142
186
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
143
187
datefmt = r'%a %H:%M:%S'
148
192
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())
160
def log_exception(msg=None):
161
"""Log the last exception to stderr and the trace file.
163
The exception string representation is used as the error
164
summary, unless msg is given.
169
exc_str = format_exception_short(sys.exc_info())
171
log_exception_quietly()
174
195
def log_exception_quietly():
175
196
"""Log the last exception to the trace file only.
195
215
_trace_file = _bzr_log_file
196
216
if _file_handler:
197
217
_file_handler.setLevel(logging.DEBUG)
198
_bzr_logger.setLevel(logging.DEBUG)
218
_bzr_logger.setLevel(logging.DEBUG)
221
def set_verbosity_level(level):
222
"""Set the verbosity level.
224
:param level: -ve for quiet, 0 for normal, +ve for verbose
226
global _verbosity_level
227
_verbosity_level = level
228
_update_logging_level(level < 0)
231
def get_verbosity_level():
232
"""Get the verbosity level.
234
See set_verbosity_level() for values.
236
return _verbosity_level
202
239
def be_quiet(quiet=True):
203
global _stderr_handler, _stderr_quiet
205
_stderr_quiet = quiet
240
# Perhaps this could be deprecated now ...
242
set_verbosity_level(-1)
244
set_verbosity_level(0)
247
def _update_logging_level(quiet=True):
248
"""Hide INFO messages if quiet."""
207
250
_stderr_handler.setLevel(logging.WARNING)
259
307
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()
310
def report_exception(exc_info, err_file):
311
exc_type, exc_object, exc_tb = exc_info
312
# Log the full traceback to ~/.bzr.log
313
log_exception_quietly()
314
if (isinstance(exc_object, IOError)
315
and getattr(exc_object, 'errno', None) == errno.EPIPE):
316
print >>err_file, "bzr: broken pipe"
317
elif isinstance(exc_object, KeyboardInterrupt):
318
print >>err_file, "bzr: interrupted"
319
elif not getattr(exc_object, 'internal_error', True):
320
report_user_error(exc_info, err_file)
321
elif isinstance(exc_object, (OSError, IOError)):
322
# Might be nice to catch all of these and show them as something more
323
# specific, but there are too many cases at the moment.
324
report_user_error(exc_info, err_file)
326
report_bug(exc_info, err_file)
329
# TODO: Should these be specially encoding the output?
330
def report_user_error(exc_info, err_file):
331
"""Report to err_file an error that's not an internal error.
333
These don't get a traceback unless -Derror was given.
335
if 'error' in debug.debug_flags:
336
report_bug(exc_info, err_file)
338
print >>err_file, "bzr: ERROR:", str(exc_info[1])
341
def report_bug(exc_info, err_file):
342
"""Report an exception that probably indicates a bug in bzr"""
272
344
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)
345
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
346
exc_type.__module__, exc_type.__name__, exc_object)
348
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
350
print >>err_file, 'bzr %s on python %s (%s)' % \
352
'.'.join(map(str, sys.version_info)),
354
print >>err_file, 'arguments: %r' % sys.argv
356
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
added
removed
bzrlib/trace.py
