1
# Copyright (C) 2005, 2006, 2007 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(), """
59
from cStringIO import StringIO
68
lazy_import(globals(), """
76
43
_file_handler = None
77
44
_stderr_handler = None
82
_bzr_log_filename = 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'
85
77
# configure convenient aliases for output routines
87
79
_bzr_logger = logging.getLogger('bzr')
89
def note(*args, **kwargs):
90
# FIXME note always emits utf-8, regardless of the terminal encoding
92
bzrlib.ui.ui_factory.clear_term()
93
_bzr_logger.info(*args, **kwargs)
95
def warning(*args, **kwargs):
97
bzrlib.ui.ui_factory.clear_term()
98
_bzr_logger.warning(*args, **kwargs)
80
_bzr_logger.setLevel(logging.DEBUG)
82
info = note = _bzr_logger.info
83
warning = _bzr_logger.warning
101
84
log_error = _bzr_logger.error
102
85
error = _bzr_logger.error
105
def mutter(fmt, *args):
106
if _trace_file is None:
108
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
111
if isinstance(fmt, unicode):
112
fmt = fmt.encode('utf8')
115
# It seems that if we do ascii % (unicode, ascii) we can
116
# get a unicode cannot encode ascii error, so make sure that "fmt"
117
# is a unicode string
120
if isinstance(arg, unicode):
121
arg = arg.encode('utf8')
122
real_args.append(arg)
123
out = fmt % tuple(real_args)
127
_trace_file.write(out)
128
# TODO: jam 20051227 Consider flushing the trace file to help debugging
132
def mutter_callsite(stacklevel, fmt, *args):
133
"""Perform a mutter of fmt and args, logging the call trace.
135
:param stacklevel: The number of frames to show. None will show all
137
:param fmt: The format string to pass to mutter.
138
:param args: A list of substitution variables.
141
traceback.print_stack(limit=stacklevel + 1, file=outf)
142
formatted_lines = outf.getvalue().splitlines()
143
formatted_stack = '\n'.join(formatted_lines[:-2])
144
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
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.
147
96
def _rollover_trace_maybe(trace_fname):
151
100
if size <= 4 << 20:
153
102
old_fname = trace_fname + '.old'
154
osutils.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)
159
def open_tracefile(tracefilename=None):
120
def open_tracefile(tracefilename='~/.bzr.log'):
160
121
# Messages are always written to here, so that we have some
161
122
# information if something goes wrong. In a future version this
162
123
# file will be removed on successful completion.
163
global _file_handler, _bzr_log_file, _bzr_log_filename
166
if tracefilename is None:
167
if sys.platform == 'win32':
168
from bzrlib import win32utils
169
home = win32utils.get_home_location()
171
home = os.path.expanduser('~')
172
_bzr_log_filename = os.path.join(home, '.bzr.log')
174
_bzr_log_filename = tracefilename
176
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
177
_rollover_trace_maybe(_bzr_log_filename)
127
trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
_rollover_trace_maybe(trace_fname)
130
# buffering=1 means line buffered
180
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
181
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
183
# tf.tell() on windows always return 0 until some writing done
186
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
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")
187
136
tf.write("you can delete or truncate this file, or include sections in\n")
188
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
137
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
189
139
_file_handler = logging.StreamHandler(tf)
190
140
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
191
141
datefmt = r'%a %H:%M:%S'
192
142
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
193
143
_file_handler.setLevel(logging.DEBUG)
194
144
logging.getLogger('').addHandler(_file_handler)
195
146
except IOError, e:
196
147
warning("failed to open trace file: %s" % (e))
199
def log_exception_quietly():
200
"""Log the last exception to the trace file only.
202
Used for exceptions that occur internally and that may be
203
interesting to developers but not to users. For example,
204
errors loading plugins.
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())
162
def log_exception(msg=None):
163
"""Log the last exception into the trace file.
165
The exception string representation is used as the error
166
summary, unless msg is given.
207
mutter(traceback.format_exc())
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
210
179
def enable_default_logging():
211
180
"""Configure default logging to stderr and .bzr.log"""
212
# FIXME: if this is run twice, things get confused
213
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
181
global _stderr_handler, _file_handler
214
183
_stderr_handler = logging.StreamHandler()
215
logging.getLogger('').addHandler(_stderr_handler)
216
_stderr_handler.setLevel(logging.INFO)
184
_stderr_handler.setFormatter(QuietFormatter())
217
186
if not _file_handler:
219
_trace_file = _bzr_log_file
221
_file_handler.setLevel(logging.DEBUG)
222
_bzr_logger.setLevel(logging.DEBUG)
225
def set_verbosity_level(level):
226
"""Set the verbosity level.
228
:param level: -ve for quiet, 0 for normal, +ve for verbose
230
global _verbosity_level
231
_verbosity_level = level
232
_update_logging_level(level < 0)
235
def get_verbosity_level():
236
"""Get the verbosity level.
238
See set_verbosity_level() for values.
240
return _verbosity_level
243
def be_quiet(quiet=True):
244
# Perhaps this could be deprecated now ...
246
set_verbosity_level(-1)
248
set_verbosity_level(0)
251
def _update_logging_level(quiet=True):
252
"""Hide INFO messages if quiet."""
254
_stderr_handler.setLevel(logging.WARNING)
256
_stderr_handler.setLevel(logging.INFO)
260
"""Is the verbosity level negative?"""
261
return _verbosity_level < 0
265
"""Is the verbosity level positive?"""
266
return _verbosity_level > 0
189
if os.environ.get('BZR_DEBUG'):
190
level = logging.DEBUG
194
_stderr_handler.setLevel(logging.INFO)
195
_file_handler.setLevel(level)
197
logging.getLogger('').addHandler(_stderr_handler)
269
201
def disable_default_logging():
277
209
l.removeHandler(_stderr_handler)
278
210
if _file_handler:
279
211
l.removeHandler(_file_handler)
283
def enable_test_log(to_file):
284
"""Redirect logging to a temporary file for a test
286
returns an opaque reference that should be passed to disable_test_log
287
after the test completes.
289
disable_default_logging()
292
hdlr = logging.StreamHandler(to_file)
293
hdlr.setLevel(logging.DEBUG)
294
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
295
_bzr_logger.addHandler(hdlr)
296
_bzr_logger.setLevel(logging.DEBUG)
297
result = hdlr, _trace_file, _trace_depth
298
_trace_file = to_file
303
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
304
_bzr_logger.removeHandler(test_log_hdlr)
305
test_log_hdlr.close()
308
_trace_file = old_trace_file
309
_trace_depth = old_trace_depth
311
enable_default_logging()
314
def report_exception(exc_info, err_file):
315
exc_type, exc_object, exc_tb = exc_info
316
# Log the full traceback to ~/.bzr.log
317
log_exception_quietly()
318
if (isinstance(exc_object, IOError)
319
and getattr(exc_object, 'errno', None) == errno.EPIPE):
320
print >>err_file, "bzr: broken pipe"
321
elif isinstance(exc_object, KeyboardInterrupt):
322
print >>err_file, "bzr: interrupted"
323
elif not getattr(exc_object, 'internal_error', True):
324
report_user_error(exc_info, err_file)
325
elif isinstance(exc_object, (OSError, IOError)):
326
# Might be nice to catch all of these and show them as something more
327
# specific, but there are too many cases at the moment.
328
report_user_error(exc_info, err_file)
330
report_bug(exc_info, err_file)
333
# TODO: Should these be specially encoding the output?
334
def report_user_error(exc_info, err_file):
335
"""Report to err_file an error that's not an internal error.
337
These don't get a traceback unless -Derror was given.
339
if 'error' in debug.debug_flags:
340
report_bug(exc_info, err_file)
342
print >>err_file, "bzr: ERROR:", str(exc_info[1])
345
def report_bug(exc_info, err_file):
346
"""Report an exception that probably indicates a bug in bzr"""
348
exc_type, exc_object, exc_tb = exc_info
349
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
350
exc_type.__module__, exc_type.__name__, exc_object)
352
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
354
print >>err_file, 'bzr %s on python %s (%s)' % \
356
'.'.join(map(str, sys.version_info)),
358
print >>err_file, 'arguments: %r' % sys.argv
360
'encoding: %r, fsenc: %r, lang: %r\n' % (
361
osutils.get_user_encoding(), sys.getfilesystemencoding(),
362
os.environ.get('LANG')))
363
err_file.write("plugins:\n")
364
for name, a_plugin in sorted(plugin.plugins().items()):
365
err_file.write(" %-20s %s [%s]\n" %
366
(name, a_plugin.path(), a_plugin.__version__))
369
"** Please send this report to bazaar@lists.ubuntu.com\n"
370
" with a description of what you were doing when the\n"
added
removed
bzrlib/trace.py
