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
"""Messages and logging for bazaar-ng
18
Messages are sent out through the Python logging library.
20
They can be sent to two places: to stderr, and to ~/.bzr.log.
22
~/.bzr.log gets all messages, and tracebacks of all uncaught
25
Normally stderr only gets messages of level INFO and higher, and gets
26
only a summary of exceptions, not the traceback.
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
30
# TODO: in debug mode, stderr should get full tracebacks and also
31
# debug messages. (Is this really needed?)
33
# TODO: When running the test suites, we should add an additional
34
# logger that sends messages into the test log file.
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,
68
lazy_import(globals(), """
69
from bzrlib import debug
43
72
_file_handler = None
44
73
_stderr_handler = None
47
class QuietFormatter(logging.Formatter):
48
"""Formatter that supresses the details of errors.
50
This is used by default on stderr so as not to scare the user.
52
# At first I tried overriding formatException to suppress the
53
# exception details, but that has global effect: no loggers
54
# can get the exception details is we suppress them here.
56
def format(self, record):
58
if record.levelno >= logging.WARNING:
59
s += record.levelname + ': '
61
s += record.getMessage()
64
# give just a summary of the exception, not the whole thing
65
exinfo = traceback.extract_tb(record.exc_info[2])
66
# the format of this string matches one of the REs
68
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
69
s += ' see ~/.bzr.log for debug information'
77
80
# configure convenient aliases for output routines
79
82
_bzr_logger = logging.getLogger('bzr')
80
_bzr_logger.setLevel(logging.DEBUG)
82
info = note = _bzr_logger.info
83
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)
84
96
log_error = _bzr_logger.error
85
97
error = _bzr_logger.error
86
mutter = _bzr_logger.debug
87
debug = _bzr_logger.debug
92
# we do the rollover using this code, rather than the default from python
93
# logging, because we only want to rollover at program startup, not on each
94
# message. maybe that's not a good enough reason.
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
96
127
def _rollover_trace_maybe(trace_fname):
100
131
if size <= 4 << 20:
102
133
old_fname = trace_fname + '.old'
105
# must remove before rename on windows
111
# might fail if in use on windows
112
os.rename(trace_fname, old_fname)
134
from osutils import rename
135
rename(trace_fname, old_fname)
120
def open_tracefile(tracefilename='~/.bzr.log'):
140
def open_tracefile(tracefilename=None):
121
141
# Messages are always written to here, so that we have some
122
142
# information if something goes wrong. In a future version this
123
143
# file will be removed on successful completion.
127
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)
128
156
_rollover_trace_maybe(trace_fname)
130
# buffering=1 means line buffered
132
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
134
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
135
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")
136
166
tf.write("you can delete or truncate this file, or include sections in\n")
137
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
167
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
139
168
_file_handler = logging.StreamHandler(tf)
140
169
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
170
datefmt = r'%a %H:%M:%S'
142
171
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
172
_file_handler.setLevel(logging.DEBUG)
144
173
logging.getLogger('').addHandler(_file_handler)
146
174
except IOError, e:
147
175
warning("failed to open trace file: %s" % (e))
150
def log_startup(argv):
153
debug('bzr %s invoked on python %s (%s)',
155
'.'.join(map(str, sys.version_info)),
158
debug(' arguments: %r', argv)
159
debug(' working dir: %s', os.getcwdu())
178
@deprecated_function(zero_nine)
162
179
def log_exception(msg=None):
163
"""Log the last exception into the trace file.
180
"""Log the last exception to stderr and the trace file.
165
182
The exception string representation is used as the error
166
183
summary, unless msg is given.
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
185
Please see log_exception_quietly() for the replacement API.
189
log_exception_quietly()
192
def log_exception_quietly():
193
"""Log the last exception to the trace file only.
195
Used for exceptions that occur internally and that may be
196
interesting to developers but not to users. For example,
197
errors loading plugins.
200
mutter(traceback.format_exc())
179
203
def enable_default_logging():
180
204
"""Configure default logging to stderr and .bzr.log"""
181
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
183
207
_stderr_handler = logging.StreamHandler()
184
_stderr_handler.setFormatter(QuietFormatter())
208
logging.getLogger('').addHandler(_stderr_handler)
209
_stderr_handler.setLevel(logging.INFO)
186
210
if not _file_handler:
189
if os.environ.get('BZR_DEBUG'):
190
level = logging.DEBUG
212
_trace_file = _bzr_log_file
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)
194
_stderr_handler.setLevel(logging.INFO)
195
_file_handler.setLevel(level)
197
logging.getLogger('').addHandler(_stderr_handler)
225
_stderr_handler.setLevel(logging.INFO)
201
233
def disable_default_logging():
209
241
l.removeHandler(_stderr_handler)
210
242
if _file_handler:
211
243
l.removeHandler(_file_handler)
247
def enable_test_log(to_file):
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.
253
disable_default_logging()
256
hdlr = logging.StreamHandler(to_file)
257
hdlr.setLevel(logging.DEBUG)
258
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
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"""
312
exc_type, exc_object, exc_tb = exc_info
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
