1
# Copyright (C) 2005, Canonical Ltd
3
"""Messages and logging for bazaar-ng.
5
Messages are supplied by callers as a string-formatting template, plus values
6
to be inserted into it. The actual %-formatting is deferred to the log
7
library so that it doesn't need to be done for messages that won't be emitted.
9
Messages are classified by severity levels: critical, error, warning, info,
12
They can be sent to two places: to stderr, and to ~/.bzr.log. For purposes
13
such as running the test suite, they can also be redirected away from both of
14
those two places to another location.
16
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
17
This trace file is always in UTF-8, regardless of the user's default encoding,
18
so that we can always rely on writing any message.
20
Output to stderr depends on the mode chosen by the user. By default, messages
21
of info and above are sent out, which results in progress messages such as the
22
list of files processed by add and commit. In quiet mode, only warnings and
23
above are shown. In debug mode, stderr gets debug messages too.
25
Errors that terminate an operation are generally passed back as exceptions;
26
others may be just emitted as messages.
28
Exceptions are reported in a brief form to stderr so as not to look scary.
29
BzrErrors are required to be able to format themselves into a properly
30
explanatory message. This is not true for builtin excexceptions such as
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?)
38
# FIXME: Unfortunately it turns out that python's logging module
39
# is quite expensive, even when the message is not printed by any handlers.
40
# We should perhaps change back to just simply doing it here.
48
from bzrlib.errors import BzrError, BzrNewError
52
_stderr_handler = None
57
class QuietFormatter(logging.Formatter):
58
"""Formatter that supresses the details of errors.
60
This is used by default on stderr so as not to scare the user.
62
# At first I tried overriding formatException to suppress the
63
# exception details, but that has global effect: no loggers
64
# can get the exception details is we suppress them here.
66
def format(self, record):
67
if record.levelno >= logging.WARNING:
68
s = 'bzr: ' + record.levelname + ': '
71
s += record.getMessage()
73
s += '\n' + format_exception_short(record.exc_info)
76
# configure convenient aliases for output routines
78
_bzr_logger = logging.getLogger('bzr')
80
info = note = _bzr_logger.info
81
warning = _bzr_logger.warning
82
log_error = _bzr_logger.error
83
error = _bzr_logger.error
86
def mutter(fmt, *args):
87
if _trace_file is None:
89
if hasattr(_trace_file, 'closed') and _trace_file.closed:
96
if isinstance(out, unicode):
97
out = out.encode('utf-8')
98
_trace_file.write(out)
102
def _rollover_trace_maybe(trace_fname):
105
size = os.stat(trace_fname)[stat.ST_SIZE]
108
old_fname = trace_fname + '.old'
109
from osutils import rename
110
rename(trace_fname, old_fname)
115
def open_tracefile(tracefilename='~/.bzr.log'):
116
# Messages are always written to here, so that we have some
117
# information if something goes wrong. In a future version this
118
# file will be removed on successful completion.
119
global _file_handler, _bzr_log_file
122
trace_fname = os.path.join(os.path.expanduser(tracefilename))
123
_rollover_trace_maybe(trace_fname)
126
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
129
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
130
tf.write("you can delete or truncate this file, or include sections in\n")
131
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
132
_file_handler = logging.StreamHandler(tf)
133
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
134
datefmt = r'%a %H:%M:%S'
135
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
136
_file_handler.setLevel(logging.DEBUG)
137
logging.getLogger('').addHandler(_file_handler)
139
warning("failed to open trace file: %s" % (e))
142
def log_startup(argv):
143
debug('\n\nbzr %s invoked on python %s (%s)',
145
'.'.join(map(str, sys.version_info)),
147
debug(' arguments: %r', argv)
148
debug(' working dir: %r', os.getcwdu())
151
def log_exception(msg=None):
152
"""Log the last exception to stderr and the trace file.
154
The exception string representation is used as the error
155
summary, unless msg is given.
160
exc_str = format_exception_short(sys.exc_info())
162
log_exception_quietly()
165
def log_exception_quietly():
166
"""Log the last exception to the trace file only.
168
Used for exceptions that occur internally and that may be
169
interesting to developers but not to users. For example,
170
errors loading plugins.
173
debug(traceback.format_exc())
176
def enable_default_logging():
177
"""Configure default logging to stderr and .bzr.log"""
178
# FIXME: if this is run twice, things get confused
179
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
180
_stderr_handler = logging.StreamHandler()
181
_stderr_handler.setFormatter(QuietFormatter())
182
logging.getLogger('').addHandler(_stderr_handler)
183
_stderr_handler.setLevel(logging.INFO)
184
if not _file_handler:
186
_trace_file = _bzr_log_file
188
_file_handler.setLevel(logging.DEBUG)
189
_bzr_logger.setLevel(logging.DEBUG)
193
def be_quiet(quiet=True):
194
global _stderr_handler, _stderr_quiet
196
_stderr_quiet = quiet
198
_stderr_handler.setLevel(logging.WARNING)
200
_stderr_handler.setLevel(logging.INFO)
208
def disable_default_logging():
209
"""Turn off default log handlers.
211
This is intended to be used by the test framework, which doesn't
212
want leakage from the code-under-test into the main logs.
215
l = logging.getLogger('')
216
l.removeHandler(_stderr_handler)
218
l.removeHandler(_file_handler)
222
def enable_test_log(to_file):
223
"""Redirect logging to a temporary file for a test"""
224
disable_default_logging()
225
global _test_log_hdlr, _trace_file
226
hdlr = logging.StreamHandler(to_file)
227
hdlr.setLevel(logging.DEBUG)
228
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
229
_bzr_logger.addHandler(hdlr)
230
_bzr_logger.setLevel(logging.DEBUG)
231
_test_log_hdlr = hdlr
232
_trace_file = to_file
235
def disable_test_log():
236
_bzr_logger.removeHandler(_test_log_hdlr)
238
enable_default_logging()
241
def format_exception_short(exc_info):
242
"""Make a short string form of an exception.
244
This is used for display to stderr. It specially handles exception
245
classes without useful string methods.
247
The result has no trailing newline.
249
exc_info - typically an exception from sys.exc_info()
251
exc_type, exc_object, exc_tb = exc_info
254
return '(no exception)'
255
if isinstance(exc_object, (BzrError, BzrNewError)):
256
return str(exc_object)
259
tb = traceback.extract_tb(exc_tb)
260
msg = '%s: %s' % (exc_type, exc_object)
264
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
266
except Exception, formatting_exc:
267
# XXX: is this really better than just letting it run up?
268
return '(error formatting exception of type %s: %s)' \
269
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
