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.
17
"""Messages and logging for bazaar-ng.
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 debug mode, stderr gets debug messages too.
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.
38
39
Errors that terminate an operation are generally passed back as exceptions;
39
40
others may be just emitted as messages.
108
113
def note(*args, **kwargs):
109
"""Output a note to the user.
111
Takes the same parameters as logging.info.
114
# FIXME note always emits utf-8, regardless of the terminal encoding
115
116
# FIXME: clearing the ui and then going through the abstract logging
116
117
# framework is whack; we should probably have a logging Handler that
117
118
# deals with terminal output if needed.
118
ui.ui_factory.clear_term()
120
bzrlib.ui.ui_factory.clear_term()
119
121
_bzr_logger.info(*args, **kwargs)
122
124
def warning(*args, **kwargs):
123
ui.ui_factory.clear_term()
126
bzrlib.ui.ui_factory.clear_term()
124
127
_bzr_logger.warning(*args, **kwargs)
127
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)
128
149
"""Show an error message to the user.
130
151
Don't use this for exceptions, use report_exception instead.
159
182
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
160
183
out = timestamp + out + '\n'
161
184
_trace_file.write(out)
162
# there's no explicit flushing; the file is typically line buffered.
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
165
196
def mutter_callsite(stacklevel, fmt, *args):
196
227
def _get_bzr_log_filename():
197
bzr_log = osutils.path_from_environ('BZR_LOG')
228
bzr_log = os.environ.get('BZR_LOG')
200
home = osutils.path_from_environ('BZR_HOME')
231
home = os.environ.get('BZR_HOME')
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()
233
if sys.platform == 'win32':
234
from bzrlib import win32utils
235
home = win32utils.get_home_location()
237
home = os.path.expanduser('~')
206
238
return os.path.join(home, '.bzr.log')
216
248
This sets the global _bzr_log_filename.
218
250
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
246
251
_bzr_log_filename = _get_bzr_log_filename()
247
252
_rollover_trace_maybe(_bzr_log_filename)
249
bzr_log_file = _open_or_create_log_file(_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
250
256
bzr_log_file.write('\n')
251
257
if bzr_log_file.tell() <= 2:
252
258
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
253
259
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
254
260
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
256
261
return bzr_log_file
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,))
263
warning("failed to open trace file: %s" % (e))
265
264
# TODO: What should happen if we fail to open the trace file? Maybe the
266
265
# objects should be pointed at /dev/null or the equivalent? Currently
267
266
# returns None which will cause failures later.
278
277
logging.getLogger("bzr").
280
279
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
286
287
bzr_log_file = _open_bzr_log()
287
288
if bzr_log_file is not None:
288
289
bzr_log_file.write(start_time.encode('utf-8') + '\n')
289
memento = push_log_file(bzr_log_file,
290
push_log_file(bzr_log_file,
290
291
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
291
292
r'%Y-%m-%d %H:%M:%S')
292
293
# after hooking output into bzr_log, we also need to attach a stderr
293
294
# handler, writing only at level info and with encoding
294
stderr_handler = EncodedStreamHandler(sys.stderr,
295
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
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)
296
299
logging.getLogger('bzr').addHandler(stderr_handler)
300
302
def push_log_file(to_file, log_format=None, date_format=None):
303
305
:param to_file: A file-like object to which messages will be sent.
305
307
:returns: A memento that should be passed to _pop_log_file to restore the
306
previously active logging.
308
previously active logging.
308
310
global _trace_file
309
311
# make a new handler
310
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
312
new_handler = logging.StreamHandler(to_file)
313
new_handler.setLevel(logging.DEBUG)
311
314
if log_format is None:
312
315
log_format = '%(levelname)8s %(message)s'
313
316
new_handler.setFormatter(logging.Formatter(log_format, date_format))
335
338
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
336
339
"""Undo changes to logging/tracing done by _push_log_file.
338
This flushes, but does not close the trace file (so that anything that was
341
This flushes, but does not close the trace file.
341
343
Takes the memento returned from _push_log_file."""
342
344
global _trace_file
343
345
_trace_file = old_trace_file
344
346
bzr_logger = logging.getLogger('bzr')
345
347
bzr_logger.removeHandler(new_handler)
346
# must be closed, otherwise logging will try to close it at exit, and the
348
# must be closed, otherwise logging will try to close it atexit, and the
347
349
# file will likely already be closed underneath.
348
350
new_handler.close()
349
351
bzr_logger.handlers = old_handlers
350
if new_trace_file is not None:
351
new_trace_file.flush()
352
new_trace_file.flush()
354
355
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)
474
441
def report_exception(exc_info, err_file):
475
442
"""Report an exception to err_file (typically stderr) and to .bzr.log.
479
446
:return: The appropriate exit code for this error.
448
exc_type, exc_object, exc_tb = exc_info
481
449
# Log the full traceback to ~/.bzr.log
482
450
log_exception_quietly()
483
if 'error' in debug.debug_flags:
484
print_exception(exc_info, err_file)
451
if (isinstance(exc_object, IOError)
452
and getattr(exc_object, 'errno', None) == errno.EPIPE):
453
err_file.write("bzr: broken pipe\n")
485
454
return errors.EXIT_ERROR
486
exc_type, exc_object, exc_tb = exc_info
487
if isinstance(exc_object, KeyboardInterrupt):
455
elif isinstance(exc_object, KeyboardInterrupt):
488
456
err_file.write("bzr: interrupted\n")
489
457
return errors.EXIT_ERROR
490
458
elif isinstance(exc_object, MemoryError):
491
459
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")
496
460
return errors.EXIT_ERROR
497
461
elif isinstance(exc_object, ImportError) \
498
462
and str(exc_object).startswith("No module named "):
502
466
elif not getattr(exc_object, 'internal_error', True):
503
467
report_user_error(exc_info, err_file)
504
468
return errors.EXIT_ERROR
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
469
elif isinstance(exc_object, (OSError, IOError)):
509
470
# Might be nice to catch all of these and show them as something more
510
471
# specific, but there are too many cases at the moment.
511
472
report_user_error(exc_info, err_file)
542
506
"""Report an exception that probably indicates a bug in bzr"""
543
507
from bzrlib.crash import report_bug
544
508
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
