1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Messages and logging.
17
"""Messages and logging for bazaar-ng.
19
19
Messages are supplied by callers as a string-formatting template, plus values
20
20
to be inserted into it. The actual %-formatting is deferred to the log
34
34
Output to stderr depends on the mode chosen by the user. By default, messages
35
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 debug mode, stderr gets debug messages too.
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.
38
39
Errors that terminate an operation are generally passed back as exceptions;
39
40
others may be just emitted as messages.
127
123
_bzr_logger.warning(*args, **kwargs)
130
@deprecated_function(deprecated_in((2, 1, 0)))
131
def info(*args, **kwargs):
132
"""Deprecated: use trace.note instead."""
133
note(*args, **kwargs)
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def log_error(*args, **kwargs):
138
"""Deprecated: use bzrlib.trace.show_error instead"""
139
_bzr_logger.error(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
149
"""Show an error message to the user.
151
Don't use this for exceptions, use report_exception instead.
153
_bzr_logger.error(*args, **kwargs)
126
# configure convenient aliases for output routines
128
# TODO: deprecate them, have one name for each.
130
log_error = _bzr_logger.error
131
error = _bzr_logger.error
156
134
def mutter(fmt, *args):
157
135
if _trace_file is None:
159
# XXX: Don't check this every time; instead anyone who closes the file
160
# ought to deregister it. We can tolerate None.
161
137
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
176
152
out = fmt % tuple(real_args)
180
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
155
timestamp = '%0.3f ' % (time.time() - _bzr_log_start_time,)
181
156
out = timestamp + out + '\n'
182
157
_trace_file.write(out)
183
# there's no explicit flushing; the file is typically line buffered.
158
# no need to flush here, the trace file is now linebuffered when it's
186
162
def mutter_callsite(stacklevel, fmt, *args):
231
207
def _open_bzr_log():
232
"""Open the .bzr.log trace file.
208
"""Open the .bzr.log trace file.
234
210
If the log is more than a particular length, the old file is renamed to
235
211
.bzr.log.old and a new file is started. Otherwise, we append to the
241
217
_bzr_log_filename = _get_bzr_log_filename()
242
218
_rollover_trace_maybe(_bzr_log_filename)
244
bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
220
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
245
221
# bzr_log_file.tell() on windows always return 0 until some writing done
246
222
bzr_log_file.write('\n')
247
223
if bzr_log_file.tell() <= 2:
250
226
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
251
227
return bzr_log_file
252
228
except IOError, e:
253
# If we are failing to open the log, then most likely logging has not
254
# been set up yet. So we just write to stderr rather than using
255
# 'warning()'. If we using warning(), users get the unhelpful 'no
256
# handlers registered for "bzr"' when something goes wrong on the
257
# server. (bug #503886)
258
sys.stderr.write("failed to open trace file: %s\n" % (e,))
229
warning("failed to open trace file: %s" % (e))
259
230
# TODO: What should happen if we fail to open the trace file? Maybe the
260
231
# objects should be pointed at /dev/null or the equivalent? Currently
261
232
# returns None which will cause failures later.
265
235
def enable_default_logging():
266
236
"""Configure default logging: messages to stderr and debug to .bzr.log
268
238
This should only be called once per process.
270
240
Non-command-line programs embedding bzrlib do not need to call this. They
271
241
can instead either pass a file to _push_log_file, or act directly on
272
242
logging.getLogger("bzr").
274
244
Output can be redirected away by calling _push_log_file.
276
# Do this before we open the log file, so we prevent
277
# get_terminal_encoding() from mutter()ing multiple times
278
term_encoding = osutils.get_terminal_encoding()
279
start_time = osutils.format_local_date(_bzr_log_start_time,
281
246
# create encoded wrapper around stderr
282
247
bzr_log_file = _open_bzr_log()
283
if bzr_log_file is not None:
284
bzr_log_file.write(start_time.encode('utf-8') + '\n')
285
248
push_log_file(bzr_log_file,
286
249
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
287
250
r'%Y-%m-%d %H:%M:%S')
288
251
# after hooking output into bzr_log, we also need to attach a stderr
289
252
# handler, writing only at level info and with encoding
290
writer_factory = codecs.getwriter(term_encoding)
253
writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
291
254
encoded_stderr = writer_factory(sys.stderr, errors='replace')
292
255
stderr_handler = logging.StreamHandler(encoded_stderr)
293
256
stderr_handler.setLevel(logging.INFO)
347
310
new_trace_file.flush()
313
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
314
def enable_test_log(to_file):
315
"""Redirect logging to a temporary file for a test
317
:returns: an opaque reference that should be passed to disable_test_log
318
after the test completes.
320
return push_log_file(to_file)
323
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
324
def disable_test_log(memento):
325
return pop_log_file(memento)
350
328
def log_exception_quietly():
351
329
"""Log the last exception to the trace file only.
353
Used for exceptions that occur internally and that may be
354
interesting to developers but not to users. For example,
331
Used for exceptions that occur internally and that may be
332
interesting to developers but not to users. For example,
355
333
errors loading plugins.
357
335
mutter(traceback.format_exc())
401
379
return _verbosity_level > 0
382
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
383
def disable_default_logging():
384
"""Turn off default log handlers.
386
Don't call this method, use _push_log_file and _pop_log_file instead.
391
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
404
393
def debug_memory(message='', short=True):
405
394
"""Write out a memory dump."""
406
if sys.platform == 'win32':
407
from bzrlib import win32utils
408
win32utils.debug_memory_win32api(message=message, short=short)
410
_debug_memory_proc(message=message, short=short)
413
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
415
def _debug_memory_proc(message='', short=True):
417
396
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
441
420
:return: The appropriate exit code for this error.
422
exc_type, exc_object, exc_tb = exc_info
443
423
# Log the full traceback to ~/.bzr.log
444
424
log_exception_quietly()
445
if 'error' in debug.debug_flags:
446
print_exception(exc_info, err_file)
447
return errors.EXIT_ERROR
448
exc_type, exc_object, exc_tb = exc_info
449
425
if (isinstance(exc_object, IOError)
450
426
and getattr(exc_object, 'errno', None) == errno.EPIPE):
451
427
err_file.write("bzr: broken pipe\n")
453
429
elif isinstance(exc_object, KeyboardInterrupt):
454
430
err_file.write("bzr: interrupted\n")
455
431
return errors.EXIT_ERROR
456
elif isinstance(exc_object, MemoryError):
457
err_file.write("bzr: out of memory\n")
458
return errors.EXIT_ERROR
459
432
elif isinstance(exc_object, ImportError) \
460
433
and str(exc_object).startswith("No module named "):
461
434
report_user_error(exc_info, err_file,
492
465
:param advice: Extra advice to the user to be printed following the
468
if 'error' in debug.debug_flags:
469
print_exception(exc_info, err_file)
495
471
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
497
473
err_file.write("%s\n" % (advice,))
500
476
def report_bug(exc_info, err_file):
501
477
"""Report an exception that probably indicates a bug in bzr"""
502
from bzrlib.crash import report_bug
503
report_bug(exc_info, err_file)
478
print_exception(exc_info, err_file)
480
err_file.write('bzr %s on python %s (%s)\n' % \
482
bzrlib._format_version_tuple(sys.version_info),
484
err_file.write('arguments: %r\n' % sys.argv)
486
'encoding: %r, fsenc: %r, lang: %r\n' % (
487
osutils.get_user_encoding(), sys.getfilesystemencoding(),
488
os.environ.get('LANG')))
489
err_file.write("plugins:\n")
490
for name, a_plugin in sorted(plugin.plugins().items()):
491
err_file.write(" %-20s %s [%s]\n" %
492
(name, a_plugin.path(), a_plugin.__version__))
495
*** Bazaar has encountered an internal error.
496
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
497
including this traceback, and a description of what you
498
were doing when the error occurred.
added
removed
bzrlib/trace.py
