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
134
_last_mutter_flush_time = None
156
136
def mutter(fmt, *args):
137
global _last_mutter_flush_time
157
138
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
140
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
180
159
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
181
160
out = timestamp + out + '\n'
182
161
_trace_file.write(out)
183
# there's no explicit flushing; the file is typically line buffered.
162
# We flush if we haven't flushed for a few seconds. We don't want to flush
163
# on every mutter, but when a command takes a while, it can be nice to see
164
# updates in the debug log.
165
if (_last_mutter_flush_time is None
166
or (now - _last_mutter_flush_time) > 2.0):
167
flush = getattr(_trace_file, 'flush', None)
168
if flush is not None:
170
_last_mutter_flush_time = now
186
173
def mutter_callsite(stacklevel, fmt, *args):
241
228
_bzr_log_filename = _get_bzr_log_filename()
242
229
_rollover_trace_maybe(_bzr_log_filename)
244
bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
231
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
245
232
# bzr_log_file.tell() on windows always return 0 until some writing done
246
233
bzr_log_file.write('\n')
247
234
if bzr_log_file.tell() <= 2:
250
237
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
251
238
return bzr_log_file
252
239
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,))
240
warning("failed to open trace file: %s" % (e))
259
241
# TODO: What should happen if we fail to open the trace file? Maybe the
260
242
# objects should be pointed at /dev/null or the equivalent? Currently
261
243
# returns None which will cause failures later.
347
329
new_trace_file.flush()
332
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
333
def enable_test_log(to_file):
334
"""Redirect logging to a temporary file for a test
336
:returns: an opaque reference that should be passed to disable_test_log
337
after the test completes.
339
return push_log_file(to_file)
342
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
343
def disable_test_log(memento):
344
return pop_log_file(memento)
350
347
def log_exception_quietly():
351
348
"""Log the last exception to the trace file only.
401
398
return _verbosity_level > 0
401
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
402
def disable_default_logging():
403
"""Turn off default log handlers.
405
Don't call this method, use _push_log_file and _pop_log_file instead.
404
410
def debug_memory(message='', short=True):
405
411
"""Write out a memory dump."""
406
412
if sys.platform == 'win32':
441
447
:return: The appropriate exit code for this error.
449
exc_type, exc_object, exc_tb = exc_info
443
450
# Log the full traceback to ~/.bzr.log
444
451
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
452
if (isinstance(exc_object, IOError)
450
453
and getattr(exc_object, 'errno', None) == errno.EPIPE):
451
454
err_file.write("bzr: broken pipe\n")
453
456
elif isinstance(exc_object, KeyboardInterrupt):
454
457
err_file.write("bzr: interrupted\n")
455
458
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
459
elif isinstance(exc_object, ImportError) \
460
460
and str(exc_object).startswith("No module named "):
461
461
report_user_error(exc_info, err_file,
492
492
:param advice: Extra advice to the user to be printed following the
495
if 'error' in debug.debug_flags:
496
print_exception(exc_info, err_file)
495
498
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
497
500
err_file.write("%s\n" % (advice,))
500
503
def report_bug(exc_info, err_file):
501
504
"""Report an exception that probably indicates a bug in bzr"""
502
from bzrlib.crash import report_bug
503
report_bug(exc_info, err_file)
505
print_exception(exc_info, err_file)
507
err_file.write('bzr %s on python %s (%s)\n' % \
509
bzrlib._format_version_tuple(sys.version_info),
511
err_file.write('arguments: %r\n' % sys.argv)
513
'encoding: %r, fsenc: %r, lang: %r\n' % (
514
osutils.get_user_encoding(), sys.getfilesystemencoding(),
515
os.environ.get('LANG')))
516
err_file.write("plugins:\n")
517
for name, a_plugin in sorted(plugin.plugins().items()):
518
err_file.write(" %-20s %s [%s]\n" %
519
(name, a_plugin.path(), a_plugin.__version__))
522
*** Bazaar has encountered an internal error.
523
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
524
including this traceback, and a description of what you
525
were doing when the error occurred.
added
removed
bzrlib/trace.py
