1
# Copyright (C) 2005, 2006 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.
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
72
43
_file_handler = None
73
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):
57
if record.levelno >= logging.WARNING:
58
s = 'bzr: ' + record.levelname + ': '
62
s += record.getMessage()
65
##s = textwrap.fill(s)
68
# give just a summary of the exception, not the whole thing
69
exinfo = traceback.extract_tb(record.exc_info[2])
70
# the format of this string matches one of the REs
72
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
73
s += ' see ~/.bzr.log for debug information'
80
81
# configure convenient aliases for output routines
82
83
_bzr_logger = logging.getLogger('bzr')
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
_bzr_logger.setLevel(logging.DEBUG)
86
info = note = _bzr_logger.info
87
warning = _bzr_logger.warning
96
88
log_error = _bzr_logger.error
97
89
error = _bzr_logger.error
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
90
mutter = _bzr_logger.debug
91
debug = _bzr_logger.debug
96
# we do the rollover using this code, rather than the default from python
97
# logging, because we only want to rollover at program startup, not on each
98
# message. maybe that's not a good enough reason.
127
100
def _rollover_trace_maybe(trace_fname):
131
104
if size <= 4 << 20:
133
106
old_fname = trace_fname + '.old'
134
108
from osutils import rename
135
109
rename(trace_fname, old_fname)
140
116
def open_tracefile(tracefilename='~/.bzr.log'):
141
117
# Messages are always written to here, so that we have some
142
118
# information if something goes wrong. In a future version this
143
119
# file will be removed on successful completion.
144
global _file_handler, _bzr_log_file
147
123
trace_fname = os.path.join(os.path.expanduser(tracefilename))
148
124
_rollover_trace_maybe(trace_fname)
126
# buffering=1 means line buffered
151
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
152
tf = open(trace_fname, 'at', LINE_BUFFERED)
128
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
130
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
155
131
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
156
132
tf.write("you can delete or truncate this file, or include sections in\n")
157
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
133
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
158
135
_file_handler = logging.StreamHandler(tf)
159
136
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
160
137
datefmt = r'%a %H:%M:%S'
161
138
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
162
139
_file_handler.setLevel(logging.DEBUG)
163
140
logging.getLogger('').addHandler(_file_handler)
164
142
except IOError, e:
165
143
warning("failed to open trace file: %s" % (e))
168
@deprecated_function(zero_nine)
146
def log_startup(argv):
149
debug('bzr %s invoked on python %s (%s)',
151
'.'.join(map(str, sys.version_info)),
154
debug(' arguments: %r', argv)
155
debug(' working dir: %s', os.getcwdu())
169
158
def log_exception(msg=None):
170
"""Log the last exception to stderr and the trace file.
159
"""Log the last exception into the trace file.
172
161
The exception string representation is used as the error
173
162
summary, unless msg is given.
177
log_exception_quietly()
180
def log_exception_quietly():
181
"""Log the last exception to the trace file only.
183
Used for exceptions that occur internally and that may be
184
interesting to developers but not to users. For example,
185
errors loading plugins.
188
mutter(traceback.format_exc())
164
cmd_repr = ' '.join(repr(arg) for arg in sys.argv)
165
cmd_info = '\n command: %s\n pwd: %s' \
166
% (cmd_repr, os.getcwd())
170
if msg and (msg[-1] == '\n'):
172
## msg = "(%s) %s" % (str(type(ei[1])), msg)
173
_bzr_logger.exception(msg + cmd_info)
191
177
def enable_default_logging():
192
178
"""Configure default logging to stderr and .bzr.log"""
193
# FIXME: if this is run twice, things get confused
194
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
179
global _stderr_handler, _file_handler
195
181
_stderr_handler = logging.StreamHandler()
196
logging.getLogger('').addHandler(_stderr_handler)
197
_stderr_handler.setLevel(logging.INFO)
182
_stderr_handler.setFormatter(QuietFormatter())
198
184
if not _file_handler:
200
_trace_file = _bzr_log_file
202
_file_handler.setLevel(logging.DEBUG)
203
_bzr_logger.setLevel(logging.DEBUG)
206
def be_quiet(quiet=True):
207
global _stderr_handler, _stderr_quiet
209
_stderr_quiet = quiet
211
_stderr_handler.setLevel(logging.WARNING)
187
if os.environ.get('BZR_DEBUG'):
188
level = logging.DEBUG
213
_stderr_handler.setLevel(logging.INFO)
192
_stderr_handler.setLevel(logging.INFO)
193
_file_handler.setLevel(level)
195
logging.getLogger('').addHandler(_stderr_handler)
221
198
def disable_default_logging():
229
206
l.removeHandler(_stderr_handler)
230
207
if _file_handler:
231
208
l.removeHandler(_file_handler)
235
def enable_test_log(to_file):
236
"""Redirect logging to a temporary file for a test
238
returns an opaque reference that should be passed to disable_test_log
239
after the test completes.
241
disable_default_logging()
244
hdlr = logging.StreamHandler(to_file)
245
hdlr.setLevel(logging.DEBUG)
246
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
247
_bzr_logger.addHandler(hdlr)
248
_bzr_logger.setLevel(logging.DEBUG)
249
result = hdlr, _trace_file, _trace_depth
250
_trace_file = to_file
255
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
256
_bzr_logger.removeHandler(test_log_hdlr)
257
test_log_hdlr.close()
260
_trace_file = old_trace_file
261
_trace_depth = old_trace_depth
263
enable_default_logging()
266
def report_exception(exc_info, err_file):
267
exc_type, exc_object, exc_tb = exc_info
268
# Log the full traceback to ~/.bzr.log
269
log_exception_quietly()
270
if (isinstance(exc_object, IOError)
271
and getattr(exc_object, 'errno', None) == errno.EPIPE):
272
print >>err_file, "bzr: broken pipe"
273
elif isinstance(exc_object, KeyboardInterrupt):
274
print >>err_file, "bzr: interrupted"
275
elif not getattr(exc_object, 'internal_error', True):
276
report_user_error(exc_info, err_file)
277
elif isinstance(exc_object, (OSError, IOError)):
278
# Might be nice to catch all of these and show them as something more
279
# specific, but there are too many cases at the moment.
280
report_user_error(exc_info, err_file)
282
report_bug(exc_info, err_file)
285
# TODO: Should these be specially encoding the output?
286
def report_user_error(exc_info, err_file):
287
"""Report to err_file an error that's not an internal error.
289
These don't get a traceback unless -Derror was given.
291
if 'error' in debug.debug_flags:
292
report_bug(exc_info, err_file)
294
print >>err_file, "bzr: ERROR:", str(exc_info[1])
297
def report_bug(exc_info, err_file):
298
"""Report an exception that probably indicates a bug in bzr"""
300
exc_type, exc_object, exc_tb = exc_info
301
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
302
exc_type.__module__, exc_type.__name__, exc_object)
304
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
306
print >>err_file, 'bzr %s on python %s (%s)' % \
308
'.'.join(map(str, sys.version_info)),
310
print >>err_file, 'arguments: %r' % sys.argv
312
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
added
removed
bzrlib/trace.py
