1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
1
3
# This program is free software; you can redistribute it and/or modify
2
4
# it under the terms of the GNU General Public License as published by
3
5
# the Free Software Foundation; either version 2 of the License, or
4
6
# (at your option) any later version.
6
8
# This program is distributed in the hope that it will be useful,
7
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
11
# GNU General Public License for more details.
11
13
# You should have received a copy of the GNU General Public License
12
14
# along with this program; if not, write to the Free Software
13
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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.
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
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.
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.
57
from bzrlib.lazy_import import lazy_import
58
lazy_import(globals(), """
59
from cStringIO import StringIO
68
lazy_import(globals(), """
43
77
_file_handler = None
44
78
_stderr_handler = 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'
83
_bzr_log_filename = None
77
86
# configure convenient aliases for output routines
79
88
_bzr_logger = logging.getLogger('bzr')
80
_bzr_logger.setLevel(logging.DEBUG)
82
info = note = _bzr_logger.info
83
warning = _bzr_logger.warning
90
def note(*args, **kwargs):
91
# FIXME note always emits utf-8, regardless of the terminal encoding
93
bzrlib.ui.ui_factory.clear_term()
94
_bzr_logger.info(*args, **kwargs)
96
def warning(*args, **kwargs):
98
bzrlib.ui.ui_factory.clear_term()
99
_bzr_logger.warning(*args, **kwargs)
84
102
log_error = _bzr_logger.error
85
103
error = _bzr_logger.error
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.
106
def mutter(fmt, *args):
107
if _trace_file is None:
109
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
112
if isinstance(fmt, unicode):
113
fmt = fmt.encode('utf8')
116
# It seems that if we do ascii % (unicode, ascii) we can
117
# get a unicode cannot encode ascii error, so make sure that "fmt"
118
# is a unicode string
121
if isinstance(arg, unicode):
122
arg = arg.encode('utf8')
123
real_args.append(arg)
124
out = fmt % tuple(real_args)
128
_trace_file.write(out)
129
# TODO: jam 20051227 Consider flushing the trace file to help debugging
133
def mutter_callsite(stacklevel, fmt, *args):
134
"""Perform a mutter of fmt and args, logging the call trace.
136
:param stacklevel: The number of frames to show. None will show all
138
:param fmt: The format string to pass to mutter.
139
:param args: A list of substitution variables.
142
traceback.print_stack(limit=stacklevel + 1, file=outf)
143
formatted_lines = outf.getvalue().splitlines()
144
formatted_stack = '\n'.join(formatted_lines[:-2])
145
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
96
148
def _rollover_trace_maybe(trace_fname):
100
152
if size <= 4 << 20:
102
154
old_fname = trace_fname + '.old'
105
# must remove before rename on windows
111
# might fail if in use on windows
112
os.rename(trace_fname, old_fname)
155
osutils.rename(trace_fname, old_fname)
120
def open_tracefile(tracefilename='~/.bzr.log'):
160
def open_tracefile(tracefilename=None):
121
161
# Messages are always written to here, so that we have some
122
162
# information if something goes wrong. In a future version this
123
163
# file will be removed on successful completion.
127
trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
_rollover_trace_maybe(trace_fname)
130
# buffering=1 means line buffered
164
global _file_handler, _bzr_log_file, _bzr_log_filename
167
if tracefilename is None:
168
if sys.platform == 'win32':
169
from bzrlib import win32utils
170
home = win32utils.get_home_location()
172
home = os.path.expanduser('~')
173
_bzr_log_filename = os.path.join(home, '.bzr.log')
175
_bzr_log_filename = tracefilename
177
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
178
_rollover_trace_maybe(_bzr_log_filename)
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")
181
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
182
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
184
# tf.tell() on windows always return 0 until some writing done
187
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
136
188
tf.write("you can delete or truncate this file, or include sections in\n")
137
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
189
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
139
190
_file_handler = logging.StreamHandler(tf)
140
191
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
192
datefmt = r'%a %H:%M:%S'
142
193
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
194
_file_handler.setLevel(logging.DEBUG)
144
195
logging.getLogger('').addHandler(_file_handler)
146
196
except IOError, e:
147
197
warning("failed to open trace file: %s" % (e))
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.
200
def log_exception_quietly():
201
"""Log the last exception to the trace file only.
203
Used for exceptions that occur internally and that may be
204
interesting to developers but not to users. For example,
205
errors loading plugins.
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
208
mutter(traceback.format_exc())
179
211
def enable_default_logging():
180
212
"""Configure default logging to stderr and .bzr.log"""
181
global _stderr_handler, _file_handler
213
# FIXME: if this is run twice, things get confused
214
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
183
215
_stderr_handler = logging.StreamHandler()
184
_stderr_handler.setFormatter(QuietFormatter())
216
logging.getLogger('').addHandler(_stderr_handler)
217
_stderr_handler.setLevel(logging.INFO)
186
218
if not _file_handler:
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)
220
_trace_file = _bzr_log_file
222
_file_handler.setLevel(logging.DEBUG)
223
_bzr_logger.setLevel(logging.DEBUG)
226
def set_verbosity_level(level):
227
"""Set the verbosity level.
229
:param level: -ve for quiet, 0 for normal, +ve for verbose
231
global _verbosity_level
232
_verbosity_level = level
233
_update_logging_level(level < 0)
236
def get_verbosity_level():
237
"""Get the verbosity level.
239
See set_verbosity_level() for values.
241
return _verbosity_level
244
def be_quiet(quiet=True):
245
# Perhaps this could be deprecated now ...
247
set_verbosity_level(-1)
249
set_verbosity_level(0)
252
def _update_logging_level(quiet=True):
253
"""Hide INFO messages if quiet."""
255
_stderr_handler.setLevel(logging.WARNING)
257
_stderr_handler.setLevel(logging.INFO)
261
"""Is the verbosity level negative?"""
262
return _verbosity_level < 0
266
"""Is the verbosity level positive?"""
267
return _verbosity_level > 0
201
270
def disable_default_logging():
209
278
l.removeHandler(_stderr_handler)
210
279
if _file_handler:
211
280
l.removeHandler(_file_handler)
284
def enable_test_log(to_file):
285
"""Redirect logging to a temporary file for a test
287
returns an opaque reference that should be passed to disable_test_log
288
after the test completes.
290
disable_default_logging()
293
hdlr = logging.StreamHandler(to_file)
294
hdlr.setLevel(logging.DEBUG)
295
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
296
_bzr_logger.addHandler(hdlr)
297
_bzr_logger.setLevel(logging.DEBUG)
298
result = hdlr, _trace_file, _trace_depth
299
_trace_file = to_file
304
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
305
_bzr_logger.removeHandler(test_log_hdlr)
306
test_log_hdlr.close()
309
_trace_file = old_trace_file
310
_trace_depth = old_trace_depth
312
enable_default_logging()
315
def report_exception(exc_info, err_file):
316
"""Report an exception to err_file (typically stderr) and to .bzr.log.
318
This will show either a full traceback or a short message as appropriate.
320
:return: The appropriate exit code for this error.
322
exc_type, exc_object, exc_tb = exc_info
323
# Log the full traceback to ~/.bzr.log
324
log_exception_quietly()
325
if (isinstance(exc_object, IOError)
326
and getattr(exc_object, 'errno', None) == errno.EPIPE):
327
print >>err_file, "bzr: broken pipe"
328
return errors.EXIT_ERROR
329
elif isinstance(exc_object, KeyboardInterrupt):
330
print >>err_file, "bzr: interrupted"
331
return errors.EXIT_ERROR
332
elif not getattr(exc_object, 'internal_error', True):
333
report_user_error(exc_info, err_file)
334
return errors.EXIT_ERROR
335
elif isinstance(exc_object, (OSError, IOError)):
336
# Might be nice to catch all of these and show them as something more
337
# specific, but there are too many cases at the moment.
338
report_user_error(exc_info, err_file)
339
return errors.EXIT_ERROR
341
report_bug(exc_info, err_file)
342
return errors.EXIT_INTERNAL_ERROR
345
# TODO: Should these be specially encoding the output?
346
def report_user_error(exc_info, err_file):
347
"""Report to err_file an error that's not an internal error.
349
These don't get a traceback unless -Derror was given.
351
if 'error' in debug.debug_flags:
352
report_bug(exc_info, err_file)
354
print >>err_file, "bzr: ERROR:", str(exc_info[1])
357
def report_bug(exc_info, err_file):
358
"""Report an exception that probably indicates a bug in bzr"""
360
exc_type, exc_object, exc_tb = exc_info
361
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
362
exc_type.__module__, exc_type.__name__, exc_object)
364
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
366
print >>err_file, 'bzr %s on python %s (%s)' % \
368
'.'.join(map(str, sys.version_info)),
370
print >>err_file, 'arguments: %r' % sys.argv
372
'encoding: %r, fsenc: %r, lang: %r\n' % (
373
osutils.get_user_encoding(), sys.getfilesystemencoding(),
374
os.environ.get('LANG')))
375
err_file.write("plugins:\n")
376
for name, a_plugin in sorted(plugin.plugins().items()):
377
err_file.write(" %-20s %s [%s]\n" %
378
(name, a_plugin.path(), a_plugin.__version__))
381
"** Please send this report to bazaar@lists.ubuntu.com\n"
382
" with a description of what you were doing when the\n"
added
removed
bzrlib/trace.py
