14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Messages and logging for bazaar-ng.
17
"""Messages and logging.
19
19
Messages are supplied by callers as a string-formatting template, plus values
20
20
to be inserted into it. The actual %-formatting is deferred to the log
34
34
Output to stderr depends on the mode chosen by the user. By default, messages
35
35
of info and above are sent out, which results in progress messages such as the
36
list of files processed by add and commit. In quiet mode, only warnings and
37
above are shown. In debug mode, stderr gets debug messages too.
36
list of files processed by add and commit. In debug mode, stderr gets debug messages too.
39
38
Errors that terminate an operation are generally passed back as exceptions;
40
39
others may be just emitted as messages.
113
108
def note(*args, **kwargs):
114
# FIXME note always emits utf-8, regardless of the terminal encoding
109
"""Output a note to the user.
111
Takes the same parameters as logging.info.
116
115
# FIXME: clearing the ui and then going through the abstract logging
117
116
# framework is whack; we should probably have a logging Handler that
118
117
# deals with terminal output if needed.
120
bzrlib.ui.ui_factory.clear_term()
118
ui.ui_factory.clear_term()
121
119
_bzr_logger.info(*args, **kwargs)
124
122
def warning(*args, **kwargs):
126
bzrlib.ui.ui_factory.clear_term()
123
ui.ui_factory.clear_term()
127
124
_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)
127
def show_error(*args, **kwargs):
149
128
"""Show an error message to the user.
151
130
Don't use this for exceptions, use report_exception instead.
182
159
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
183
160
out = timestamp + out + '\n'
184
161
_trace_file.write(out)
185
# We flush if we haven't flushed for a few seconds. We don't want to flush
186
# on every mutter, but when a command takes a while, it can be nice to see
187
# updates in the debug log.
188
if (_last_mutter_flush_time is None
189
or (now - _last_mutter_flush_time) > 2.0):
190
flush = getattr(_trace_file, 'flush', None)
191
if flush is not None:
193
_last_mutter_flush_time = now
162
# there's no explicit flushing; the file is typically line buffered.
196
165
def mutter_callsite(stacklevel, fmt, *args):
227
196
def _get_bzr_log_filename():
228
bzr_log = os.environ.get('BZR_LOG')
197
bzr_log = osutils.path_from_environ('BZR_LOG')
231
home = os.environ.get('BZR_HOME')
200
home = osutils.path_from_environ('BZR_HOME')
233
if sys.platform == 'win32':
234
from bzrlib import win32utils
235
home = win32utils.get_home_location()
237
home = os.path.expanduser('~')
202
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
203
# over what would be better. On windows, bug 240550
204
# suggests LOCALAPPDATA be used instead.
205
home = osutils._get_home_dir()
238
206
return os.path.join(home, '.bzr.log')
248
216
This sets the global _bzr_log_filename.
250
218
global _bzr_log_filename
220
def _open_or_create_log_file(filename):
221
"""Open existing log file, or create with ownership and permissions
223
It inherits the ownership and permissions (masked by umask) from
224
the containing directory to cope better with being run under sudo
225
with $HOME still set to the user's homedir.
227
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
230
fd = os.open(filename, flags)
233
if e.errno != errno.ENOENT:
236
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
238
if e.errno != errno.EEXIST:
241
osutils.copy_ownership_from_path(filename)
243
return os.fdopen(fd, 'at', 0) # unbuffered
251
246
_bzr_log_filename = _get_bzr_log_filename()
252
247
_rollover_trace_maybe(_bzr_log_filename)
254
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
255
# bzr_log_file.tell() on windows always return 0 until some writing done
249
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
256
250
bzr_log_file.write('\n')
257
251
if bzr_log_file.tell() <= 2:
258
252
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
259
253
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
260
254
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
261
256
return bzr_log_file
263
warning("failed to open trace file: %s" % (e))
258
except EnvironmentError, e:
259
# If we are failing to open the log, then most likely logging has not
260
# been set up yet. So we just write to stderr rather than using
261
# 'warning()'. If we using warning(), users get the unhelpful 'no
262
# handlers registered for "bzr"' when something goes wrong on the
263
# server. (bug #503886)
264
sys.stderr.write("failed to open trace file: %s\n" % (e,))
264
265
# TODO: What should happen if we fail to open the trace file? Maybe the
265
266
# objects should be pointed at /dev/null or the equivalent? Currently
266
267
# returns None which will cause failures later.
277
278
logging.getLogger("bzr").
279
280
Output can be redirected away by calling _push_log_file.
282
:return: A memento from push_log_file for restoring the log state.
281
# Do this before we open the log file, so we prevent
282
# get_terminal_encoding() from mutter()ing multiple times
283
term_encoding = osutils.get_terminal_encoding()
284
284
start_time = osutils.format_local_date(_bzr_log_start_time,
285
285
timezone='local')
286
# create encoded wrapper around stderr
287
286
bzr_log_file = _open_bzr_log()
288
287
if bzr_log_file is not None:
289
288
bzr_log_file.write(start_time.encode('utf-8') + '\n')
290
push_log_file(bzr_log_file,
289
memento = push_log_file(bzr_log_file,
291
290
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
292
291
r'%Y-%m-%d %H:%M:%S')
293
292
# after hooking output into bzr_log, we also need to attach a stderr
294
293
# handler, writing only at level info and with encoding
295
writer_factory = codecs.getwriter(term_encoding)
296
encoded_stderr = writer_factory(sys.stderr, errors='replace')
297
stderr_handler = logging.StreamHandler(encoded_stderr)
298
stderr_handler.setLevel(logging.INFO)
294
stderr_handler = EncodedStreamHandler(sys.stderr,
295
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
299
296
logging.getLogger('bzr').addHandler(stderr_handler)
302
300
def push_log_file(to_file, log_format=None, date_format=None):
305
303
:param to_file: A file-like object to which messages will be sent.
307
305
:returns: A memento that should be passed to _pop_log_file to restore the
308
previously active logging.
306
previously active logging.
310
308
global _trace_file
311
309
# make a new handler
312
new_handler = logging.StreamHandler(to_file)
313
new_handler.setLevel(logging.DEBUG)
310
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
314
311
if log_format is None:
315
312
log_format = '%(levelname)8s %(message)s'
316
313
new_handler.setFormatter(logging.Formatter(log_format, date_format))
338
335
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
339
336
"""Undo changes to logging/tracing done by _push_log_file.
341
This flushes, but does not close the trace file.
338
This flushes, but does not close the trace file (so that anything that was
343
341
Takes the memento returned from _push_log_file."""
344
342
global _trace_file
345
343
_trace_file = old_trace_file
346
344
bzr_logger = logging.getLogger('bzr')
347
345
bzr_logger.removeHandler(new_handler)
348
# must be closed, otherwise logging will try to close it atexit, and the
346
# must be closed, otherwise logging will try to close it at exit, and the
349
347
# file will likely already be closed underneath.
350
348
new_handler.close()
351
349
bzr_logger.handlers = old_handlers
352
new_trace_file.flush()
350
if new_trace_file is not None:
351
new_trace_file.flush()
355
354
def log_exception_quietly():
439
def _dump_memory_usage(err_file):
442
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
443
dump_file = os.fdopen(fd, 'w')
444
from meliae import scanner
445
scanner.dump_gc_objects(dump_file)
446
err_file.write("Memory dumped to %s\n" % name)
448
err_file.write("Dumping memory requires meliae module.\n")
449
log_exception_quietly()
451
err_file.write("Exception while dumping memory.\n")
452
log_exception_quietly()
454
if dump_file is not None:
460
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
461
"""Give name of error class including module for non-builtin exceptions
463
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
464
also omit the module prefix.
466
class_name = eclass.__name__
467
module_name = eclass.__module__
468
if module_name in ("exceptions", "__main__") or (
469
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
471
return "%s.%s" % (module_name, class_name)
441
474
def report_exception(exc_info, err_file):
442
475
"""Report an exception to err_file (typically stderr) and to .bzr.log.
446
479
:return: The appropriate exit code for this error.
448
exc_type, exc_object, exc_tb = exc_info
449
481
# Log the full traceback to ~/.bzr.log
450
482
log_exception_quietly()
451
if (isinstance(exc_object, IOError)
452
and getattr(exc_object, 'errno', None) == errno.EPIPE):
453
err_file.write("bzr: broken pipe\n")
483
if 'error' in debug.debug_flags:
484
print_exception(exc_info, err_file)
454
485
return errors.EXIT_ERROR
455
elif isinstance(exc_object, KeyboardInterrupt):
486
exc_type, exc_object, exc_tb = exc_info
487
if isinstance(exc_object, KeyboardInterrupt):
456
488
err_file.write("bzr: interrupted\n")
457
489
return errors.EXIT_ERROR
458
490
elif isinstance(exc_object, MemoryError):
459
491
err_file.write("bzr: out of memory\n")
492
if 'mem_dump' in debug.debug_flags:
493
_dump_memory_usage(err_file)
495
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
460
496
return errors.EXIT_ERROR
461
497
elif isinstance(exc_object, ImportError) \
462
498
and str(exc_object).startswith("No module named "):
466
502
elif not getattr(exc_object, 'internal_error', True):
467
503
report_user_error(exc_info, err_file)
468
504
return errors.EXIT_ERROR
469
elif isinstance(exc_object, (OSError, IOError)):
505
elif osutils.is_environment_error(exc_object):
506
if getattr(exc_object, 'errno', None) == errno.EPIPE:
507
err_file.write("bzr: broken pipe\n")
508
return errors.EXIT_ERROR
470
509
# Might be nice to catch all of these and show them as something more
471
510
# specific, but there are too many cases at the moment.
472
511
report_user_error(exc_info, err_file)
506
542
"""Report an exception that probably indicates a bug in bzr"""
507
543
from bzrlib.crash import report_bug
508
544
report_bug(exc_info, err_file)
547
def _flush_stdout_stderr():
548
# called from the bzrlib library finalizer returned by bzrlib.initialize()
552
except ValueError, e:
553
# On Windows, I get ValueError calling stdout.flush() on a closed
558
if e.errno in [errno.EINVAL, errno.EPIPE]:
565
# called from the bzrlib library finalizer returned by bzrlib.initialize()
571
class EncodedStreamHandler(logging.Handler):
572
"""Robustly write logging events to a stream using the specified encoding
574
Messages are expected to be formatted to unicode, but UTF-8 byte strings
575
are also accepted. An error during formatting or a str message in another
576
encoding will be quitely noted as an error in the Bazaar log file.
578
The stream is not closed so sys.stdout or sys.stderr may be passed.
581
def __init__(self, stream, encoding=None, errors='strict', level=0):
582
logging.Handler.__init__(self, level)
585
encoding = getattr(stream, "encoding", "ascii")
586
self.encoding = encoding
590
flush = getattr(self.stream, "flush", None)
591
if flush is not None:
594
def emit(self, record):
596
line = self.format(record)
597
if not isinstance(line, unicode):
598
line = line.decode("utf-8")
599
self.stream.write(line.encode(self.encoding, self.errors) + "\n")
601
log_exception_quietly()
602
# Try saving the details that would have been logged in some form
603
msg = args = "<Unformattable>"
605
msg = repr(record.msg).encode("ascii")
606
args = repr(record.args).encode("ascii")
609
# Using mutter() bypasses the logging module and writes directly
610
# to the file so there's no danger of getting into a loop here.
611
mutter("Logging record unformattable: %s %% %s", msg, args)
614
class Config(object):
615
"""Configuration of message tracing in bzrlib.
617
This implements the context manager protocol and should manage any global
618
variables still used. The default config used is DefaultConfig, but
619
embedded uses of bzrlib may wish to use a custom manager.
623
return self # This is bound to the 'as' clause in a with statement.
625
def __exit__(self, exc_type, exc_val, exc_tb):
626
return False # propogate exceptions.
629
class DefaultConfig(Config):
630
"""A default configuration for tracing of messages in bzrlib.
632
This implements the context manager protocol.
636
self._original_filename = _bzr_log_filename
637
self._original_state = enable_default_logging()
638
return self # This is bound to the 'as' clause in a with statement.
640
def __exit__(self, exc_type, exc_val, exc_tb):
641
pop_log_file(self._original_state)
642
global _bzr_log_filename
643
_bzr_log_filename = self._original_filename
644
return False # propogate exceptions.
added
removed
bzrlib/trace.py
