1
# This program is free software; you can redistribute it and/or modify
2
# it under the terms of the GNU General Public License as published by
3
# the Free Software Foundation; either version 2 of the License, or
4
# (at your option) any later version.
6
# This program is distributed in the hope that it will be useful,
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
# GNU General Public License for more details.
11
# You should have received a copy of the GNU General Public License
12
# along with this program; if not, write to the Free Software
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
"""Messages and logging for bazaar-ng.
18
Messages are supplied by callers as a string-formatting template, plus values
19
to be inserted into it. The actual %-formatting is deferred to the log
20
library so that it doesn't need to be done for messages that won't be emitted.
22
Messages are classified by severity levels: critical, error, warning, info,
25
They can be sent to two places: to stderr, and to ~/.bzr.log. For purposes
26
such as running the test suite, they can also be redirected away from both of
27
those two places to another location.
29
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
31
Output to stderr depends on the mode chosen by the user. By default, messages
32
of info and above are sent out, which results in progress messages such as the
33
list of files processed by add and commit. In quiet mode, only warnings and
34
above are shown. In debug mode, stderr gets debug messages too.
36
Errors that terminate an operation are generally passed back as exceptions;
37
others may be just emitted as messages.
39
Exceptions are reported in a brief form to stderr so as not to look scary.
40
BzrErrors are required to be able to format themselves into a properly
41
explanatory message. This is not true for builtin excexceptions such as
42
KeyError, which typically just str to "0". They're printed in a different
47
# TODO: in debug mode, stderr should get full tracebacks and also
48
# debug messages. (Is this really needed?)
50
# TODO: When running the test suites, we should add an additional
51
# logger that sends messages into the test log file.
53
# FIXME: Unfortunately it turns out that python's logging module
54
# is quite expensive, even when the message is not printed by any handlers.
55
# We should perhaps change back to just simply doing it here.
63
from bzrlib.errors import BzrNewError
67
_stderr_handler = None
69
class QuietFormatter(logging.Formatter):
70
"""Formatter that supresses the details of errors.
72
This is used by default on stderr so as not to scare the user.
74
# At first I tried overriding formatException to suppress the
75
# exception details, but that has global effect: no loggers
76
# can get the exception details is we suppress them here.
78
def format(self, record):
79
if record.levelno >= logging.WARNING:
80
s = 'bzr: ' + record.levelname + ': '
83
s += record.getMessage()
85
s += '\n' + format_exception_short(record.exc_info)
92
# configure convenient aliases for output routines
94
_bzr_logger = logging.getLogger('bzr')
96
info = note = _bzr_logger.info
97
warning = _bzr_logger.warning
98
log_error = _bzr_logger.error
99
error = _bzr_logger.error
100
mutter = _bzr_logger.debug
101
debug = _bzr_logger.debug
104
def _rollover_trace_maybe(trace_fname):
107
size = os.stat(trace_fname)[stat.ST_SIZE]
110
old_fname = trace_fname + '.old'
111
from osutils import rename
112
rename(trace_fname, old_fname)
117
def open_tracefile(tracefilename='~/.bzr.log'):
118
# Messages are always written to here, so that we have some
119
# information if something goes wrong. In a future version this
120
# file will be removed on successful completion.
124
trace_fname = os.path.join(os.path.expanduser(tracefilename))
125
_rollover_trace_maybe(trace_fname)
128
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
130
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
131
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
132
tf.write("you can delete or truncate this file, or include sections in\n")
133
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
135
_file_handler = logging.StreamHandler(tf)
136
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
137
datefmt = r'%a %H:%M:%S'
138
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
139
_file_handler.setLevel(logging.DEBUG)
140
logging.getLogger('').addHandler(_file_handler)
142
warning("failed to open trace file: %s" % (e))
145
def log_startup(argv):
146
debug('bzr %s invoked on python %s (%s)',
148
'.'.join(map(str, sys.version_info)),
150
debug(' arguments: %r', argv)
151
debug(' working dir: %r', os.getcwdu())
154
def log_exception(msg=None):
155
"""Log the last exception to stderr and the trace file.
157
The exception string representation is used as the error
158
summary, unless msg is given.
160
exc_str = format_exception_short(sys.exc_info())
162
_bzr_logger.exception(msg)
163
_bzr_logger.error(exc_str)
166
def log_exception_quietly():
167
"""Log the last exception to the trace file only.
169
Used for exceptions that occur internally and that may be
170
interesting to developers but not to users. For example,
171
errors loading plugins.
174
debug(traceback.format_exc())
177
def enable_default_logging():
178
"""Configure default logging to stderr and .bzr.log"""
179
global _stderr_handler, _file_handler
181
_stderr_handler = logging.StreamHandler()
182
_stderr_handler.setFormatter(QuietFormatter())
183
logging.getLogger('').addHandler(_stderr_handler)
185
if os.environ.get('BZR_DEBUG'):
186
level = logging.DEBUG
190
_stderr_handler.setLevel(logging.INFO)
192
if not _file_handler:
196
_file_handler.setLevel(level)
198
_bzr_logger.setLevel(level)
200
def disable_default_logging():
201
"""Turn off default log handlers.
203
This is intended to be used by the test framework, which doesn't
204
want leakage from the code-under-test into the main logs.
207
l = logging.getLogger('')
208
l.removeHandler(_stderr_handler)
210
l.removeHandler(_file_handler)
213
def enable_test_log(to_file):
214
"""Redirect logging to a temporary file for a test"""
215
disable_default_logging()
216
global _test_log_hdlr
217
hdlr = logging.StreamHandler(to_file)
218
hdlr.setLevel(logging.DEBUG)
219
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
220
logging.getLogger('').addHandler(hdlr)
221
logging.getLogger('').setLevel(logging.DEBUG)
222
_test_log_hdlr = hdlr
225
def disable_test_log():
226
logging.getLogger('').removeHandler(_test_log_hdlr)
227
enable_default_logging()
230
def format_exception_short(exc_info):
231
"""Make a short string form of an exception.
233
This is used for display to stderr. It specially handles exception
234
classes without useful string methods.
236
The result has no trailing newline.
238
exc_info - typically an exception from sys.exc_info()
240
exc_type, exc_object, exc_tb = exc_info
243
return '(no exception)'
244
if isinstance(exc_object, BzrNewError):
245
return str(exc_object)
248
tb = traceback.extract_tb(exc_tb)
249
msg = '%s: %s' % (exc_type, exc_object)
253
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
256
return '(error formatting exception of type %s)' % exc_type
added
removed
bzrlib/trace.py
