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):
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'
73
81
# configure convenient aliases for output routines
75
83
_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)
84
_bzr_logger.setLevel(logging.DEBUG)
86
info = note = _bzr_logger.info
87
warning = _bzr_logger.warning
89
88
log_error = _bzr_logger.error
90
89
error = _bzr_logger.error
93
def mutter(fmt, *args):
94
if _trace_file is None:
96
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
99
if isinstance(fmt, unicode):
100
fmt = fmt.encode('utf8')
103
# It seems that if we do ascii % (unicode, ascii) we can
104
# get a unicode cannot encode ascii error, so make sure that "fmt"
105
# is a unicode string
108
if isinstance(arg, unicode):
109
arg = arg.encode('utf8')
110
real_args.append(arg)
111
out = fmt % tuple(real_args)
115
_trace_file.write(out)
116
# 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.
121
100
def _rollover_trace_maybe(trace_fname):
125
104
if size <= 4 << 20:
127
106
old_fname = trace_fname + '.old'
128
108
from osutils import rename
129
109
rename(trace_fname, old_fname)
134
116
def open_tracefile(tracefilename='~/.bzr.log'):
135
117
# Messages are always written to here, so that we have some
136
118
# information if something goes wrong. In a future version this
137
119
# file will be removed on successful completion.
138
global _file_handler, _bzr_log_file
141
123
trace_fname = os.path.join(os.path.expanduser(tracefilename))
142
124
_rollover_trace_maybe(trace_fname)
126
# buffering=1 means line buffered
145
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
146
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:
149
131
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
150
132
tf.write("you can delete or truncate this file, or include sections in\n")
151
133
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
152
135
_file_handler = logging.StreamHandler(tf)
153
136
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
154
137
datefmt = r'%a %H:%M:%S'
155
138
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
156
139
_file_handler.setLevel(logging.DEBUG)
157
140
logging.getLogger('').addHandler(_file_handler)
158
142
except IOError, e:
159
143
warning("failed to open trace file: %s" % (e))
162
@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())
163
158
def log_exception(msg=None):
164
"""Log the last exception to stderr and the trace file.
159
"""Log the last exception into the trace file.
166
161
The exception string representation is used as the error
167
162
summary, unless msg is given.
172
exc_str = format_exception_short(sys.exc_info())
174
log_exception_quietly()
177
def log_exception_quietly():
178
"""Log the last exception to the trace file only.
180
Used for exceptions that occur internally and that may be
181
interesting to developers but not to users. For example,
182
errors loading plugins.
185
debug(traceback.format_exc())
167
if msg and (msg[-1] == '\n'):
169
## msg = "(%s) %s" % (str(type(ei[1])), msg)
170
_bzr_logger.exception(msg)
188
174
def enable_default_logging():
189
175
"""Configure default logging to stderr and .bzr.log"""
190
# FIXME: if this is run twice, things get confused
191
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
176
global _stderr_handler, _file_handler
192
178
_stderr_handler = logging.StreamHandler()
193
logging.getLogger('').addHandler(_stderr_handler)
194
_stderr_handler.setLevel(logging.INFO)
179
_stderr_handler.setFormatter(QuietFormatter())
195
181
if not _file_handler:
197
_trace_file = _bzr_log_file
199
_file_handler.setLevel(logging.DEBUG)
200
_bzr_logger.setLevel(logging.DEBUG)
203
def be_quiet(quiet=True):
204
global _stderr_handler, _stderr_quiet
206
_stderr_quiet = quiet
208
_stderr_handler.setLevel(logging.WARNING)
184
if os.environ.get('BZR_DEBUG'):
185
level = logging.DEBUG
210
_stderr_handler.setLevel(logging.INFO)
189
_stderr_handler.setLevel(logging.INFO)
190
_file_handler.setLevel(level)
192
logging.getLogger('').addHandler(_stderr_handler)
218
195
def disable_default_logging():
226
203
l.removeHandler(_stderr_handler)
227
204
if _file_handler:
228
205
l.removeHandler(_file_handler)
232
def enable_test_log(to_file):
233
"""Redirect logging to a temporary file for a test
235
returns an opaque reference that should be passed to disable_test_log
236
after the test completes.
238
disable_default_logging()
241
hdlr = logging.StreamHandler(to_file)
242
hdlr.setLevel(logging.DEBUG)
243
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
244
_bzr_logger.addHandler(hdlr)
245
_bzr_logger.setLevel(logging.DEBUG)
246
result = hdlr, _trace_file, _trace_depth
247
_trace_file = to_file
252
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
253
_bzr_logger.removeHandler(test_log_hdlr)
254
test_log_hdlr.close()
257
_trace_file = old_trace_file
258
_trace_depth = old_trace_depth
260
enable_default_logging()
263
def report_exception(exc_info, err_file):
264
exc_type, exc_object, exc_tb = exc_info
265
# Log the full traceback to ~/.bzr.log
266
log_exception_quietly()
267
if (isinstance(exc_object, IOError)
268
and getattr(exc_object, 'errno', None) == errno.EPIPE):
269
print >>err_file, "bzr: broken pipe"
270
elif isinstance(exc_object, KeyboardInterrupt):
271
print >>err_file, "bzr: interrupted"
272
elif getattr(exc_object, 'is_user_error', False):
273
report_user_error(exc_info, err_file)
274
elif isinstance(exc_object, (OSError, IOError)):
275
# Might be nice to catch all of these and show them as something more
276
# specific, but there are too many cases at the moment.
277
report_user_error(exc_info, err_file)
279
report_bug(exc_info, err_file)
282
# TODO: Should these be specially encoding the output?
283
def report_user_error(exc_info, err_file):
284
print >>err_file, "bzr: ERROR:", str(exc_info[1])
287
def report_bug(exc_info, err_file):
288
"""Report an exception that probably indicates a bug in bzr"""
290
exc_type, exc_object, exc_tb = exc_info
291
print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
293
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
295
print >>err_file, 'bzr %s on python %s (%s)' % \
297
'.'.join(map(str, sys.version_info)),
299
print >>err_file, 'arguments: %r' % sys.argv
301
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
added
removed
bzrlib/trace.py
