1
# Copyright (C) 2005, 2006 by 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
17
"""Messages and logging for bazaar-ng.
19
Messages are supplied by callers as a string-formatting template, plus values
20
to be inserted into it. The actual %-formatting is deferred to the log
21
library so that it doesn't need to be done for messages that won't be emitted.
23
Messages are classified by severity levels: critical, error, warning, info,
26
They can be sent to two places: to stderr, and to ~/.bzr.log. For purposes
27
such as running the test suite, they can also be redirected away from both of
28
those two places to another location.
30
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
31
This trace file is always in UTF-8, regardless of the user's default encoding,
32
so that we can always rely on writing any message.
34
Output to stderr depends on the mode chosen by the user. By default, messages
35
of info and above are sent out, which results in progress messages such as the
36
list of files processed by add and commit. In quiet mode, only warnings and
37
above are shown. In debug mode, stderr gets debug messages too.
39
Errors that terminate an operation are generally passed back as exceptions;
40
others may be just emitted as messages.
42
Exceptions are reported in a brief form to stderr so as not to look scary.
43
BzrErrors are required to be able to format themselves into a properly
44
explanatory message. This is not true for builtin exceptions such as
45
KeyError, which typically just str to "0". They're printed in a different
49
# FIXME: Unfortunately it turns out that python's logging module
50
# is quite expensive, even when the message is not printed by any handlers.
51
# We should perhaps change back to just simply doing it here.
60
from bzrlib.errors import BzrError, BzrNewError
61
from bzrlib.symbol_versioning import (deprecated_function,
66
_stderr_handler = None
73
# configure convenient aliases for output routines
75
_bzr_logger = logging.getLogger('bzr')
77
def note(*args, **kwargs):
79
bzrlib.ui.ui_factory.clear_term()
80
_bzr_logger.info(*args, **kwargs)
82
def warning(*args, **kwargs):
84
bzrlib.ui.ui_factory.clear_term()
85
_bzr_logger.warning(*args, **kwargs)
88
log_error = _bzr_logger.error
89
error = _bzr_logger.error
92
def mutter(fmt, *args):
93
if _trace_file is None:
95
if hasattr(_trace_file, 'closed') and _trace_file.closed:
98
# It seems that if we do ascii % (unicode, ascii) we can
99
# get a unicode cannot encode ascii error, so make sure that "fmt"
100
# is a unicode string
101
out = unicode(fmt) % args
106
_trace_file.write(out)
107
except UnicodeError, e:
108
warning('UnicodeError: %s', e)
109
_trace_file.write(repr(out))
110
# TODO: jam 20051227 Consider flushing the trace file to help debugging
115
def _rollover_trace_maybe(trace_fname):
118
size = os.stat(trace_fname)[stat.ST_SIZE]
121
old_fname = trace_fname + '.old'
122
from osutils import rename
123
rename(trace_fname, old_fname)
128
def open_tracefile(tracefilename='~/.bzr.log'):
129
# Messages are always written to here, so that we have some
130
# information if something goes wrong. In a future version this
131
# file will be removed on successful completion.
132
global _file_handler, _bzr_log_file
135
trace_fname = os.path.join(os.path.expanduser(tracefilename))
136
_rollover_trace_maybe(trace_fname)
139
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
142
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
143
tf.write("you can delete or truncate this file, or include sections in\n")
144
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
145
_file_handler = logging.StreamHandler(tf)
146
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
147
datefmt = r'%a %H:%M:%S'
148
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
149
_file_handler.setLevel(logging.DEBUG)
150
logging.getLogger('').addHandler(_file_handler)
152
warning("failed to open trace file: %s" % (e))
155
@deprecated_function(zero_nine)
156
def log_exception(msg=None):
157
"""Log the last exception to stderr and the trace file.
159
The exception string representation is used as the error
160
summary, unless msg is given.
165
exc_str = format_exception_short(sys.exc_info())
167
log_exception_quietly()
170
def log_exception_quietly():
171
"""Log the last exception to the trace file only.
173
Used for exceptions that occur internally and that may be
174
interesting to developers but not to users. For example,
175
errors loading plugins.
178
debug(traceback.format_exc())
181
def enable_default_logging():
182
"""Configure default logging to stderr and .bzr.log"""
183
# FIXME: if this is run twice, things get confused
184
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
185
_stderr_handler = logging.StreamHandler()
186
logging.getLogger('').addHandler(_stderr_handler)
187
_stderr_handler.setLevel(logging.INFO)
188
if not _file_handler:
190
_trace_file = _bzr_log_file
192
_file_handler.setLevel(logging.DEBUG)
193
_bzr_logger.setLevel(logging.DEBUG)
196
def be_quiet(quiet=True):
197
global _stderr_handler, _stderr_quiet
199
_stderr_quiet = quiet
201
_stderr_handler.setLevel(logging.WARNING)
203
_stderr_handler.setLevel(logging.INFO)
211
def disable_default_logging():
212
"""Turn off default log handlers.
214
This is intended to be used by the test framework, which doesn't
215
want leakage from the code-under-test into the main logs.
218
l = logging.getLogger('')
219
l.removeHandler(_stderr_handler)
221
l.removeHandler(_file_handler)
225
def enable_test_log(to_file):
226
"""Redirect logging to a temporary file for a test
228
returns an opaque reference that should be passed to disable_test_log
229
after the test completes.
231
disable_default_logging()
234
hdlr = logging.StreamHandler(to_file)
235
hdlr.setLevel(logging.DEBUG)
236
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
237
_bzr_logger.addHandler(hdlr)
238
_bzr_logger.setLevel(logging.DEBUG)
239
result = hdlr, _trace_file, _trace_depth
240
_trace_file = to_file
245
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
246
_bzr_logger.removeHandler(test_log_hdlr)
247
test_log_hdlr.close()
250
_trace_file = old_trace_file
251
_trace_depth = old_trace_depth
253
enable_default_logging()
256
def report_exception(exc_info, err_file):
257
exc_type, exc_object, exc_tb = exc_info
258
if (isinstance(exc_object, IOError)
259
and getattr(exc_object, 'errno', None) == errno.EPIPE):
260
print >>err_file, "bzr: broken pipe"
261
elif isinstance(exc_object, KeyboardInterrupt):
262
print >>err_file, "bzr: interrupted"
263
elif getattr(exc_object, 'is_user_error', False):
264
report_user_error(exc_info, err_file)
265
elif isinstance(exc_object, (OSError, IOError)):
266
# Might be nice to catch all of these and show them as something more
267
# specific, but there are too many cases at the moment.
268
report_user_error(exc_info, err_file)
270
report_bug(exc_info, err_file)
273
# TODO: Should these be specially encoding the output?
274
def report_user_error(exc_info, err_file):
275
print >>err_file, "bzr: ERROR:", str(exc_info[1])
278
def report_bug(exc_info, err_file):
279
"""Report an exception that probably indicates a bug in bzr"""
281
exc_type, exc_object, exc_tb = exc_info
282
print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
284
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
286
print >>err_file, 'bzr %s on python %s (%s)' % \
288
'.'.join(map(str, sys.version_info)),
290
print >>err_file, 'arguments: %r' % sys.argv
292
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
added
removed
bzrlib/trace.py
