1
# Copyright (C) 2005, 2006 Canonical Ltd
3
1
# This program is free software; you can redistribute it and/or modify
4
2
# it under the terms of the GNU General Public License as published by
5
3
# the Free Software Foundation; either version 2 of the License, or
6
4
# (at your option) any later version.
8
6
# This program is distributed in the hope that it will be useful,
9
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
9
# GNU General Public License for more details.
13
11
# You should have received a copy of the GNU General Public License
14
12
# along with this program; if not, write to the Free Software
15
13
# 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
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.
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.
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.
57
from bzrlib.lazy_import import lazy_import
58
lazy_import(globals(), """
64
from bzrlib.symbol_versioning import (deprecated_function,
68
lazy_import(globals(), """
69
from bzrlib import debug
72
43
_file_handler = None
73
_stderr_handler = None
46
class QuietFormatter(logging.Formatter):
47
"""Formatter that supresses the details of errors.
49
This is used by default on stderr so as not to scare the user.
51
# At first I tried overriding formatException to suppress the
52
# exception details, but that has global effect: no loggers
53
# can get the exception details is we suppress them here.
55
def format(self, record):
57
if record.levelno >= logging.WARNING:
58
s += record.levelname + ': '
60
s += record.getMessage()
63
# give just a summary of the exception, not the whole thing
64
exinfo = traceback.extract_tb(record.exc_info[2])
65
# the format of this string matches one of the REs
67
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
68
s += ' see ~/.bzr.log for debug information'
73
# configure default handler to stderr
75
_stderr_handler = logging.StreamHandler()
76
_stderr_handler.setFormatter(QuietFormatter())
78
if os.environ.get('BZR_DEBUG'):
79
_stderr_handler.setLevel(logging.DEBUG)
81
_stderr_handler.setLevel(logging.INFO)
83
logging.getLogger('').addHandler(_stderr_handler)
80
88
# configure convenient aliases for output routines
82
90
_bzr_logger = logging.getLogger('bzr')
84
def note(*args, **kwargs):
85
# FIXME note always emits utf-8, regardless of the terminal encoding
87
bzrlib.ui.ui_factory.clear_term()
88
_bzr_logger.info(*args, **kwargs)
90
def warning(*args, **kwargs):
92
bzrlib.ui.ui_factory.clear_term()
93
_bzr_logger.warning(*args, **kwargs)
91
_bzr_logger.setLevel(logging.DEBUG)
93
note = _bzr_logger.info
94
warning = _bzr_logger.warning
96
95
log_error = _bzr_logger.error
97
96
error = _bzr_logger.error
100
def mutter(fmt, *args):
101
if _trace_file is None:
103
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
106
if isinstance(fmt, unicode):
107
fmt = fmt.encode('utf8')
110
# It seems that if we do ascii % (unicode, ascii) we can
111
# get a unicode cannot encode ascii error, so make sure that "fmt"
112
# is a unicode string
115
if isinstance(arg, unicode):
116
arg = arg.encode('utf8')
117
real_args.append(arg)
118
out = fmt % tuple(real_args)
122
_trace_file.write(out)
123
# TODO: jam 20051227 Consider flushing the trace file to help debugging
97
mutter = _bzr_logger.debug
98
debug = _bzr_logger.debug
103
# we do the rollover using this code, rather than the default from python
104
# logging, because we only want to rollover at program startup, not on each
105
# message. maybe that's not a good enough reason.
127
107
def _rollover_trace_maybe(trace_fname):
131
111
if size <= 4 << 20:
133
113
old_fname = trace_fname + '.old'
134
from osutils import rename
135
rename(trace_fname, old_fname)
116
# must remove before rename on windows
122
# might fail if in use on windows
123
os.rename(trace_fname, old_fname)
140
def open_tracefile(tracefilename=None):
131
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
141
132
# Messages are always written to here, so that we have some
142
133
# information if something goes wrong. In a future version this
143
134
# file will be removed on successful completion.
144
global _file_handler, _bzr_log_file
147
if tracefilename is None:
148
if sys.platform == 'win32':
149
from bzrlib import win32utils
150
home = win32utils.get_home_location()
152
home = os.path.expanduser('~')
153
tracefilename = os.path.join(home, '.bzr.log')
155
trace_fname = os.path.expanduser(tracefilename)
138
trace_fname = os.path.join(os.path.expanduser(tracefilename))
156
139
_rollover_trace_maybe(trace_fname)
141
# buffering=1 means line buffered
159
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
160
tf = open(trace_fname, 'at', LINE_BUFFERED)
162
# tf.tell() on windows always return 0 until some writing done
165
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
143
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
145
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
146
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
166
147
tf.write("you can delete or truncate this file, or include sections in\n")
167
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
148
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
168
150
_file_handler = logging.StreamHandler(tf)
169
151
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
170
152
datefmt = r'%a %H:%M:%S'
171
153
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
172
154
_file_handler.setLevel(logging.DEBUG)
173
155
logging.getLogger('').addHandler(_file_handler)
159
debug('bzr %s invoked on python %s (%s)'
160
% (bzrlib.__version__,
161
'.'.join(map(str, sys.version_info)),
164
debug(' arguments: %r' % argv)
165
debug(' working dir: ' + os.getcwdu())
174
166
except IOError, e:
175
167
warning("failed to open trace file: %s" % (e))
178
@deprecated_function(zero_nine)
179
171
def log_exception(msg=None):
180
"""Log the last exception to stderr and the trace file.
172
"""Log the last exception into the trace file.
182
174
The exception string representation is used as the error
183
175
summary, unless msg is given.
187
log_exception_quietly()
190
def log_exception_quietly():
191
"""Log the last exception to the trace file only.
193
Used for exceptions that occur internally and that may be
194
interesting to developers but not to users. For example,
195
errors loading plugins.
198
mutter(traceback.format_exc())
201
def enable_default_logging():
202
"""Configure default logging to stderr and .bzr.log"""
203
# FIXME: if this is run twice, things get confused
204
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
205
_stderr_handler = logging.StreamHandler()
206
logging.getLogger('').addHandler(_stderr_handler)
207
_stderr_handler.setLevel(logging.INFO)
208
if not _file_handler:
210
_trace_file = _bzr_log_file
212
_file_handler.setLevel(logging.DEBUG)
213
_bzr_logger.setLevel(logging.DEBUG)
216
def be_quiet(quiet=True):
217
global _stderr_handler, _stderr_quiet
219
_stderr_quiet = quiet
221
_stderr_handler.setLevel(logging.WARNING)
223
_stderr_handler.setLevel(logging.INFO)
231
def disable_default_logging():
232
"""Turn off default log handlers.
234
This is intended to be used by the test framework, which doesn't
235
want leakage from the code-under-test into the main logs.
238
l = logging.getLogger('')
239
l.removeHandler(_stderr_handler)
241
l.removeHandler(_file_handler)
245
def enable_test_log(to_file):
246
"""Redirect logging to a temporary file for a test
248
returns an opaque reference that should be passed to disable_test_log
249
after the test completes.
251
disable_default_logging()
254
hdlr = logging.StreamHandler(to_file)
255
hdlr.setLevel(logging.DEBUG)
256
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
257
_bzr_logger.addHandler(hdlr)
258
_bzr_logger.setLevel(logging.DEBUG)
259
result = hdlr, _trace_file, _trace_depth
260
_trace_file = to_file
265
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
266
_bzr_logger.removeHandler(test_log_hdlr)
267
test_log_hdlr.close()
270
_trace_file = old_trace_file
271
_trace_depth = old_trace_depth
273
enable_default_logging()
276
def report_exception(exc_info, err_file):
277
exc_type, exc_object, exc_tb = exc_info
278
# Log the full traceback to ~/.bzr.log
279
log_exception_quietly()
280
if (isinstance(exc_object, IOError)
281
and getattr(exc_object, 'errno', None) == errno.EPIPE):
282
print >>err_file, "bzr: broken pipe"
283
elif isinstance(exc_object, KeyboardInterrupt):
284
print >>err_file, "bzr: interrupted"
285
elif not getattr(exc_object, 'internal_error', True):
286
report_user_error(exc_info, err_file)
287
elif isinstance(exc_object, (OSError, IOError)):
288
# Might be nice to catch all of these and show them as something more
289
# specific, but there are too many cases at the moment.
290
report_user_error(exc_info, err_file)
292
report_bug(exc_info, err_file)
295
# TODO: Should these be specially encoding the output?
296
def report_user_error(exc_info, err_file):
297
"""Report to err_file an error that's not an internal error.
299
These don't get a traceback unless -Derror was given.
301
if 'error' in debug.debug_flags:
302
report_bug(exc_info, err_file)
304
print >>err_file, "bzr: ERROR:", str(exc_info[1])
307
def report_bug(exc_info, err_file):
308
"""Report an exception that probably indicates a bug in bzr"""
310
exc_type, exc_object, exc_tb = exc_info
311
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
312
exc_type.__module__, exc_type.__name__, exc_object)
314
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
316
print >>err_file, 'bzr %s on python %s (%s)' % \
318
'.'.join(map(str, sys.version_info)),
320
print >>err_file, 'arguments: %r' % sys.argv
322
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
184
_bzr_logger.exception(msg)
added
removed
bzrlib/trace.py
