113
111
def note(*args, **kwargs):
114
# FIXME note always emits utf-8, regardless of the terminal encoding
112
"""Output a note to the user.
114
Takes the same parameters as logging.info.
116
118
# FIXME: clearing the ui and then going through the abstract logging
117
119
# framework is whack; we should probably have a logging Handler that
118
120
# deals with terminal output if needed.
120
bzrlib.ui.ui_factory.clear_term()
121
ui.ui_factory.clear_term()
121
122
_bzr_logger.info(*args, **kwargs)
124
125
def warning(*args, **kwargs):
126
bzrlib.ui.ui_factory.clear_term()
126
ui.ui_factory.clear_term()
127
127
_bzr_logger.warning(*args, **kwargs)
300
300
logging.getLogger("bzr").
302
302
Output can be redirected away by calling _push_log_file.
304
: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
306
start_time = osutils.format_local_date(_bzr_log_start_time,
308
307
timezone='local')
309
# create encoded wrapper around stderr
310
308
bzr_log_file = _open_bzr_log()
311
309
if bzr_log_file is not None:
312
310
bzr_log_file.write(start_time.encode('utf-8') + '\n')
313
push_log_file(bzr_log_file,
311
memento = push_log_file(bzr_log_file,
314
312
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
315
313
r'%Y-%m-%d %H:%M:%S')
316
314
# after hooking output into bzr_log, we also need to attach a stderr
317
315
# handler, writing only at level info and with encoding
318
writer_factory = codecs.getwriter(term_encoding)
319
encoded_stderr = writer_factory(sys.stderr, errors='replace')
320
stderr_handler = logging.StreamHandler(encoded_stderr)
321
stderr_handler.setLevel(logging.INFO)
316
stderr_handler = EncodedStreamHandler(sys.stderr,
317
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
322
318
logging.getLogger('bzr').addHandler(stderr_handler)
325
322
def push_log_file(to_file, log_format=None, date_format=None):
328
325
:param to_file: A file-like object to which messages will be sent.
330
327
:returns: A memento that should be passed to _pop_log_file to restore the
331
previously active logging.
328
previously active logging.
333
330
global _trace_file
334
331
# make a new handler
335
new_handler = logging.StreamHandler(to_file)
336
new_handler.setLevel(logging.DEBUG)
332
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
337
333
if log_format is None:
338
334
log_format = '%(levelname)8s %(message)s'
339
335
new_handler.setFormatter(logging.Formatter(log_format, date_format))
361
357
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
362
358
"""Undo changes to logging/tracing done by _push_log_file.
364
This flushes, but does not close the trace file.
360
This flushes, but does not close the trace file (so that anything that was
366
363
Takes the memento returned from _push_log_file."""
367
364
global _trace_file
368
365
_trace_file = old_trace_file
369
366
bzr_logger = logging.getLogger('bzr')
370
367
bzr_logger.removeHandler(new_handler)
371
# must be closed, otherwise logging will try to close it atexit, and the
368
# must be closed, otherwise logging will try to close it at exit, and the
372
369
# file will likely already be closed underneath.
373
370
new_handler.close()
374
371
bzr_logger.handlers = old_handlers
375
new_trace_file.flush()
372
if new_trace_file is not None:
373
new_trace_file.flush()
378
376
def log_exception_quietly():
461
def _dump_memory_usage(err_file):
464
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
465
dump_file = os.fdopen(fd, 'w')
466
from meliae import scanner
467
scanner.dump_gc_objects(dump_file)
468
err_file.write("Memory dumped to %s\n" % name)
470
err_file.write("Dumping memory requires meliae module.\n")
471
log_exception_quietly()
473
err_file.write("Exception while dumping memory.\n")
474
log_exception_quietly()
476
if dump_file is not None:
482
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
483
"""Give name of error class including module for non-builtin exceptions
485
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
486
also omit the module prefix.
488
class_name = eclass.__name__
489
module_name = eclass.__module__
490
if module_name in ("exceptions", "__main__") or (
491
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
493
return "%s.%s" % (module_name, class_name)
464
496
def report_exception(exc_info, err_file):
465
497
"""Report an exception to err_file (typically stderr) and to .bzr.log.
483
515
return errors.EXIT_ERROR
484
516
elif isinstance(exc_object, MemoryError):
485
517
err_file.write("bzr: out of memory\n")
518
if 'mem_dump' in debug.debug_flags:
519
_dump_memory_usage(err_file)
521
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
486
522
return errors.EXIT_ERROR
487
523
elif isinstance(exc_object, ImportError) \
488
524
and str(exc_object).startswith("No module named "):
492
528
elif not getattr(exc_object, 'internal_error', True):
493
529
report_user_error(exc_info, err_file)
494
530
return errors.EXIT_ERROR
495
elif isinstance(exc_object, (OSError, IOError)):
531
elif isinstance(exc_object, (OSError, IOError)) or (
532
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
533
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
496
534
# Might be nice to catch all of these and show them as something more
497
535
# specific, but there are too many cases at the moment.
498
536
report_user_error(exc_info, err_file)
547
585
def _flush_trace():
548
# run from atexit hook
586
# called from the bzrlib library finalizer returned by bzrlib.initialize()
549
587
global _trace_file
551
589
_trace_file.flush()
592
class EncodedStreamHandler(logging.Handler):
593
"""Robustly write logging events to a stream using the specified encoding
595
Messages are expected to be formatted to unicode, but UTF-8 byte strings
596
are also accepted. An error during formatting or a str message in another
597
encoding will be quitely noted as an error in the Bazaar log file.
599
The stream is not closed so sys.stdout or sys.stderr may be passed.
602
def __init__(self, stream, encoding=None, errors='strict', level=0):
603
logging.Handler.__init__(self, level)
606
encoding = getattr(stream, "encoding", "ascii")
607
self.encoding = encoding
611
flush = getattr(self.stream, "flush", None)
612
if flush is not None:
615
def emit(self, record):
617
line = self.format(record)
618
if not isinstance(line, unicode):
619
line = line.decode("utf-8")
620
self.stream.write(line.encode(self.encoding, self.errors) + "\n")
622
log_exception_quietly()
623
# Try saving the details that would have been logged in some form
624
msg = args = "<Unformattable>"
626
msg = repr(record.msg).encode("ascii")
627
args = repr(record.args).encode("ascii")
630
# Using mutter() bypasses the logging module and writes directly
631
# to the file so there's no danger of getting into a loop here.
632
mutter("Logging record unformattable: %s %% %s", msg, args)
635
class Config(object):
636
"""Configuration of message tracing in bzrlib.
638
This implements the context manager protocol and should manage any global
639
variables still used. The default config used is DefaultConfig, but
640
embedded uses of bzrlib may wish to use a custom manager.
644
return self # This is bound to the 'as' clause in a with statement.
646
def __exit__(self, exc_type, exc_val, exc_tb):
647
return False # propogate exceptions.
650
class DefaultConfig(Config):
651
"""A default configuration for tracing of messages in bzrlib.
653
This implements the context manager protocol.
657
self._original_filename = _bzr_log_filename
658
self._original_state = enable_default_logging()
659
return self # This is bound to the 'as' clause in a with statement.
661
def __exit__(self, exc_type, exc_val, exc_tb):
662
pop_log_file(self._original_state)
663
global _bzr_log_filename
664
_bzr_log_filename = self._original_filename
665
return False # propogate exceptions.
added
removed
bzrlib/trace.py
