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
113
112
def note(*args, **kwargs):
113
"""Output a note to the user.
115
Takes the same parameters as logging.info.
114
119
# FIXME note always emits utf-8, regardless of the terminal encoding
116
121
# FIXME: clearing the ui and then going through the abstract logging
117
122
# framework is whack; we should probably have a logging Handler that
118
123
# deals with terminal output if needed.
120
bzrlib.ui.ui_factory.clear_term()
124
ui.ui_factory.clear_term()
121
125
_bzr_logger.info(*args, **kwargs)
124
128
def warning(*args, **kwargs):
126
bzrlib.ui.ui_factory.clear_term()
129
ui.ui_factory.clear_term()
127
130
_bzr_logger.warning(*args, **kwargs)
300
303
logging.getLogger("bzr").
302
305
Output can be redirected away by calling _push_log_file.
307
: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
309
start_time = osutils.format_local_date(_bzr_log_start_time,
308
310
timezone='local')
309
311
# create encoded wrapper around stderr
310
312
bzr_log_file = _open_bzr_log()
311
313
if bzr_log_file is not None:
312
314
bzr_log_file.write(start_time.encode('utf-8') + '\n')
313
push_log_file(bzr_log_file,
315
memento = push_log_file(bzr_log_file,
314
316
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
315
317
r'%Y-%m-%d %H:%M:%S')
316
318
# after hooking output into bzr_log, we also need to attach a stderr
317
319
# handler, writing only at level info and with encoding
320
term_encoding = osutils.get_terminal_encoding()
318
321
writer_factory = codecs.getwriter(term_encoding)
319
322
encoded_stderr = writer_factory(sys.stderr, errors='replace')
320
323
stderr_handler = logging.StreamHandler(encoded_stderr)
321
324
stderr_handler.setLevel(logging.INFO)
322
325
logging.getLogger('bzr').addHandler(stderr_handler)
325
329
def push_log_file(to_file, log_format=None, date_format=None):
361
365
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
362
366
"""Undo changes to logging/tracing done by _push_log_file.
364
This flushes, but does not close the trace file.
368
This flushes, but does not close the trace file (so that anything that was
366
371
Takes the memento returned from _push_log_file."""
367
372
global _trace_file
368
373
_trace_file = old_trace_file
369
374
bzr_logger = logging.getLogger('bzr')
370
375
bzr_logger.removeHandler(new_handler)
371
# must be closed, otherwise logging will try to close it atexit, and the
376
# must be closed, otherwise logging will try to close it at exit, and the
372
377
# file will likely already be closed underneath.
373
378
new_handler.close()
374
379
bzr_logger.handlers = old_handlers
375
new_trace_file.flush()
380
if new_trace_file is not None:
381
new_trace_file.flush()
378
384
def log_exception_quietly():
469
def _dump_memory_usage(err_file):
472
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
473
dump_file = os.fdopen(fd, 'w')
474
from meliae import scanner
475
scanner.dump_gc_objects(dump_file)
476
err_file.write("Memory dumped to %s\n" % name)
478
err_file.write("Dumping memory requires meliae module.\n")
479
log_exception_quietly()
481
err_file.write("Exception while dumping memory.\n")
482
log_exception_quietly()
484
if dump_file is not None:
490
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
491
"""Give name of error class including module for non-builtin exceptions
493
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
494
also omit the module prefix.
496
class_name = eclass.__name__
497
module_name = eclass.__module__
498
if module_name in ("exceptions", "__main__") or (
499
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
501
return "%s.%s" % (module_name, class_name)
464
504
def report_exception(exc_info, err_file):
465
505
"""Report an exception to err_file (typically stderr) and to .bzr.log.
483
523
return errors.EXIT_ERROR
484
524
elif isinstance(exc_object, MemoryError):
485
525
err_file.write("bzr: out of memory\n")
526
if 'mem_dump' in debug.debug_flags:
527
_dump_memory_usage(err_file)
529
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
486
530
return errors.EXIT_ERROR
487
531
elif isinstance(exc_object, ImportError) \
488
532
and str(exc_object).startswith("No module named "):
492
536
elif not getattr(exc_object, 'internal_error', True):
493
537
report_user_error(exc_info, err_file)
494
538
return errors.EXIT_ERROR
495
elif isinstance(exc_object, (OSError, IOError)):
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"):
496
542
# Might be nice to catch all of these and show them as something more
497
543
# specific, but there are too many cases at the moment.
498
544
report_user_error(exc_info, err_file)
547
593
def _flush_trace():
548
# run from atexit hook
594
# called from the bzrlib library finalizer returned by bzrlib.initialize()
549
595
global _trace_file
551
597
_trace_file.flush()
600
class Config(object):
601
"""Configuration of message tracing in bzrlib.
603
This implements the context manager protocol and should manage any global
604
variables still used. The default config used is DefaultConfig, but
605
embedded uses of bzrlib may wish to use a custom manager.
609
return self # This is bound to the 'as' clause in a with statement.
611
def __exit__(self, exc_type, exc_val, exc_tb):
612
return False # propogate exceptions.
615
class DefaultConfig(Config):
616
"""A default configuration for tracing of messages in bzrlib.
618
This implements the context manager protocol.
622
self._original_filename = _bzr_log_filename
623
self._original_state = enable_default_logging()
624
return self # This is bound to the 'as' clause in a with statement.
626
def __exit__(self, exc_type, exc_val, exc_tb):
627
pop_log_file(self._original_state)
628
global _bzr_log_filename
629
_bzr_log_filename = self._original_filename
630
return False # propogate exceptions.
added
removed
bzrlib/trace.py
