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.
133
123
_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
def show_error(*args, **kwargs):
155
"""Show an error message to the user.
157
Don't use this for exceptions, use report_exception instead.
159
_bzr_logger.error(*args, **kwargs)
126
# configure convenient aliases for output routines
128
# TODO: deprecate them, have one name for each.
130
log_error = _bzr_logger.error
131
error = _bzr_logger.error
134
_last_mutter_flush_time = None
162
136
def mutter(fmt, *args):
137
global _last_mutter_flush_time
163
138
if _trace_file is None:
165
# XXX: Don't check this every time; instead anyone who closes the file
166
# ought to deregister it. We can tolerate None.
167
140
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
186
159
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
187
160
out = timestamp + out + '\n'
188
161
_trace_file.write(out)
189
# there's no explicit flushing; the file is typically line buffered.
162
# We flush if we haven't flushed for a few seconds. We don't want to flush
163
# on every mutter, but when a command takes a while, it can be nice to see
164
# updates in the debug log.
165
if (_last_mutter_flush_time is None
166
or (now - _last_mutter_flush_time) > 2.0):
167
flush = getattr(_trace_file, 'flush', None)
168
if flush is not None:
170
_last_mutter_flush_time = now
192
173
def mutter_callsite(stacklevel, fmt, *args):
244
225
This sets the global _bzr_log_filename.
246
227
global _bzr_log_filename
248
def _open_or_create_log_file(filename):
249
"""Open existing log file, or create with ownership and permissions
251
It inherits the ownership and permissions (masked by umask) from
252
the containing directory to cope better with being run under sudo
253
with $HOME still set to the user's homedir.
255
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
258
fd = os.open(filename, flags)
261
if e.errno != errno.ENOENT:
264
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
266
if e.errno != errno.EEXIST:
269
osutils.copy_ownership_from_path(filename)
271
return os.fdopen(fd, 'at', 0) # unbuffered
274
228
_bzr_log_filename = _get_bzr_log_filename()
275
229
_rollover_trace_maybe(_bzr_log_filename)
277
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
231
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
232
# bzr_log_file.tell() on windows always return 0 until some writing done
278
233
bzr_log_file.write('\n')
279
234
if bzr_log_file.tell() <= 2:
280
235
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
236
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
237
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
284
238
return bzr_log_file
286
except EnvironmentError, e:
287
# If we are failing to open the log, then most likely logging has not
288
# been set up yet. So we just write to stderr rather than using
289
# 'warning()'. If we using warning(), users get the unhelpful 'no
290
# handlers registered for "bzr"' when something goes wrong on the
291
# server. (bug #503886)
292
sys.stderr.write("failed to open trace file: %s\n" % (e,))
240
warning("failed to open trace file: %s" % (e))
293
241
# TODO: What should happen if we fail to open the trace file? Maybe the
294
242
# objects should be pointed at /dev/null or the equivalent? Currently
295
243
# returns None which will cause failures later.
306
254
logging.getLogger("bzr").
308
256
Output can be redirected away by calling _push_log_file.
310
:return: A memento from push_log_file for restoring the log state.
258
# Do this before we open the log file, so we prevent
259
# get_terminal_encoding() from mutter()ing multiple times
260
term_encoding = osutils.get_terminal_encoding()
312
261
start_time = osutils.format_local_date(_bzr_log_start_time,
313
262
timezone='local')
314
263
# create encoded wrapper around stderr
315
264
bzr_log_file = _open_bzr_log()
316
265
if bzr_log_file is not None:
317
266
bzr_log_file.write(start_time.encode('utf-8') + '\n')
318
memento = push_log_file(bzr_log_file,
267
push_log_file(bzr_log_file,
319
268
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
269
r'%Y-%m-%d %H:%M:%S')
321
270
# after hooking output into bzr_log, we also need to attach a stderr
322
271
# handler, writing only at level info and with encoding
323
term_encoding = osutils.get_terminal_encoding()
324
272
writer_factory = codecs.getwriter(term_encoding)
325
273
encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
274
stderr_handler = logging.StreamHandler(encoded_stderr)
327
275
stderr_handler.setLevel(logging.INFO)
328
276
logging.getLogger('bzr').addHandler(stderr_handler)
332
279
def push_log_file(to_file, log_format=None, date_format=None):
368
315
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
369
316
"""Undo changes to logging/tracing done by _push_log_file.
371
This flushes, but does not close the trace file (so that anything that was
318
This flushes, but does not close the trace file.
374
320
Takes the memento returned from _push_log_file."""
375
321
global _trace_file
376
322
_trace_file = old_trace_file
377
323
bzr_logger = logging.getLogger('bzr')
378
324
bzr_logger.removeHandler(new_handler)
379
# must be closed, otherwise logging will try to close it at exit, and the
325
# must be closed, otherwise logging will try to close it atexit, and the
380
326
# file will likely already be closed underneath.
381
327
new_handler.close()
382
328
bzr_logger.handlers = old_handlers
383
if new_trace_file is not None:
384
new_trace_file.flush()
329
new_trace_file.flush()
387
332
def log_exception_quietly():
478
423
:return: The appropriate exit code for this error.
425
exc_type, exc_object, exc_tb = exc_info
480
426
# Log the full traceback to ~/.bzr.log
481
427
log_exception_quietly()
482
if 'error' in debug.debug_flags:
483
print_exception(exc_info, err_file)
484
return errors.EXIT_ERROR
485
exc_type, exc_object, exc_tb = exc_info
486
428
if (isinstance(exc_object, IOError)
487
429
and getattr(exc_object, 'errno', None) == errno.EPIPE):
488
430
err_file.write("bzr: broken pipe\n")
490
432
elif isinstance(exc_object, KeyboardInterrupt):
491
433
err_file.write("bzr: interrupted\n")
492
434
return errors.EXIT_ERROR
493
elif isinstance(exc_object, MemoryError):
494
err_file.write("bzr: out of memory\n")
495
return errors.EXIT_ERROR
496
435
elif isinstance(exc_object, ImportError) \
497
436
and str(exc_object).startswith("No module named "):
498
437
report_user_error(exc_info, err_file,
501
440
elif not getattr(exc_object, 'internal_error', True):
502
441
report_user_error(exc_info, err_file)
503
442
return errors.EXIT_ERROR
504
elif isinstance(exc_object, (OSError, IOError)) or (
505
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
506
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
443
elif isinstance(exc_object, (OSError, IOError)):
507
444
# Might be nice to catch all of these and show them as something more
508
445
# specific, but there are too many cases at the moment.
509
446
report_user_error(exc_info, err_file)
539
479
def report_bug(exc_info, err_file):
540
480
"""Report an exception that probably indicates a bug in bzr"""
541
from bzrlib.crash import report_bug
542
report_bug(exc_info, err_file)
545
def _flush_stdout_stderr():
546
# called from the bzrlib library finalizer returned by bzrlib.initialize()
552
if e.errno in [errno.EINVAL, errno.EPIPE]:
559
# called from the bzrlib library finalizer returned by bzrlib.initialize()
565
class Config(object):
566
"""Configuration of message tracing in bzrlib.
568
This implements the context manager protocol and should manage any global
569
variables still used. The default config used is DefaultConfig, but
570
embedded uses of bzrlib may wish to use a custom manager.
574
return self # This is bound to the 'as' clause in a with statement.
576
def __exit__(self, exc_type, exc_val, exc_tb):
577
return False # propogate exceptions.
580
class DefaultConfig(Config):
581
"""A default configuration for tracing of messages in bzrlib.
583
This implements the context manager protocol.
587
self._original_filename = _bzr_log_filename
588
self._original_state = enable_default_logging()
589
return self # This is bound to the 'as' clause in a with statement.
591
def __exit__(self, exc_type, exc_val, exc_tb):
592
pop_log_file(self._original_state)
593
global _bzr_log_filename
594
_bzr_log_filename = self._original_filename
595
return False # propogate exceptions.
481
print_exception(exc_info, err_file)
483
err_file.write('bzr %s on python %s (%s)\n' % \
485
bzrlib._format_version_tuple(sys.version_info),
487
err_file.write('arguments: %r\n' % sys.argv)
489
'encoding: %r, fsenc: %r, lang: %r\n' % (
490
osutils.get_user_encoding(), sys.getfilesystemencoding(),
491
os.environ.get('LANG')))
492
err_file.write("plugins:\n")
493
for name, a_plugin in sorted(plugin.plugins().items()):
494
err_file.write(" %-20s %s [%s]\n" %
495
(name, a_plugin.path(), a_plugin.__version__))
498
*** Bazaar has encountered an internal error.
499
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
500
including this traceback, and a description of what you
501
were doing when the error occurred.
added
removed
bzrlib/trace.py
