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(), """
65
lazy_import(globals(), """
66
from bzrlib import debug
70
_stderr_handler = None
75
_bzr_log_filename = None
78
# configure convenient aliases for output routines
80
_bzr_logger = logging.getLogger('bzr')
82
def note(*args, **kwargs):
83
# FIXME note always emits utf-8, regardless of the terminal encoding
85
bzrlib.ui.ui_factory.clear_term()
86
_bzr_logger.info(*args, **kwargs)
88
def warning(*args, **kwargs):
90
bzrlib.ui.ui_factory.clear_term()
91
_bzr_logger.warning(*args, **kwargs)
94
log_error = _bzr_logger.error
95
error = _bzr_logger.error
98
def mutter(fmt, *args):
99
if _trace_file is None:
101
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
104
if isinstance(fmt, unicode):
105
fmt = fmt.encode('utf8')
108
# It seems that if we do ascii % (unicode, ascii) we can
109
# get a unicode cannot encode ascii error, so make sure that "fmt"
110
# is a unicode string
113
if isinstance(arg, unicode):
114
arg = arg.encode('utf8')
115
real_args.append(arg)
116
out = fmt % tuple(real_args)
120
_trace_file.write(out)
121
# TODO: jam 20051227 Consider flushing the trace file to help debugging
125
def _rollover_trace_maybe(trace_fname):
128
size = os.stat(trace_fname)[stat.ST_SIZE]
131
old_fname = trace_fname + '.old'
132
from osutils import rename
133
rename(trace_fname, old_fname)
138
def open_tracefile(tracefilename=None):
139
# Messages are always written to here, so that we have some
140
# information if something goes wrong. In a future version this
141
# file will be removed on successful completion.
142
global _file_handler, _bzr_log_file, _bzr_log_filename
145
if tracefilename is None:
146
if sys.platform == 'win32':
147
from bzrlib import win32utils
148
home = win32utils.get_home_location()
150
home = os.path.expanduser('~')
151
_bzr_log_filename = os.path.join(home, '.bzr.log')
153
_bzr_log_filename = tracefilename
155
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
156
_rollover_trace_maybe(_bzr_log_filename)
159
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
160
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
162
# tf.tell() on windows always return 0 until some writing done
165
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
166
tf.write("you can delete or truncate this file, or include sections in\n")
167
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
168
_file_handler = logging.StreamHandler(tf)
169
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
170
datefmt = r'%a %H:%M:%S'
171
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
172
_file_handler.setLevel(logging.DEBUG)
173
logging.getLogger('').addHandler(_file_handler)
175
warning("failed to open trace file: %s" % (e))
178
def log_exception_quietly():
179
"""Log the last exception to the trace file only.
181
Used for exceptions that occur internally and that may be
182
interesting to developers but not to users. For example,
183
errors loading plugins.
186
mutter(traceback.format_exc())
189
def enable_default_logging():
190
"""Configure default logging to stderr and .bzr.log"""
191
# FIXME: if this is run twice, things get confused
192
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
193
_stderr_handler = logging.StreamHandler()
194
logging.getLogger('').addHandler(_stderr_handler)
195
_stderr_handler.setLevel(logging.INFO)
196
if not _file_handler:
198
_trace_file = _bzr_log_file
200
_file_handler.setLevel(logging.DEBUG)
201
_bzr_logger.setLevel(logging.DEBUG)
204
def be_quiet(quiet=True):
205
global _stderr_handler, _stderr_quiet
207
_stderr_quiet = quiet
209
_stderr_handler.setLevel(logging.WARNING)
211
_stderr_handler.setLevel(logging.INFO)
219
def disable_default_logging():
220
"""Turn off default log handlers.
222
This is intended to be used by the test framework, which doesn't
223
want leakage from the code-under-test into the main logs.
226
l = logging.getLogger('')
227
l.removeHandler(_stderr_handler)
229
l.removeHandler(_file_handler)
233
def enable_test_log(to_file):
234
"""Redirect logging to a temporary file for a test
236
returns an opaque reference that should be passed to disable_test_log
237
after the test completes.
239
disable_default_logging()
242
hdlr = logging.StreamHandler(to_file)
243
hdlr.setLevel(logging.DEBUG)
244
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
245
_bzr_logger.addHandler(hdlr)
246
_bzr_logger.setLevel(logging.DEBUG)
247
result = hdlr, _trace_file, _trace_depth
248
_trace_file = to_file
253
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
254
_bzr_logger.removeHandler(test_log_hdlr)
255
test_log_hdlr.close()
258
_trace_file = old_trace_file
259
_trace_depth = old_trace_depth
261
enable_default_logging()
264
def report_exception(exc_info, err_file):
265
exc_type, exc_object, exc_tb = exc_info
266
# Log the full traceback to ~/.bzr.log
267
log_exception_quietly()
268
if (isinstance(exc_object, IOError)
269
and getattr(exc_object, 'errno', None) == errno.EPIPE):
270
print >>err_file, "bzr: broken pipe"
271
elif isinstance(exc_object, KeyboardInterrupt):
272
print >>err_file, "bzr: interrupted"
273
elif not getattr(exc_object, 'internal_error', True):
274
report_user_error(exc_info, err_file)
275
elif isinstance(exc_object, (OSError, IOError)):
276
# Might be nice to catch all of these and show them as something more
277
# specific, but there are too many cases at the moment.
278
report_user_error(exc_info, err_file)
280
report_bug(exc_info, err_file)
283
# TODO: Should these be specially encoding the output?
284
def report_user_error(exc_info, err_file):
285
"""Report to err_file an error that's not an internal error.
287
These don't get a traceback unless -Derror was given.
289
if 'error' in debug.debug_flags:
290
report_bug(exc_info, err_file)
292
print >>err_file, "bzr: ERROR:", str(exc_info[1])
295
def report_bug(exc_info, err_file):
296
"""Report an exception that probably indicates a bug in bzr"""
298
exc_type, exc_object, exc_tb = exc_info
299
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
300
exc_type.__module__, exc_type.__name__, exc_object)
302
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
304
print >>err_file, 'bzr %s on python %s (%s)' % \
306
'.'.join(map(str, sys.version_info)),
308
print >>err_file, 'arguments: %r' % sys.argv
310
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
added
removed
bzrlib/trace.py
