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