120
# FIXME note always emits utf-8, regardless of the terminal encoding
122
113
# FIXME: clearing the ui and then going through the abstract logging
123
114
# framework is whack; we should probably have a logging Handler that
124
115
# deals with terminal output if needed.
126
bzrlib.ui.ui_factory.clear_term()
116
ui.ui_factory.clear_term()
127
117
_bzr_logger.info(*args, **kwargs)
130
120
def warning(*args, **kwargs):
132
bzrlib.ui.ui_factory.clear_term()
121
ui.ui_factory.clear_term()
133
122
_bzr_logger.warning(*args, **kwargs)
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def info(*args, **kwargs):
138
"""Deprecated: use trace.note instead."""
139
note(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def log_error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
148
@deprecated_function(deprecated_in((2, 1, 0)))
149
def error(*args, **kwargs):
150
"""Deprecated: use bzrlib.trace.show_error instead"""
151
_bzr_logger.error(*args, **kwargs)
154
125
def show_error(*args, **kwargs):
155
126
"""Show an error message to the user.
306
277
logging.getLogger("bzr").
308
279
Output can be redirected away by calling _push_log_file.
281
: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
283
start_time = osutils.format_local_date(_bzr_log_start_time,
314
284
timezone='local')
315
# create encoded wrapper around stderr
316
285
bzr_log_file = _open_bzr_log()
317
286
if bzr_log_file is not None:
318
287
bzr_log_file.write(start_time.encode('utf-8') + '\n')
319
push_log_file(bzr_log_file,
288
memento = push_log_file(bzr_log_file,
320
289
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
290
r'%Y-%m-%d %H:%M:%S')
322
291
# after hooking output into bzr_log, we also need to attach a stderr
323
292
# handler, writing only at level info and with encoding
324
writer_factory = codecs.getwriter(term_encoding)
325
encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
stderr_handler = logging.StreamHandler(encoded_stderr)
327
stderr_handler.setLevel(logging.INFO)
293
stderr_handler = EncodedStreamHandler(sys.stderr,
294
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
328
295
logging.getLogger('bzr').addHandler(stderr_handler)
331
299
def push_log_file(to_file, log_format=None, date_format=None):
334
302
:param to_file: A file-like object to which messages will be sent.
336
304
:returns: A memento that should be passed to _pop_log_file to restore the
337
previously active logging.
305
previously active logging.
339
307
global _trace_file
340
308
# make a new handler
341
new_handler = logging.StreamHandler(to_file)
342
new_handler.setLevel(logging.DEBUG)
309
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
343
310
if log_format is None:
344
311
log_format = '%(levelname)8s %(message)s'
345
312
new_handler.setFormatter(logging.Formatter(log_format, date_format))
367
334
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
368
335
"""Undo changes to logging/tracing done by _push_log_file.
370
This flushes, but does not close the trace file.
337
This flushes, but does not close the trace file (so that anything that was
372
340
Takes the memento returned from _push_log_file."""
373
341
global _trace_file
374
342
_trace_file = old_trace_file
375
343
bzr_logger = logging.getLogger('bzr')
376
344
bzr_logger.removeHandler(new_handler)
377
# must be closed, otherwise logging will try to close it atexit, and the
345
# must be closed, otherwise logging will try to close it at exit, and the
378
346
# file will likely already be closed underneath.
379
347
new_handler.close()
380
348
bzr_logger.handlers = old_handlers
381
new_trace_file.flush()
349
if new_trace_file is not None:
350
new_trace_file.flush()
384
353
def log_exception_quietly():
438
def _dump_memory_usage(err_file):
441
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
442
dump_file = os.fdopen(fd, 'w')
443
from meliae import scanner
444
scanner.dump_gc_objects(dump_file)
445
err_file.write("Memory dumped to %s\n" % name)
447
err_file.write("Dumping memory requires meliae module.\n")
448
log_exception_quietly()
450
err_file.write("Exception while dumping memory.\n")
451
log_exception_quietly()
453
if dump_file is not None:
459
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
460
"""Give name of error class including module for non-builtin exceptions
462
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
463
also omit the module prefix.
465
class_name = eclass.__name__
466
module_name = eclass.__module__
467
if module_name in ("exceptions", "__main__") or (
468
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
470
return "%s.%s" % (module_name, class_name)
470
473
def report_exception(exc_info, err_file):
471
474
"""Report an exception to err_file (typically stderr) and to .bzr.log.
480
483
print_exception(exc_info, err_file)
481
484
return errors.EXIT_ERROR
482
485
exc_type, exc_object, exc_tb = exc_info
483
if (isinstance(exc_object, IOError)
484
and getattr(exc_object, 'errno', None) == errno.EPIPE):
485
err_file.write("bzr: broken pipe\n")
486
return errors.EXIT_ERROR
487
elif isinstance(exc_object, KeyboardInterrupt):
486
if isinstance(exc_object, KeyboardInterrupt):
488
487
err_file.write("bzr: interrupted\n")
489
488
return errors.EXIT_ERROR
490
489
elif isinstance(exc_object, MemoryError):
491
490
err_file.write("bzr: out of memory\n")
491
if 'mem_dump' in debug.debug_flags:
492
_dump_memory_usage(err_file)
494
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
492
495
return errors.EXIT_ERROR
493
496
elif isinstance(exc_object, ImportError) \
494
497
and str(exc_object).startswith("No module named "):
498
501
elif not getattr(exc_object, 'internal_error', True):
499
502
report_user_error(exc_info, err_file)
500
503
return errors.EXIT_ERROR
501
elif isinstance(exc_object, (OSError, IOError)):
504
elif osutils.is_environment_error(exc_object):
505
if getattr(exc_object, 'errno', None) == errno.EPIPE:
506
err_file.write("bzr: broken pipe\n")
507
return errors.EXIT_ERROR
502
508
# Might be nice to catch all of these and show them as something more
503
509
# specific, but there are too many cases at the moment.
504
510
report_user_error(exc_info, err_file)
553
563
def _flush_trace():
554
# run from atexit hook
564
# called from the bzrlib library finalizer returned by bzrlib.initialize()
555
565
global _trace_file
557
567
_trace_file.flush()
570
class EncodedStreamHandler(logging.Handler):
571
"""Robustly write logging events to a stream using the specified encoding
573
Messages are expected to be formatted to unicode, but UTF-8 byte strings
574
are also accepted. An error during formatting or a str message in another
575
encoding will be quitely noted as an error in the Bazaar log file.
577
The stream is not closed so sys.stdout or sys.stderr may be passed.
580
def __init__(self, stream, encoding=None, errors='strict', level=0):
581
logging.Handler.__init__(self, level)
584
encoding = getattr(stream, "encoding", "ascii")
585
self.encoding = encoding
589
flush = getattr(self.stream, "flush", None)
590
if flush is not None:
593
def emit(self, record):
595
line = self.format(record)
596
if not isinstance(line, unicode):
597
line = line.decode("utf-8")
598
self.stream.write(line.encode(self.encoding, self.errors) + "\n")
600
log_exception_quietly()
601
# Try saving the details that would have been logged in some form
602
msg = args = "<Unformattable>"
604
msg = repr(record.msg).encode("ascii")
605
args = repr(record.args).encode("ascii")
608
# Using mutter() bypasses the logging module and writes directly
609
# to the file so there's no danger of getting into a loop here.
610
mutter("Logging record unformattable: %s %% %s", msg, args)
613
class Config(object):
614
"""Configuration of message tracing in bzrlib.
616
This implements the context manager protocol and should manage any global
617
variables still used. The default config used is DefaultConfig, but
618
embedded uses of bzrlib may wish to use a custom manager.
622
return self # This is bound to the 'as' clause in a with statement.
624
def __exit__(self, exc_type, exc_val, exc_tb):
625
return False # propogate exceptions.
628
class DefaultConfig(Config):
629
"""A default configuration for tracing of messages in bzrlib.
631
This implements the context manager protocol.
635
self._original_filename = _bzr_log_filename
636
self._original_state = enable_default_logging()
637
return self # This is bound to the 'as' clause in a with statement.
639
def __exit__(self, exc_type, exc_val, exc_tb):
640
pop_log_file(self._original_state)
641
global _bzr_log_filename
642
_bzr_log_filename = self._original_filename
643
return False # propogate exceptions.
added
removed
bzrlib/trace.py
