1
# Copyright (C) 2005, 2006 Canonical Ltd
2
# -*- coding: UTF-8 -*-
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
12
# GNU General Public License for more details.
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
16
# 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.
57
from bzrlib.lazy_import import lazy_import
58
lazy_import(globals(), """
19
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
__author__ = "Martin Pool <mbp@canonical.com>"
23
import sys, os, time, socket, stat, codecs
64
from bzrlib.symbol_versioning import (deprecated_function,
68
lazy_import(globals(), """
69
from bzrlib import debug
73
_stderr_handler = None
78
_bzr_log_filename = None
81
# configure convenient aliases for output routines
83
_bzr_logger = logging.getLogger('bzr')
85
def note(*args, **kwargs):
86
# FIXME note always emits utf-8, regardless of the terminal encoding
88
bzrlib.ui.ui_factory.clear_term()
89
_bzr_logger.info(*args, **kwargs)
91
def warning(*args, **kwargs):
93
bzrlib.ui.ui_factory.clear_term()
94
_bzr_logger.warning(*args, **kwargs)
97
log_error = _bzr_logger.error
98
error = _bzr_logger.error
101
def mutter(fmt, *args):
102
if _trace_file is None:
104
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
107
if isinstance(fmt, unicode):
108
fmt = fmt.encode('utf8')
111
# It seems that if we do ascii % (unicode, ascii) we can
112
# get a unicode cannot encode ascii error, so make sure that "fmt"
113
# is a unicode string
116
if isinstance(arg, unicode):
117
arg = arg.encode('utf8')
118
real_args.append(arg)
119
out = fmt % tuple(real_args)
123
_trace_file.write(out)
124
# TODO: jam 20051227 Consider flushing the trace file to help debugging
26
######################################################################
27
# messages and logging
29
## TODO: If --verbose is given then write to both stderr and
30
## _tracefile; perhaps replace _tracefile with a tee thing.
32
global _tracefile, _starttime
35
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
38
# If false, notes also go to stdout; should replace this with --silent
43
# TODO: Somehow tie this to the --verbose option?
47
# fix this if we ever fork within python
49
_logprefix = '[%d] ' % _mypid
52
def _write_trace(msg):
53
_tracefile.write(_logprefix + msg + '\n')
57
sys.stderr.write('bzr: warning: ' + msg + '\n')
58
_write_trace('warning: ' + msg)
65
b = '* ' + str(msg) + '\n'
68
_write_trace('note: ' + msg)
72
sys.stderr.write(msg + '\n')
76
# TODO: Something to log exceptions in here.
128
80
def _rollover_trace_maybe(trace_fname):
131
82
size = os.stat(trace_fname)[stat.ST_SIZE]
134
85
old_fname = trace_fname + '.old'
135
from osutils import rename
136
rename(trace_fname, old_fname)
88
# must remove before rename on windows
94
# might fail if in use on windows
95
os.rename(trace_fname, old_fname)
141
def open_tracefile(tracefilename=None):
103
def create_tracefile(argv):
104
# TODO: Also show contents of /etc/lsb-release, if it can be parsed.
105
# Perhaps that should eventually go into the platform library?
106
# TODO: If the file doesn't exist, add a note describing it.
142
108
# Messages are always written to here, so that we have some
143
109
# information if something goes wrong. In a future version this
144
110
# file will be removed on successful completion.
145
global _file_handler, _bzr_log_file, _bzr_log_filename
148
if tracefilename is None:
149
if sys.platform == 'win32':
150
from bzrlib import win32utils
151
home = win32utils.get_home_location()
153
home = os.path.expanduser('~')
154
_bzr_log_filename = os.path.join(home, '.bzr.log')
156
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
157
_rollover_trace_maybe(_bzr_log_filename)
160
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
161
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
163
# tf.tell() on windows always return 0 until some writing done
166
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
167
tf.write("you can delete or truncate this file, or include sections in\n")
168
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
169
_file_handler = logging.StreamHandler(tf)
170
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
171
datefmt = r'%a %H:%M:%S'
172
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
173
_file_handler.setLevel(logging.DEBUG)
174
logging.getLogger('').addHandler(_file_handler)
176
warning("failed to open trace file: %s" % (e))
179
@deprecated_function(zero_nine)
180
def log_exception(msg=None):
181
"""Log the last exception to stderr and the trace file.
183
The exception string representation is used as the error
184
summary, unless msg is given.
186
Please see log_exception_quietly() for the replacement API.
190
log_exception_quietly()
193
def log_exception_quietly():
194
"""Log the last exception to the trace file only.
196
Used for exceptions that occur internally and that may be
197
interesting to developers but not to users. For example,
198
errors loading plugins.
201
mutter(traceback.format_exc())
204
def enable_default_logging():
205
"""Configure default logging to stderr and .bzr.log"""
206
# FIXME: if this is run twice, things get confused
207
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
208
_stderr_handler = logging.StreamHandler()
209
logging.getLogger('').addHandler(_stderr_handler)
210
_stderr_handler.setLevel(logging.INFO)
211
if not _file_handler:
213
_trace_file = _bzr_log_file
215
_file_handler.setLevel(logging.DEBUG)
216
_bzr_logger.setLevel(logging.DEBUG)
219
def be_quiet(quiet=True):
220
global _stderr_handler, _stderr_quiet
222
_stderr_quiet = quiet
224
_stderr_handler.setLevel(logging.WARNING)
226
_stderr_handler.setLevel(logging.INFO)
234
def disable_default_logging():
235
"""Turn off default log handlers.
237
This is intended to be used by the test framework, which doesn't
238
want leakage from the code-under-test into the main logs.
241
l = logging.getLogger('')
242
l.removeHandler(_stderr_handler)
244
l.removeHandler(_file_handler)
248
def enable_test_log(to_file):
249
"""Redirect logging to a temporary file for a test
251
returns an opaque reference that should be passed to disable_test_log
252
after the test completes.
254
disable_default_logging()
257
hdlr = logging.StreamHandler(to_file)
258
hdlr.setLevel(logging.DEBUG)
259
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
260
_bzr_logger.addHandler(hdlr)
261
_bzr_logger.setLevel(logging.DEBUG)
262
result = hdlr, _trace_file, _trace_depth
263
_trace_file = to_file
268
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
269
_bzr_logger.removeHandler(test_log_hdlr)
270
test_log_hdlr.close()
273
_trace_file = old_trace_file
274
_trace_depth = old_trace_depth
276
enable_default_logging()
279
def report_exception(exc_info, err_file):
280
exc_type, exc_object, exc_tb = exc_info
281
# Log the full traceback to ~/.bzr.log
282
log_exception_quietly()
283
if (isinstance(exc_object, IOError)
284
and getattr(exc_object, 'errno', None) == errno.EPIPE):
285
print >>err_file, "bzr: broken pipe"
286
elif isinstance(exc_object, KeyboardInterrupt):
287
print >>err_file, "bzr: interrupted"
288
elif not getattr(exc_object, 'internal_error', True):
289
report_user_error(exc_info, err_file)
290
elif isinstance(exc_object, (OSError, IOError)):
291
# Might be nice to catch all of these and show them as something more
292
# specific, but there are too many cases at the moment.
293
report_user_error(exc_info, err_file)
295
report_bug(exc_info, err_file)
298
# TODO: Should these be specially encoding the output?
299
def report_user_error(exc_info, err_file):
300
"""Report to err_file an error that's not an internal error.
302
These don't get a traceback unless -Derror was given.
304
if 'error' in debug.debug_flags:
305
report_bug(exc_info, err_file)
307
print >>err_file, "bzr: ERROR:", str(exc_info[1])
310
def report_bug(exc_info, err_file):
311
"""Report an exception that probably indicates a bug in bzr"""
313
exc_type, exc_object, exc_tb = exc_info
314
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
315
exc_type.__module__, exc_type.__name__, exc_object)
317
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
319
print >>err_file, 'bzr %s on python %s (%s)' % \
321
'.'.join(map(str, sys.version_info)),
323
print >>err_file, 'arguments: %r' % sys.argv
325
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
111
global _starttime, _tracefile
113
_starttime = os.times()[4]
115
trace_fname = os.path.join(os.path.expanduser('~/.bzr.log'))
116
_rollover_trace_maybe(trace_fname)
118
# buffering=1 means line buffered
119
_tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
122
if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
123
t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
124
t.write("you can delete or truncate this file, or include sections in\n")
125
t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
127
# TODO: If we failed to create the file, perhaps give a warning
128
# but don't abort; send things to /dev/null instead?
130
_write_trace('bzr %s invoked on python %s (%s)'
131
% (bzrlib.__version__,
132
'.'.join(map(str, sys.version_info)),
135
_write_trace(' arguments: %r' % argv)
136
_write_trace(' working dir: ' + os.getcwdu())
141
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
142
% (times[:4] + ((times[4] - _starttime),)))
146
def log_exception(e):
147
import traceback, cStringIO
148
s = cStringIO.StringIO()
149
traceback.print_exc(None, s)
150
for l in s.getvalue().split('\n'):
added
removed
bzrlib/trace.py
