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
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.
57
from bzrlib.lazy_import import lazy_import
58
lazy_import(globals(), """
64
from bzrlib.symbol_versioning import (deprecated_function,
69
_stderr_handler = None
76
# configure convenient aliases for output routines
78
_bzr_logger = logging.getLogger('bzr')
80
def note(*args, **kwargs):
81
# FIXME note always emits utf-8, regardless of the terminal encoding
83
bzrlib.ui.ui_factory.clear_term()
84
_bzr_logger.info(*args, **kwargs)
86
def warning(*args, **kwargs):
88
bzrlib.ui.ui_factory.clear_term()
89
_bzr_logger.warning(*args, **kwargs)
92
log_error = _bzr_logger.error
93
error = _bzr_logger.error
96
def mutter(fmt, *args):
97
if _trace_file is None:
99
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
102
if isinstance(fmt, unicode):
103
fmt = fmt.encode('utf8')
106
# It seems that if we do ascii % (unicode, ascii) we can
107
# get a unicode cannot encode ascii error, so make sure that "fmt"
108
# is a unicode string
111
if isinstance(arg, unicode):
112
arg = arg.encode('utf8')
113
real_args.append(arg)
114
out = fmt % tuple(real_args)
118
_trace_file.write(out)
119
# TODO: jam 20051227 Consider flushing the trace file to help debugging
124
def _rollover_trace_maybe(trace_fname):
127
size = os.stat(trace_fname)[stat.ST_SIZE]
130
old_fname = trace_fname + '.old'
131
from osutils import rename
132
rename(trace_fname, old_fname)
137
def open_tracefile(tracefilename='~/.bzr.log'):
138
# Messages are always written to here, so that we have some
139
# information if something goes wrong. In a future version this
140
# file will be removed on successful completion.
141
global _file_handler, _bzr_log_file
144
trace_fname = os.path.join(os.path.expanduser(tracefilename))
145
_rollover_trace_maybe(trace_fname)
148
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
149
tf = open(trace_fname, 'at', LINE_BUFFERED)
152
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
153
tf.write("you can delete or truncate this file, or include sections in\n")
154
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
155
_file_handler = logging.StreamHandler(tf)
156
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
157
datefmt = r'%a %H:%M:%S'
158
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
159
_file_handler.setLevel(logging.DEBUG)
160
logging.getLogger('').addHandler(_file_handler)
162
warning("failed to open trace file: %s" % (e))
165
@deprecated_function(zero_nine)
166
def log_exception(msg=None):
167
"""Log the last exception to stderr and the trace file.
169
The exception string representation is used as the error
170
summary, unless msg is given.
174
log_exception_quietly()
177
def log_exception_quietly():
178
"""Log the last exception to the trace file only.
180
Used for exceptions that occur internally and that may be
181
interesting to developers but not to users. For example,
182
errors loading plugins.
185
debug(traceback.format_exc())
188
def enable_default_logging():
189
"""Configure default logging to stderr and .bzr.log"""
190
# FIXME: if this is run twice, things get confused
191
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
192
_stderr_handler = logging.StreamHandler()
193
logging.getLogger('').addHandler(_stderr_handler)
194
_stderr_handler.setLevel(logging.INFO)
195
if not _file_handler:
197
_trace_file = _bzr_log_file
199
_file_handler.setLevel(logging.DEBUG)
200
_bzr_logger.setLevel(logging.DEBUG)
203
def be_quiet(quiet=True):
204
global _stderr_handler, _stderr_quiet
206
_stderr_quiet = quiet
208
_stderr_handler.setLevel(logging.WARNING)
210
_stderr_handler.setLevel(logging.INFO)
218
def disable_default_logging():
219
"""Turn off default log handlers.
221
This is intended to be used by the test framework, which doesn't
222
want leakage from the code-under-test into the main logs.
225
l = logging.getLogger('')
226
l.removeHandler(_stderr_handler)
228
l.removeHandler(_file_handler)
232
def enable_test_log(to_file):
233
"""Redirect logging to a temporary file for a test
235
returns an opaque reference that should be passed to disable_test_log
236
after the test completes.
238
disable_default_logging()
241
hdlr = logging.StreamHandler(to_file)
242
hdlr.setLevel(logging.DEBUG)
243
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
244
_bzr_logger.addHandler(hdlr)
245
_bzr_logger.setLevel(logging.DEBUG)
246
result = hdlr, _trace_file, _trace_depth
247
_trace_file = to_file
252
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
253
_bzr_logger.removeHandler(test_log_hdlr)
254
test_log_hdlr.close()
257
_trace_file = old_trace_file
258
_trace_depth = old_trace_depth
260
enable_default_logging()
263
def report_exception(exc_info, err_file):
264
exc_type, exc_object, exc_tb = exc_info
265
# Log the full traceback to ~/.bzr.log
266
log_exception_quietly()
267
if (isinstance(exc_object, IOError)
268
and getattr(exc_object, 'errno', None) == errno.EPIPE):
269
print >>err_file, "bzr: broken pipe"
270
elif isinstance(exc_object, KeyboardInterrupt):
271
print >>err_file, "bzr: interrupted"
272
elif getattr(exc_object, 'is_user_error', False):
273
report_user_error(exc_info, err_file)
274
elif isinstance(exc_object, (OSError, IOError)):
275
# Might be nice to catch all of these and show them as something more
276
# specific, but there are too many cases at the moment.
277
report_user_error(exc_info, err_file)
279
report_bug(exc_info, err_file)
282
# TODO: Should these be specially encoding the output?
283
def report_user_error(exc_info, err_file):
284
print >>err_file, "bzr: ERROR:", str(exc_info[1])
287
def report_bug(exc_info, err_file):
288
"""Report an exception that probably indicates a bug in bzr"""
290
exc_type, exc_object, exc_tb = exc_info
291
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
292
exc_type.__module__, exc_type.__name__, exc_object)
294
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
296
print >>err_file, 'bzr %s on python %s (%s)' % \
298
'.'.join(map(str, sys.version_info)),
300
print >>err_file, 'arguments: %r' % sys.argv
302
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
added
removed
bzrlib/trace.py
