113
113
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
120
114
# FIXME note always emits utf-8, regardless of the terminal encoding
122
116
# FIXME: clearing the ui and then going through the abstract logging
306
300
logging.getLogger("bzr").
308
302
Output can be redirected away by calling _push_log_file.
310
: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()
312
307
start_time = osutils.format_local_date(_bzr_log_start_time,
313
308
timezone='local')
314
309
# create encoded wrapper around stderr
315
310
bzr_log_file = _open_bzr_log()
316
311
if bzr_log_file is not None:
317
312
bzr_log_file.write(start_time.encode('utf-8') + '\n')
318
memento = push_log_file(bzr_log_file,
313
push_log_file(bzr_log_file,
319
314
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
315
r'%Y-%m-%d %H:%M:%S')
321
316
# after hooking output into bzr_log, we also need to attach a stderr
322
317
# handler, writing only at level info and with encoding
323
term_encoding = osutils.get_terminal_encoding()
324
318
writer_factory = codecs.getwriter(term_encoding)
325
319
encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
320
stderr_handler = logging.StreamHandler(encoded_stderr)
327
321
stderr_handler.setLevel(logging.INFO)
328
322
logging.getLogger('bzr').addHandler(stderr_handler)
332
325
def push_log_file(to_file, log_format=None, date_format=None):
368
361
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
369
362
"""Undo changes to logging/tracing done by _push_log_file.
371
This flushes, but does not close the trace file (so that anything that was
364
This flushes, but does not close the trace file.
374
366
Takes the memento returned from _push_log_file."""
375
367
global _trace_file
376
368
_trace_file = old_trace_file
377
369
bzr_logger = logging.getLogger('bzr')
378
370
bzr_logger.removeHandler(new_handler)
379
# must be closed, otherwise logging will try to close it at exit, and the
371
# must be closed, otherwise logging will try to close it atexit, and the
380
372
# file will likely already be closed underneath.
381
373
new_handler.close()
382
374
bzr_logger.handlers = old_handlers
383
if new_trace_file is not None:
384
new_trace_file.flush()
375
new_trace_file.flush()
387
378
def log_exception_quietly():
501
492
elif not getattr(exc_object, 'internal_error', True):
502
493
report_user_error(exc_info, err_file)
503
494
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"):
495
elif isinstance(exc_object, (OSError, IOError)):
507
496
# Might be nice to catch all of these and show them as something more
508
497
# specific, but there are too many cases at the moment.
509
498
report_user_error(exc_info, err_file)
558
547
def _flush_trace():
559
# called from the bzrlib library finalizer returned by bzrlib.initialize()
548
# run from atexit hook
560
549
global _trace_file
562
551
_trace_file.flush()
565
class Config(object):
566
"""Configuration of message tracing in bzrlib.
568
This implements the context manager protocol and should manage any global
569
variables still used. The default config used is DefaultConfig, but
570
embedded uses of bzrlib may wish to use a custom manager.
574
return self # This is bound to the 'as' clause in a with statement.
576
def __exit__(self, exc_type, exc_val, exc_tb):
577
return False # propogate exceptions.
580
class DefaultConfig(Config):
581
"""A default configuration for tracing of messages in bzrlib.
583
This implements the context manager protocol.
587
self._original_filename = _bzr_log_filename
588
self._original_state = enable_default_logging()
589
return self # This is bound to the 'as' clause in a with statement.
591
def __exit__(self, exc_type, exc_val, exc_tb):
592
pop_log_file(self._original_state)
593
global _bzr_log_filename
594
_bzr_log_filename = self._original_filename
595
return False # propogate exceptions.