1
# Copyright (C) 2005, 2006, 2007, 2008 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.
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
65
from bzrlib.lazy_import import lazy_import
66
lazy_import(globals(), """
67
from cStringIO import StringIO
75
lazy_import(globals(), """
86
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
87
# is quiet; >0 is verbose.
90
# File-like object where mutter/debug output is currently sent. Can be
91
# changed by _push_log_file etc. This is directly manipulated by some
92
# external code; maybe there should be functions to do that more precisely
93
# than push/pop_log_file.
96
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
97
# redirected elsewhere. Used to show the location in --version.
98
_bzr_log_filename = None
100
# The time the first message was written to the trace file, so that we can
101
# show relative times since startup.
102
_bzr_log_start_time = bzrlib._start_time
105
# held in a global for quick reference
106
_bzr_logger = logging.getLogger('bzr')
109
def note(*args, **kwargs):
110
# FIXME note always emits utf-8, regardless of the terminal encoding
112
# FIXME: clearing the ui and then going through the abstract logging
113
# framework is whack; we should probably have a logging Handler that
114
# deals with terminal output if needed.
116
bzrlib.ui.ui_factory.clear_term()
117
_bzr_logger.info(*args, **kwargs)
120
def warning(*args, **kwargs):
122
bzrlib.ui.ui_factory.clear_term()
123
_bzr_logger.warning(*args, **kwargs)
126
# configure convenient aliases for output routines
128
# TODO: deprecate them, have one name for each.
130
log_error = _bzr_logger.error
131
error = _bzr_logger.error
134
def mutter(fmt, *args):
135
if _trace_file is None:
137
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
140
if isinstance(fmt, unicode):
141
fmt = fmt.encode('utf8')
144
# It seems that if we do ascii % (unicode, ascii) we can
145
# get a unicode cannot encode ascii error, so make sure that "fmt"
146
# is a unicode string
149
if isinstance(arg, unicode):
150
arg = arg.encode('utf8')
151
real_args.append(arg)
152
out = fmt % tuple(real_args)
155
timestamp = '%0.3f ' % (time.time() - _bzr_log_start_time,)
156
out = timestamp + out + '\n'
157
_trace_file.write(out)
158
# no need to flush here, the trace file is now linebuffered when it's
162
def mutter_callsite(stacklevel, fmt, *args):
163
"""Perform a mutter of fmt and args, logging the call trace.
165
:param stacklevel: The number of frames to show. None will show all
167
:param fmt: The format string to pass to mutter.
168
:param args: A list of substitution variables.
171
traceback.print_stack(limit=stacklevel + 1, file=outf)
172
formatted_lines = outf.getvalue().splitlines()
173
formatted_stack = '\n'.join(formatted_lines[:-2])
174
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
177
def _rollover_trace_maybe(trace_fname):
180
size = os.stat(trace_fname)[stat.ST_SIZE]
183
old_fname = trace_fname + '.old'
184
osutils.rename(trace_fname, old_fname)
189
def _get_bzr_log_filename():
190
bzr_log = os.environ.get('BZR_LOG')
193
home = os.environ.get('BZR_HOME')
195
if sys.platform == 'win32':
196
from bzrlib import win32utils
197
home = win32utils.get_home_location()
199
home = os.path.expanduser('~')
200
return os.path.join(home, '.bzr.log')
204
"""Open the .bzr.log trace file.
206
If the log is more than a particular length, the old file is renamed to
207
.bzr.log.old and a new file is started. Otherwise, we append to the
210
This sets the global _bzr_log_filename.
212
global _bzr_log_filename
213
_bzr_log_filename = _get_bzr_log_filename()
214
_rollover_trace_maybe(_bzr_log_filename)
216
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
217
# bzr_log_file.tell() on windows always return 0 until some writing done
218
bzr_log_file.write('\n')
219
if bzr_log_file.tell() <= 2:
220
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
221
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
222
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
225
warning("failed to open trace file: %s" % (e))
226
# TODO: What should happen if we fail to open the trace file? Maybe the
227
# objects should be pointed at /dev/null or the equivalent? Currently
228
# returns None which will cause failures later.
231
def enable_default_logging():
232
"""Configure default logging: messages to stderr and debug to .bzr.log
234
This should only be called once per process.
236
Non-command-line programs embedding bzrlib do not need to call this. They
237
can instead either pass a file to _push_log_file, or act directly on
238
logging.getLogger("bzr").
240
Output can be redirected away by calling _push_log_file.
242
# create encoded wrapper around stderr
243
bzr_log_file = _open_bzr_log()
244
push_log_file(bzr_log_file,
245
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
246
r'%Y-%m-%d %H:%M:%S')
247
# after hooking output into bzr_log, we also need to attach a stderr
248
# handler, writing only at level info and with encoding
249
writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
250
encoded_stderr = writer_factory(sys.stderr, errors='replace')
251
stderr_handler = logging.StreamHandler(encoded_stderr)
252
stderr_handler.setLevel(logging.INFO)
253
logging.getLogger('bzr').addHandler(stderr_handler)
256
def push_log_file(to_file, log_format=None, date_format=None):
257
"""Intercept log and trace messages and send them to a file.
259
:param to_file: A file-like object to which messages will be sent.
261
:returns: A memento that should be passed to _pop_log_file to restore the
262
previously active logging.
266
new_handler = logging.StreamHandler(to_file)
267
new_handler.setLevel(logging.DEBUG)
268
if log_format is None:
269
log_format = '%(levelname)8s %(message)s'
270
new_handler.setFormatter(logging.Formatter(log_format, date_format))
271
# save and remove any existing log handlers
272
bzr_logger = logging.getLogger('bzr')
273
old_handlers = bzr_logger.handlers[:]
274
del bzr_logger.handlers[:]
275
# set that as the default logger
276
bzr_logger.addHandler(new_handler)
277
bzr_logger.setLevel(logging.DEBUG)
278
# TODO: check if any changes are needed to the root logger
280
# TODO: also probably need to save and restore the level on bzr_logger.
281
# but maybe we can avoid setting the logger level altogether, and just set
282
# the level on the handler?
284
# save the old trace file
285
old_trace_file = _trace_file
286
# send traces to the new one
287
_trace_file = to_file
288
result = new_handler, _trace_file
289
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
292
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
293
"""Undo changes to logging/tracing done by _push_log_file.
295
This flushes, but does not close the trace file.
297
Takes the memento returned from _push_log_file."""
298
assert magic == 'log_memento'
300
_trace_file = old_trace_file
301
bzr_logger = logging.getLogger('bzr')
302
bzr_logger.removeHandler(new_handler)
303
# must be closed, otherwise logging will try to close it atexit, and the
304
# file will likely already be closed underneath.
306
bzr_logger.handlers = old_handlers
307
new_trace_file.flush()
310
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
311
def enable_test_log(to_file):
312
"""Redirect logging to a temporary file for a test
314
:returns: an opaque reference that should be passed to disable_test_log
315
after the test completes.
317
return push_log_file(to_file)
320
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
321
def disable_test_log(memento):
322
return pop_log_file(memento)
325
def log_exception_quietly():
326
"""Log the last exception to the trace file only.
328
Used for exceptions that occur internally and that may be
329
interesting to developers but not to users. For example,
330
errors loading plugins.
332
mutter(traceback.format_exc())
335
def set_verbosity_level(level):
336
"""Set the verbosity level.
338
:param level: -ve for quiet, 0 for normal, +ve for verbose
340
global _verbosity_level
341
_verbosity_level = level
342
_update_logging_level(level < 0)
345
def get_verbosity_level():
346
"""Get the verbosity level.
348
See set_verbosity_level() for values.
350
return _verbosity_level
353
def be_quiet(quiet=True):
354
# Perhaps this could be deprecated now ...
356
set_verbosity_level(-1)
358
set_verbosity_level(0)
361
def _update_logging_level(quiet=True):
362
"""Hide INFO messages if quiet."""
364
_bzr_logger.setLevel(logging.WARNING)
366
_bzr_logger.setLevel(logging.INFO)
370
"""Is the verbosity level negative?"""
371
return _verbosity_level < 0
375
"""Is the verbosity level positive?"""
376
return _verbosity_level > 0
379
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
380
def disable_default_logging():
381
"""Turn off default log handlers.
383
Don't call this method, use _push_log_file and _pop_log_file instead.
388
def report_exception(exc_info, err_file):
389
"""Report an exception to err_file (typically stderr) and to .bzr.log.
391
This will show either a full traceback or a short message as appropriate.
393
:return: The appropriate exit code for this error.
395
exc_type, exc_object, exc_tb = exc_info
396
# Log the full traceback to ~/.bzr.log
397
log_exception_quietly()
398
if (isinstance(exc_object, IOError)
399
and getattr(exc_object, 'errno', None) == errno.EPIPE):
400
err_file.write("bzr: broken pipe\n")
401
return errors.EXIT_ERROR
402
elif isinstance(exc_object, KeyboardInterrupt):
403
err_file.write("bzr: interrupted\n")
404
return errors.EXIT_ERROR
405
elif not getattr(exc_object, 'internal_error', True):
406
report_user_error(exc_info, err_file)
407
return errors.EXIT_ERROR
408
elif isinstance(exc_object, (OSError, IOError)):
409
# Might be nice to catch all of these and show them as something more
410
# specific, but there are too many cases at the moment.
411
report_user_error(exc_info, err_file)
412
return errors.EXIT_ERROR
414
report_bug(exc_info, err_file)
415
return errors.EXIT_INTERNAL_ERROR
418
# TODO: Should these be specially encoding the output?
419
def report_user_error(exc_info, err_file):
420
"""Report to err_file an error that's not an internal error.
422
These don't get a traceback unless -Derror was given.
424
if 'error' in debug.debug_flags:
425
report_bug(exc_info, err_file)
427
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
430
def report_bug(exc_info, err_file):
431
"""Report an exception that probably indicates a bug in bzr"""
432
exc_type, exc_object, exc_tb = exc_info
433
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
434
exc_type.__module__, exc_type.__name__, exc_object))
436
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
438
err_file.write('bzr %s on python %s (%s)\n' % \
440
bzrlib._format_version_tuple(sys.version_info),
442
err_file.write('arguments: %r\n' % sys.argv)
444
'encoding: %r, fsenc: %r, lang: %r\n' % (
445
osutils.get_user_encoding(), sys.getfilesystemencoding(),
446
os.environ.get('LANG')))
447
err_file.write("plugins:\n")
448
for name, a_plugin in sorted(plugin.plugins().items()):
449
err_file.write(" %-20s %s [%s]\n" %
450
(name, a_plugin.path(), a_plugin.__version__))
453
*** Bazaar has encountered an internal error.
454
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
455
including this traceback, and a description of what you
456
were doing when the error occurred.
added
removed
bzrlib/trace.py
