1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# 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
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.
60
from bzrlib.lazy_import import lazy_import
61
lazy_import(globals(), """
62
from cStringIO import StringIO
70
lazy_import(globals(), """
80
_stderr_handler = None
85
_bzr_log_filename = None
86
_start_time = bzrlib._start_time
89
# configure convenient aliases for output routines
91
_bzr_logger = logging.getLogger('bzr')
94
def note(*args, **kwargs):
95
# FIXME note always emits utf-8, regardless of the terminal encoding
97
bzrlib.ui.ui_factory.clear_term()
98
_bzr_logger.info(*args, **kwargs)
100
def warning(*args, **kwargs):
102
bzrlib.ui.ui_factory.clear_term()
103
_bzr_logger.warning(*args, **kwargs)
106
log_error = _bzr_logger.error
107
error = _bzr_logger.error
110
def mutter(fmt, *args):
111
if _trace_file is None:
113
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
116
if isinstance(fmt, unicode):
117
fmt = fmt.encode('utf8')
120
# It seems that if we do ascii % (unicode, ascii) we can
121
# get a unicode cannot encode ascii error, so make sure that "fmt"
122
# is a unicode string
125
if isinstance(arg, unicode):
126
arg = arg.encode('utf8')
127
real_args.append(arg)
128
out = fmt % tuple(real_args)
131
timestamp = '%0.3f ' % (time.time() - _start_time,)
132
out = timestamp + out + '\n'
133
_trace_file.write(out)
134
# TODO: jam 20051227 Consider flushing the trace file to help debugging
138
def mutter_callsite(stacklevel, fmt, *args):
139
"""Perform a mutter of fmt and args, logging the call trace.
141
:param stacklevel: The number of frames to show. None will show all
143
:param fmt: The format string to pass to mutter.
144
:param args: A list of substitution variables.
147
traceback.print_stack(limit=stacklevel + 1, file=outf)
148
formatted_lines = outf.getvalue().splitlines()
149
formatted_stack = '\n'.join(formatted_lines[:-2])
150
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
153
def _rollover_trace_maybe(trace_fname):
156
size = os.stat(trace_fname)[stat.ST_SIZE]
159
old_fname = trace_fname + '.old'
160
osutils.rename(trace_fname, old_fname)
165
def open_tracefile(tracefilename=None):
166
# Messages are always written to here, so that we have some
167
# information if something goes wrong. In a future version this
168
# file will be removed on successful completion.
169
global _file_handler, _bzr_log_file, _bzr_log_filename
172
if tracefilename is None:
173
home = os.environ.get('BZR_HOME')
175
if sys.platform == 'win32':
176
from bzrlib import win32utils
177
home = win32utils.get_home_location()
179
home = os.path.expanduser('~')
180
_bzr_log_filename = os.path.join(home, '.bzr.log')
182
_bzr_log_filename = tracefilename
184
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
185
_rollover_trace_maybe(_bzr_log_filename)
188
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
189
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
191
# tf.tell() on windows always return 0 until some writing done
194
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
195
tf.write("you can delete or truncate this file, or include sections in\n")
196
tf.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
197
_file_handler = logging.StreamHandler(tf)
198
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
199
datefmt = r'%Y-%m-%d %H:%M:%S'
200
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
201
_file_handler.setLevel(logging.DEBUG)
202
logging.getLogger('').addHandler(_file_handler)
204
warning("failed to open trace file: %s" % (e))
207
def log_exception_quietly():
208
"""Log the last exception to the trace file only.
210
Used for exceptions that occur internally and that may be
211
interesting to developers but not to users. For example,
212
errors loading plugins.
215
mutter(traceback.format_exc())
218
def enable_default_logging(tracefilename=None):
219
"""Configure default logging to stderr and .bzr.log"""
220
# FIXME: if this is run twice, things get confused
221
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
222
# create encoded wrapper around stderr
223
stderr = codecs.getwriter(osutils.get_terminal_encoding())(sys.stderr,
225
_stderr_handler = logging.StreamHandler(stderr)
226
logging.getLogger('').addHandler(_stderr_handler)
227
_stderr_handler.setLevel(logging.INFO)
228
if not _file_handler:
229
open_tracefile(tracefilename)
230
_trace_file = _bzr_log_file
232
_file_handler.setLevel(logging.DEBUG)
233
_bzr_logger.setLevel(logging.DEBUG)
236
def set_verbosity_level(level):
237
"""Set the verbosity level.
239
:param level: -ve for quiet, 0 for normal, +ve for verbose
241
global _verbosity_level
242
_verbosity_level = level
243
_update_logging_level(level < 0)
246
def get_verbosity_level():
247
"""Get the verbosity level.
249
See set_verbosity_level() for values.
251
return _verbosity_level
254
def be_quiet(quiet=True):
255
# Perhaps this could be deprecated now ...
257
set_verbosity_level(-1)
259
set_verbosity_level(0)
262
def _update_logging_level(quiet=True):
263
"""Hide INFO messages if quiet."""
265
_stderr_handler.setLevel(logging.WARNING)
267
_stderr_handler.setLevel(logging.INFO)
271
"""Is the verbosity level negative?"""
272
return _verbosity_level < 0
276
"""Is the verbosity level positive?"""
277
return _verbosity_level > 0
280
def disable_default_logging():
281
"""Turn off default log handlers.
283
This is intended to be used by the test framework, which doesn't
284
want leakage from the code-under-test into the main logs.
287
l = logging.getLogger('')
288
l.removeHandler(_stderr_handler)
290
l.removeHandler(_file_handler)
294
def enable_test_log(to_file):
295
"""Redirect logging to a temporary file for a test
297
returns an opaque reference that should be passed to disable_test_log
298
after the test completes.
300
disable_default_logging()
303
hdlr = logging.StreamHandler(to_file)
304
hdlr.setLevel(logging.DEBUG)
305
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
306
_bzr_logger.addHandler(hdlr)
307
_bzr_logger.setLevel(logging.DEBUG)
308
result = hdlr, _trace_file, _trace_depth
309
_trace_file = to_file
314
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
315
_bzr_logger.removeHandler(test_log_hdlr)
316
test_log_hdlr.close()
319
_trace_file = old_trace_file
320
_trace_depth = old_trace_depth
322
enable_default_logging()
325
def report_exception(exc_info, err_file):
326
"""Report an exception to err_file (typically stderr) and to .bzr.log.
328
This will show either a full traceback or a short message as appropriate.
330
:return: The appropriate exit code for this error.
332
exc_type, exc_object, exc_tb = exc_info
333
# Log the full traceback to ~/.bzr.log
334
log_exception_quietly()
335
if (isinstance(exc_object, IOError)
336
and getattr(exc_object, 'errno', None) == errno.EPIPE):
337
err_file.write("bzr: broken pipe\n")
338
return errors.EXIT_ERROR
339
elif isinstance(exc_object, KeyboardInterrupt):
340
err_file.write("bzr: interrupted\n")
341
return errors.EXIT_ERROR
342
elif not getattr(exc_object, 'internal_error', True):
343
report_user_error(exc_info, err_file)
344
return errors.EXIT_ERROR
345
elif isinstance(exc_object, (OSError, IOError)):
346
# Might be nice to catch all of these and show them as something more
347
# specific, but there are too many cases at the moment.
348
report_user_error(exc_info, err_file)
349
return errors.EXIT_ERROR
351
report_bug(exc_info, err_file)
352
return errors.EXIT_INTERNAL_ERROR
355
# TODO: Should these be specially encoding the output?
356
def report_user_error(exc_info, err_file):
357
"""Report to err_file an error that's not an internal error.
359
These don't get a traceback unless -Derror was given.
361
if 'error' in debug.debug_flags:
362
report_bug(exc_info, err_file)
364
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
367
def report_bug(exc_info, err_file):
368
"""Report an exception that probably indicates a bug in bzr"""
370
exc_type, exc_object, exc_tb = exc_info
371
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
372
exc_type.__module__, exc_type.__name__, exc_object))
374
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
376
err_file.write('bzr %s on python %s (%s)\n' % \
378
'.'.join(map(str, sys.version_info)),
380
err_file.write('arguments: %r\n' % sys.argv)
382
'encoding: %r, fsenc: %r, lang: %r\n' % (
383
osutils.get_user_encoding(), sys.getfilesystemencoding(),
384
os.environ.get('LANG')))
385
err_file.write("plugins:\n")
386
for name, a_plugin in sorted(plugin.plugins().items()):
387
err_file.write(" %-20s %s [%s]\n" %
388
(name, a_plugin.path(), a_plugin.__version__))
391
*** Bazaar has encountered an internal error.
392
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
393
including this traceback, and a description of what you
394
were doing when the error occurred.
added
removed
bzrlib/trace.py
