1
# Copyright (C) 2005, Canonical Ltd
3
"""Messages and logging for bazaar-ng.
5
Messages are supplied by callers as a string-formatting template, plus values
6
to be inserted into it. The actual %-formatting is deferred to the log
7
library so that it doesn't need to be done for messages that won't be emitted.
9
Messages are classified by severity levels: critical, error, warning, info,
12
They can be sent to two places: to stderr, and to ~/.bzr.log. For purposes
13
such as running the test suite, they can also be redirected away from both of
14
those two places to another location.
16
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
17
This trace file is always in UTF-8, regardless of the user's default encoding,
18
so that we can always rely on writing any message.
20
Output to stderr depends on the mode chosen by the user. By default, messages
21
of info and above are sent out, which results in progress messages such as the
22
list of files processed by add and commit. In quiet mode, only warnings and
23
above are shown. In debug mode, stderr gets debug messages too.
25
Errors that terminate an operation are generally passed back as exceptions;
26
others may be just emitted as messages.
28
Exceptions are reported in a brief form to stderr so as not to look scary.
29
BzrErrors are required to be able to format themselves into a properly
30
explanatory message. This is not true for builtin exceptions such as
31
KeyError, which typically just str to "0". They're printed in a different
1
# This program is free software; you can redistribute it and/or modify
2
# it under the terms of the GNU General Public License as published by
3
# the Free Software Foundation; either version 2 of the License, or
4
# (at your option) any later version.
6
# This program is distributed in the hope that it will be useful,
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
# GNU General Public License for more details.
11
# You should have received a copy of the GNU General Public License
12
# along with this program; if not, write to the Free Software
13
# 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.
35
30
# TODO: in debug mode, stderr should get full tracebacks and also
36
31
# debug messages. (Is this really needed?)
38
# FIXME: Unfortunately it turns out that python's logging module
39
# is quite expensive, even when the message is not printed by any handlers.
40
# We should perhaps change back to just simply doing it here.
33
# TODO: When running the test suites, we should add an additional
34
# logger that sends messages into the test log file.
48
from bzrlib.errors import BzrError, BzrNewError
51
43
_file_handler = None
52
44
_stderr_handler = None
59
47
class QuietFormatter(logging.Formatter):
60
"""Formatter that suppresses the details of errors.
48
"""Formatter that supresses the details of errors.
62
50
This is used by default on stderr so as not to scare the user.
64
# At first I tried overriding FormatException to suppress the
52
# At first I tried overriding formatException to suppress the
65
53
# exception details, but that has global effect: no loggers
66
54
# can get the exception details is we suppress them here.
68
56
def format(self, record):
69
58
if record.levelno >= logging.WARNING:
70
s = 'bzr: ' + record.levelname + ': '
73
s += record.getMessage()
59
s += record.levelname + ': '
61
s += record.getMessage()
74
63
if record.exc_info:
75
s += '\n' + format_exception_short(record.exc_info)
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'
78
77
# configure convenient aliases for output routines
80
79
_bzr_logger = logging.getLogger('bzr')
82
def note(*args, **kwargs):
84
bzrlib.ui.ui_factory.clear_term()
85
_bzr_logger.info(*args, **kwargs)
87
def warning(*args, **kwargs):
89
bzrlib.ui.ui_factory.clear_term()
90
_bzr_logger.warning(*args, **kwargs)
80
_bzr_logger.setLevel(logging.DEBUG)
82
info = note = _bzr_logger.info
83
warning = _bzr_logger.warning
93
84
log_error = _bzr_logger.error
94
85
error = _bzr_logger.error
97
def mutter(fmt, *args):
98
if _trace_file is None:
100
if hasattr(_trace_file, 'closed') and _trace_file.closed:
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
106
out = unicode(fmt) % args
111
_trace_file.write(out)
112
except UnicodeError, e:
113
warning('UnicodeError: %s', e)
114
_trace_file.write(repr(out))
115
# TODO: jam 20051227 Consider flushing the trace file to help debugging
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.
120
96
def _rollover_trace_maybe(trace_fname):
124
100
if size <= 4 << 20:
126
102
old_fname = trace_fname + '.old'
127
from osutils import rename
128
rename(trace_fname, old_fname)
105
# must remove before rename on windows
111
# might fail if in use on windows
112
os.rename(trace_fname, old_fname)
133
120
def open_tracefile(tracefilename='~/.bzr.log'):
134
121
# Messages are always written to here, so that we have some
135
122
# information if something goes wrong. In a future version this
136
123
# file will be removed on successful completion.
137
global _file_handler, _bzr_log_file
138
125
import stat, codecs
140
127
trace_fname = os.path.join(os.path.expanduser(tracefilename))
141
128
_rollover_trace_maybe(trace_fname)
130
# buffering=1 means line buffered
144
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
132
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
134
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
147
135
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
148
136
tf.write("you can delete or truncate this file, or include sections in\n")
149
137
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
150
139
_file_handler = logging.StreamHandler(tf)
151
140
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
152
141
datefmt = r'%a %H:%M:%S'
153
142
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
154
143
_file_handler.setLevel(logging.DEBUG)
155
144
logging.getLogger('').addHandler(_file_handler)
156
146
except IOError, e:
157
147
warning("failed to open trace file: %s" % (e))
160
150
def log_startup(argv):
161
debug('\n\nbzr %s invoked on python %s (%s)',
153
debug('bzr %s invoked on python %s (%s)',
162
154
bzrlib.__version__,
163
155
'.'.join(map(str, sys.version_info)),
165
158
debug(' arguments: %r', argv)
166
debug(' working dir: %r', os.getcwdu())
159
debug(' working dir: %s', os.getcwdu())
169
162
def log_exception(msg=None):
170
"""Log the last exception to stderr and the trace file.
163
"""Log the last exception into the trace file.
172
165
The exception string representation is used as the error
173
166
summary, unless msg is given.
178
exc_str = format_exception_short(sys.exc_info())
180
log_exception_quietly()
183
def log_exception_quietly():
184
"""Log the last exception to the trace file only.
186
Used for exceptions that occur internally and that may be
187
interesting to developers but not to users. For example,
188
errors loading plugins.
191
debug(traceback.format_exc())
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
194
179
def enable_default_logging():
195
180
"""Configure default logging to stderr and .bzr.log"""
196
# FIXME: if this is run twice, things get confused
197
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
181
global _stderr_handler, _file_handler
198
183
_stderr_handler = logging.StreamHandler()
199
184
_stderr_handler.setFormatter(QuietFormatter())
200
logging.getLogger('').addHandler(_stderr_handler)
201
_stderr_handler.setLevel(logging.INFO)
202
186
if not _file_handler:
204
_trace_file = _bzr_log_file
206
_file_handler.setLevel(logging.DEBUG)
207
_bzr_logger.setLevel(logging.DEBUG)
211
def be_quiet(quiet=True):
212
global _stderr_handler, _stderr_quiet
214
_stderr_quiet = quiet
216
_stderr_handler.setLevel(logging.WARNING)
189
if os.environ.get('BZR_DEBUG'):
190
level = logging.DEBUG
218
_stderr_handler.setLevel(logging.INFO)
194
_stderr_handler.setLevel(logging.INFO)
195
_file_handler.setLevel(level)
197
logging.getLogger('').addHandler(_stderr_handler)
226
201
def disable_default_logging():
234
209
l.removeHandler(_stderr_handler)
235
210
if _file_handler:
236
211
l.removeHandler(_file_handler)
240
def enable_test_log(to_file):
241
"""Redirect logging to a temporary file for a test
243
returns an opaque reference that should be passed to disable_test_log
244
after the test completes.
246
disable_default_logging()
249
hdlr = logging.StreamHandler(to_file)
250
hdlr.setLevel(logging.DEBUG)
251
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
252
_bzr_logger.addHandler(hdlr)
253
_bzr_logger.setLevel(logging.DEBUG)
254
result = hdlr, _trace_file, _trace_depth
255
_trace_file = to_file
260
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
261
_bzr_logger.removeHandler(test_log_hdlr)
262
test_log_hdlr.close()
265
_trace_file = old_trace_file
266
_trace_depth = old_trace_depth
268
enable_default_logging()
271
def format_exception_short(exc_info):
272
"""Make a short string form of an exception.
274
This is used for display to stderr. It specially handles exception
275
classes without useful string methods.
277
The result has no trailing newline.
279
exc_info - typically an exception from sys.exc_info()
281
exc_type, exc_object, exc_tb = exc_info
284
return '(no exception)'
285
if isinstance(exc_object, (BzrError, BzrNewError)):
286
return str(exc_object)
289
tb = traceback.extract_tb(exc_tb)
290
msg = '%s: %s' % (exc_type, exc_object)
294
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
296
except Exception, formatting_exc:
297
# XXX: is this really better than just letting it run up?
298
return '(error formatting exception of type %s: %s)' \
299
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
