113
108
def note(*args, **kwargs):
114
# FIXME note always emits utf-8, regardless of the terminal encoding
109
"""Output a note to the user.
111
Takes the same parameters as logging.info.
116
115
# FIXME: clearing the ui and then going through the abstract logging
117
116
# framework is whack; we should probably have a logging Handler that
118
117
# deals with terminal output if needed.
120
bzrlib.ui.ui_factory.clear_term()
118
ui.ui_factory.clear_term()
121
119
_bzr_logger.info(*args, **kwargs)
124
122
def warning(*args, **kwargs):
126
bzrlib.ui.ui_factory.clear_term()
123
ui.ui_factory.clear_term()
127
124
_bzr_logger.warning(*args, **kwargs)
130
@deprecated_function(deprecated_in((2, 1, 0)))
131
def info(*args, **kwargs):
132
"""Deprecated: use trace.note instead."""
133
note(*args, **kwargs)
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def log_error(*args, **kwargs):
138
"""Deprecated: use bzrlib.trace.show_error instead"""
139
_bzr_logger.error(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
148
127
def show_error(*args, **kwargs):
149
128
"""Show an error message to the user.
217
196
def _get_bzr_log_filename():
218
bzr_log = os.environ.get('BZR_LOG')
197
bzr_log = osutils.path_from_environ('BZR_LOG')
221
home = os.environ.get('BZR_HOME')
200
home = osutils.path_from_environ('BZR_HOME')
223
if sys.platform == 'win32':
224
from bzrlib import win32utils
225
home = win32utils.get_home_location()
227
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()
228
206
return os.path.join(home, '.bzr.log')
300
278
logging.getLogger("bzr").
302
280
Output can be redirected away by calling _push_log_file.
282
: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
284
start_time = osutils.format_local_date(_bzr_log_start_time,
308
285
timezone='local')
309
# create encoded wrapper around stderr
310
286
bzr_log_file = _open_bzr_log()
311
287
if bzr_log_file is not None:
312
288
bzr_log_file.write(start_time.encode('utf-8') + '\n')
313
push_log_file(bzr_log_file,
289
memento = push_log_file(bzr_log_file,
314
290
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
315
291
r'%Y-%m-%d %H:%M:%S')
316
292
# after hooking output into bzr_log, we also need to attach a stderr
317
293
# 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)
294
stderr_handler = EncodedStreamHandler(sys.stderr,
295
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
322
296
logging.getLogger('bzr').addHandler(stderr_handler)
325
300
def push_log_file(to_file, log_format=None, date_format=None):
328
303
:param to_file: A file-like object to which messages will be sent.
330
305
:returns: A memento that should be passed to _pop_log_file to restore the
331
previously active logging.
306
previously active logging.
333
308
global _trace_file
334
309
# make a new handler
335
new_handler = logging.StreamHandler(to_file)
336
new_handler.setLevel(logging.DEBUG)
310
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
337
311
if log_format is None:
338
312
log_format = '%(levelname)8s %(message)s'
339
313
new_handler.setFormatter(logging.Formatter(log_format, date_format))
361
335
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
362
336
"""Undo changes to logging/tracing done by _push_log_file.
364
This flushes, but does not close the trace file.
338
This flushes, but does not close the trace file (so that anything that was
366
341
Takes the memento returned from _push_log_file."""
367
342
global _trace_file
368
343
_trace_file = old_trace_file
369
344
bzr_logger = logging.getLogger('bzr')
370
345
bzr_logger.removeHandler(new_handler)
371
# must be closed, otherwise logging will try to close it atexit, and the
346
# must be closed, otherwise logging will try to close it at exit, and the
372
347
# file will likely already be closed underneath.
373
348
new_handler.close()
374
349
bzr_logger.handlers = old_handlers
375
new_trace_file.flush()
350
if new_trace_file is not None:
351
new_trace_file.flush()
378
354
def log_exception_quietly():
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)
464
474
def report_exception(exc_info, err_file):
465
475
"""Report an exception to err_file (typically stderr) and to .bzr.log.
474
484
print_exception(exc_info, err_file)
475
485
return errors.EXIT_ERROR
476
486
exc_type, exc_object, exc_tb = exc_info
477
if (isinstance(exc_object, IOError)
478
and getattr(exc_object, 'errno', None) == errno.EPIPE):
479
err_file.write("bzr: broken pipe\n")
480
return errors.EXIT_ERROR
481
elif isinstance(exc_object, KeyboardInterrupt):
487
if isinstance(exc_object, KeyboardInterrupt):
482
488
err_file.write("bzr: interrupted\n")
483
489
return errors.EXIT_ERROR
484
490
elif isinstance(exc_object, MemoryError):
485
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")
486
496
return errors.EXIT_ERROR
487
497
elif isinstance(exc_object, ImportError) \
488
498
and str(exc_object).startswith("No module named "):
492
502
elif not getattr(exc_object, 'internal_error', True):
493
503
report_user_error(exc_info, err_file)
494
504
return errors.EXIT_ERROR
495
elif isinstance(exc_object, (OSError, IOError)):
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
496
509
# Might be nice to catch all of these and show them as something more
497
510
# specific, but there are too many cases at the moment.
498
511
report_user_error(exc_info, err_file)
547
564
def _flush_trace():
548
# run from atexit hook
565
# called from the bzrlib library finalizer returned by bzrlib.initialize()
549
566
global _trace_file
551
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)
614
class Config(object):
615
"""Configuration of message tracing in bzrlib.
617
This implements the context manager protocol and should manage any global
618
variables still used. The default config used is DefaultConfig, but
619
embedded uses of bzrlib may wish to use a custom manager.
623
return self # This is bound to the 'as' clause in a with statement.
625
def __exit__(self, exc_type, exc_val, exc_tb):
626
return False # propogate exceptions.
629
class DefaultConfig(Config):
630
"""A default configuration for tracing of messages in bzrlib.
632
This implements the context manager protocol.
636
self._original_filename = _bzr_log_filename
637
self._original_state = enable_default_logging()
638
return self # This is bound to the 'as' clause in a with statement.
640
def __exit__(self, exc_type, exc_val, exc_tb):
641
pop_log_file(self._original_state)
642
global _bzr_log_filename
643
_bzr_log_filename = self._original_filename
644
return False # propogate exceptions.
added
removed
bzrlib/trace.py
