306
307
logging.getLogger("bzr").
308
309
Output can be redirected away by calling _push_log_file.
311
:return: A memento from push_log_file for restoring the log state.
310
# Do this before we open the log file, so we prevent
311
# get_terminal_encoding() from mutter()ing multiple times
312
term_encoding = osutils.get_terminal_encoding()
313
313
start_time = osutils.format_local_date(_bzr_log_start_time,
314
314
timezone='local')
315
315
# create encoded wrapper around stderr
316
316
bzr_log_file = _open_bzr_log()
317
317
if bzr_log_file is not None:
318
318
bzr_log_file.write(start_time.encode('utf-8') + '\n')
319
push_log_file(bzr_log_file,
319
memento = push_log_file(bzr_log_file,
320
320
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
321
r'%Y-%m-%d %H:%M:%S')
322
322
# after hooking output into bzr_log, we also need to attach a stderr
323
323
# handler, writing only at level info and with encoding
324
term_encoding = osutils.get_terminal_encoding()
324
325
writer_factory = codecs.getwriter(term_encoding)
325
326
encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
327
stderr_handler = logging.StreamHandler(encoded_stderr)
327
328
stderr_handler.setLevel(logging.INFO)
328
329
logging.getLogger('bzr').addHandler(stderr_handler)
331
333
def push_log_file(to_file, log_format=None, date_format=None):
367
369
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
368
370
"""Undo changes to logging/tracing done by _push_log_file.
370
This flushes, but does not close the trace file.
372
This flushes, but does not close the trace file (so that anything that was
372
375
Takes the memento returned from _push_log_file."""
373
376
global _trace_file
374
377
_trace_file = old_trace_file
375
378
bzr_logger = logging.getLogger('bzr')
376
379
bzr_logger.removeHandler(new_handler)
377
# must be closed, otherwise logging will try to close it atexit, and the
380
# must be closed, otherwise logging will try to close it at exit, and the
378
381
# file will likely already be closed underneath.
379
382
new_handler.close()
380
383
bzr_logger.handlers = old_handlers
381
new_trace_file.flush()
384
if new_trace_file is not None:
385
new_trace_file.flush()
384
388
def log_exception_quietly():
473
def _dump_memory_usage(err_file):
476
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
477
dump_file = os.fdopen(fd, 'w')
478
from meliae import scanner
479
scanner.dump_gc_objects(dump_file)
480
err_file.write("Memory dumped to %s\n" % name)
482
err_file.write("Dumping memory requires meliae module.\n")
483
log_exception_quietly()
485
err_file.write("Exception while dumping memory.\n")
486
log_exception_quietly()
488
if dump_file is not None:
470
493
def report_exception(exc_info, err_file):
471
494
"""Report an exception to err_file (typically stderr) and to .bzr.log.
489
512
return errors.EXIT_ERROR
490
513
elif isinstance(exc_object, MemoryError):
491
514
err_file.write("bzr: out of memory\n")
515
if 'mem_dump' in debug.debug_flags:
516
_dump_memory_usage(err_file)
518
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
492
519
return errors.EXIT_ERROR
493
520
elif isinstance(exc_object, ImportError) \
494
521
and str(exc_object).startswith("No module named "):
498
525
elif not getattr(exc_object, 'internal_error', True):
499
526
report_user_error(exc_info, err_file)
500
527
return errors.EXIT_ERROR
501
elif isinstance(exc_object, (OSError, IOError)):
528
elif isinstance(exc_object, (OSError, IOError)) or (
529
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
530
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
502
531
# Might be nice to catch all of these and show them as something more
503
532
# specific, but there are too many cases at the moment.
504
533
report_user_error(exc_info, err_file)
553
582
def _flush_trace():
554
# run from atexit hook
583
# called from the bzrlib library finalizer returned by bzrlib.initialize()
555
584
global _trace_file
557
586
_trace_file.flush()
589
class Config(object):
590
"""Configuration of message tracing in bzrlib.
592
This implements the context manager protocol and should manage any global
593
variables still used. The default config used is DefaultConfig, but
594
embedded uses of bzrlib may wish to use a custom manager.
598
return self # This is bound to the 'as' clause in a with statement.
600
def __exit__(self, exc_type, exc_val, exc_tb):
601
return False # propogate exceptions.
604
class DefaultConfig(Config):
605
"""A default configuration for tracing of messages in bzrlib.
607
This implements the context manager protocol.
611
self._original_filename = _bzr_log_filename
612
self._original_state = enable_default_logging()
613
return self # This is bound to the 'as' clause in a with statement.
615
def __exit__(self, exc_type, exc_val, exc_tb):
616
pop_log_file(self._original_state)
617
global _bzr_log_filename
618
_bzr_log_filename = self._original_filename
619
return False # propogate exceptions.
added
removed
bzrlib/trace.py
