~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

Emit warning to trace file only if using cElementTree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
1
# Copyright (C) 2005, Canonical Ltd
16
2
 
17
3
"""Messages and logging for bazaar-ng.
18
4
 
41
27
 
42
28
Exceptions are reported in a brief form to stderr so as not to look scary.
43
29
BzrErrors are required to be able to format themselves into a properly
44
 
explanatory message.  This is not true for builtin exceptions such as
 
30
explanatory message.  This is not true for builtin excexceptions such as
45
31
KeyError, which typically just str to "0".  They're printed in a different
46
32
form.
47
33
"""
48
34
 
 
35
# TODO: in debug mode, stderr should get full tracebacks and also
 
36
# debug messages.  (Is this really needed?)
 
37
 
49
38
# FIXME: Unfortunately it turns out that python's logging module
50
39
# is quite expensive, even when the message is not printed by any handlers.
51
40
# We should perhaps change back to just simply doing it here.
52
41
 
 
42
 
 
43
import sys
53
44
import os
54
 
import sys
55
 
import re
56
 
 
57
 
from bzrlib.lazy_import import lazy_import
58
 
lazy_import(globals(), """
59
 
import errno
60
45
import logging
61
 
""")
62
46
 
63
47
import bzrlib
64
 
from bzrlib.symbol_versioning import (deprecated_function,
65
 
        zero_nine,
66
 
        )
 
48
from bzrlib.errors import BzrError, BzrNewError
67
49
 
68
 
lazy_import(globals(), """
69
 
from bzrlib import debug
70
 
""")
71
50
 
72
51
_file_handler = None
73
52
_stderr_handler = None
74
53
_stderr_quiet = False
75
54
_trace_file = None
76
 
_trace_depth = 0
77
55
_bzr_log_file = None
78
56
 
79
 
 
 
57
class QuietFormatter(logging.Formatter):
 
58
    """Formatter that supresses the details of errors.
 
59
 
 
60
    This is used by default on stderr so as not to scare the user.
 
61
    """
 
62
    # At first I tried overriding formatException to suppress the
 
63
    # exception details, but that has global effect: no loggers
 
64
    # can get the exception details is we suppress them here.
 
65
 
 
66
    def format(self, record):
 
67
        if record.levelno >= logging.WARNING:
 
68
            s = 'bzr: ' + record.levelname + ': '
 
69
        else:
 
70
            s = ''
 
71
        s += record.getMessage()
 
72
        if record.exc_info:
 
73
            s += '\n' + format_exception_short(record.exc_info)
 
74
        return s
 
75
        
80
76
# configure convenient aliases for output routines
81
77
 
82
78
_bzr_logger = logging.getLogger('bzr')
83
79
 
84
 
def note(*args, **kwargs):
85
 
    # FIXME note always emits utf-8, regardless of the terminal encoding
86
 
    import bzrlib.ui
87
 
    bzrlib.ui.ui_factory.clear_term()
88
 
    _bzr_logger.info(*args, **kwargs)
89
 
 
90
 
def warning(*args, **kwargs):
91
 
    import bzrlib.ui
92
 
    bzrlib.ui.ui_factory.clear_term()
93
 
    _bzr_logger.warning(*args, **kwargs)
94
 
 
95
 
info = note
 
80
info = note = _bzr_logger.info
 
81
warning =   _bzr_logger.warning
96
82
log_error = _bzr_logger.error
97
83
error =     _bzr_logger.error
98
84
 
100
86
def mutter(fmt, *args):
101
87
    if _trace_file is None:
102
88
        return
103
 
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
 
89
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
104
90
        return
105
 
 
106
 
    if isinstance(fmt, unicode):
107
 
        fmt = fmt.encode('utf8')
108
 
 
109
91
    if len(args) > 0:
110
 
        # It seems that if we do ascii % (unicode, ascii) we can
111
 
        # get a unicode cannot encode ascii error, so make sure that "fmt"
112
 
        # is a unicode string
113
 
        real_args = []
114
 
        for arg in args:
115
 
            if isinstance(arg, unicode):
116
 
                arg = arg.encode('utf8')
117
 
            real_args.append(arg)
118
 
        out = fmt % tuple(real_args)
 
92
        out = fmt % args
119
93
    else:
120
94
        out = fmt
121
95
    out += '\n'
 
96
    if isinstance(out, unicode):
 
97
        out = out.encode('utf-8')
122
98
    _trace_file.write(out)
123
 
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
124
 
    #_trace_file.flush()
 
99
debug = mutter
125
100
 
126
101
 
127
102
def _rollover_trace_maybe(trace_fname):
137
112
        return
138
113
 
139
114
 
140
 
def open_tracefile(tracefilename=None):
 
115
def open_tracefile(tracefilename='~/.bzr.log'):
141
116
    # Messages are always written to here, so that we have some
142
117
    # information if something goes wrong.  In a future version this
143
118
    # file will be removed on successful completion.
144
119
    global _file_handler, _bzr_log_file
145
 
    import codecs
146
 
 
147
 
    if tracefilename is None:
148
 
        if sys.platform == 'win32':
149
 
            from bzrlib import win32utils
150
 
            home = win32utils.get_home_location()
151
 
        else:
152
 
            home = os.path.expanduser('~')
153
 
        tracefilename = os.path.join(home, '.bzr.log')
154
 
 
155
 
    trace_fname = os.path.expanduser(tracefilename)
 
120
    import stat, codecs
 
121
 
 
122
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
156
123
    _rollover_trace_maybe(trace_fname)
157
124
    try:
158
125
        LINE_BUFFERED = 1
159
 
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
160
 
        tf = open(trace_fname, 'at', LINE_BUFFERED)
 
126
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
161
127
        _bzr_log_file = tf
162
 
        # tf.tell() on windows always return 0 until some writing done
163
 
        tf.write('\n')
164
 
        if tf.tell() <= 2:
165
 
            tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
 
128
        if tf.tell() == 0:
 
129
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
166
130
            tf.write("you can delete or truncate this file, or include sections in\n")
167
 
            tf.write("bug reports to bazaar@lists.canonical.com\n\n")
 
131
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
168
132
        _file_handler = logging.StreamHandler(tf)
169
133
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
170
134
        datefmt = r'%a %H:%M:%S'
175
139
        warning("failed to open trace file: %s" % (e))
176
140
 
177
141
 
178
 
@deprecated_function(zero_nine)
 
142
def log_startup(argv):
 
143
    debug('\n\nbzr %s invoked on python %s (%s)',
 
144
          bzrlib.__version__,
 
145
          '.'.join(map(str, sys.version_info)),
 
146
          sys.platform)
 
147
    debug('  arguments: %r', argv)
 
148
    debug('  working dir: %r', os.getcwdu())
 
149
 
 
150
 
179
151
def log_exception(msg=None):
180
152
    """Log the last exception to stderr and the trace file.
181
153
 
182
154
    The exception string representation is used as the error
183
155
    summary, unless msg is given.
184
 
 
185
 
    Please see log_exception_quietly() for the replacement API.
186
156
    """
187
157
    if msg:
188
158
        error(msg)
 
159
    else:
 
160
        exc_str = format_exception_short(sys.exc_info())
 
161
        error(exc_str)
189
162
    log_exception_quietly()
190
163
 
191
164
 
197
170
    errors loading plugins.
198
171
    """
199
172
    import traceback
200
 
    mutter(traceback.format_exc())
 
173
    debug(traceback.format_exc())
201
174
 
202
175
 
203
176
def enable_default_logging():
205
178
    # FIXME: if this is run twice, things get confused
206
179
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
207
180
    _stderr_handler = logging.StreamHandler()
 
181
    _stderr_handler.setFormatter(QuietFormatter())
208
182
    logging.getLogger('').addHandler(_stderr_handler)
209
183
    _stderr_handler.setLevel(logging.INFO)
210
184
    if not _file_handler:
212
186
    _trace_file = _bzr_log_file
213
187
    if _file_handler:
214
188
        _file_handler.setLevel(logging.DEBUG)
215
 
    _bzr_logger.setLevel(logging.DEBUG)
 
189
    _bzr_logger.setLevel(logging.DEBUG) 
 
190
 
216
191
 
217
192
 
218
193
def be_quiet(quiet=True):
245
220
 
246
221
 
247
222
def enable_test_log(to_file):
248
 
    """Redirect logging to a temporary file for a test
249
 
    
250
 
    returns an opaque reference that should be passed to disable_test_log
251
 
    after the test completes.
252
 
    """
 
223
    """Redirect logging to a temporary file for a test"""
253
224
    disable_default_logging()
254
 
    global _trace_file
255
 
    global _trace_depth
 
225
    global _test_log_hdlr, _trace_file
256
226
    hdlr = logging.StreamHandler(to_file)
257
227
    hdlr.setLevel(logging.DEBUG)
258
228
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
259
229
    _bzr_logger.addHandler(hdlr)
260
230
    _bzr_logger.setLevel(logging.DEBUG)
261
 
    result = hdlr, _trace_file, _trace_depth
 
231
    _test_log_hdlr = hdlr
262
232
    _trace_file = to_file
263
 
    _trace_depth += 1
264
 
    return result
265
 
 
266
 
 
267
 
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
268
 
    _bzr_logger.removeHandler(test_log_hdlr)
269
 
    test_log_hdlr.close()
270
 
    global _trace_file
271
 
    global _trace_depth
272
 
    _trace_file = old_trace_file
273
 
    _trace_depth = old_trace_depth
274
 
    if not _trace_depth:
275
 
        enable_default_logging()
276
 
 
277
 
 
278
 
def report_exception(exc_info, err_file):
279
 
    exc_type, exc_object, exc_tb = exc_info
280
 
    # Log the full traceback to ~/.bzr.log
281
 
    log_exception_quietly()
282
 
    if (isinstance(exc_object, IOError)
283
 
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
284
 
        print >>err_file, "bzr: broken pipe"
285
 
    elif isinstance(exc_object, KeyboardInterrupt):
286
 
        print >>err_file, "bzr: interrupted"
287
 
    elif not getattr(exc_object, 'internal_error', True):
288
 
        report_user_error(exc_info, err_file)
289
 
    elif isinstance(exc_object, (OSError, IOError)):
290
 
        # Might be nice to catch all of these and show them as something more
291
 
        # specific, but there are too many cases at the moment.
292
 
        report_user_error(exc_info, err_file)
293
 
    else:
294
 
        report_bug(exc_info, err_file)
295
 
 
296
 
 
297
 
# TODO: Should these be specially encoding the output?
298
 
def report_user_error(exc_info, err_file):
299
 
    """Report to err_file an error that's not an internal error.
300
 
 
301
 
    These don't get a traceback unless -Derror was given.
 
233
 
 
234
 
 
235
def disable_test_log():
 
236
    _bzr_logger.removeHandler(_test_log_hdlr)
 
237
    _trace_file = None
 
238
    enable_default_logging()
 
239
 
 
240
 
 
241
def format_exception_short(exc_info):
 
242
    """Make a short string form of an exception.
 
243
 
 
244
    This is used for display to stderr.  It specially handles exception
 
245
    classes without useful string methods.
 
246
 
 
247
    The result has no trailing newline.
 
248
 
 
249
    exc_info - typically an exception from sys.exc_info()
302
250
    """
303
 
    if 'error' in debug.debug_flags:
304
 
        report_bug(exc_info, err_file)
305
 
        return
306
 
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
307
 
 
308
 
 
309
 
def report_bug(exc_info, err_file):
310
 
    """Report an exception that probably indicates a bug in bzr"""
311
 
    import traceback
312
251
    exc_type, exc_object, exc_tb = exc_info
313
 
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
314
 
        exc_type.__module__, exc_type.__name__, exc_object)
315
 
    print >>err_file
316
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
317
 
    print >>err_file
318
 
    print >>err_file, 'bzr %s on python %s (%s)' % \
319
 
                       (bzrlib.__version__,
320
 
                        '.'.join(map(str, sys.version_info)),
321
 
                        sys.platform)
322
 
    print >>err_file, 'arguments: %r' % sys.argv
323
 
    print >>err_file
324
 
    print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
 
252
    try:
 
253
        if exc_type is None:
 
254
            return '(no exception)'
 
255
        if isinstance(exc_object, (BzrError, BzrNewError)):
 
256
            return str(exc_object)
 
257
        else:
 
258
            import traceback
 
259
            tb = traceback.extract_tb(exc_tb)
 
260
            msg = '%s: %s' % (exc_type, exc_object)
 
261
            if msg[-1] == '\n':
 
262
                msg = msg[:-1]
 
263
            if tb:
 
264
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
 
265
            return msg
 
266
    except Exception, formatting_exc:
 
267
        # XXX: is this really better than just letting it run up?
 
268
        return '(error formatting exception of type %s: %s)' \
 
269
                % (exc_type, formatting_exc)