114
113
def note(*args, **kwargs):
115
"""Output a note to the user.
117
Takes the same parameters as logging.info.
121
114
# FIXME note always emits utf-8, regardless of the terminal encoding
123
116
# FIXME: clearing the ui and then going through the abstract logging
307
300
logging.getLogger("bzr").
309
302
Output can be redirected away by calling _push_log_file.
311
:return: A memento from push_log_file for restoring the log state.
304
# Do this before we open the log file, so we prevent
305
# get_terminal_encoding() from mutter()ing multiple times
306
term_encoding = osutils.get_terminal_encoding()
313
307
start_time = osutils.format_local_date(_bzr_log_start_time,
314
308
timezone='local')
315
309
# create encoded wrapper around stderr
316
310
bzr_log_file = _open_bzr_log()
317
311
if bzr_log_file is not None:
318
312
bzr_log_file.write(start_time.encode('utf-8') + '\n')
319
memento = push_log_file(bzr_log_file,
313
push_log_file(bzr_log_file,
320
314
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
315
r'%Y-%m-%d %H:%M:%S')
322
316
# after hooking output into bzr_log, we also need to attach a stderr
323
317
# handler, writing only at level info and with encoding
324
term_encoding = osutils.get_terminal_encoding()
325
318
writer_factory = codecs.getwriter(term_encoding)
326
319
encoded_stderr = writer_factory(sys.stderr, errors='replace')
327
320
stderr_handler = logging.StreamHandler(encoded_stderr)
328
321
stderr_handler.setLevel(logging.INFO)
329
322
logging.getLogger('bzr').addHandler(stderr_handler)
333
325
def push_log_file(to_file, log_format=None, date_format=None):
369
361
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
370
362
"""Undo changes to logging/tracing done by _push_log_file.
372
This flushes, but does not close the trace file (so that anything that was
364
This flushes, but does not close the trace file.
375
366
Takes the memento returned from _push_log_file."""
376
367
global _trace_file
377
368
_trace_file = old_trace_file
378
369
bzr_logger = logging.getLogger('bzr')
379
370
bzr_logger.removeHandler(new_handler)
380
# must be closed, otherwise logging will try to close it at exit, and the
371
# must be closed, otherwise logging will try to close it atexit, and the
381
372
# file will likely already be closed underneath.
382
373
new_handler.close()
383
374
bzr_logger.handlers = old_handlers
384
if new_trace_file is not None:
385
new_trace_file.flush()
375
new_trace_file.flush()
388
378
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:
493
464
def report_exception(exc_info, err_file):
494
465
"""Report an exception to err_file (typically stderr) and to .bzr.log.
512
483
return errors.EXIT_ERROR
513
484
elif isinstance(exc_object, MemoryError):
514
485
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")
519
486
return errors.EXIT_ERROR
520
487
elif isinstance(exc_object, ImportError) \
521
488
and str(exc_object).startswith("No module named "):
525
492
elif not getattr(exc_object, 'internal_error', True):
526
493
report_user_error(exc_info, err_file)
527
494
return errors.EXIT_ERROR
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"):
495
elif isinstance(exc_object, (OSError, IOError)):
531
496
# Might be nice to catch all of these and show them as something more
532
497
# specific, but there are too many cases at the moment.
533
498
report_user_error(exc_info, err_file)
582
547
def _flush_trace():
583
# called from the bzrlib library finalizer returned by bzrlib.initialize()
548
# run from atexit hook
584
549
global _trace_file
586
551
_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
