1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009, 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)
128
def show_error(*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)
129
149
"""Show an error message to the user.
131
151
Don't use this for exceptions, use report_exception instead.
218
238
This sets the global _bzr_log_filename.
220
240
global _bzr_log_filename
222
def _open_or_create_log_file(filename):
223
"""Open existing log file, or create with ownership and permissions
225
It inherits the ownership and permissions (masked by umask) from
226
the containing directory to cope better with being run under sudo
227
with $HOME still set to the user's homedir.
229
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
232
fd = os.open(filename, flags)
235
if e.errno != errno.ENOENT:
238
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
240
if e.errno != errno.EEXIST:
243
osutils.copy_ownership_from_path(filename)
245
return os.fdopen(fd, 'at', 0) # unbuffered
248
241
_bzr_log_filename = _get_bzr_log_filename()
249
242
_rollover_trace_maybe(_bzr_log_filename)
251
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
244
bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
245
# bzr_log_file.tell() on windows always return 0 until some writing done
252
246
bzr_log_file.write('\n')
253
247
if bzr_log_file.tell() <= 2:
254
248
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
255
249
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
256
250
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
258
251
return bzr_log_file
260
except EnvironmentError, e:
261
253
# If we are failing to open the log, then most likely logging has not
262
254
# been set up yet. So we just write to stderr rather than using
263
255
# 'warning()'. If we using warning(), users get the unhelpful 'no
280
272
logging.getLogger("bzr").
282
274
Output can be redirected away by calling _push_log_file.
284
:return: A memento from push_log_file for restoring the log state.
276
# Do this before we open the log file, so we prevent
277
# get_terminal_encoding() from mutter()ing multiple times
278
term_encoding = osutils.get_terminal_encoding()
286
279
start_time = osutils.format_local_date(_bzr_log_start_time,
287
280
timezone='local')
288
281
# create encoded wrapper around stderr
289
282
bzr_log_file = _open_bzr_log()
290
283
if bzr_log_file is not None:
291
284
bzr_log_file.write(start_time.encode('utf-8') + '\n')
292
memento = push_log_file(bzr_log_file,
285
push_log_file(bzr_log_file,
293
286
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
294
287
r'%Y-%m-%d %H:%M:%S')
295
288
# after hooking output into bzr_log, we also need to attach a stderr
296
289
# handler, writing only at level info and with encoding
297
term_encoding = osutils.get_terminal_encoding()
298
290
writer_factory = codecs.getwriter(term_encoding)
299
291
encoded_stderr = writer_factory(sys.stderr, errors='replace')
300
292
stderr_handler = logging.StreamHandler(encoded_stderr)
301
293
stderr_handler.setLevel(logging.INFO)
302
294
logging.getLogger('bzr').addHandler(stderr_handler)
306
297
def push_log_file(to_file, log_format=None, date_format=None):
342
333
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
343
334
"""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
336
This flushes, but does not close the trace file.
348
338
Takes the memento returned from _push_log_file."""
349
339
global _trace_file
350
340
_trace_file = old_trace_file
351
341
bzr_logger = logging.getLogger('bzr')
352
342
bzr_logger.removeHandler(new_handler)
353
# must be closed, otherwise logging will try to close it at exit, and the
343
# must be closed, otherwise logging will try to close it atexit, and the
354
344
# file will likely already be closed underneath.
355
345
new_handler.close()
356
346
bzr_logger.handlers = old_handlers
357
if new_trace_file is not None:
358
new_trace_file.flush()
347
new_trace_file.flush()
361
350
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
436
def report_exception(exc_info, err_file):
482
437
"""Report an exception to err_file (typically stderr) and to .bzr.log.
500
455
return errors.EXIT_ERROR
501
456
elif isinstance(exc_object, MemoryError):
502
457
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
458
return errors.EXIT_ERROR
508
459
elif isinstance(exc_object, ImportError) \
509
460
and str(exc_object).startswith("No module named "):
513
464
elif not getattr(exc_object, 'internal_error', True):
514
465
report_user_error(exc_info, err_file)
515
466
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"):
467
elif isinstance(exc_object, (OSError, IOError)):
519
468
# Might be nice to catch all of these and show them as something more
520
469
# specific, but there are too many cases at the moment.
521
470
report_user_error(exc_info, err_file)
557
506
def _flush_stdout_stderr():
558
# called from the bzrlib library finalizer returned by bzrlib.initialize()
507
# installed into an atexit hook by bzrlib.initialize()
560
509
sys.stdout.flush()
561
510
sys.stderr.flush()
562
except ValueError, e:
563
# On Windows, I get ValueError calling stdout.flush() on a closed
566
511
except IOError, e:
568
513
if e.errno in [errno.EINVAL, errno.EPIPE]:
574
519
def _flush_trace():
575
# called from the bzrlib library finalizer returned by bzrlib.initialize()
520
# run from atexit hook
576
521
global _trace_file
578
523
_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
