1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
112
113
def note(*args, **kwargs):
113
"""Output a note to the user.
115
Takes the same parameters as logging.info.
119
114
# FIXME note always emits utf-8, regardless of the terminal encoding
121
116
# FIXME: clearing the ui and then going through the abstract logging
122
117
# framework is whack; we should probably have a logging Handler that
123
118
# deals with terminal output if needed.
124
ui.ui_factory.clear_term()
120
bzrlib.ui.ui_factory.clear_term()
125
121
_bzr_logger.info(*args, **kwargs)
128
124
def warning(*args, **kwargs):
129
ui.ui_factory.clear_term()
126
bzrlib.ui.ui_factory.clear_term()
130
127
_bzr_logger.warning(*args, **kwargs)
241
238
This sets the global _bzr_log_filename.
243
240
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
241
_bzr_log_filename = _get_bzr_log_filename()
272
242
_rollover_trace_maybe(_bzr_log_filename)
274
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
244
buffering = 0 # unbuffered
245
bzr_log_file = osutils.open_with_ownership(_bzr_log_filename, 'at', buffering)
246
# bzr_log_file.tell() on windows always return 0 until some writing done
275
247
bzr_log_file.write('\n')
276
248
if bzr_log_file.tell() <= 2:
277
249
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
253
return bzr_log_file
283
except EnvironmentError, e:
284
256
# If we are failing to open the log, then most likely logging has not
285
257
# been set up yet. So we just write to stderr rather than using
286
258
# 'warning()'. If we using warning(), users get the unhelpful 'no
303
275
logging.getLogger("bzr").
305
277
Output can be redirected away by calling _push_log_file.
307
:return: A memento from push_log_file for restoring the log state.
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()
309
282
start_time = osutils.format_local_date(_bzr_log_start_time,
310
283
timezone='local')
311
284
# create encoded wrapper around stderr
312
285
bzr_log_file = _open_bzr_log()
313
286
if bzr_log_file is not None:
314
287
bzr_log_file.write(start_time.encode('utf-8') + '\n')
315
memento = push_log_file(bzr_log_file,
288
push_log_file(bzr_log_file,
316
289
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
317
290
r'%Y-%m-%d %H:%M:%S')
318
291
# after hooking output into bzr_log, we also need to attach a stderr
319
292
# handler, writing only at level info and with encoding
320
term_encoding = osutils.get_terminal_encoding()
321
293
writer_factory = codecs.getwriter(term_encoding)
322
294
encoded_stderr = writer_factory(sys.stderr, errors='replace')
323
295
stderr_handler = logging.StreamHandler(encoded_stderr)
324
296
stderr_handler.setLevel(logging.INFO)
325
297
logging.getLogger('bzr').addHandler(stderr_handler)
329
300
def push_log_file(to_file, log_format=None, date_format=None):
365
336
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
366
337
"""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
339
This flushes, but does not close the trace file.
371
341
Takes the memento returned from _push_log_file."""
372
342
global _trace_file
373
343
_trace_file = old_trace_file
374
344
bzr_logger = logging.getLogger('bzr')
375
345
bzr_logger.removeHandler(new_handler)
376
# must be closed, otherwise logging will try to close it at exit, and the
346
# must be closed, otherwise logging will try to close it atexit, and the
377
347
# file will likely already be closed underneath.
378
348
new_handler.close()
379
349
bzr_logger.handlers = old_handlers
380
if new_trace_file is not None:
381
new_trace_file.flush()
350
new_trace_file.flush()
384
353
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
439
def report_exception(exc_info, err_file):
505
440
"""Report an exception to err_file (typically stderr) and to .bzr.log.
523
458
return errors.EXIT_ERROR
524
459
elif isinstance(exc_object, MemoryError):
525
460
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
461
return errors.EXIT_ERROR
531
462
elif isinstance(exc_object, ImportError) \
532
463
and str(exc_object).startswith("No module named "):
536
467
elif not getattr(exc_object, 'internal_error', True):
537
468
report_user_error(exc_info, err_file)
538
469
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"):
470
elif isinstance(exc_object, (OSError, IOError)):
542
471
# Might be nice to catch all of these and show them as something more
543
472
# specific, but there are too many cases at the moment.
544
473
report_user_error(exc_info, err_file)
593
522
def _flush_trace():
594
# called from the bzrlib library finalizer returned by bzrlib.initialize()
523
# run from atexit hook
595
524
global _trace_file
597
526
_trace_file.flush()
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
