1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005-2011 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
48
50
# FIXME: Unfortunately it turns out that python's logging module
49
51
# is quite expensive, even when the message is not printed by any handlers.
50
52
# We should perhaps change back to just simply doing it here.
120
# FIXME note always emits utf-8, regardless of the terminal encoding
122
115
# FIXME: clearing the ui and then going through the abstract logging
123
116
# framework is whack; we should probably have a logging Handler that
124
117
# deals with terminal output if needed.
126
bzrlib.ui.ui_factory.clear_term()
118
ui.ui_factory.clear_term()
127
119
_bzr_logger.info(*args, **kwargs)
130
122
def warning(*args, **kwargs):
132
bzrlib.ui.ui_factory.clear_term()
123
ui.ui_factory.clear_term()
133
124
_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
127
def show_error(*args, **kwargs):
155
128
"""Show an error message to the user.
223
196
def _get_bzr_log_filename():
224
bzr_log = os.environ.get('BZR_LOG')
197
bzr_log = osutils.path_from_environ('BZR_LOG')
227
home = os.environ.get('BZR_HOME')
200
home = osutils.path_from_environ('BZR_HOME')
229
if sys.platform == 'win32':
230
from bzrlib import win32utils
231
home = win32utils.get_home_location()
233
home = os.path.expanduser('~')
202
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
203
# over what would be better. On windows, bug 240550
204
# suggests LOCALAPPDATA be used instead.
205
home = osutils._get_home_dir()
234
206
return os.path.join(home, '.bzr.log')
312
284
start_time = osutils.format_local_date(_bzr_log_start_time,
313
285
timezone='local')
314
# create encoded wrapper around stderr
315
286
bzr_log_file = _open_bzr_log()
316
287
if bzr_log_file is not None:
317
288
bzr_log_file.write(start_time.encode('utf-8') + '\n')
320
291
r'%Y-%m-%d %H:%M:%S')
321
292
# after hooking output into bzr_log, we also need to attach a stderr
322
293
# handler, writing only at level info and with encoding
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)
294
stderr_handler = EncodedStreamHandler(sys.stderr,
295
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
328
296
logging.getLogger('bzr').addHandler(stderr_handler)
335
303
:param to_file: A file-like object to which messages will be sent.
337
305
:returns: A memento that should be passed to _pop_log_file to restore the
338
previously active logging.
306
previously active logging.
340
308
global _trace_file
341
309
# make a new handler
342
new_handler = logging.StreamHandler(to_file)
343
new_handler.setLevel(logging.DEBUG)
310
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
344
311
if log_format is None:
345
312
log_format = '%(levelname)8s %(message)s'
346
313
new_handler.setFormatter(logging.Formatter(log_format, date_format))
439
def _dump_memory_usage(err_file):
442
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
443
dump_file = os.fdopen(fd, 'w')
444
from meliae import scanner
445
scanner.dump_gc_objects(dump_file)
446
err_file.write("Memory dumped to %s\n" % name)
448
err_file.write("Dumping memory requires meliae module.\n")
449
log_exception_quietly()
451
err_file.write("Exception while dumping memory.\n")
452
log_exception_quietly()
454
if dump_file is not None:
460
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
461
"""Give name of error class including module for non-builtin exceptions
463
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
464
also omit the module prefix.
466
class_name = eclass.__name__
467
module_name = eclass.__module__
468
if module_name in ("exceptions", "__main__") or (
469
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
471
return "%s.%s" % (module_name, class_name)
473
474
def report_exception(exc_info, err_file):
474
475
"""Report an exception to err_file (typically stderr) and to .bzr.log.
483
484
print_exception(exc_info, err_file)
484
485
return errors.EXIT_ERROR
485
486
exc_type, exc_object, exc_tb = exc_info
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):
487
if isinstance(exc_object, KeyboardInterrupt):
491
488
err_file.write("bzr: interrupted\n")
492
489
return errors.EXIT_ERROR
493
490
elif isinstance(exc_object, MemoryError):
494
491
err_file.write("bzr: out of memory\n")
492
if 'mem_dump' in debug.debug_flags:
493
_dump_memory_usage(err_file)
495
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
495
496
return errors.EXIT_ERROR
496
497
elif isinstance(exc_object, ImportError) \
497
498
and str(exc_object).startswith("No module named "):
501
502
elif not getattr(exc_object, 'internal_error', True):
502
503
report_user_error(exc_info, err_file)
503
504
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"):
505
elif osutils.is_environment_error(exc_object):
506
if getattr(exc_object, 'errno', None) == errno.EPIPE:
507
err_file.write("bzr: broken pipe\n")
508
return errors.EXIT_ERROR
507
509
# Might be nice to catch all of these and show them as something more
508
510
# specific, but there are too many cases at the moment.
509
511
report_user_error(exc_info, err_file)
562
568
_trace_file.flush()
571
class EncodedStreamHandler(logging.Handler):
572
"""Robustly write logging events to a stream using the specified encoding
574
Messages are expected to be formatted to unicode, but UTF-8 byte strings
575
are also accepted. An error during formatting or a str message in another
576
encoding will be quitely noted as an error in the Bazaar log file.
578
The stream is not closed so sys.stdout or sys.stderr may be passed.
581
def __init__(self, stream, encoding=None, errors='strict', level=0):
582
logging.Handler.__init__(self, level)
585
encoding = getattr(stream, "encoding", "ascii")
586
self.encoding = encoding
590
flush = getattr(self.stream, "flush", None)
591
if flush is not None:
594
def emit(self, record):
596
line = self.format(record)
597
if not isinstance(line, unicode):
598
line = line.decode("utf-8")
599
self.stream.write(line.encode(self.encoding, self.errors) + "\n")
601
log_exception_quietly()
602
# Try saving the details that would have been logged in some form
603
msg = args = "<Unformattable>"
605
msg = repr(record.msg).encode("ascii")
606
args = repr(record.args).encode("ascii")
609
# Using mutter() bypasses the logging module and writes directly
610
# to the file so there's no danger of getting into a loop here.
611
mutter("Logging record unformattable: %s %% %s", msg, args)
565
614
class Config(object):
566
615
"""Configuration of message tracing in bzrlib.
added
removed
bzrlib/trace.py
