1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
"""Messages and logging for bazaar-ng.
123
127
_bzr_logger.warning(*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
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)
136
156
def mutter(fmt, *args):
137
global _last_mutter_flush_time
138
157
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.
140
161
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
159
180
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
160
181
out = timestamp + out + '\n'
161
182
_trace_file.write(out)
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
183
# there's no explicit flushing; the file is typically line buffered.
173
186
def mutter_callsite(stacklevel, fmt, *args):
218
231
def _open_bzr_log():
219
"""Open the .bzr.log trace file.
232
"""Open the .bzr.log trace file.
221
234
If the log is more than a particular length, the old file is renamed to
222
235
.bzr.log.old and a new file is started. Otherwise, we append to the
228
241
_bzr_log_filename = _get_bzr_log_filename()
229
242
_rollover_trace_maybe(_bzr_log_filename)
231
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
244
bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
232
245
# bzr_log_file.tell() on windows always return 0 until some writing done
233
246
bzr_log_file.write('\n')
234
247
if bzr_log_file.tell() <= 2:
282
295
:param to_file: A file-like object to which messages will be sent.
284
:returns: A memento that should be passed to _pop_log_file to restore the
297
:returns: A memento that should be passed to _pop_log_file to restore the
285
298
previously active logging.
287
300
global _trace_file
316
329
"""Undo changes to logging/tracing done by _push_log_file.
318
331
This flushes, but does not close the trace file.
320
333
Takes the memento returned from _push_log_file."""
321
334
global _trace_file
322
335
_trace_file = old_trace_file
329
342
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)
347
345
def log_exception_quietly():
348
346
"""Log the last exception to the trace file only.
350
Used for exceptions that occur internally and that may be
351
interesting to developers but not to users. For example,
348
Used for exceptions that occur internally and that may be
349
interesting to developers but not to users. For example,
352
350
errors loading plugins.
354
352
mutter(traceback.format_exc())
398
396
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.
410
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
412
399
def debug_memory(message='', short=True):
413
400
"""Write out a memory dump."""
401
if sys.platform == 'win32':
402
from bzrlib import win32utils
403
win32utils.debug_memory_win32api(message=message, short=short)
405
_debug_memory_proc(message=message, short=short)
408
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
410
def _debug_memory_proc(message='', short=True):
415
412
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
439
436
:return: The appropriate exit code for this error.
441
exc_type, exc_object, exc_tb = exc_info
442
438
# Log the full traceback to ~/.bzr.log
443
439
log_exception_quietly()
440
if 'error' in debug.debug_flags:
441
print_exception(exc_info, err_file)
442
return errors.EXIT_ERROR
443
exc_type, exc_object, exc_tb = exc_info
444
444
if (isinstance(exc_object, IOError)
445
445
and getattr(exc_object, 'errno', None) == errno.EPIPE):
446
446
err_file.write("bzr: broken pipe\n")
448
448
elif isinstance(exc_object, KeyboardInterrupt):
449
449
err_file.write("bzr: interrupted\n")
450
450
return errors.EXIT_ERROR
451
elif isinstance(exc_object, MemoryError):
452
err_file.write("bzr: out of memory\n")
453
return errors.EXIT_ERROR
451
454
elif isinstance(exc_object, ImportError) \
452
455
and str(exc_object).startswith("No module named "):
453
456
report_user_error(exc_info, err_file,
484
487
:param advice: Extra advice to the user to be printed following the
487
if 'error' in debug.debug_flags:
488
print_exception(exc_info, err_file)
490
490
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
492
492
err_file.write("%s\n" % (advice,))
495
495
def report_bug(exc_info, err_file):
496
496
"""Report an exception that probably indicates a bug in bzr"""
497
print_exception(exc_info, err_file)
499
err_file.write('bzr %s on python %s (%s)\n' % \
501
bzrlib._format_version_tuple(sys.version_info),
503
err_file.write('arguments: %r\n' % sys.argv)
505
'encoding: %r, fsenc: %r, lang: %r\n' % (
506
osutils.get_user_encoding(), sys.getfilesystemencoding(),
507
os.environ.get('LANG')))
508
err_file.write("plugins:\n")
509
for name, a_plugin in sorted(plugin.plugins().items()):
510
err_file.write(" %-20s %s [%s]\n" %
511
(name, a_plugin.path(), a_plugin.__version__))
514
*** Bazaar has encountered an internal error.
515
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
516
including this traceback, and a description of what you
517
were doing when the error occurred.
497
from bzrlib.crash import report_bug
498
report_bug(exc_info, err_file)
added
removed
bzrlib/trace.py
