/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005, Canonical Ltd
 
1
# Copyright (C) 2005, 2006 by 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
2
16
 
3
17
"""Messages and logging for bazaar-ng.
4
18
 
27
41
 
28
42
Exceptions are reported in a brief form to stderr so as not to look scary.
29
43
BzrErrors are required to be able to format themselves into a properly
30
 
explanatory message.  This is not true for builtin excexceptions such as
 
44
explanatory message.  This is not true for builtin exceptions such as
31
45
KeyError, which typically just str to "0".  They're printed in a different
32
46
form.
33
47
"""
34
48
 
35
 
# TODO: in debug mode, stderr should get full tracebacks and also
36
 
# debug messages.  (Is this really needed?)
37
 
 
38
49
# FIXME: Unfortunately it turns out that python's logging module
39
50
# is quite expensive, even when the message is not printed by any handlers.
40
51
# We should perhaps change back to just simply doing it here.
41
52
 
42
53
 
 
54
import errno
 
55
import os
43
56
import sys
44
 
import os
45
57
import logging
46
58
 
47
59
import bzrlib
48
60
from bzrlib.errors import BzrError, BzrNewError
49
 
 
 
61
from bzrlib.symbol_versioning import (deprecated_function,
 
62
        zero_nine,
 
63
        )
50
64
 
51
65
_file_handler = None
52
66
_stderr_handler = None
53
67
_stderr_quiet = False
54
68
_trace_file = None
 
69
_trace_depth = 0
55
70
_bzr_log_file = None
56
71
 
57
72
 
58
 
class QuietFormatter(logging.Formatter):
59
 
    """Formatter that supresses the details of errors.
60
 
 
61
 
    This is used by default on stderr so as not to scare the user.
62
 
    """
63
 
    # At first I tried overriding formatException to suppress the
64
 
    # exception details, but that has global effect: no loggers
65
 
    # can get the exception details is we suppress them here.
66
 
 
67
 
    def format(self, record):
68
 
        if record.levelno >= logging.WARNING:
69
 
            s = 'bzr: ' + record.levelname + ': '
70
 
        else:
71
 
            s = ''
72
 
        s += record.getMessage()
73
 
        if record.exc_info:
74
 
            s += '\n' + format_exception_short(record.exc_info)
75
 
        return s
76
 
        
77
73
# configure convenient aliases for output routines
78
74
 
79
75
_bzr_logger = logging.getLogger('bzr')
80
76
 
81
77
def note(*args, **kwargs):
 
78
    # FIXME note always emits utf-8, regardless of the terminal encoding
82
79
    import bzrlib.ui
83
80
    bzrlib.ui.ui_factory.clear_term()
84
81
    _bzr_logger.info(*args, **kwargs)
99
96
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
100
97
        return
101
98
    if len(args) > 0:
102
 
        out = fmt % args
 
99
        # It seems that if we do ascii % (unicode, ascii) we can
 
100
        # get a unicode cannot encode ascii error, so make sure that "fmt"
 
101
        # is a unicode string
 
102
        out = unicode(fmt) % args
103
103
    else:
104
104
        out = fmt
105
105
    out += '\n'
106
 
    _trace_file.write(out)
 
106
    try:
 
107
        _trace_file.write(out)
 
108
    except UnicodeError, e:
 
109
        warning('UnicodeError: %s', e)
 
110
        _trace_file.write(repr(out))
 
111
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
112
    #_trace_file.flush()
107
113
debug = mutter
108
114
 
109
115
 
125
131
    # information if something goes wrong.  In a future version this
126
132
    # file will be removed on successful completion.
127
133
    global _file_handler, _bzr_log_file
128
 
    import stat, codecs
 
134
    import codecs
129
135
 
130
136
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
131
137
    _rollover_trace_maybe(trace_fname)
147
153
        warning("failed to open trace file: %s" % (e))
148
154
 
149
155
 
150
 
def log_startup(argv):
151
 
    debug('\n\nbzr %s invoked on python %s (%s)',
152
 
          bzrlib.__version__,
153
 
          '.'.join(map(str, sys.version_info)),
154
 
          sys.platform)
155
 
    debug('  arguments: %r', argv)
156
 
    debug('  working dir: %r', os.getcwdu())
157
 
 
158
 
 
 
156
@deprecated_function(zero_nine)
159
157
def log_exception(msg=None):
160
158
    """Log the last exception to stderr and the trace file.
161
159
 
186
184
    # FIXME: if this is run twice, things get confused
187
185
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
188
186
    _stderr_handler = logging.StreamHandler()
189
 
    _stderr_handler.setFormatter(QuietFormatter())
190
187
    logging.getLogger('').addHandler(_stderr_handler)
191
188
    _stderr_handler.setLevel(logging.INFO)
192
189
    if not _file_handler:
194
191
    _trace_file = _bzr_log_file
195
192
    if _file_handler:
196
193
        _file_handler.setLevel(logging.DEBUG)
197
 
    _bzr_logger.setLevel(logging.DEBUG) 
198
 
 
 
194
    _bzr_logger.setLevel(logging.DEBUG)
199
195
 
200
196
 
201
197
def be_quiet(quiet=True):
231
227
    """Redirect logging to a temporary file for a test
232
228
    
233
229
    returns an opaque reference that should be passed to disable_test_log
234
 
    after the test complete.
 
230
    after the test completes.
235
231
    """
236
232
    disable_default_logging()
237
233
    global _trace_file
 
234
    global _trace_depth
238
235
    hdlr = logging.StreamHandler(to_file)
239
236
    hdlr.setLevel(logging.DEBUG)
240
237
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
241
238
    _bzr_logger.addHandler(hdlr)
242
239
    _bzr_logger.setLevel(logging.DEBUG)
243
 
    result = hdlr, _trace_file
 
240
    result = hdlr, _trace_file, _trace_depth
244
241
    _trace_file = to_file
 
242
    _trace_depth += 1
245
243
    return result
246
244
 
247
245
 
248
 
def disable_test_log((test_log_hdlr, old_trace_file)):
 
246
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
249
247
    _bzr_logger.removeHandler(test_log_hdlr)
250
248
    test_log_hdlr.close()
 
249
    global _trace_file
 
250
    global _trace_depth
251
251
    _trace_file = old_trace_file
252
 
    enable_default_logging()
253
 
 
254
 
 
255
 
def format_exception_short(exc_info):
256
 
    """Make a short string form of an exception.
257
 
 
258
 
    This is used for display to stderr.  It specially handles exception
259
 
    classes without useful string methods.
260
 
 
261
 
    The result has no trailing newline.
262
 
 
263
 
    exc_info - typically an exception from sys.exc_info()
264
 
    """
265
 
    exc_type, exc_object, exc_tb = exc_info
266
 
    try:
267
 
        if exc_type is None:
268
 
            return '(no exception)'
269
 
        if isinstance(exc_object, (BzrError, BzrNewError)):
270
 
            return str(exc_object)
271
 
        else:
272
 
            import traceback
273
 
            tb = traceback.extract_tb(exc_tb)
274
 
            msg = '%s: %s' % (exc_type, exc_object)
275
 
            if msg[-1] == '\n':
276
 
                msg = msg[:-1]
277
 
            if tb:
278
 
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
279
 
            return msg
280
 
    except Exception, formatting_exc:
281
 
        # XXX: is this really better than just letting it run up?
282
 
        return '(error formatting exception of type %s: %s)' \
283
 
                % (exc_type, formatting_exc)
 
252
    _trace_depth = old_trace_depth
 
253
    if not _trace_depth:
 
254
        enable_default_logging()
 
255
 
 
256
 
 
257
def report_exception(exc_info, err_file):
 
258
    exc_type, exc_object, exc_tb = exc_info
 
259
    # Log the full traceback to ~/.bzr.log
 
260
    log_exception_quietly()
 
261
    if (isinstance(exc_object, IOError)
 
262
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
 
263
        print >>err_file, "bzr: broken pipe"
 
264
    elif isinstance(exc_object, KeyboardInterrupt):
 
265
        print >>err_file, "bzr: interrupted"
 
266
    elif getattr(exc_object, 'is_user_error', False):
 
267
        report_user_error(exc_info, err_file)
 
268
    elif isinstance(exc_object, (OSError, IOError)):
 
269
        # Might be nice to catch all of these and show them as something more
 
270
        # specific, but there are too many cases at the moment.
 
271
        report_user_error(exc_info, err_file)
 
272
    else:
 
273
        report_bug(exc_info, err_file)
 
274
 
 
275
 
 
276
# TODO: Should these be specially encoding the output?
 
277
def report_user_error(exc_info, err_file):
 
278
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
 
279
 
 
280
 
 
281
def report_bug(exc_info, err_file):
 
282
    """Report an exception that probably indicates a bug in bzr"""
 
283
    import traceback
 
284
    exc_type, exc_object, exc_tb = exc_info
 
285
    print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
 
286
    print >>err_file
 
287
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
288
    print >>err_file
 
289
    print >>err_file, 'bzr %s on python %s (%s)' % \
 
290
                       (bzrlib.__version__,
 
291
                        '.'.join(map(str, sys.version_info)),
 
292
                        sys.platform)
 
293
    print >>err_file, 'arguments: %r' % sys.argv
 
294
    print >>err_file
 
295
    print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"