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.
119
# FIXME note always emits utf-8, regardless of the terminal encoding
121
115
# FIXME: clearing the ui and then going through the abstract logging
122
116
# framework is whack; we should probably have a logging Handler that
123
117
# deals with terminal output if needed.
130
124
_bzr_logger.warning(*args, **kwargs)
133
@deprecated_function(deprecated_in((2, 1, 0)))
134
def info(*args, **kwargs):
135
"""Deprecated: use trace.note instead."""
136
note(*args, **kwargs)
139
@deprecated_function(deprecated_in((2, 1, 0)))
140
def log_error(*args, **kwargs):
141
"""Deprecated: use bzrlib.trace.show_error instead"""
142
_bzr_logger.error(*args, **kwargs)
145
@deprecated_function(deprecated_in((2, 1, 0)))
146
def error(*args, **kwargs):
147
"""Deprecated: use bzrlib.trace.show_error instead"""
148
_bzr_logger.error(*args, **kwargs)
151
127
def show_error(*args, **kwargs):
152
128
"""Show an error message to the user.
220
196
def _get_bzr_log_filename():
221
bzr_log = os.environ.get('BZR_LOG')
197
bzr_log = osutils.path_from_environ('BZR_LOG')
224
home = os.environ.get('BZR_HOME')
200
home = osutils.path_from_environ('BZR_HOME')
226
if sys.platform == 'win32':
227
from bzrlib import win32utils
228
home = win32utils.get_home_location()
230
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()
231
206
return os.path.join(home, '.bzr.log')
309
284
start_time = osutils.format_local_date(_bzr_log_start_time,
310
285
timezone='local')
311
# create encoded wrapper around stderr
312
286
bzr_log_file = _open_bzr_log()
313
287
if bzr_log_file is not None:
314
288
bzr_log_file.write(start_time.encode('utf-8') + '\n')
317
291
r'%Y-%m-%d %H:%M:%S')
318
292
# after hooking output into bzr_log, we also need to attach a stderr
319
293
# handler, writing only at level info and with encoding
320
term_encoding = osutils.get_terminal_encoding()
321
writer_factory = codecs.getwriter(term_encoding)
322
encoded_stderr = writer_factory(sys.stderr, errors='replace')
323
stderr_handler = logging.StreamHandler(encoded_stderr)
324
stderr_handler.setLevel(logging.INFO)
294
stderr_handler = EncodedStreamHandler(sys.stderr,
295
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
325
296
logging.getLogger('bzr').addHandler(stderr_handler)
332
303
:param to_file: A file-like object to which messages will be sent.
334
305
:returns: A memento that should be passed to _pop_log_file to restore the
335
previously active logging.
306
previously active logging.
337
308
global _trace_file
338
309
# make a new handler
339
new_handler = logging.StreamHandler(to_file)
340
new_handler.setLevel(logging.DEBUG)
310
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
341
311
if log_format is None:
342
312
log_format = '%(levelname)8s %(message)s'
343
313
new_handler.setFormatter(logging.Formatter(log_format, date_format))
514
484
print_exception(exc_info, err_file)
515
485
return errors.EXIT_ERROR
516
486
exc_type, exc_object, exc_tb = exc_info
517
if (isinstance(exc_object, IOError)
518
and getattr(exc_object, 'errno', None) == errno.EPIPE):
519
err_file.write("bzr: broken pipe\n")
520
return errors.EXIT_ERROR
521
elif isinstance(exc_object, KeyboardInterrupt):
487
if isinstance(exc_object, KeyboardInterrupt):
522
488
err_file.write("bzr: interrupted\n")
523
489
return errors.EXIT_ERROR
524
490
elif isinstance(exc_object, MemoryError):
536
502
elif not getattr(exc_object, 'internal_error', True):
537
503
report_user_error(exc_info, err_file)
538
504
return errors.EXIT_ERROR
539
elif isinstance(exc_object, (OSError, IOError)) or (
540
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
541
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
542
509
# Might be nice to catch all of these and show them as something more
543
510
# specific, but there are too many cases at the moment.
544
511
report_user_error(exc_info, err_file)
597
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)
600
614
class Config(object):
601
615
"""Configuration of message tracing in bzrlib.
added
removed
bzrlib/trace.py
