2
# -*- coding: UTF-8 -*-
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
11
# GNU General Public License for more details.
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
__author__ = "Martin Pool <mbp@canonical.com>"
23
import sys, os, time, socket, stat, codecs
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.
57
from bzrlib.lazy_import import lazy_import
58
lazy_import(globals(), """
59
from cStringIO import StringIO
26
######################################################################
27
# messages and logging
29
global _tracefile, _starttime
32
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
35
# If false, notes also go to stdout; should replace this with --silent
40
# fix this if we ever fork within python
42
_logprefix = '[%d] ' % _mypid
45
def _write_trace(msg):
46
_tracefile.write(_logprefix + msg + '\n')
50
sys.stderr.write('bzr: warning: ' + msg + '\n')
51
_write_trace('warning: ' + msg)
58
b = '* ' + str(msg) + '\n'
61
_write_trace('note: ' + msg)
65
sys.stderr.write(msg + '\n')
67
lazy_import(globals(), """
75
_stderr_handler = None
80
_bzr_log_filename = None
83
# configure convenient aliases for output routines
85
_bzr_logger = logging.getLogger('bzr')
87
def note(*args, **kwargs):
88
# FIXME note always emits utf-8, regardless of the terminal encoding
90
bzrlib.ui.ui_factory.clear_term()
91
_bzr_logger.info(*args, **kwargs)
93
def warning(*args, **kwargs):
95
bzrlib.ui.ui_factory.clear_term()
96
_bzr_logger.warning(*args, **kwargs)
99
log_error = _bzr_logger.error
100
error = _bzr_logger.error
103
def mutter(fmt, *args):
104
if _trace_file is None:
106
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
109
if isinstance(fmt, unicode):
110
fmt = fmt.encode('utf8')
113
# It seems that if we do ascii % (unicode, ascii) we can
114
# get a unicode cannot encode ascii error, so make sure that "fmt"
115
# is a unicode string
118
if isinstance(arg, unicode):
119
arg = arg.encode('utf8')
120
real_args.append(arg)
121
out = fmt % tuple(real_args)
125
_trace_file.write(out)
126
# TODO: jam 20051227 Consider flushing the trace file to help debugging
130
def mutter_callsite(stacklevel, fmt, *args):
131
"""Perform a mutter of fmt and args, logging the call trace.
133
:param stacklevel: The number of frames to show. None will show all
135
:param fmt: The format string to pass to mutter.
136
:param args: A list of substitution variables.
139
traceback.print_stack(limit=stacklevel + 1, file=outf)
140
formatted_lines = outf.getvalue().splitlines()
141
formatted_stack = '\n'.join(formatted_lines[:-2])
142
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
69
145
def _rollover_trace_maybe(trace_fname):
71
148
size = os.stat(trace_fname)[stat.ST_SIZE]
72
149
if size <= 4 << 20:
74
151
old_fname = trace_fname + '.old'
77
# must remove before rename on windows
83
# might fail if in use on windows
84
os.rename(trace_fname, old_fname)
152
from osutils import rename
153
rename(trace_fname, old_fname)
92
def create_tracefile(argv):
158
def open_tracefile(tracefilename=None):
93
159
# Messages are always written to here, so that we have some
94
160
# information if something goes wrong. In a future version this
95
161
# file will be removed on successful completion.
96
global _starttime, _tracefile
98
_starttime = os.times()[4]
100
trace_fname = os.path.join(os.path.expanduser('~/.bzr.log'))
101
_rollover_trace_maybe(trace_fname)
103
# buffering=1 means line buffered
104
_tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
107
if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
108
t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
109
t.write("you can delete or truncate this file, or include sections in\n")
110
t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
112
# TODO: If we failed to create the file, perhaps give a warning
113
# but don't abort; send things to /dev/null instead?
115
_write_trace('bzr %s invoked on python %s (%s)'
116
% (bzrlib.__version__,
117
'.'.join(map(str, sys.version_info)),
120
_write_trace(' arguments: %r' % argv)
121
_write_trace(' working dir: ' + os.getcwdu())
126
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
127
% (times[:4] + ((times[4] - _starttime),)))
131
def log_exception(e):
132
import traceback, cStringIO
133
s = cStringIO.StringIO()
134
traceback.print_exc(None, s)
135
for l in s.getvalue().split('\n'):
162
global _file_handler, _bzr_log_file, _bzr_log_filename
165
if tracefilename is None:
166
if sys.platform == 'win32':
167
from bzrlib import win32utils
168
home = win32utils.get_home_location()
170
home = os.path.expanduser('~')
171
_bzr_log_filename = os.path.join(home, '.bzr.log')
173
_bzr_log_filename = tracefilename
175
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
176
_rollover_trace_maybe(_bzr_log_filename)
179
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
180
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
182
# tf.tell() on windows always return 0 until some writing done
185
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
186
tf.write("you can delete or truncate this file, or include sections in\n")
187
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
188
_file_handler = logging.StreamHandler(tf)
189
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
190
datefmt = r'%a %H:%M:%S'
191
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
192
_file_handler.setLevel(logging.DEBUG)
193
logging.getLogger('').addHandler(_file_handler)
195
warning("failed to open trace file: %s" % (e))
198
def log_exception_quietly():
199
"""Log the last exception to the trace file only.
201
Used for exceptions that occur internally and that may be
202
interesting to developers but not to users. For example,
203
errors loading plugins.
206
mutter(traceback.format_exc())
209
def enable_default_logging():
210
"""Configure default logging to stderr and .bzr.log"""
211
# FIXME: if this is run twice, things get confused
212
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
213
_stderr_handler = logging.StreamHandler()
214
logging.getLogger('').addHandler(_stderr_handler)
215
_stderr_handler.setLevel(logging.INFO)
216
if not _file_handler:
218
_trace_file = _bzr_log_file
220
_file_handler.setLevel(logging.DEBUG)
221
_bzr_logger.setLevel(logging.DEBUG)
224
def set_verbosity_level(level):
225
"""Set the verbosity level.
227
:param level: -ve for quiet, 0 for normal, +ve for verbose
229
global _verbosity_level
230
_verbosity_level = level
231
_update_logging_level(level < 0)
234
def get_verbosity_level():
235
"""Get the verbosity level.
237
See set_verbosity_level() for values.
239
return _verbosity_level
242
def be_quiet(quiet=True):
243
# Perhaps this could be deprecated now ...
245
set_verbosity_level(-1)
247
set_verbosity_level(0)
250
def _update_logging_level(quiet=True):
251
"""Hide INFO messages if quiet."""
253
_stderr_handler.setLevel(logging.WARNING)
255
_stderr_handler.setLevel(logging.INFO)
259
"""Is the verbosity level negative?"""
260
return _verbosity_level < 0
264
"""Is the verbosity level positive?"""
265
return _verbosity_level > 0
268
def disable_default_logging():
269
"""Turn off default log handlers.
271
This is intended to be used by the test framework, which doesn't
272
want leakage from the code-under-test into the main logs.
275
l = logging.getLogger('')
276
l.removeHandler(_stderr_handler)
278
l.removeHandler(_file_handler)
282
def enable_test_log(to_file):
283
"""Redirect logging to a temporary file for a test
285
returns an opaque reference that should be passed to disable_test_log
286
after the test completes.
288
disable_default_logging()
291
hdlr = logging.StreamHandler(to_file)
292
hdlr.setLevel(logging.DEBUG)
293
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
294
_bzr_logger.addHandler(hdlr)
295
_bzr_logger.setLevel(logging.DEBUG)
296
result = hdlr, _trace_file, _trace_depth
297
_trace_file = to_file
302
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
303
_bzr_logger.removeHandler(test_log_hdlr)
304
test_log_hdlr.close()
307
_trace_file = old_trace_file
308
_trace_depth = old_trace_depth
310
enable_default_logging()
313
def report_exception(exc_info, err_file):
314
"""Report an exception to err_file (typically stderr) and to .bzr.log.
316
This will show either a full traceback or a short message as appropriate.
318
:return: The appropriate exit code for this error.
320
exc_type, exc_object, exc_tb = exc_info
321
# Log the full traceback to ~/.bzr.log
322
log_exception_quietly()
323
if (isinstance(exc_object, IOError)
324
and getattr(exc_object, 'errno', None) == errno.EPIPE):
325
print >>err_file, "bzr: broken pipe"
326
return errors.EXIT_ERROR
327
elif isinstance(exc_object, KeyboardInterrupt):
328
print >>err_file, "bzr: interrupted"
329
return errors.EXIT_ERROR
330
elif not getattr(exc_object, 'internal_error', True):
331
report_user_error(exc_info, err_file)
332
return errors.EXIT_ERROR
333
elif isinstance(exc_object, (OSError, IOError)):
334
# Might be nice to catch all of these and show them as something more
335
# specific, but there are too many cases at the moment.
336
report_user_error(exc_info, err_file)
337
return errors.EXIT_ERROR
339
report_bug(exc_info, err_file)
340
return errors.EXIT_INTERNAL_ERROR
343
# TODO: Should these be specially encoding the output?
344
def report_user_error(exc_info, err_file):
345
"""Report to err_file an error that's not an internal error.
347
These don't get a traceback unless -Derror was given.
349
if 'error' in debug.debug_flags:
350
report_bug(exc_info, err_file)
352
print >>err_file, "bzr: ERROR:", str(exc_info[1])
355
def report_bug(exc_info, err_file):
356
"""Report an exception that probably indicates a bug in bzr"""
358
exc_type, exc_object, exc_tb = exc_info
359
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
360
exc_type.__module__, exc_type.__name__, exc_object)
362
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
364
print >>err_file, 'bzr %s on python %s (%s)' % \
366
'.'.join(map(str, sys.version_info)),
368
print >>err_file, 'arguments: %r' % sys.argv
370
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
added
removed
bzrlib/trace.py
