13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
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
162
134
def mutter(fmt, *args):
163
135
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
137
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
244
210
This sets the global _bzr_log_filename.
246
212
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
213
_bzr_log_filename = _get_bzr_log_filename()
275
214
_rollover_trace_maybe(_bzr_log_filename)
277
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
216
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
217
# bzr_log_file.tell() on windows always return 0 until some writing done
278
218
bzr_log_file.write('\n')
279
219
if bzr_log_file.tell() <= 2:
280
220
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
221
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
222
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
284
223
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,))
225
warning("failed to open trace file: %s" % (e))
293
226
# TODO: What should happen if we fail to open the trace file? Maybe the
294
227
# objects should be pointed at /dev/null or the equivalent? Currently
295
228
# returns None which will cause failures later.
299
231
def enable_default_logging():
300
232
"""Configure default logging: messages to stderr and debug to .bzr.log
302
234
This should only be called once per process.
304
236
Non-command-line programs embedding bzrlib do not need to call this. They
305
237
can instead either pass a file to _push_log_file, or act directly on
306
238
logging.getLogger("bzr").
308
240
Output can be redirected away by calling _push_log_file.
310
:return: A memento from push_log_file for restoring the log state.
312
start_time = osutils.format_local_date(_bzr_log_start_time,
314
242
# create encoded wrapper around stderr
315
243
bzr_log_file = _open_bzr_log()
316
if bzr_log_file is not None:
317
bzr_log_file.write(start_time.encode('utf-8') + '\n')
318
memento = push_log_file(bzr_log_file,
244
push_log_file(bzr_log_file,
319
245
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
246
r'%Y-%m-%d %H:%M:%S')
321
247
# after hooking output into bzr_log, we also need to attach a stderr
322
248
# handler, writing only at level info and with encoding
323
term_encoding = osutils.get_terminal_encoding()
324
writer_factory = codecs.getwriter(term_encoding)
249
writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
325
250
encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
251
stderr_handler = logging.StreamHandler(encoded_stderr)
327
252
stderr_handler.setLevel(logging.INFO)
328
253
logging.getLogger('bzr').addHandler(stderr_handler)
332
256
def push_log_file(to_file, log_format=None, date_format=None):
368
292
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
369
293
"""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
295
This flushes, but does not close the trace file.
374
297
Takes the memento returned from _push_log_file."""
298
assert magic == 'log_memento'
375
299
global _trace_file
376
300
_trace_file = old_trace_file
377
301
bzr_logger = logging.getLogger('bzr')
378
302
bzr_logger.removeHandler(new_handler)
379
# must be closed, otherwise logging will try to close it at exit, and the
303
# must be closed, otherwise logging will try to close it atexit, and the
380
304
# file will likely already be closed underneath.
381
305
new_handler.close()
382
306
bzr_logger.handlers = old_handlers
383
if new_trace_file is not None:
384
new_trace_file.flush()
307
new_trace_file.flush()
310
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
311
def enable_test_log(to_file):
312
"""Redirect logging to a temporary file for a test
314
:returns: an opaque reference that should be passed to disable_test_log
315
after the test completes.
317
return push_log_file(to_file)
320
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
321
def disable_test_log(memento):
322
return pop_log_file(memento)
387
325
def log_exception_quietly():
388
326
"""Log the last exception to the trace file only.
390
Used for exceptions that occur internally and that may be
391
interesting to developers but not to users. For example,
328
Used for exceptions that occur internally and that may be
329
interesting to developers but not to users. For example,
392
330
errors loading plugins.
394
332
mutter(traceback.format_exc())
438
376
return _verbosity_level > 0
441
def debug_memory(message='', short=True):
442
"""Write out a memory dump."""
443
if sys.platform == 'win32':
444
from bzrlib import win32utils
445
win32utils.debug_memory_win32api(message=message, short=short)
447
_debug_memory_proc(message=message, short=short)
450
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
452
def _debug_memory_proc(message='', short=True):
454
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
458
status = status_file.read()
463
for line in status.splitlines():
467
for field in _short_fields:
468
if line.startswith(field):
379
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
380
def disable_default_logging():
381
"""Turn off default log handlers.
383
Don't call this method, use _push_log_file and _pop_log_file instead.
473
388
def report_exception(exc_info, err_file):
478
393
:return: The appropriate exit code for this error.
395
exc_type, exc_object, exc_tb = exc_info
480
396
# Log the full traceback to ~/.bzr.log
481
397
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
398
if (isinstance(exc_object, IOError)
487
399
and getattr(exc_object, 'errno', None) == errno.EPIPE):
488
400
err_file.write("bzr: broken pipe\n")
490
402
elif isinstance(exc_object, KeyboardInterrupt):
491
403
err_file.write("bzr: interrupted\n")
492
404
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
elif isinstance(exc_object, ImportError) \
497
and str(exc_object).startswith("No module named "):
498
report_user_error(exc_info, err_file,
499
'You may need to install this Python library separately.')
500
return errors.EXIT_ERROR
501
405
elif not getattr(exc_object, 'internal_error', True):
502
406
report_user_error(exc_info, err_file)
503
407
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"):
408
elif isinstance(exc_object, (OSError, IOError)):
507
409
# Might be nice to catch all of these and show them as something more
508
410
# specific, but there are too many cases at the moment.
509
411
report_user_error(exc_info, err_file)
513
415
return errors.EXIT_INTERNAL_ERROR
516
def print_exception(exc_info, err_file):
517
exc_type, exc_object, exc_tb = exc_info
518
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
519
exc_type.__module__, exc_type.__name__, exc_object))
521
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
524
418
# TODO: Should these be specially encoding the output?
525
def report_user_error(exc_info, err_file, advice=None):
419
def report_user_error(exc_info, err_file):
526
420
"""Report to err_file an error that's not an internal error.
528
422
These don't get a traceback unless -Derror was given.
530
:param exc_info: 3-tuple from sys.exc_info()
531
:param advice: Extra advice to the user to be printed following the
424
if 'error' in debug.debug_flags:
425
report_bug(exc_info, err_file)
534
427
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
536
err_file.write("%s\n" % (advice,))
539
430
def report_bug(exc_info, err_file):
540
431
"""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.
432
exc_type, exc_object, exc_tb = exc_info
433
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
434
exc_type.__module__, exc_type.__name__, exc_object))
436
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
438
err_file.write('bzr %s on python %s (%s)\n' % \
440
bzrlib._format_version_tuple(sys.version_info),
442
err_file.write('arguments: %r\n' % sys.argv)
444
'encoding: %r, fsenc: %r, lang: %r\n' % (
445
osutils.get_user_encoding(), sys.getfilesystemencoding(),
446
os.environ.get('LANG')))
447
err_file.write("plugins:\n")
448
for name, a_plugin in sorted(plugin.plugins().items()):
449
err_file.write(" %-20s %s [%s]\n" %
450
(name, a_plugin.path(), a_plugin.__version__))
453
*** Bazaar has encountered an internal error.
454
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
455
including this traceback, and a description of what you
456
were doing when the error occurred.
added
removed
bzrlib/trace.py
