1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005-2010 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
116
122
# FIXME: clearing the ui and then going through the abstract logging
117
123
# framework is whack; we should probably have a logging Handler that
118
124
# deals with terminal output if needed.
119
ui.ui_factory.clear_term()
126
bzrlib.ui.ui_factory.clear_term()
120
127
_bzr_logger.info(*args, **kwargs)
123
130
def warning(*args, **kwargs):
124
ui.ui_factory.clear_term()
132
bzrlib.ui.ui_factory.clear_term()
125
133
_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)
128
154
def show_error(*args, **kwargs):
129
155
"""Show an error message to the user.
280
306
logging.getLogger("bzr").
282
308
Output can be redirected away by calling _push_log_file.
284
:return: A memento from push_log_file for restoring the log state.
310
# Do this before we open the log file, so we prevent
311
# get_terminal_encoding() from mutter()ing multiple times
312
term_encoding = osutils.get_terminal_encoding()
286
313
start_time = osutils.format_local_date(_bzr_log_start_time,
287
314
timezone='local')
288
315
# create encoded wrapper around stderr
289
316
bzr_log_file = _open_bzr_log()
290
317
if bzr_log_file is not None:
291
318
bzr_log_file.write(start_time.encode('utf-8') + '\n')
292
memento = push_log_file(bzr_log_file,
319
push_log_file(bzr_log_file,
293
320
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
294
321
r'%Y-%m-%d %H:%M:%S')
295
322
# after hooking output into bzr_log, we also need to attach a stderr
296
323
# handler, writing only at level info and with encoding
297
term_encoding = osutils.get_terminal_encoding()
298
324
writer_factory = codecs.getwriter(term_encoding)
299
325
encoded_stderr = writer_factory(sys.stderr, errors='replace')
300
326
stderr_handler = logging.StreamHandler(encoded_stderr)
301
327
stderr_handler.setLevel(logging.INFO)
302
328
logging.getLogger('bzr').addHandler(stderr_handler)
306
331
def push_log_file(to_file, log_format=None, date_format=None):
342
367
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
343
368
"""Undo changes to logging/tracing done by _push_log_file.
345
This flushes, but does not close the trace file (so that anything that was
370
This flushes, but does not close the trace file.
348
372
Takes the memento returned from _push_log_file."""
349
373
global _trace_file
350
374
_trace_file = old_trace_file
351
375
bzr_logger = logging.getLogger('bzr')
352
376
bzr_logger.removeHandler(new_handler)
353
# must be closed, otherwise logging will try to close it at exit, and the
377
# must be closed, otherwise logging will try to close it atexit, and the
354
378
# file will likely already be closed underneath.
355
379
new_handler.close()
356
380
bzr_logger.handlers = old_handlers
357
if new_trace_file is not None:
358
new_trace_file.flush()
381
new_trace_file.flush()
361
384
def log_exception_quietly():
446
def _dump_memory_usage(err_file):
449
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
450
dump_file = os.fdopen(fd, 'w')
451
from meliae import scanner
452
scanner.dump_gc_objects(dump_file)
453
err_file.write("Memory dumped to %s\n" % name)
455
err_file.write("Dumping memory requires meliae module.\n")
456
log_exception_quietly()
458
err_file.write("Exception while dumping memory.\n")
459
log_exception_quietly()
461
if dump_file is not None:
467
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
468
"""Give name of error class including module for non-builtin exceptions
470
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
471
also omit the module prefix.
473
class_name = eclass.__name__
474
module_name = eclass.__module__
475
if module_name in ("exceptions", "__main__") or (
476
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
478
return "%s.%s" % (module_name, class_name)
481
470
def report_exception(exc_info, err_file):
482
471
"""Report an exception to err_file (typically stderr) and to .bzr.log.
500
489
return errors.EXIT_ERROR
501
490
elif isinstance(exc_object, MemoryError):
502
491
err_file.write("bzr: out of memory\n")
503
if 'mem_dump' in debug.debug_flags:
504
_dump_memory_usage(err_file)
506
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
507
492
return errors.EXIT_ERROR
508
493
elif isinstance(exc_object, ImportError) \
509
494
and str(exc_object).startswith("No module named "):
513
498
elif not getattr(exc_object, 'internal_error', True):
514
499
report_user_error(exc_info, err_file)
515
500
return errors.EXIT_ERROR
516
elif isinstance(exc_object, (OSError, IOError)) or (
517
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
518
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
501
elif isinstance(exc_object, (OSError, IOError)):
519
502
# Might be nice to catch all of these and show them as something more
520
503
# specific, but there are too many cases at the moment.
521
504
report_user_error(exc_info, err_file)
570
553
def _flush_trace():
571
# called from the bzrlib library finalizer returned by bzrlib.initialize()
554
# run from atexit hook
572
555
global _trace_file
574
557
_trace_file.flush()
577
class Config(object):
578
"""Configuration of message tracing in bzrlib.
580
This implements the context manager protocol and should manage any global
581
variables still used. The default config used is DefaultConfig, but
582
embedded uses of bzrlib may wish to use a custom manager.
586
return self # This is bound to the 'as' clause in a with statement.
588
def __exit__(self, exc_type, exc_val, exc_tb):
589
return False # propogate exceptions.
592
class DefaultConfig(Config):
593
"""A default configuration for tracing of messages in bzrlib.
595
This implements the context manager protocol.
599
self._original_filename = _bzr_log_filename
600
self._original_state = enable_default_logging()
601
return self # This is bound to the 'as' clause in a with statement.
603
def __exit__(self, exc_type, exc_val, exc_tb):
604
pop_log_file(self._original_state)
605
global _bzr_log_filename
606
_bzr_log_filename = self._original_filename
607
return False # propogate exceptions.
added
removed
bzrlib/trace.py
