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
107
113
def note(*args, **kwargs):
108
"""Output a note to the user.
110
Takes the same parameters as logging.info.
114
114
# FIXME note always emits utf-8, regardless of the terminal encoding
116
116
# FIXME: clearing the ui and then going through the abstract logging
117
117
# framework is whack; we should probably have a logging Handler that
118
118
# deals with terminal output if needed.
119
ui.ui_factory.clear_term()
120
bzrlib.ui.ui_factory.clear_term()
120
121
_bzr_logger.info(*args, **kwargs)
123
124
def warning(*args, **kwargs):
124
ui.ui_factory.clear_term()
126
bzrlib.ui.ui_factory.clear_term()
125
127
_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)
128
148
def show_error(*args, **kwargs):
129
149
"""Show an error message to the user.
280
300
logging.getLogger("bzr").
282
302
Output can be redirected away by calling _push_log_file.
284
: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()
286
307
start_time = osutils.format_local_date(_bzr_log_start_time,
287
308
timezone='local')
288
309
# create encoded wrapper around stderr
289
310
bzr_log_file = _open_bzr_log()
290
311
if bzr_log_file is not None:
291
312
bzr_log_file.write(start_time.encode('utf-8') + '\n')
292
memento = push_log_file(bzr_log_file,
313
push_log_file(bzr_log_file,
293
314
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
294
315
r'%Y-%m-%d %H:%M:%S')
295
316
# after hooking output into bzr_log, we also need to attach a stderr
296
317
# handler, writing only at level info and with encoding
297
term_encoding = osutils.get_terminal_encoding()
298
318
writer_factory = codecs.getwriter(term_encoding)
299
319
encoded_stderr = writer_factory(sys.stderr, errors='replace')
300
320
stderr_handler = logging.StreamHandler(encoded_stderr)
301
321
stderr_handler.setLevel(logging.INFO)
302
322
logging.getLogger('bzr').addHandler(stderr_handler)
306
325
def push_log_file(to_file, log_format=None, date_format=None):
342
361
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
343
362
"""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
364
This flushes, but does not close the trace file.
348
366
Takes the memento returned from _push_log_file."""
349
367
global _trace_file
350
368
_trace_file = old_trace_file
351
369
bzr_logger = logging.getLogger('bzr')
352
370
bzr_logger.removeHandler(new_handler)
353
# 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
354
372
# file will likely already be closed underneath.
355
373
new_handler.close()
356
374
bzr_logger.handlers = old_handlers
357
if new_trace_file is not None:
358
new_trace_file.flush()
375
new_trace_file.flush()
361
378
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
464
def report_exception(exc_info, err_file):
482
465
"""Report an exception to err_file (typically stderr) and to .bzr.log.
500
483
return errors.EXIT_ERROR
501
484
elif isinstance(exc_object, MemoryError):
502
485
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
486
return errors.EXIT_ERROR
508
487
elif isinstance(exc_object, ImportError) \
509
488
and str(exc_object).startswith("No module named "):
513
492
elif not getattr(exc_object, 'internal_error', True):
514
493
report_user_error(exc_info, err_file)
515
494
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"):
495
elif isinstance(exc_object, (OSError, IOError)):
519
496
# Might be nice to catch all of these and show them as something more
520
497
# specific, but there are too many cases at the moment.
521
498
report_user_error(exc_info, err_file)
557
534
def _flush_stdout_stderr():
558
# called from the bzrlib library finalizer returned by bzrlib.initialize()
535
# installed into an atexit hook by bzrlib.initialize()
560
537
sys.stdout.flush()
561
538
sys.stderr.flush()
562
except ValueError, e:
563
# On Windows, I get ValueError calling stdout.flush() on a closed
566
539
except IOError, e:
568
541
if e.errno in [errno.EINVAL, errno.EPIPE]:
574
547
def _flush_trace():
575
# called from the bzrlib library finalizer returned by bzrlib.initialize()
548
# run from atexit hook
576
549
global _trace_file
578
551
_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
