13
13
# 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.
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
62
80
s = 'bzr: ' + record.levelname + ': '
66
83
s += record.getMessage()
69
##s = textwrap.fill(s)
71
84
if record.exc_info:
72
# give just a summary of the exception, not the whole thing
73
exinfo = traceback.extract_tb(record.exc_info[2])
74
# the format of this string matches one of the REs
76
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
77
s += ' see ~/.bzr.log for debug information'
85
s += '\n' + format_exception_short(record.exc_info)
94
101
debug = _bzr_logger.debug
99
# we do the rollover using this code, rather than the default from python
100
# logging, because we only want to rollover at program startup, not on each
101
# message. maybe that's not a good enough reason.
103
104
def _rollover_trace_maybe(trace_fname):
107
108
if size <= 4 << 20:
109
110
old_fname = trace_fname + '.old'
111
111
from osutils import rename
112
112
rename(trace_fname, old_fname)
119
117
def open_tracefile(tracefilename='~/.bzr.log'):
120
118
# Messages are always written to here, so that we have some
121
119
# information if something goes wrong. In a future version this
126
124
trace_fname = os.path.join(os.path.expanduser(tracefilename))
127
125
_rollover_trace_maybe(trace_fname)
129
# buffering=1 means line buffered
131
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
128
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
133
130
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
134
131
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
141
138
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
142
139
_file_handler.setLevel(logging.DEBUG)
143
140
logging.getLogger('').addHandler(_file_handler)
145
141
except IOError, e:
146
142
warning("failed to open trace file: %s" % (e))
149
145
def log_startup(argv):
152
146
debug('bzr %s invoked on python %s (%s)',
153
147
bzrlib.__version__,
154
148
'.'.join(map(str, sys.version_info)),
157
150
debug(' arguments: %r', argv)
158
151
debug(' working dir: %r', os.getcwdu())
164
157
The exception string representation is used as the error
165
158
summary, unless msg is given.
170
if msg and (msg[-1] == '\n'):
172
msg += '\n command: %s' % ' '.join(repr(arg) for arg in sys.argv)
173
msg += '\n pwd: %r' % os.getcwdu()
174
msg += '\n error: %s' % ei[0] # exception type
175
_bzr_logger.exception(msg)
160
exc_str = format_exception_short(sys.exc_info())
162
_bzr_logger.exception(msg)
163
_bzr_logger.error(exc_str)
178
166
def log_exception_quietly():
201
188
level = logging.INFO
203
190
_stderr_handler.setLevel(logging.INFO)
204
_file_handler.setLevel(level)
192
if not _file_handler:
196
_file_handler.setLevel(level)
205
198
_bzr_logger.setLevel(level)
207
logging.getLogger('').addHandler(_stderr_handler)
210
200
def disable_default_logging():
211
201
"""Turn off default log handlers.
218
208
l.removeHandler(_stderr_handler)
219
209
if _file_handler:
220
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
