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
122
116
# FIXME: clearing the ui and then going through the abstract logging
123
117
# framework is whack; we should probably have a logging Handler that
124
118
# deals with terminal output if needed.
126
bzrlib.ui.ui_factory.clear_term()
119
ui.ui_factory.clear_term()
127
120
_bzr_logger.info(*args, **kwargs)
130
123
def warning(*args, **kwargs):
132
bzrlib.ui.ui_factory.clear_term()
124
ui.ui_factory.clear_term()
133
125
_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)
154
128
def show_error(*args, **kwargs):
155
129
"""Show an error message to the user.
306
280
logging.getLogger("bzr").
308
282
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()
313
286
start_time = osutils.format_local_date(_bzr_log_start_time,
314
287
timezone='local')
315
288
# create encoded wrapper around stderr
316
289
bzr_log_file = _open_bzr_log()
317
290
if bzr_log_file is not None:
318
291
bzr_log_file.write(start_time.encode('utf-8') + '\n')
319
push_log_file(bzr_log_file,
292
memento = push_log_file(bzr_log_file,
320
293
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
294
r'%Y-%m-%d %H:%M:%S')
322
295
# after hooking output into bzr_log, we also need to attach a stderr
323
296
# handler, writing only at level info and with encoding
297
term_encoding = osutils.get_terminal_encoding()
324
298
writer_factory = codecs.getwriter(term_encoding)
325
299
encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
300
stderr_handler = logging.StreamHandler(encoded_stderr)
327
301
stderr_handler.setLevel(logging.INFO)
328
302
logging.getLogger('bzr').addHandler(stderr_handler)
331
306
def push_log_file(to_file, log_format=None, date_format=None):
367
342
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
368
343
"""Undo changes to logging/tracing done by _push_log_file.
370
This flushes, but does not close the trace file.
345
This flushes, but does not close the trace file (so that anything that was
372
348
Takes the memento returned from _push_log_file."""
373
349
global _trace_file
374
350
_trace_file = old_trace_file
375
351
bzr_logger = logging.getLogger('bzr')
376
352
bzr_logger.removeHandler(new_handler)
377
# must be closed, otherwise logging will try to close it atexit, and the
353
# must be closed, otherwise logging will try to close it at exit, and the
378
354
# file will likely already be closed underneath.
379
355
new_handler.close()
380
356
bzr_logger.handlers = old_handlers
381
new_trace_file.flush()
357
if new_trace_file is not None:
358
new_trace_file.flush()
384
361
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)
470
481
def report_exception(exc_info, err_file):
471
482
"""Report an exception to err_file (typically stderr) and to .bzr.log.
489
500
return errors.EXIT_ERROR
490
501
elif isinstance(exc_object, MemoryError):
491
502
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")
492
507
return errors.EXIT_ERROR
493
508
elif isinstance(exc_object, ImportError) \
494
509
and str(exc_object).startswith("No module named "):
498
513
elif not getattr(exc_object, 'internal_error', True):
499
514
report_user_error(exc_info, err_file)
500
515
return errors.EXIT_ERROR
501
elif isinstance(exc_object, (OSError, IOError)):
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"):
502
519
# Might be nice to catch all of these and show them as something more
503
520
# specific, but there are too many cases at the moment.
504
521
report_user_error(exc_info, err_file)
540
557
def _flush_stdout_stderr():
541
# installed into an atexit hook by bzrlib.initialize()
558
# called from the bzrlib library finalizer returned by bzrlib.initialize()
543
560
sys.stdout.flush()
544
561
sys.stderr.flush()
562
except ValueError, e:
563
# On Windows, I get ValueError calling stdout.flush() on a closed
545
566
except IOError, e:
547
568
if e.errno in [errno.EINVAL, errno.EPIPE]:
553
574
def _flush_trace():
554
# run from atexit hook
575
# called from the bzrlib library finalizer returned by bzrlib.initialize()
555
576
global _trace_file
557
578
_trace_file.flush()
581
class Config(object):
582
"""Configuration of message tracing in bzrlib.
584
This implements the context manager protocol and should manage any global
585
variables still used. The default config used is DefaultConfig, but
586
embedded uses of bzrlib may wish to use a custom manager.
590
return self # This is bound to the 'as' clause in a with statement.
592
def __exit__(self, exc_type, exc_val, exc_tb):
593
return False # propogate exceptions.
596
class DefaultConfig(Config):
597
"""A default configuration for tracing of messages in bzrlib.
599
This implements the context manager protocol.
603
self._original_filename = _bzr_log_filename
604
self._original_state = enable_default_logging()
605
return self # This is bound to the 'as' clause in a with statement.
607
def __exit__(self, exc_type, exc_val, exc_tb):
608
pop_log_file(self._original_state)
609
global _bzr_log_filename
610
_bzr_log_filename = self._original_filename
611
return False # propogate exceptions.
added
removed
bzrlib/trace.py
