1
# Copyright (C) 2005, 2006 Canonical Ltd
1
3
# This program is free software; you can redistribute it and/or modify
2
4
# it under the terms of the GNU General Public License as published by
3
5
# the Free Software Foundation; either version 2 of the License, or
4
6
# (at your option) any later version.
6
8
# This program is distributed in the hope that it will be useful,
7
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
11
# GNU General Public License for more details.
11
13
# You should have received a copy of the GNU General Public License
12
14
# along with this program; if not, write to the Free Software
13
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17
"""Messages and logging for bazaar-ng.
18
19
Messages are supplied by callers as a string-formatting template, plus values
39
42
Exceptions are reported in a brief form to stderr so as not to look scary.
40
43
BzrErrors are required to be able to format themselves into a properly
41
explanatory message. This is not true for builtin excexceptions such as
44
explanatory message. This is not true for builtin exceptions such as
42
45
KeyError, which typically just str to "0". They're printed in a different
47
# TODO: in debug mode, stderr should get full tracebacks and also
48
# debug messages. (Is this really needed?)
50
# TODO: When running the test suites, we should add an additional
51
# logger that sends messages into the test log file.
53
49
# FIXME: Unfortunately it turns out that python's logging module
54
50
# is quite expensive, even when the message is not printed by any handlers.
55
51
# We should perhaps change back to just simply doing it here.
57
from bzrlib.lazy_import import lazy_import
58
lazy_import(globals(), """
63
from bzrlib.errors import BzrNewError
64
from bzrlib.symbol_versioning import (deprecated_function,
68
lazy_import(globals(), """
69
from bzrlib import debug
66
72
_file_handler = None
67
73
_stderr_handler = None
69
class QuietFormatter(logging.Formatter):
70
"""Formatter that supresses the details of errors.
72
This is used by default on stderr so as not to scare the user.
74
# At first I tried overriding formatException to suppress the
75
# exception details, but that has global effect: no loggers
76
# can get the exception details is we suppress them here.
78
def format(self, record):
79
if record.levelno >= logging.WARNING:
80
s = 'bzr: ' + record.levelname + ': '
83
s += record.getMessage()
85
s += '\n' + format_exception_short(record.exc_info)
92
80
# configure convenient aliases for output routines
94
82
_bzr_logger = logging.getLogger('bzr')
96
info = note = _bzr_logger.info
97
warning = _bzr_logger.warning
84
def note(*args, **kwargs):
85
# FIXME note always emits utf-8, regardless of the terminal encoding
87
bzrlib.ui.ui_factory.clear_term()
88
_bzr_logger.info(*args, **kwargs)
90
def warning(*args, **kwargs):
92
bzrlib.ui.ui_factory.clear_term()
93
_bzr_logger.warning(*args, **kwargs)
98
96
log_error = _bzr_logger.error
99
97
error = _bzr_logger.error
100
mutter = _bzr_logger.debug
101
debug = _bzr_logger.debug
100
def mutter(fmt, *args):
101
if _trace_file is None:
103
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
106
if isinstance(fmt, unicode):
107
fmt = fmt.encode('utf8')
110
# It seems that if we do ascii % (unicode, ascii) we can
111
# get a unicode cannot encode ascii error, so make sure that "fmt"
112
# is a unicode string
115
if isinstance(arg, unicode):
116
arg = arg.encode('utf8')
117
real_args.append(arg)
118
out = fmt % tuple(real_args)
122
_trace_file.write(out)
123
# TODO: jam 20051227 Consider flushing the trace file to help debugging
104
127
def _rollover_trace_maybe(trace_fname):
117
def open_tracefile(tracefilename='~/.bzr.log'):
140
def open_tracefile(tracefilename=None):
118
141
# Messages are always written to here, so that we have some
119
142
# information if something goes wrong. In a future version this
120
143
# file will be removed on successful completion.
124
trace_fname = os.path.join(os.path.expanduser(tracefilename))
144
global _file_handler, _bzr_log_file
147
if tracefilename is None:
148
if sys.platform == 'win32':
149
from bzrlib import win32utils
150
home = win32utils.get_home_location()
152
home = os.path.expanduser('~')
153
tracefilename = os.path.join(home, '.bzr.log')
155
trace_fname = os.path.expanduser(tracefilename)
125
156
_rollover_trace_maybe(trace_fname)
127
158
LINE_BUFFERED = 1
128
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
130
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
131
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
159
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
160
tf = open(trace_fname, '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")
132
166
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")
167
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
135
168
_file_handler = logging.StreamHandler(tf)
136
169
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
137
170
datefmt = r'%a %H:%M:%S'
142
175
warning("failed to open trace file: %s" % (e))
145
def log_startup(argv):
146
debug('bzr %s invoked on python %s (%s)',
148
'.'.join(map(str, sys.version_info)),
150
debug(' arguments: %r', argv)
151
debug(' working dir: %r', os.getcwdu())
178
@deprecated_function(zero_nine)
154
179
def log_exception(msg=None):
155
180
"""Log the last exception to stderr and the trace file.
157
182
The exception string representation is used as the error
158
183
summary, unless msg is given.
185
Please see log_exception_quietly() for the replacement API.
160
exc_str = format_exception_short(sys.exc_info())
162
_bzr_logger.exception(msg)
163
_bzr_logger.error(exc_str)
189
log_exception_quietly()
166
192
def log_exception_quietly():
171
197
errors loading plugins.
174
debug(traceback.format_exc())
200
mutter(traceback.format_exc())
177
203
def enable_default_logging():
178
204
"""Configure default logging to stderr and .bzr.log"""
179
global _stderr_handler, _file_handler
205
# FIXME: if this is run twice, things get confused
206
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
181
207
_stderr_handler = logging.StreamHandler()
182
_stderr_handler.setFormatter(QuietFormatter())
183
208
logging.getLogger('').addHandler(_stderr_handler)
185
if os.environ.get('BZR_DEBUG'):
186
level = logging.DEBUG
190
209
_stderr_handler.setLevel(logging.INFO)
192
210
if not _file_handler:
212
_trace_file = _bzr_log_file
195
213
if _file_handler:
196
_file_handler.setLevel(level)
198
_bzr_logger.setLevel(level)
214
_file_handler.setLevel(logging.DEBUG)
215
_bzr_logger.setLevel(logging.DEBUG)
218
def be_quiet(quiet=True):
219
global _stderr_handler, _stderr_quiet
221
_stderr_quiet = quiet
223
_stderr_handler.setLevel(logging.WARNING)
225
_stderr_handler.setLevel(logging.INFO)
200
233
def disable_default_logging():
201
234
"""Turn off default log handlers.
208
241
l.removeHandler(_stderr_handler)
209
242
if _file_handler:
210
243
l.removeHandler(_file_handler)
213
247
def enable_test_log(to_file):
214
"""Redirect logging to a temporary file for a test"""
248
"""Redirect logging to a temporary file for a test
250
returns an opaque reference that should be passed to disable_test_log
251
after the test completes.
215
253
disable_default_logging()
216
global _test_log_hdlr
217
256
hdlr = logging.StreamHandler(to_file)
218
257
hdlr.setLevel(logging.DEBUG)
219
258
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
220
logging.getLogger('').addHandler(hdlr)
221
logging.getLogger('').setLevel(logging.DEBUG)
222
_test_log_hdlr = hdlr
225
def disable_test_log():
226
logging.getLogger('').removeHandler(_test_log_hdlr)
227
enable_default_logging()
230
def format_exception_short(exc_info):
231
"""Make a short string form of an exception.
233
This is used for display to stderr. It specially handles exception
234
classes without useful string methods.
236
The result has no trailing newline.
238
exc_info - typically an exception from sys.exc_info()
259
_bzr_logger.addHandler(hdlr)
260
_bzr_logger.setLevel(logging.DEBUG)
261
result = hdlr, _trace_file, _trace_depth
262
_trace_file = to_file
267
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
268
_bzr_logger.removeHandler(test_log_hdlr)
269
test_log_hdlr.close()
272
_trace_file = old_trace_file
273
_trace_depth = old_trace_depth
275
enable_default_logging()
278
def report_exception(exc_info, err_file):
279
exc_type, exc_object, exc_tb = exc_info
280
# Log the full traceback to ~/.bzr.log
281
log_exception_quietly()
282
if (isinstance(exc_object, IOError)
283
and getattr(exc_object, 'errno', None) == errno.EPIPE):
284
print >>err_file, "bzr: broken pipe"
285
elif isinstance(exc_object, KeyboardInterrupt):
286
print >>err_file, "bzr: interrupted"
287
elif not getattr(exc_object, 'internal_error', True):
288
report_user_error(exc_info, err_file)
289
elif isinstance(exc_object, (OSError, IOError)):
290
# Might be nice to catch all of these and show them as something more
291
# specific, but there are too many cases at the moment.
292
report_user_error(exc_info, err_file)
294
report_bug(exc_info, err_file)
297
# TODO: Should these be specially encoding the output?
298
def report_user_error(exc_info, err_file):
299
"""Report to err_file an error that's not an internal error.
301
These don't get a traceback unless -Derror was given.
303
if 'error' in debug.debug_flags:
304
report_bug(exc_info, err_file)
306
print >>err_file, "bzr: ERROR:", str(exc_info[1])
309
def report_bug(exc_info, err_file):
310
"""Report an exception that probably indicates a bug in bzr"""
240
312
exc_type, exc_object, exc_tb = exc_info
243
return '(no exception)'
244
if isinstance(exc_object, BzrNewError):
245
return str(exc_object)
248
tb = traceback.extract_tb(exc_tb)
249
msg = '%s: %s' % (exc_type, exc_object)
253
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
256
return '(error formatting exception of type %s)' % exc_type
313
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
314
exc_type.__module__, exc_type.__name__, exc_object)
316
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
318
print >>err_file, 'bzr %s on python %s (%s)' % \
320
'.'.join(map(str, sys.version_info)),
322
print >>err_file, 'arguments: %r' % sys.argv
324
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
added
removed
bzrlib/trace.py
