113
114
def note(*args, **kwargs):
115
"""Output a note to the user.
117
Takes the same parameters as logging.info.
114
121
# FIXME note always emits utf-8, regardless of the terminal encoding
116
123
# FIXME: clearing the ui and then going through the abstract logging
117
124
# framework is whack; we should probably have a logging Handler that
118
125
# deals with terminal output if needed.
120
bzrlib.ui.ui_factory.clear_term()
126
ui.ui_factory.clear_term()
121
127
_bzr_logger.info(*args, **kwargs)
124
130
def warning(*args, **kwargs):
126
bzrlib.ui.ui_factory.clear_term()
131
ui.ui_factory.clear_term()
127
132
_bzr_logger.warning(*args, **kwargs)
300
305
logging.getLogger("bzr").
302
307
Output can be redirected away by calling _push_log_file.
309
: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()
307
311
start_time = osutils.format_local_date(_bzr_log_start_time,
308
312
timezone='local')
309
313
# create encoded wrapper around stderr
310
314
bzr_log_file = _open_bzr_log()
311
315
if bzr_log_file is not None:
312
316
bzr_log_file.write(start_time.encode('utf-8') + '\n')
313
push_log_file(bzr_log_file,
317
memento = push_log_file(bzr_log_file,
314
318
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
315
319
r'%Y-%m-%d %H:%M:%S')
316
320
# after hooking output into bzr_log, we also need to attach a stderr
317
321
# handler, writing only at level info and with encoding
322
term_encoding = osutils.get_terminal_encoding()
318
323
writer_factory = codecs.getwriter(term_encoding)
319
324
encoded_stderr = writer_factory(sys.stderr, errors='replace')
320
325
stderr_handler = logging.StreamHandler(encoded_stderr)
321
326
stderr_handler.setLevel(logging.INFO)
322
327
logging.getLogger('bzr').addHandler(stderr_handler)
325
331
def push_log_file(to_file, log_format=None, date_format=None):
361
367
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
362
368
"""Undo changes to logging/tracing done by _push_log_file.
364
This flushes, but does not close the trace file.
370
This flushes, but does not close the trace file (so that anything that was
366
373
Takes the memento returned from _push_log_file."""
367
374
global _trace_file
368
375
_trace_file = old_trace_file
369
376
bzr_logger = logging.getLogger('bzr')
370
377
bzr_logger.removeHandler(new_handler)
371
# must be closed, otherwise logging will try to close it atexit, and the
378
# must be closed, otherwise logging will try to close it at exit, and the
372
379
# file will likely already be closed underneath.
373
380
new_handler.close()
374
381
bzr_logger.handlers = old_handlers
375
new_trace_file.flush()
382
if new_trace_file is not None:
383
new_trace_file.flush()
378
386
def log_exception_quietly():
471
def _dump_memory_usage(err_file):
474
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
475
dump_file = os.fdopen(fd, 'w')
476
from meliae import scanner
477
scanner.dump_gc_objects(dump_file)
478
err_file.write("Memory dumped to %s\n" % name)
480
err_file.write("Dumping memory requires meliae module.\n")
481
log_exception_quietly()
483
err_file.write("Exception while dumping memory.\n")
484
log_exception_quietly()
486
if dump_file is not None:
492
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
493
"""Give name of error class including module for non-builtin exceptions
495
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
496
also omit the module prefix.
498
class_name = eclass.__name__
499
module_name = eclass.__module__
500
if module_name in ("exceptions", "__main__") or (
501
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
503
return "%s.%s" % (module_name, class_name)
464
506
def report_exception(exc_info, err_file):
465
507
"""Report an exception to err_file (typically stderr) and to .bzr.log.
483
525
return errors.EXIT_ERROR
484
526
elif isinstance(exc_object, MemoryError):
485
527
err_file.write("bzr: out of memory\n")
528
if 'mem_dump' in debug.debug_flags:
529
_dump_memory_usage(err_file)
531
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
486
532
return errors.EXIT_ERROR
487
533
elif isinstance(exc_object, ImportError) \
488
534
and str(exc_object).startswith("No module named "):
492
538
elif not getattr(exc_object, 'internal_error', True):
493
539
report_user_error(exc_info, err_file)
494
540
return errors.EXIT_ERROR
495
elif isinstance(exc_object, (OSError, IOError)):
541
elif isinstance(exc_object, (OSError, IOError)) or (
542
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
543
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
496
544
# Might be nice to catch all of these and show them as something more
497
545
# specific, but there are too many cases at the moment.
498
546
report_user_error(exc_info, err_file)
547
595
def _flush_trace():
548
# run from atexit hook
596
# called from the bzrlib library finalizer returned by bzrlib.initialize()
549
597
global _trace_file
551
599
_trace_file.flush()
602
class Config(object):
603
"""Configuration of message tracing in bzrlib.
605
This implements the context manager protocol and should manage any global
606
variables still used. The default config used is DefaultConfig, but
607
embedded uses of bzrlib may wish to use a custom manager.
611
return self # This is bound to the 'as' clause in a with statement.
613
def __exit__(self, exc_type, exc_val, exc_tb):
614
return False # propogate exceptions.
617
class DefaultConfig(Config):
618
"""A default configuration for tracing of messages in bzrlib.
620
This implements the context manager protocol.
624
self._original_filename = _bzr_log_filename
625
self._original_state = enable_default_logging()
626
return self # This is bound to the 'as' clause in a with statement.
628
def __exit__(self, exc_type, exc_val, exc_tb):
629
pop_log_file(self._original_state)
630
global _bzr_log_filename
631
_bzr_log_filename = self._original_filename
632
return False # propogate exceptions.
added
removed
bzrlib/trace.py
