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 excexceptions 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
64
_stderr_handler = None
71
# configure convenient aliases for output routines
73
_bzr_logger = logging.getLogger('bzr')
75
def note(*args, **kwargs):
77
bzrlib.ui.ui_factory.clear_term()
78
_bzr_logger.info(*args, **kwargs)
80
def warning(*args, **kwargs):
82
bzrlib.ui.ui_factory.clear_term()
83
_bzr_logger.warning(*args, **kwargs)
86
log_error = _bzr_logger.error
87
error = _bzr_logger.error
90
def mutter(fmt, *args):
91
if _trace_file is None:
93
if hasattr(_trace_file, 'closed') and _trace_file.closed:
100
_trace_file.write(out)
104
def _rollover_trace_maybe(trace_fname):
107
size = os.stat(trace_fname)[stat.ST_SIZE]
110
old_fname = trace_fname + '.old'
111
from osutils import rename
112
rename(trace_fname, old_fname)
117
def open_tracefile(tracefilename='~/.bzr.log'):
118
# Messages are always written to here, so that we have some
119
# information if something goes wrong. In a future version this
120
# file will be removed on successful completion.
121
global _file_handler, _bzr_log_file
124
trace_fname = os.path.join(os.path.expanduser(tracefilename))
125
_rollover_trace_maybe(trace_fname)
128
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
131
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
132
tf.write("you can delete or truncate this file, or include sections in\n")
133
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
134
_file_handler = logging.StreamHandler(tf)
135
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
136
datefmt = r'%a %H:%M:%S'
137
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
138
_file_handler.setLevel(logging.DEBUG)
139
logging.getLogger('').addHandler(_file_handler)
141
warning("failed to open trace file: %s" % (e))
144
def log_exception_quietly():
145
"""Log the last exception to the trace file only.
147
Used for exceptions that occur internally and that may be
148
interesting to developers but not to users. For example,
149
errors loading plugins.
152
debug(traceback.format_exc())
155
def enable_default_logging():
156
"""Configure default logging to stderr and .bzr.log"""
157
# FIXME: if this is run twice, things get confused
158
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
159
_stderr_handler = logging.StreamHandler()
160
logging.getLogger('').addHandler(_stderr_handler)
161
_stderr_handler.setLevel(logging.INFO)
162
if not _file_handler:
164
_trace_file = _bzr_log_file
166
_file_handler.setLevel(logging.DEBUG)
167
_bzr_logger.setLevel(logging.DEBUG)
170
def be_quiet(quiet=True):
171
global _stderr_handler, _stderr_quiet
173
_stderr_quiet = quiet
175
_stderr_handler.setLevel(logging.WARNING)
177
_stderr_handler.setLevel(logging.INFO)
185
def disable_default_logging():
186
"""Turn off default log handlers.
188
This is intended to be used by the test framework, which doesn't
189
want leakage from the code-under-test into the main logs.
192
l = logging.getLogger('')
193
l.removeHandler(_stderr_handler)
195
l.removeHandler(_file_handler)
199
def enable_test_log(to_file):
200
"""Redirect logging to a temporary file for a test
202
returns an opaque reference that should be passed to disable_test_log
203
after the test completes.
205
disable_default_logging()
208
hdlr = logging.StreamHandler(to_file)
209
hdlr.setLevel(logging.DEBUG)
210
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
211
_bzr_logger.addHandler(hdlr)
212
_bzr_logger.setLevel(logging.DEBUG)
213
result = hdlr, _trace_file, _trace_depth
214
_trace_file = to_file
219
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
220
_bzr_logger.removeHandler(test_log_hdlr)
221
test_log_hdlr.close()
224
_trace_file = old_trace_file
225
_trace_depth = old_trace_depth
227
enable_default_logging()
230
def report_exception(exc_info, err_file):
231
exc_type, exc_object, exc_tb = exc_info
232
if (isinstance(exc_object, IOError)
233
and getattr(exc_object, 'errno', None) == errno.EPIPE):
234
print >>err_file, "bzr: broken pipe"
235
elif isinstance(exc_object, KeyboardInterrupt):
236
print >>err_file, "bzr: interrupted"
237
elif getattr(exc_object, 'is_user_error', False):
238
report_user_error(exc_info, err_file)
239
elif isinstance(exc_object, (OSError, IOError)):
240
# Might be nice to catch all of these and show them as something more
241
# specific, but there are too many cases at the moment.
242
report_user_error(exc_info, err_file)
244
report_bug(exc_info, err_file)
247
# TODO: Should these be specially encoding the output?
248
def report_user_error(exc_info, err_file):
249
print >>err_file, "bzr: ERROR:", str(exc_info[1])
252
def report_bug(exc_info, err_file):
253
"""Report an exception that probably indicates a bug in bzr"""
255
exc_type, exc_object, exc_tb = exc_info
256
print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
258
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
260
print >>err_file, 'bzr %s on python %s (%s)' % \
262
'.'.join(map(str, sys.version_info)),
264
print >>err_file, 'arguments: %r' % sys.argv
266
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
added
removed
bzrlib/trace.py
