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.
112
109
def note(*args, **kwargs):
113
"""Output a note to the user.
115
Takes the same parameters as logging.info.
119
110
# FIXME note always emits utf-8, regardless of the terminal encoding
121
112
# FIXME: clearing the ui and then going through the abstract logging
122
113
# framework is whack; we should probably have a logging Handler that
123
114
# deals with terminal output if needed.
124
ui.ui_factory.clear_term()
116
bzrlib.ui.ui_factory.clear_term()
125
117
_bzr_logger.info(*args, **kwargs)
128
120
def warning(*args, **kwargs):
129
ui.ui_factory.clear_term()
122
bzrlib.ui.ui_factory.clear_term()
130
123
_bzr_logger.warning(*args, **kwargs)
133
@deprecated_function(deprecated_in((2, 1, 0)))
134
def info(*args, **kwargs):
135
"""Deprecated: use trace.note instead."""
136
note(*args, **kwargs)
139
@deprecated_function(deprecated_in((2, 1, 0)))
140
def log_error(*args, **kwargs):
141
"""Deprecated: use bzrlib.trace.show_error instead"""
142
_bzr_logger.error(*args, **kwargs)
145
@deprecated_function(deprecated_in((2, 1, 0)))
146
def error(*args, **kwargs):
147
"""Deprecated: use bzrlib.trace.show_error instead"""
148
_bzr_logger.error(*args, **kwargs)
151
def show_error(*args, **kwargs):
152
"""Show an error message to the user.
154
Don't use this for exceptions, use report_exception instead.
156
_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
159
136
def mutter(fmt, *args):
137
global _last_mutter_flush_time
160
138
if _trace_file is None:
162
# XXX: Don't check this every time; instead anyone who closes the file
163
# ought to deregister it. We can tolerate None.
164
140
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
183
159
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
184
160
out = timestamp + out + '\n'
185
161
_trace_file.write(out)
186
# 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
189
173
def mutter_callsite(stacklevel, fmt, *args):
241
225
This sets the global _bzr_log_filename.
243
227
global _bzr_log_filename
245
def _open_or_create_log_file(filename):
246
"""Open existing log file, or create with ownership and permissions
248
It inherits the ownership and permissions (masked by umask) from
249
the containing directory to cope better with being run under sudo
250
with $HOME still set to the user's homedir.
252
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
255
fd = os.open(filename, flags)
258
if e.errno != errno.ENOENT:
261
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
263
if e.errno != errno.EEXIST:
266
osutils.copy_ownership_from_path(filename)
268
return os.fdopen(fd, 'at', 0) # unbuffered
271
228
_bzr_log_filename = _get_bzr_log_filename()
272
229
_rollover_trace_maybe(_bzr_log_filename)
274
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
275
233
bzr_log_file.write('\n')
276
234
if bzr_log_file.tell() <= 2:
277
235
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
278
236
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
279
237
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
281
238
return bzr_log_file
283
except EnvironmentError, e:
284
# If we are failing to open the log, then most likely logging has not
285
# been set up yet. So we just write to stderr rather than using
286
# 'warning()'. If we using warning(), users get the unhelpful 'no
287
# handlers registered for "bzr"' when something goes wrong on the
288
# server. (bug #503886)
289
sys.stderr.write("failed to open trace file: %s\n" % (e,))
240
warning("failed to open trace file: %s" % (e))
290
241
# TODO: What should happen if we fail to open the trace file? Maybe the
291
242
# objects should be pointed at /dev/null or the equivalent? Currently
292
243
# returns None which will cause failures later.
303
254
logging.getLogger("bzr").
305
256
Output can be redirected away by calling _push_log_file.
307
: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()
309
261
start_time = osutils.format_local_date(_bzr_log_start_time,
310
262
timezone='local')
311
263
# create encoded wrapper around stderr
312
264
bzr_log_file = _open_bzr_log()
313
265
if bzr_log_file is not None:
314
266
bzr_log_file.write(start_time.encode('utf-8') + '\n')
315
memento = push_log_file(bzr_log_file,
267
push_log_file(bzr_log_file,
316
268
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
317
269
r'%Y-%m-%d %H:%M:%S')
318
270
# after hooking output into bzr_log, we also need to attach a stderr
319
271
# handler, writing only at level info and with encoding
320
term_encoding = osutils.get_terminal_encoding()
321
272
writer_factory = codecs.getwriter(term_encoding)
322
273
encoded_stderr = writer_factory(sys.stderr, errors='replace')
323
274
stderr_handler = logging.StreamHandler(encoded_stderr)
324
275
stderr_handler.setLevel(logging.INFO)
325
276
logging.getLogger('bzr').addHandler(stderr_handler)
329
279
def push_log_file(to_file, log_format=None, date_format=None):
365
315
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
366
316
"""Undo changes to logging/tracing done by _push_log_file.
368
This flushes, but does not close the trace file (so that anything that was
318
This flushes, but does not close the trace file.
371
320
Takes the memento returned from _push_log_file."""
372
321
global _trace_file
373
322
_trace_file = old_trace_file
374
323
bzr_logger = logging.getLogger('bzr')
375
324
bzr_logger.removeHandler(new_handler)
376
# 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
377
326
# file will likely already be closed underneath.
378
327
new_handler.close()
379
328
bzr_logger.handlers = old_handlers
380
if new_trace_file is not None:
381
new_trace_file.flush()
329
new_trace_file.flush()
384
332
def log_exception_quietly():
469
def _dump_memory_usage(err_file):
472
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
473
dump_file = os.fdopen(fd, 'w')
474
from meliae import scanner
475
scanner.dump_gc_objects(dump_file)
476
err_file.write("Memory dumped to %s\n" % name)
478
err_file.write("Dumping memory requires meliae module.\n")
479
log_exception_quietly()
481
err_file.write("Exception while dumping memory.\n")
482
log_exception_quietly()
484
if dump_file is not None:
490
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
491
"""Give name of error class including module for non-builtin exceptions
493
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
494
also omit the module prefix.
496
class_name = eclass.__name__
497
module_name = eclass.__module__
498
if module_name in ("exceptions", "__main__") or (
499
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
501
return "%s.%s" % (module_name, class_name)
504
418
def report_exception(exc_info, err_file):
505
419
"""Report an exception to err_file (typically stderr) and to .bzr.log.
509
423
:return: The appropriate exit code for this error.
425
exc_type, exc_object, exc_tb = exc_info
511
426
# Log the full traceback to ~/.bzr.log
512
427
log_exception_quietly()
513
if 'error' in debug.debug_flags:
514
print_exception(exc_info, err_file)
515
return errors.EXIT_ERROR
516
exc_type, exc_object, exc_tb = exc_info
517
428
if (isinstance(exc_object, IOError)
518
429
and getattr(exc_object, 'errno', None) == errno.EPIPE):
519
430
err_file.write("bzr: broken pipe\n")
521
432
elif isinstance(exc_object, KeyboardInterrupt):
522
433
err_file.write("bzr: interrupted\n")
523
434
return errors.EXIT_ERROR
524
elif isinstance(exc_object, MemoryError):
525
err_file.write("bzr: out of memory\n")
526
if 'mem_dump' in debug.debug_flags:
527
_dump_memory_usage(err_file)
529
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
530
return errors.EXIT_ERROR
531
435
elif isinstance(exc_object, ImportError) \
532
436
and str(exc_object).startswith("No module named "):
533
437
report_user_error(exc_info, err_file,
536
440
elif not getattr(exc_object, 'internal_error', True):
537
441
report_user_error(exc_info, err_file)
538
442
return errors.EXIT_ERROR
539
elif isinstance(exc_object, (OSError, IOError)) or (
540
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
541
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
443
elif isinstance(exc_object, (OSError, IOError)):
542
444
# Might be nice to catch all of these and show them as something more
543
445
# specific, but there are too many cases at the moment.
544
446
report_user_error(exc_info, err_file)
566
468
:param advice: Extra advice to the user to be printed following the
471
if 'error' in debug.debug_flags:
472
print_exception(exc_info, err_file)
569
474
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
571
476
err_file.write("%s\n" % (advice,))
575
480
"""Report an exception that probably indicates a bug in bzr"""
576
481
from bzrlib.crash import report_bug
577
482
report_bug(exc_info, err_file)
580
def _flush_stdout_stderr():
581
# called from the bzrlib library finalizer returned by bzrlib.initialize()
587
if e.errno in [errno.EINVAL, errno.EPIPE]:
594
# called from the bzrlib library finalizer returned by bzrlib.initialize()
600
class Config(object):
601
"""Configuration of message tracing in bzrlib.
603
This implements the context manager protocol and should manage any global
604
variables still used. The default config used is DefaultConfig, but
605
embedded uses of bzrlib may wish to use a custom manager.
609
return self # This is bound to the 'as' clause in a with statement.
611
def __exit__(self, exc_type, exc_val, exc_tb):
612
return False # propogate exceptions.
615
class DefaultConfig(Config):
616
"""A default configuration for tracing of messages in bzrlib.
618
This implements the context manager protocol.
622
self._original_filename = _bzr_log_filename
623
self._original_state = enable_default_logging()
624
return self # This is bound to the 'as' clause in a with statement.
626
def __exit__(self, exc_type, exc_val, exc_tb):
627
pop_log_file(self._original_state)
628
global _bzr_log_filename
629
_bzr_log_filename = self._original_filename
630
return False # propogate exceptions.
added
removed
bzrlib/trace.py
