1
# Copyright (C) 2005, 2006 by Canonical Ltd
3
1
# This program is free software; you can redistribute it and/or modify
4
2
# it under the terms of the GNU General Public License as published by
5
3
# the Free Software Foundation; either version 2 of the License, or
6
4
# (at your option) any later version.
8
6
# This program is distributed in the hope that it will be useful,
9
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
9
# GNU General Public License for more details.
13
11
# You should have received a copy of the GNU General Public License
14
12
# along with this program; if not, write to the Free Software
15
13
# 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
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.
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.
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.
60
from bzrlib.errors import BzrError, BzrNewError
61
from bzrlib.symbol_versioning import (deprecated_function,
65
43
_file_handler = None
66
44
_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
##s = textwrap.fill(s)
67
# give just a summary of the exception, not the whole thing
68
exinfo = traceback.extract_tb(record.exc_info[2])
69
# the format of this string matches one of the REs
71
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
72
s += ' see ~/.bzr.log for debug information'
73
80
# configure convenient aliases for output routines
75
82
_bzr_logger = logging.getLogger('bzr')
77
def note(*args, **kwargs):
78
# FIXME note always emits utf-8, regardless of the terminal encoding
80
bzrlib.ui.ui_factory.clear_term()
81
_bzr_logger.info(*args, **kwargs)
83
def warning(*args, **kwargs):
85
bzrlib.ui.ui_factory.clear_term()
86
_bzr_logger.warning(*args, **kwargs)
83
_bzr_logger.setLevel(logging.DEBUG)
85
info = note = _bzr_logger.info
86
warning = _bzr_logger.warning
89
87
log_error = _bzr_logger.error
90
88
error = _bzr_logger.error
93
def mutter(fmt, *args):
94
if _trace_file is None:
96
if hasattr(_trace_file, 'closed') and _trace_file.closed:
99
# It seems that if we do ascii % (unicode, ascii) we can
100
# get a unicode cannot encode ascii error, so make sure that "fmt"
101
# is a unicode string
102
out = unicode(fmt) % args
107
_trace_file.write(out)
108
except UnicodeError, e:
109
warning('UnicodeError: %s', e)
110
_trace_file.write(repr(out))
111
# TODO: jam 20051227 Consider flushing the trace file to help debugging
89
mutter = _bzr_logger.debug
90
debug = _bzr_logger.debug
95
# we do the rollover using this code, rather than the default from python
96
# logging, because we only want to rollover at program startup, not on each
97
# message. maybe that's not a good enough reason.
116
99
def _rollover_trace_maybe(trace_fname):
120
103
if size <= 4 << 20:
122
105
old_fname = trace_fname + '.old'
123
from osutils import rename
124
rename(trace_fname, old_fname)
108
# must remove before rename on windows
114
# might fail if in use on windows
115
os.rename(trace_fname, old_fname)
129
123
def open_tracefile(tracefilename='~/.bzr.log'):
130
124
# Messages are always written to here, so that we have some
131
125
# information if something goes wrong. In a future version this
132
126
# file will be removed on successful completion.
133
global _file_handler, _bzr_log_file
136
130
trace_fname = os.path.join(os.path.expanduser(tracefilename))
137
131
_rollover_trace_maybe(trace_fname)
133
# buffering=1 means line buffered
140
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
135
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
137
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
143
138
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
144
139
tf.write("you can delete or truncate this file, or include sections in\n")
145
140
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
146
142
_file_handler = logging.StreamHandler(tf)
147
143
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
148
144
datefmt = r'%a %H:%M:%S'
149
145
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
150
146
_file_handler.setLevel(logging.DEBUG)
151
147
logging.getLogger('').addHandler(_file_handler)
152
149
except IOError, e:
153
150
warning("failed to open trace file: %s" % (e))
156
@deprecated_function(zero_nine)
153
def log_startup(argv):
156
debug('bzr %s invoked on python %s (%s)',
158
'.'.join(map(str, sys.version_info)),
161
debug(' arguments: %r', argv)
162
debug(' working dir: %s', os.getcwdu())
157
165
def log_exception(msg=None):
158
"""Log the last exception to stderr and the trace file.
166
"""Log the last exception into the trace file.
160
168
The exception string representation is used as the error
161
169
summary, unless msg is given.
166
exc_str = format_exception_short(sys.exc_info())
168
log_exception_quietly()
171
def log_exception_quietly():
172
"""Log the last exception to the trace file only.
174
Used for exceptions that occur internally and that may be
175
interesting to developers but not to users. For example,
176
errors loading plugins.
179
debug(traceback.format_exc())
175
if msg and (msg[-1] == '\n'):
178
_bzr_logger.exception(msg)
182
182
def enable_default_logging():
183
183
"""Configure default logging to stderr and .bzr.log"""
184
# FIXME: if this is run twice, things get confused
185
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
184
global _stderr_handler, _file_handler
186
186
_stderr_handler = logging.StreamHandler()
187
logging.getLogger('').addHandler(_stderr_handler)
188
_stderr_handler.setLevel(logging.INFO)
187
_stderr_handler.setFormatter(QuietFormatter())
189
189
if not _file_handler:
191
_trace_file = _bzr_log_file
193
_file_handler.setLevel(logging.DEBUG)
194
_bzr_logger.setLevel(logging.DEBUG)
197
def be_quiet(quiet=True):
198
global _stderr_handler, _stderr_quiet
200
_stderr_quiet = quiet
202
_stderr_handler.setLevel(logging.WARNING)
192
if os.environ.get('BZR_DEBUG'):
193
level = logging.DEBUG
204
_stderr_handler.setLevel(logging.INFO)
197
_stderr_handler.setLevel(logging.INFO)
198
_file_handler.setLevel(level)
200
logging.getLogger('').addHandler(_stderr_handler)
212
204
def disable_default_logging():
220
212
l.removeHandler(_stderr_handler)
221
213
if _file_handler:
222
214
l.removeHandler(_file_handler)
226
def enable_test_log(to_file):
227
"""Redirect logging to a temporary file for a test
229
returns an opaque reference that should be passed to disable_test_log
230
after the test completes.
232
disable_default_logging()
235
hdlr = logging.StreamHandler(to_file)
236
hdlr.setLevel(logging.DEBUG)
237
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
238
_bzr_logger.addHandler(hdlr)
239
_bzr_logger.setLevel(logging.DEBUG)
240
result = hdlr, _trace_file, _trace_depth
241
_trace_file = to_file
246
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
247
_bzr_logger.removeHandler(test_log_hdlr)
248
test_log_hdlr.close()
251
_trace_file = old_trace_file
252
_trace_depth = old_trace_depth
254
enable_default_logging()
257
def report_exception(exc_info, err_file):
258
exc_type, exc_object, exc_tb = exc_info
259
if (isinstance(exc_object, IOError)
260
and getattr(exc_object, 'errno', None) == errno.EPIPE):
261
print >>err_file, "bzr: broken pipe"
262
elif isinstance(exc_object, KeyboardInterrupt):
263
print >>err_file, "bzr: interrupted"
264
elif getattr(exc_object, 'is_user_error', False):
265
report_user_error(exc_info, err_file)
266
elif isinstance(exc_object, (OSError, IOError)):
267
# Might be nice to catch all of these and show them as something more
268
# specific, but there are too many cases at the moment.
269
report_user_error(exc_info, err_file)
271
report_bug(exc_info, err_file)
274
# TODO: Should these be specially encoding the output?
275
def report_user_error(exc_info, err_file):
276
print >>err_file, "bzr: ERROR:", str(exc_info[1])
279
def report_bug(exc_info, err_file):
280
"""Report an exception that probably indicates a bug in bzr"""
282
exc_type, exc_object, exc_tb = exc_info
283
print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
285
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
287
print >>err_file, 'bzr %s on python %s (%s)' % \
289
'.'.join(map(str, sys.version_info)),
291
print >>err_file, 'arguments: %r' % sys.argv
293
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
added
removed
bzrlib/trace.py
