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.
59
from bzrlib.lazy_import import lazy_import
60
lazy_import(globals(), """
61
from cStringIO import StringIO
69
lazy_import(globals(), """
79
_stderr_handler = None
84
_bzr_log_filename = None
87
# configure convenient aliases for output routines
89
_bzr_logger = logging.getLogger('bzr')
92
def note(*args, **kwargs):
93
# FIXME note always emits utf-8, regardless of the terminal encoding
95
bzrlib.ui.ui_factory.clear_term()
96
_bzr_logger.info(*args, **kwargs)
98
def warning(*args, **kwargs):
100
bzrlib.ui.ui_factory.clear_term()
101
_bzr_logger.warning(*args, **kwargs)
104
log_error = _bzr_logger.error
105
error = _bzr_logger.error
108
def mutter(fmt, *args):
109
if _trace_file is None:
111
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
114
if isinstance(fmt, unicode):
115
fmt = fmt.encode('utf8')
118
# It seems that if we do ascii % (unicode, ascii) we can
119
# get a unicode cannot encode ascii error, so make sure that "fmt"
120
# is a unicode string
123
if isinstance(arg, unicode):
124
arg = arg.encode('utf8')
125
real_args.append(arg)
126
out = fmt % tuple(real_args)
130
_trace_file.write(out)
131
# TODO: jam 20051227 Consider flushing the trace file to help debugging
135
def mutter_callsite(stacklevel, fmt, *args):
136
"""Perform a mutter of fmt and args, logging the call trace.
138
:param stacklevel: The number of frames to show. None will show all
140
:param fmt: The format string to pass to mutter.
141
:param args: A list of substitution variables.
144
traceback.print_stack(limit=stacklevel + 1, file=outf)
145
formatted_lines = outf.getvalue().splitlines()
146
formatted_stack = '\n'.join(formatted_lines[:-2])
147
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
150
def _rollover_trace_maybe(trace_fname):
153
size = os.stat(trace_fname)[stat.ST_SIZE]
156
old_fname = trace_fname + '.old'
157
osutils.rename(trace_fname, old_fname)
162
def open_tracefile(tracefilename=None):
163
# Messages are always written to here, so that we have some
164
# information if something goes wrong. In a future version this
165
# file will be removed on successful completion.
166
global _file_handler, _bzr_log_file, _bzr_log_filename
169
if tracefilename is None:
170
if sys.platform == 'win32':
171
from bzrlib import win32utils
172
home = win32utils.get_home_location()
174
home = os.path.expanduser('~')
175
_bzr_log_filename = os.path.join(home, '.bzr.log')
177
_bzr_log_filename = tracefilename
179
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
180
_rollover_trace_maybe(_bzr_log_filename)
183
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
184
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
186
# tf.tell() on windows always return 0 until some writing done
189
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
190
tf.write("you can delete or truncate this file, or include sections in\n")
191
tf.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
192
_file_handler = logging.StreamHandler(tf)
193
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
194
datefmt = r'%a %H:%M:%S'
195
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
196
_file_handler.setLevel(logging.DEBUG)
197
logging.getLogger('').addHandler(_file_handler)
199
warning("failed to open trace file: %s" % (e))
202
def log_exception_quietly():
203
"""Log the last exception to the trace file only.
205
Used for exceptions that occur internally and that may be
206
interesting to developers but not to users. For example,
207
errors loading plugins.
210
mutter(traceback.format_exc())
213
def enable_default_logging():
214
"""Configure default logging to stderr and .bzr.log"""
215
# FIXME: if this is run twice, things get confused
216
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
217
# create encoded wrapper around stderr
218
stderr = codecs.getwriter(osutils.get_terminal_encoding())(sys.stderr,
220
_stderr_handler = logging.StreamHandler(stderr)
221
logging.getLogger('').addHandler(_stderr_handler)
222
_stderr_handler.setLevel(logging.INFO)
223
if not _file_handler:
225
_trace_file = _bzr_log_file
227
_file_handler.setLevel(logging.DEBUG)
228
_bzr_logger.setLevel(logging.DEBUG)
231
def set_verbosity_level(level):
232
"""Set the verbosity level.
234
:param level: -ve for quiet, 0 for normal, +ve for verbose
236
global _verbosity_level
237
_verbosity_level = level
238
_update_logging_level(level < 0)
241
def get_verbosity_level():
242
"""Get the verbosity level.
244
See set_verbosity_level() for values.
246
return _verbosity_level
249
def be_quiet(quiet=True):
250
# Perhaps this could be deprecated now ...
252
set_verbosity_level(-1)
254
set_verbosity_level(0)
257
def _update_logging_level(quiet=True):
258
"""Hide INFO messages if quiet."""
260
_stderr_handler.setLevel(logging.WARNING)
262
_stderr_handler.setLevel(logging.INFO)
266
"""Is the verbosity level negative?"""
267
return _verbosity_level < 0
271
"""Is the verbosity level positive?"""
272
return _verbosity_level > 0
275
def disable_default_logging():
276
"""Turn off default log handlers.
278
This is intended to be used by the test framework, which doesn't
279
want leakage from the code-under-test into the main logs.
282
l = logging.getLogger('')
283
l.removeHandler(_stderr_handler)
285
l.removeHandler(_file_handler)
289
def enable_test_log(to_file):
290
"""Redirect logging to a temporary file for a test
292
returns an opaque reference that should be passed to disable_test_log
293
after the test completes.
295
disable_default_logging()
298
hdlr = logging.StreamHandler(to_file)
299
hdlr.setLevel(logging.DEBUG)
300
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
301
_bzr_logger.addHandler(hdlr)
302
_bzr_logger.setLevel(logging.DEBUG)
303
result = hdlr, _trace_file, _trace_depth
304
_trace_file = to_file
309
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
310
_bzr_logger.removeHandler(test_log_hdlr)
311
test_log_hdlr.close()
314
_trace_file = old_trace_file
315
_trace_depth = old_trace_depth
317
enable_default_logging()
320
def report_exception(exc_info, err_file):
321
"""Report an exception to err_file (typically stderr) and to .bzr.log.
323
This will show either a full traceback or a short message as appropriate.
325
:return: The appropriate exit code for this error.
327
exc_type, exc_object, exc_tb = exc_info
328
# Log the full traceback to ~/.bzr.log
329
log_exception_quietly()
330
if (isinstance(exc_object, IOError)
331
and getattr(exc_object, 'errno', None) == errno.EPIPE):
332
err_file.write("bzr: broken pipe\n")
333
return errors.EXIT_ERROR
334
elif isinstance(exc_object, KeyboardInterrupt):
335
err_file.write("bzr: interrupted\n")
336
return errors.EXIT_ERROR
337
elif not getattr(exc_object, 'internal_error', True):
338
report_user_error(exc_info, err_file)
339
return errors.EXIT_ERROR
340
elif isinstance(exc_object, (OSError, IOError)):
341
# Might be nice to catch all of these and show them as something more
342
# specific, but there are too many cases at the moment.
343
report_user_error(exc_info, err_file)
344
return errors.EXIT_ERROR
346
report_bug(exc_info, err_file)
347
return errors.EXIT_INTERNAL_ERROR
350
# TODO: Should these be specially encoding the output?
351
def report_user_error(exc_info, err_file):
352
"""Report to err_file an error that's not an internal error.
354
These don't get a traceback unless -Derror was given.
356
if 'error' in debug.debug_flags:
357
report_bug(exc_info, err_file)
359
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
362
def report_bug(exc_info, err_file):
363
"""Report an exception that probably indicates a bug in bzr"""
365
exc_type, exc_object, exc_tb = exc_info
366
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
367
exc_type.__module__, exc_type.__name__, exc_object))
369
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
371
err_file.write('bzr %s on python %s (%s)\n' % \
373
'.'.join(map(str, sys.version_info)),
375
err_file.write('arguments: %r\n' % sys.argv)
377
'encoding: %r, fsenc: %r, lang: %r\n' % (
378
osutils.get_user_encoding(), sys.getfilesystemencoding(),
379
os.environ.get('LANG')))
380
err_file.write("plugins:\n")
381
for name, a_plugin in sorted(plugin.plugins().items()):
382
err_file.write(" %-20s %s [%s]\n" %
383
(name, a_plugin.path(), a_plugin.__version__))
386
*** Bazaar has encountered an internal error.
387
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
388
including this traceback, and a description of what you
389
were doing when the error occurred.
added
removed
bzrlib/trace.py
