42
28
Exceptions are reported in a brief form to stderr so as not to look scary.
43
29
BzrErrors are required to be able to format themselves into a properly
44
explanatory message. This is not true for builtin exceptions such as
30
explanatory message. This is not true for builtin excexceptions such as
45
31
KeyError, which typically just str to "0". They're printed in a different
35
# TODO: in debug mode, stderr should get full tracebacks and also
36
# debug messages. (Is this really needed?)
49
38
# FIXME: Unfortunately it turns out that python's logging module
50
39
# is quite expensive, even when the message is not printed by any handlers.
51
40
# We should perhaps change back to just simply doing it here.
53
# On the other hand, as of 1.2 we generally only call the mutter() statement
54
# if (according to debug_flags) we actually intend to write it. So the
55
# increased cost of logging.py is not so bad, and we could standardize on
64
from bzrlib.lazy_import import lazy_import
65
lazy_import(globals(), """
66
from cStringIO import StringIO
74
from bzrlib.symbol_versioning import (
79
lazy_import(globals(), """
90
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
91
# is quiet; >0 is verbose.
94
# File-like object where mutter/debug output is currently sent. Can be
95
# changed by _push_log_file etc. This is directly manipulated by some
96
# external code; maybe there should be functions to do that more precisely
97
# than push/pop_log_file.
48
from bzrlib.errors import BzrError, BzrNewError
52
_stderr_handler = None
100
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
101
# redirected elsewhere. Used to show the location in --version.
102
_bzr_log_filename = None
104
# The time the first message was written to the trace file, so that we can
105
# show relative times since startup.
106
_bzr_log_start_time = bzrlib._start_time
109
# held in a global for quick reference
58
class QuietFormatter(logging.Formatter):
59
"""Formatter that supresses the details of errors.
61
This is used by default on stderr so as not to scare the user.
63
# At first I tried overriding formatException to suppress the
64
# exception details, but that has global effect: no loggers
65
# can get the exception details is we suppress them here.
67
def format(self, record):
68
if record.levelno >= logging.WARNING:
69
s = 'bzr: ' + record.levelname + ': '
72
s += record.getMessage()
74
s += '\n' + format_exception_short(record.exc_info)
77
# configure convenient aliases for output routines
110
79
_bzr_logger = logging.getLogger('bzr')
113
def note(*args, **kwargs):
114
# FIXME note always emits utf-8, regardless of the terminal encoding
116
# FIXME: clearing the ui and then going through the abstract logging
117
# framework is whack; we should probably have a logging Handler that
118
# deals with terminal output if needed.
120
bzrlib.ui.ui_factory.clear_term()
121
_bzr_logger.info(*args, **kwargs)
124
def warning(*args, **kwargs):
126
bzrlib.ui.ui_factory.clear_term()
127
_bzr_logger.warning(*args, **kwargs)
130
@deprecated_function(deprecated_in((2, 1, 0)))
131
def info(*args, **kwargs):
132
"""Deprecated: use trace.note instead."""
133
note(*args, **kwargs)
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def log_error(*args, **kwargs):
138
"""Deprecated: use bzrlib.trace.show_error instead"""
139
_bzr_logger.error(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
149
"""Show an error message to the user.
151
Don't use this for exceptions, use report_exception instead.
153
_bzr_logger.error(*args, **kwargs)
81
info = note = _bzr_logger.info
82
warning = _bzr_logger.warning
83
log_error = _bzr_logger.error
84
error = _bzr_logger.error
156
87
def mutter(fmt, *args):
157
88
if _trace_file is None:
159
# XXX: Don't check this every time; instead anyone who closes the file
160
# ought to deregister it. We can tolerate None.
161
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
90
if hasattr(_trace_file, 'closed') and _trace_file.closed:
164
if isinstance(fmt, unicode):
165
fmt = fmt.encode('utf8')
168
# It seems that if we do ascii % (unicode, ascii) we can
169
# get a unicode cannot encode ascii error, so make sure that "fmt"
170
# is a unicode string
173
if isinstance(arg, unicode):
174
arg = arg.encode('utf8')
175
real_args.append(arg)
176
out = fmt % tuple(real_args)
180
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
181
out = timestamp + out + '\n'
182
97
_trace_file.write(out)
183
# there's no explicit flushing; the file is typically line buffered.
186
def mutter_callsite(stacklevel, fmt, *args):
187
"""Perform a mutter of fmt and args, logging the call trace.
189
:param stacklevel: The number of frames to show. None will show all
191
:param fmt: The format string to pass to mutter.
192
:param args: A list of substitution variables.
195
if stacklevel is None:
198
limit = stacklevel + 1
199
traceback.print_stack(limit=limit, file=outf)
200
formatted_lines = outf.getvalue().splitlines()
201
formatted_stack = '\n'.join(formatted_lines[:-2])
202
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
205
101
def _rollover_trace_maybe(trace_fname):
209
105
if size <= 4 << 20:
211
107
old_fname = trace_fname + '.old'
212
osutils.rename(trace_fname, old_fname)
108
from osutils import rename
109
rename(trace_fname, old_fname)
217
def _get_bzr_log_filename():
218
bzr_log = os.environ.get('BZR_LOG')
221
home = os.environ.get('BZR_HOME')
223
if sys.platform == 'win32':
224
from bzrlib import win32utils
225
home = win32utils.get_home_location()
227
home = os.path.expanduser('~')
228
return os.path.join(home, '.bzr.log')
232
"""Open the .bzr.log trace file.
234
If the log is more than a particular length, the old file is renamed to
235
.bzr.log.old and a new file is started. Otherwise, we append to the
238
This sets the global _bzr_log_filename.
240
global _bzr_log_filename
241
_bzr_log_filename = _get_bzr_log_filename()
242
_rollover_trace_maybe(_bzr_log_filename)
114
def open_tracefile(tracefilename='~/.bzr.log'):
115
# Messages are always written to here, so that we have some
116
# information if something goes wrong. In a future version this
117
# file will be removed on successful completion.
118
global _file_handler, _bzr_log_file
121
trace_fname = os.path.join(os.path.expanduser(tracefilename))
122
_rollover_trace_maybe(trace_fname)
244
bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
245
# bzr_log_file.tell() on windows always return 0 until some writing done
246
bzr_log_file.write('\n')
247
if bzr_log_file.tell() <= 2:
248
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
249
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
250
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
125
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
128
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
129
tf.write("you can delete or truncate this file, or include sections in\n")
130
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
131
_file_handler = logging.StreamHandler(tf)
132
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
133
datefmt = r'%a %H:%M:%S'
134
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
135
_file_handler.setLevel(logging.DEBUG)
136
logging.getLogger('').addHandler(_file_handler)
252
137
except IOError, e:
253
138
warning("failed to open trace file: %s" % (e))
254
# TODO: What should happen if we fail to open the trace file? Maybe the
255
# objects should be pointed at /dev/null or the equivalent? Currently
256
# returns None which will cause failures later.
260
def enable_default_logging():
261
"""Configure default logging: messages to stderr and debug to .bzr.log
263
This should only be called once per process.
265
Non-command-line programs embedding bzrlib do not need to call this. They
266
can instead either pass a file to _push_log_file, or act directly on
267
logging.getLogger("bzr").
269
Output can be redirected away by calling _push_log_file.
271
# Do this before we open the log file, so we prevent
272
# get_terminal_encoding() from mutter()ing multiple times
273
term_encoding = osutils.get_terminal_encoding()
274
start_time = osutils.format_local_date(_bzr_log_start_time,
276
# create encoded wrapper around stderr
277
bzr_log_file = _open_bzr_log()
278
if bzr_log_file is not None:
279
bzr_log_file.write(start_time.encode('utf-8') + '\n')
280
push_log_file(bzr_log_file,
281
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
282
r'%Y-%m-%d %H:%M:%S')
283
# after hooking output into bzr_log, we also need to attach a stderr
284
# handler, writing only at level info and with encoding
285
writer_factory = codecs.getwriter(term_encoding)
286
encoded_stderr = writer_factory(sys.stderr, errors='replace')
287
stderr_handler = logging.StreamHandler(encoded_stderr)
288
stderr_handler.setLevel(logging.INFO)
289
logging.getLogger('bzr').addHandler(stderr_handler)
292
def push_log_file(to_file, log_format=None, date_format=None):
293
"""Intercept log and trace messages and send them to a file.
295
:param to_file: A file-like object to which messages will be sent.
297
:returns: A memento that should be passed to _pop_log_file to restore the
298
previously active logging.
302
new_handler = logging.StreamHandler(to_file)
303
new_handler.setLevel(logging.DEBUG)
304
if log_format is None:
305
log_format = '%(levelname)8s %(message)s'
306
new_handler.setFormatter(logging.Formatter(log_format, date_format))
307
# save and remove any existing log handlers
308
bzr_logger = logging.getLogger('bzr')
309
old_handlers = bzr_logger.handlers[:]
310
del bzr_logger.handlers[:]
311
# set that as the default logger
312
bzr_logger.addHandler(new_handler)
313
bzr_logger.setLevel(logging.DEBUG)
314
# TODO: check if any changes are needed to the root logger
316
# TODO: also probably need to save and restore the level on bzr_logger.
317
# but maybe we can avoid setting the logger level altogether, and just set
318
# the level on the handler?
320
# save the old trace file
321
old_trace_file = _trace_file
322
# send traces to the new one
323
_trace_file = to_file
324
result = new_handler, _trace_file
325
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
328
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
329
"""Undo changes to logging/tracing done by _push_log_file.
331
This flushes, but does not close the trace file.
333
Takes the memento returned from _push_log_file."""
335
_trace_file = old_trace_file
336
bzr_logger = logging.getLogger('bzr')
337
bzr_logger.removeHandler(new_handler)
338
# must be closed, otherwise logging will try to close it atexit, and the
339
# file will likely already be closed underneath.
341
bzr_logger.handlers = old_handlers
342
new_trace_file.flush()
141
def log_startup(argv):
142
debug('\n\nbzr %s invoked on python %s (%s)',
144
'.'.join(map(str, sys.version_info)),
146
debug(' arguments: %r', argv)
147
debug(' working dir: %r', os.getcwdu())
150
def log_exception(msg=None):
151
"""Log the last exception to stderr and the trace file.
153
The exception string representation is used as the error
154
summary, unless msg is given.
159
exc_str = format_exception_short(sys.exc_info())
161
log_exception_quietly()
345
164
def log_exception_quietly():
346
165
"""Log the last exception to the trace file only.
348
Used for exceptions that occur internally and that may be
349
interesting to developers but not to users. For example,
167
Used for exceptions that occur internally and that may be
168
interesting to developers but not to users. For example,
350
169
errors loading plugins.
352
mutter(traceback.format_exc())
355
def set_verbosity_level(level):
356
"""Set the verbosity level.
358
:param level: -ve for quiet, 0 for normal, +ve for verbose
360
global _verbosity_level
361
_verbosity_level = level
362
_update_logging_level(level < 0)
365
def get_verbosity_level():
366
"""Get the verbosity level.
368
See set_verbosity_level() for values.
370
return _verbosity_level
172
debug(traceback.format_exc())
175
def enable_default_logging():
176
"""Configure default logging to stderr and .bzr.log"""
177
# FIXME: if this is run twice, things get confused
178
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
179
_stderr_handler = logging.StreamHandler()
180
_stderr_handler.setFormatter(QuietFormatter())
181
logging.getLogger('').addHandler(_stderr_handler)
182
_stderr_handler.setLevel(logging.INFO)
183
if not _file_handler:
185
_trace_file = _bzr_log_file
187
_file_handler.setLevel(logging.DEBUG)
188
_bzr_logger.setLevel(logging.DEBUG)
373
192
def be_quiet(quiet=True):
374
# Perhaps this could be deprecated now ...
376
set_verbosity_level(-1)
378
set_verbosity_level(0)
381
def _update_logging_level(quiet=True):
382
"""Hide INFO messages if quiet."""
384
_bzr_logger.setLevel(logging.WARNING)
386
_bzr_logger.setLevel(logging.INFO)
193
global _stderr_handler, _stderr_quiet
195
_stderr_quiet = quiet
197
_stderr_handler.setLevel(logging.WARNING)
199
_stderr_handler.setLevel(logging.INFO)
390
"""Is the verbosity level negative?"""
391
return _verbosity_level < 0
395
"""Is the verbosity level positive?"""
396
return _verbosity_level > 0
399
def debug_memory(message='', short=True):
400
"""Write out a memory dump."""
401
if sys.platform == 'win32':
402
from bzrlib import win32utils
403
win32utils.debug_memory_win32api(message=message, short=short)
405
_debug_memory_proc(message=message, short=short)
408
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
410
def _debug_memory_proc(message='', short=True):
412
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
416
status = status_file.read()
421
for line in status.splitlines():
207
def disable_default_logging():
208
"""Turn off default log handlers.
210
This is intended to be used by the test framework, which doesn't
211
want leakage from the code-under-test into the main logs.
214
l = logging.getLogger('')
215
l.removeHandler(_stderr_handler)
217
l.removeHandler(_file_handler)
221
def enable_test_log(to_file):
222
"""Redirect logging to a temporary file for a test
224
returns an opaque reference that should be passed to disable_test_log
225
after the test complete.
227
disable_default_logging()
229
hdlr = logging.StreamHandler(to_file)
230
hdlr.setLevel(logging.DEBUG)
231
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
232
_bzr_logger.addHandler(hdlr)
233
_bzr_logger.setLevel(logging.DEBUG)
234
result = hdlr, _trace_file
235
_trace_file = to_file
239
def disable_test_log((test_log_hdlr, old_trace_file)):
240
_bzr_logger.removeHandler(test_log_hdlr)
241
_trace_file = old_trace_file
242
enable_default_logging()
245
def format_exception_short(exc_info):
246
"""Make a short string form of an exception.
248
This is used for display to stderr. It specially handles exception
249
classes without useful string methods.
251
The result has no trailing newline.
253
exc_info - typically an exception from sys.exc_info()
255
exc_type, exc_object, exc_tb = exc_info
258
return '(no exception)'
259
if isinstance(exc_object, (BzrError, BzrNewError)):
260
return str(exc_object)
425
for field in _short_fields:
426
if line.startswith(field):
431
def report_exception(exc_info, err_file):
432
"""Report an exception to err_file (typically stderr) and to .bzr.log.
434
This will show either a full traceback or a short message as appropriate.
436
:return: The appropriate exit code for this error.
438
# Log the full traceback to ~/.bzr.log
439
log_exception_quietly()
440
if 'error' in debug.debug_flags:
441
print_exception(exc_info, err_file)
442
return errors.EXIT_ERROR
443
exc_type, exc_object, exc_tb = exc_info
444
if (isinstance(exc_object, IOError)
445
and getattr(exc_object, 'errno', None) == errno.EPIPE):
446
err_file.write("bzr: broken pipe\n")
447
return errors.EXIT_ERROR
448
elif isinstance(exc_object, KeyboardInterrupt):
449
err_file.write("bzr: interrupted\n")
450
return errors.EXIT_ERROR
451
elif isinstance(exc_object, MemoryError):
452
err_file.write("bzr: out of memory\n")
453
return errors.EXIT_ERROR
454
elif isinstance(exc_object, ImportError) \
455
and str(exc_object).startswith("No module named "):
456
report_user_error(exc_info, err_file,
457
'You may need to install this Python library separately.')
458
return errors.EXIT_ERROR
459
elif not getattr(exc_object, 'internal_error', True):
460
report_user_error(exc_info, err_file)
461
return errors.EXIT_ERROR
462
elif isinstance(exc_object, (OSError, IOError)):
463
# Might be nice to catch all of these and show them as something more
464
# specific, but there are too many cases at the moment.
465
report_user_error(exc_info, err_file)
466
return errors.EXIT_ERROR
468
report_bug(exc_info, err_file)
469
return errors.EXIT_INTERNAL_ERROR
472
def print_exception(exc_info, err_file):
473
exc_type, exc_object, exc_tb = exc_info
474
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
475
exc_type.__module__, exc_type.__name__, exc_object))
477
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
480
# TODO: Should these be specially encoding the output?
481
def report_user_error(exc_info, err_file, advice=None):
482
"""Report to err_file an error that's not an internal error.
484
These don't get a traceback unless -Derror was given.
486
:param exc_info: 3-tuple from sys.exc_info()
487
:param advice: Extra advice to the user to be printed following the
490
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
492
err_file.write("%s\n" % (advice,))
495
def report_bug(exc_info, err_file):
496
"""Report an exception that probably indicates a bug in bzr"""
497
from bzrlib.crash import report_bug
498
report_bug(exc_info, err_file)
263
tb = traceback.extract_tb(exc_tb)
264
msg = '%s: %s' % (exc_type, exc_object)
268
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
270
except Exception, formatting_exc:
271
# XXX: is this really better than just letting it run up?
272
return '(error formatting exception of type %s: %s)' \
273
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
