1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
48
from __future__ import absolute_import
50
48
# FIXME: Unfortunately it turns out that python's logging module
51
49
# is quite expensive, even when the message is not printed by any handlers.
52
50
# We should perhaps change back to just simply doing it here.
120
# FIXME note always emits utf-8, regardless of the terminal encoding
115
122
# FIXME: clearing the ui and then going through the abstract logging
116
123
# framework is whack; we should probably have a logging Handler that
117
124
# deals with terminal output if needed.
118
ui.ui_factory.clear_term()
126
bzrlib.ui.ui_factory.clear_term()
119
127
_bzr_logger.info(*args, **kwargs)
122
130
def warning(*args, **kwargs):
123
ui.ui_factory.clear_term()
132
bzrlib.ui.ui_factory.clear_term()
124
133
_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)
127
154
def show_error(*args, **kwargs):
128
155
"""Show an error message to the user.
285
312
start_time = osutils.format_local_date(_bzr_log_start_time,
286
313
timezone='local')
314
# create encoded wrapper around stderr
287
315
bzr_log_file = _open_bzr_log()
288
316
if bzr_log_file is not None:
289
317
bzr_log_file.write(start_time.encode('utf-8') + '\n')
292
320
r'%Y-%m-%d %H:%M:%S')
293
321
# after hooking output into bzr_log, we also need to attach a stderr
294
322
# handler, writing only at level info and with encoding
295
stderr_handler = EncodedStreamHandler(sys.stderr,
296
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
323
term_encoding = osutils.get_terminal_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)
297
328
logging.getLogger('bzr').addHandler(stderr_handler)
304
335
:param to_file: A file-like object to which messages will be sent.
306
337
:returns: A memento that should be passed to _pop_log_file to restore the
307
previously active logging.
338
previously active logging.
309
340
global _trace_file
310
341
# make a new handler
311
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
342
new_handler = logging.StreamHandler(to_file)
343
new_handler.setLevel(logging.DEBUG)
312
344
if log_format is None:
313
345
log_format = '%(levelname)8s %(message)s'
314
346
new_handler.setFormatter(logging.Formatter(log_format, date_format))
440
def _dump_memory_usage(err_file):
443
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
444
dump_file = os.fdopen(fd, 'w')
445
from meliae import scanner
446
scanner.dump_gc_objects(dump_file)
447
err_file.write("Memory dumped to %s\n" % name)
449
err_file.write("Dumping memory requires meliae module.\n")
450
log_exception_quietly()
452
err_file.write("Exception while dumping memory.\n")
453
log_exception_quietly()
455
if dump_file is not None:
461
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
462
"""Give name of error class including module for non-builtin exceptions
464
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
465
also omit the module prefix.
467
class_name = eclass.__name__
468
module_name = eclass.__module__
469
if module_name in ("exceptions", "__main__") or (
470
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
472
return "%s.%s" % (module_name, class_name)
475
473
def report_exception(exc_info, err_file):
476
474
"""Report an exception to err_file (typically stderr) and to .bzr.log.
485
483
print_exception(exc_info, err_file)
486
484
return errors.EXIT_ERROR
487
485
exc_type, exc_object, exc_tb = exc_info
488
if isinstance(exc_object, KeyboardInterrupt):
486
if (isinstance(exc_object, IOError)
487
and getattr(exc_object, 'errno', None) == errno.EPIPE):
488
err_file.write("bzr: broken pipe\n")
489
return errors.EXIT_ERROR
490
elif isinstance(exc_object, KeyboardInterrupt):
489
491
err_file.write("bzr: interrupted\n")
490
492
return errors.EXIT_ERROR
491
493
elif isinstance(exc_object, MemoryError):
492
494
err_file.write("bzr: out of memory\n")
493
if 'mem_dump' in debug.debug_flags:
494
_dump_memory_usage(err_file)
496
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
497
495
return errors.EXIT_ERROR
498
496
elif isinstance(exc_object, ImportError) \
499
497
and str(exc_object).startswith("No module named "):
503
501
elif not getattr(exc_object, 'internal_error', True):
504
502
report_user_error(exc_info, err_file)
505
503
return errors.EXIT_ERROR
506
elif osutils.is_environment_error(exc_object):
507
if getattr(exc_object, 'errno', None) == errno.EPIPE:
508
err_file.write("bzr: broken pipe\n")
509
return errors.EXIT_ERROR
504
elif isinstance(exc_object, (OSError, IOError)) or (
505
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
506
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
510
507
# Might be nice to catch all of these and show them as something more
511
508
# specific, but there are too many cases at the moment.
512
509
report_user_error(exc_info, err_file)
569
562
_trace_file.flush()
572
class EncodedStreamHandler(logging.Handler):
573
"""Robustly write logging events to a stream using the specified encoding
575
Messages are expected to be formatted to unicode, but UTF-8 byte strings
576
are also accepted. An error during formatting or a str message in another
577
encoding will be quitely noted as an error in the Bazaar log file.
579
The stream is not closed so sys.stdout or sys.stderr may be passed.
582
def __init__(self, stream, encoding=None, errors='strict', level=0):
583
logging.Handler.__init__(self, level)
586
encoding = getattr(stream, "encoding", "ascii")
587
self.encoding = encoding
591
flush = getattr(self.stream, "flush", None)
592
if flush is not None:
595
def emit(self, record):
597
line = self.format(record)
598
if not isinstance(line, unicode):
599
line = line.decode("utf-8")
600
self.stream.write(line.encode(self.encoding, self.errors) + "\n")
602
log_exception_quietly()
603
# Try saving the details that would have been logged in some form
604
msg = args = "<Unformattable>"
606
msg = repr(record.msg).encode("ascii")
607
args = repr(record.args).encode("ascii")
610
# Using mutter() bypasses the logging module and writes directly
611
# to the file so there's no danger of getting into a loop here.
612
mutter("Logging record unformattable: %s %% %s", msg, args)
615
565
class Config(object):
616
566
"""Configuration of message tracing in bzrlib.
added
removed
bzrlib/trace.py
