113
113
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
120
114
# FIXME note always emits utf-8, regardless of the terminal encoding
122
116
# FIXME: clearing the ui and then going through the abstract logging
244
238
This sets the global _bzr_log_filename.
246
240
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
241
_bzr_log_filename = _get_bzr_log_filename()
275
242
_rollover_trace_maybe(_bzr_log_filename)
277
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
278
247
bzr_log_file.write('\n')
279
248
if bzr_log_file.tell() <= 2:
280
249
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
284
253
return bzr_log_file
286
except EnvironmentError, e:
287
256
# If we are failing to open the log, then most likely logging has not
288
257
# been set up yet. So we just write to stderr rather than using
289
258
# 'warning()'. If we using warning(), users get the unhelpful 'no
306
275
logging.getLogger("bzr").
308
277
Output can be redirected away by calling _push_log_file.
310
: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()
312
282
start_time = osutils.format_local_date(_bzr_log_start_time,
313
283
timezone='local')
314
284
# create encoded wrapper around stderr
315
285
bzr_log_file = _open_bzr_log()
316
286
if bzr_log_file is not None:
317
287
bzr_log_file.write(start_time.encode('utf-8') + '\n')
318
memento = push_log_file(bzr_log_file,
288
push_log_file(bzr_log_file,
319
289
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
290
r'%Y-%m-%d %H:%M:%S')
321
291
# after hooking output into bzr_log, we also need to attach a stderr
322
292
# handler, writing only at level info and with encoding
323
term_encoding = osutils.get_terminal_encoding()
324
293
writer_factory = codecs.getwriter(term_encoding)
325
294
encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
295
stderr_handler = logging.StreamHandler(encoded_stderr)
327
296
stderr_handler.setLevel(logging.INFO)
328
297
logging.getLogger('bzr').addHandler(stderr_handler)
332
300
def push_log_file(to_file, log_format=None, date_format=None):
368
336
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
369
337
"""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
339
This flushes, but does not close the trace file.
374
341
Takes the memento returned from _push_log_file."""
375
342
global _trace_file
376
343
_trace_file = old_trace_file
377
344
bzr_logger = logging.getLogger('bzr')
378
345
bzr_logger.removeHandler(new_handler)
379
# 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
380
347
# file will likely already be closed underneath.
381
348
new_handler.close()
382
349
bzr_logger.handlers = old_handlers
383
if new_trace_file is not None:
384
new_trace_file.flush()
350
new_trace_file.flush()
387
353
def log_exception_quietly():
501
467
elif not getattr(exc_object, 'internal_error', True):
502
468
report_user_error(exc_info, err_file)
503
469
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"):
470
elif isinstance(exc_object, (OSError, IOError)):
507
471
# Might be nice to catch all of these and show them as something more
508
472
# specific, but there are too many cases at the moment.
509
473
report_user_error(exc_info, err_file)
558
522
def _flush_trace():
559
# called from the bzrlib library finalizer returned by bzrlib.initialize()
523
# run from atexit hook
560
524
global _trace_file
562
526
_trace_file.flush()
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.
added
removed
bzrlib/trace.py
