1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005-2011 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
48
from __future__ import absolute_import
48
50
# FIXME: Unfortunately it turns out that python's logging module
49
51
# is quite expensive, even when the message is not printed by any handlers.
50
52
# We should perhaps change back to just simply doing it here.
54
56
# increased cost of logging.py is not so bad, and we could standardize on
64
64
from bzrlib.lazy_import import lazy_import
65
65
lazy_import(globals(), """
66
66
from cStringIO import StringIO
74
from bzrlib.symbol_versioning import (
79
75
lazy_import(globals(), """
80
76
from bzrlib import (
121
# FIXME note always emits utf-8, regardless of the terminal encoding
123
115
# FIXME: clearing the ui and then going through the abstract logging
124
116
# framework is whack; we should probably have a logging Handler that
125
117
# deals with terminal output if needed.
132
124
_bzr_logger.warning(*args, **kwargs)
135
@deprecated_function(deprecated_in((2, 1, 0)))
136
def info(*args, **kwargs):
137
"""Deprecated: use trace.note instead."""
138
note(*args, **kwargs)
141
@deprecated_function(deprecated_in((2, 1, 0)))
142
def log_error(*args, **kwargs):
143
"""Deprecated: use bzrlib.trace.show_error instead"""
144
_bzr_logger.error(*args, **kwargs)
147
@deprecated_function(deprecated_in((2, 1, 0)))
148
def error(*args, **kwargs):
149
"""Deprecated: use bzrlib.trace.show_error instead"""
150
_bzr_logger.error(*args, **kwargs)
153
127
def show_error(*args, **kwargs):
154
128
"""Show an error message to the user.
222
196
def _get_bzr_log_filename():
223
bzr_log = os.environ.get('BZR_LOG')
197
bzr_log = osutils.path_from_environ('BZR_LOG')
226
home = os.environ.get('BZR_HOME')
200
home = osutils.path_from_environ('BZR_HOME')
228
if sys.platform == 'win32':
229
from bzrlib import win32utils
230
home = win32utils.get_home_location()
232
home = os.path.expanduser('~')
202
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
203
# over what would be better. On windows, bug 240550
204
# suggests LOCALAPPDATA be used instead.
205
home = osutils._get_home_dir()
233
206
return os.path.join(home, '.bzr.log')
311
284
start_time = osutils.format_local_date(_bzr_log_start_time,
312
285
timezone='local')
313
# create encoded wrapper around stderr
314
286
bzr_log_file = _open_bzr_log()
315
287
if bzr_log_file is not None:
316
288
bzr_log_file.write(start_time.encode('utf-8') + '\n')
319
291
r'%Y-%m-%d %H:%M:%S')
320
292
# after hooking output into bzr_log, we also need to attach a stderr
321
293
# handler, writing only at level info and with encoding
322
term_encoding = osutils.get_terminal_encoding()
323
writer_factory = codecs.getwriter(term_encoding)
324
encoded_stderr = writer_factory(sys.stderr, errors='replace')
325
stderr_handler = logging.StreamHandler(encoded_stderr)
326
stderr_handler.setLevel(logging.INFO)
294
stderr_handler = EncodedStreamHandler(sys.stderr,
295
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
327
296
logging.getLogger('bzr').addHandler(stderr_handler)
334
303
:param to_file: A file-like object to which messages will be sent.
336
305
:returns: A memento that should be passed to _pop_log_file to restore the
337
previously active logging.
306
previously active logging.
339
308
global _trace_file
340
309
# make a new handler
341
new_handler = logging.StreamHandler(to_file)
342
new_handler.setLevel(logging.DEBUG)
310
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
343
311
if log_format is None:
344
312
log_format = '%(levelname)8s %(message)s'
345
313
new_handler.setFormatter(logging.Formatter(log_format, date_format))
488
456
elif fd is not None:
460
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
461
"""Give name of error class including module for non-builtin exceptions
463
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
464
also omit the module prefix.
466
class_name = eclass.__name__
467
module_name = eclass.__module__
468
if module_name in ("exceptions", "__main__") or (
469
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
471
return "%s.%s" % (module_name, class_name)
491
474
def report_exception(exc_info, err_file):
492
475
"""Report an exception to err_file (typically stderr) and to .bzr.log.
501
484
print_exception(exc_info, err_file)
502
485
return errors.EXIT_ERROR
503
486
exc_type, exc_object, exc_tb = exc_info
504
if (isinstance(exc_object, IOError)
505
and getattr(exc_object, 'errno', None) == errno.EPIPE):
506
err_file.write("bzr: broken pipe\n")
507
return errors.EXIT_ERROR
508
elif isinstance(exc_object, KeyboardInterrupt):
487
if isinstance(exc_object, KeyboardInterrupt):
509
488
err_file.write("bzr: interrupted\n")
510
489
return errors.EXIT_ERROR
511
490
elif isinstance(exc_object, MemoryError):
523
502
elif not getattr(exc_object, 'internal_error', True):
524
503
report_user_error(exc_info, err_file)
525
504
return errors.EXIT_ERROR
526
elif isinstance(exc_object, (OSError, IOError)) or (
527
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
528
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
505
elif osutils.is_environment_error(exc_object):
506
if getattr(exc_object, 'errno', None) == errno.EPIPE:
507
err_file.write("bzr: broken pipe\n")
508
return errors.EXIT_ERROR
529
509
# Might be nice to catch all of these and show them as something more
530
510
# specific, but there are too many cases at the moment.
531
511
report_user_error(exc_info, err_file)
584
568
_trace_file.flush()
571
class EncodedStreamHandler(logging.Handler):
572
"""Robustly write logging events to a stream using the specified encoding
574
Messages are expected to be formatted to unicode, but UTF-8 byte strings
575
are also accepted. An error during formatting or a str message in another
576
encoding will be quitely noted as an error in the Bazaar log file.
578
The stream is not closed so sys.stdout or sys.stderr may be passed.
581
def __init__(self, stream, encoding=None, errors='strict', level=0):
582
logging.Handler.__init__(self, level)
585
encoding = getattr(stream, "encoding", "ascii")
586
self.encoding = encoding
590
flush = getattr(self.stream, "flush", None)
591
if flush is not None:
594
def emit(self, record):
596
line = self.format(record)
597
if not isinstance(line, unicode):
598
line = line.decode("utf-8")
599
self.stream.write(line.encode(self.encoding, self.errors) + "\n")
601
log_exception_quietly()
602
# Try saving the details that would have been logged in some form
603
msg = args = "<Unformattable>"
605
msg = repr(record.msg).encode("ascii")
606
args = repr(record.args).encode("ascii")
609
# Using mutter() bypasses the logging module and writes directly
610
# to the file so there's no danger of getting into a loop here.
611
mutter("Logging record unformattable: %s %% %s", msg, args)
587
614
class Config(object):
588
615
"""Configuration of message tracing in bzrlib.
added
removed
bzrlib/trace.py
