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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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.
123
127
_bzr_logger.warning(*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
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)
148
def show_error(*args, **kwargs):
149
"""Show an error message to the user.
151
Don't use this for exceptions, use report_exception instead.
153
_bzr_logger.error(*args, **kwargs)
134
156
def mutter(fmt, *args):
135
157
if _trace_file is None:
159
# XXX: Don't check this every time; instead anyone who closes the file
160
# ought to deregister it. We can tolerate None.
137
161
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
152
176
out = fmt % tuple(real_args)
155
timestamp = '%0.3f ' % (time.time() - _bzr_log_start_time,)
180
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
156
181
out = timestamp + out + '\n'
157
182
_trace_file.write(out)
158
# no need to flush here, the trace file is now linebuffered when it's
183
# there's no explicit flushing; the file is typically line buffered.
162
186
def mutter_callsite(stacklevel, fmt, *args):
217
241
_bzr_log_filename = _get_bzr_log_filename()
218
242
_rollover_trace_maybe(_bzr_log_filename)
220
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
244
buffering = 0 # unbuffered
245
bzr_log_file = osutils.open_with_ownership(_bzr_log_filename, 'at', buffering)
221
246
# bzr_log_file.tell() on windows always return 0 until some writing done
222
247
bzr_log_file.write('\n')
223
248
if bzr_log_file.tell() <= 2:
224
249
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
225
250
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
226
251
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
227
253
return bzr_log_file
228
255
except IOError, e:
229
warning("failed to open trace file: %s" % (e))
256
# If we are failing to open the log, then most likely logging has not
257
# been set up yet. So we just write to stderr rather than using
258
# 'warning()'. If we using warning(), users get the unhelpful 'no
259
# handlers registered for "bzr"' when something goes wrong on the
260
# server. (bug #503886)
261
sys.stderr.write("failed to open trace file: %s\n" % (e,))
230
262
# TODO: What should happen if we fail to open the trace file? Maybe the
231
263
# objects should be pointed at /dev/null or the equivalent? Currently
232
264
# returns None which will cause failures later.
235
268
def enable_default_logging():
236
269
"""Configure default logging: messages to stderr and debug to .bzr.log
238
271
This should only be called once per process.
240
273
Non-command-line programs embedding bzrlib do not need to call this. They
241
274
can instead either pass a file to _push_log_file, or act directly on
242
275
logging.getLogger("bzr").
244
277
Output can be redirected away by calling _push_log_file.
279
# Do this before we open the log file, so we prevent
280
# get_terminal_encoding() from mutter()ing multiple times
281
term_encoding = osutils.get_terminal_encoding()
282
start_time = osutils.format_local_date(_bzr_log_start_time,
246
284
# create encoded wrapper around stderr
247
285
bzr_log_file = _open_bzr_log()
286
if bzr_log_file is not None:
287
bzr_log_file.write(start_time.encode('utf-8') + '\n')
248
288
push_log_file(bzr_log_file,
249
289
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
250
290
r'%Y-%m-%d %H:%M:%S')
251
291
# after hooking output into bzr_log, we also need to attach a stderr
252
292
# handler, writing only at level info and with encoding
253
writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
293
writer_factory = codecs.getwriter(term_encoding)
254
294
encoded_stderr = writer_factory(sys.stderr, errors='replace')
255
295
stderr_handler = logging.StreamHandler(encoded_stderr)
256
296
stderr_handler.setLevel(logging.INFO)
310
350
new_trace_file.flush()
313
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
314
def enable_test_log(to_file):
315
"""Redirect logging to a temporary file for a test
317
:returns: an opaque reference that should be passed to disable_test_log
318
after the test completes.
320
return push_log_file(to_file)
323
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
324
def disable_test_log(memento):
325
return pop_log_file(memento)
328
353
def log_exception_quietly():
329
354
"""Log the last exception to the trace file only.
331
Used for exceptions that occur internally and that may be
332
interesting to developers but not to users. For example,
356
Used for exceptions that occur internally and that may be
357
interesting to developers but not to users. For example,
333
358
errors loading plugins.
335
360
mutter(traceback.format_exc())
379
404
return _verbosity_level > 0
382
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
383
def disable_default_logging():
384
"""Turn off default log handlers.
386
Don't call this method, use _push_log_file and _pop_log_file instead.
391
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
393
407
def debug_memory(message='', short=True):
394
408
"""Write out a memory dump."""
409
if sys.platform == 'win32':
410
from bzrlib import win32utils
411
win32utils.debug_memory_win32api(message=message, short=short)
413
_debug_memory_proc(message=message, short=short)
416
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
418
def _debug_memory_proc(message='', short=True):
396
420
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
420
444
:return: The appropriate exit code for this error.
422
exc_type, exc_object, exc_tb = exc_info
423
446
# Log the full traceback to ~/.bzr.log
424
447
log_exception_quietly()
448
if 'error' in debug.debug_flags:
449
print_exception(exc_info, err_file)
450
return errors.EXIT_ERROR
451
exc_type, exc_object, exc_tb = exc_info
425
452
if (isinstance(exc_object, IOError)
426
453
and getattr(exc_object, 'errno', None) == errno.EPIPE):
427
454
err_file.write("bzr: broken pipe\n")
429
456
elif isinstance(exc_object, KeyboardInterrupt):
430
457
err_file.write("bzr: interrupted\n")
431
458
return errors.EXIT_ERROR
459
elif isinstance(exc_object, MemoryError):
460
err_file.write("bzr: out of memory\n")
461
return errors.EXIT_ERROR
432
462
elif isinstance(exc_object, ImportError) \
433
463
and str(exc_object).startswith("No module named "):
434
464
report_user_error(exc_info, err_file,
476
503
def report_bug(exc_info, err_file):
477
504
"""Report an exception that probably indicates a bug in bzr"""
478
print_exception(exc_info, err_file)
480
err_file.write('bzr %s on python %s (%s)\n' % \
482
bzrlib._format_version_tuple(sys.version_info),
484
err_file.write('arguments: %r\n' % sys.argv)
486
'encoding: %r, fsenc: %r, lang: %r\n' % (
487
osutils.get_user_encoding(), sys.getfilesystemencoding(),
488
os.environ.get('LANG')))
489
err_file.write("plugins:\n")
490
for name, a_plugin in sorted(plugin.plugins().items()):
491
err_file.write(" %-20s %s [%s]\n" %
492
(name, a_plugin.path(), a_plugin.__version__))
495
*** Bazaar has encountered an internal error.
496
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
497
including this traceback, and a description of what you
498
were doing when the error occurred.
505
from bzrlib.crash import report_bug
506
report_bug(exc_info, err_file)
509
def _flush_stdout_stderr():
510
# installed into an atexit hook by bzrlib.initialize()
516
if e.errno in [errno.EINVAL, errno.EPIPE]:
523
# run from atexit hook
added
removed
bzrlib/trace.py
