/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

  • Committer: Martin Pool
  • Date: 2006-10-06 02:04:17 UTC
  • mfrom: (1908.10.1 bench_usecases.merge2)
  • mto: This revision was merged to the branch mainline in revision 2068.
  • Revision ID: mbp@sourcefrog.net-20061006020417-4949ca86f4417a4d
merge additional fix from cfbolz

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
 
57
import re
45
58
import logging
46
59
 
47
60
import bzrlib
48
61
from bzrlib.errors import BzrError, BzrNewError
49
 
 
 
62
from bzrlib.symbol_versioning import (deprecated_function,
 
63
        zero_nine,
 
64
        )
50
65
 
51
66
_file_handler = None
52
67
_stderr_handler = None
53
68
_stderr_quiet = False
54
69
_trace_file = None
 
70
_trace_depth = 0
55
71
_bzr_log_file = None
56
72
 
57
73
 
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
74
# configure convenient aliases for output routines
78
75
 
79
76
_bzr_logger = logging.getLogger('bzr')
80
77
 
81
78
def note(*args, **kwargs):
 
79
    # FIXME note always emits utf-8, regardless of the terminal encoding
82
80
    import bzrlib.ui
83
81
    bzrlib.ui.ui_factory.clear_term()
84
82
    _bzr_logger.info(*args, **kwargs)
96
94
def mutter(fmt, *args):
97
95
    if _trace_file is None:
98
96
        return
99
 
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
 
97
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
100
98
        return
 
99
 
 
100
    if isinstance(fmt, unicode):
 
101
        fmt = fmt.encode('utf8')
 
102
 
101
103
    if len(args) > 0:
102
 
        out = fmt % args
 
104
        # It seems that if we do ascii % (unicode, ascii) we can
 
105
        # get a unicode cannot encode ascii error, so make sure that "fmt"
 
106
        # is a unicode string
 
107
        real_args = []
 
108
        for arg in args:
 
109
            if isinstance(arg, unicode):
 
110
                arg = arg.encode('utf8')
 
111
            real_args.append(arg)
 
112
        out = fmt % tuple(real_args)
103
113
    else:
104
114
        out = fmt
105
115
    out += '\n'
106
116
    _trace_file.write(out)
 
117
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
118
    #_trace_file.flush()
107
119
debug = mutter
108
120
 
109
121
 
125
137
    # information if something goes wrong.  In a future version this
126
138
    # file will be removed on successful completion.
127
139
    global _file_handler, _bzr_log_file
128
 
    import stat, codecs
 
140
    import codecs
129
141
 
130
142
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
131
143
    _rollover_trace_maybe(trace_fname)
132
144
    try:
133
145
        LINE_BUFFERED = 1
134
 
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
146
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
147
        tf = open(trace_fname, 'at', LINE_BUFFERED)
135
148
        _bzr_log_file = tf
136
149
        if tf.tell() == 0:
137
150
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
147
160
        warning("failed to open trace file: %s" % (e))
148
161
 
149
162
 
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
 
 
 
163
@deprecated_function(zero_nine)
159
164
def log_exception(msg=None):
160
165
    """Log the last exception to stderr and the trace file.
161
166
 
164
169
    """
165
170
    if msg:
166
171
        error(msg)
167
 
    else:
168
 
        exc_str = format_exception_short(sys.exc_info())
169
 
        error(exc_str)
170
172
    log_exception_quietly()
171
173
 
172
174
 
186
188
    # FIXME: if this is run twice, things get confused
187
189
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
188
190
    _stderr_handler = logging.StreamHandler()
189
 
    _stderr_handler.setFormatter(QuietFormatter())
190
191
    logging.getLogger('').addHandler(_stderr_handler)
191
192
    _stderr_handler.setLevel(logging.INFO)
192
193
    if not _file_handler:
194
195
    _trace_file = _bzr_log_file
195
196
    if _file_handler:
196
197
        _file_handler.setLevel(logging.DEBUG)
197
 
    _bzr_logger.setLevel(logging.DEBUG) 
198
 
 
 
198
    _bzr_logger.setLevel(logging.DEBUG)
199
199
 
200
200
 
201
201
def be_quiet(quiet=True):
231
231
    """Redirect logging to a temporary file for a test
232
232
    
233
233
    returns an opaque reference that should be passed to disable_test_log
234
 
    after the test complete.
 
234
    after the test completes.
235
235
    """
236
236
    disable_default_logging()
237
237
    global _trace_file
 
238
    global _trace_depth
238
239
    hdlr = logging.StreamHandler(to_file)
239
240
    hdlr.setLevel(logging.DEBUG)
240
241
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
241
242
    _bzr_logger.addHandler(hdlr)
242
243
    _bzr_logger.setLevel(logging.DEBUG)
243
 
    result = hdlr, _trace_file
 
244
    result = hdlr, _trace_file, _trace_depth
244
245
    _trace_file = to_file
 
246
    _trace_depth += 1
245
247
    return result
246
248
 
247
249
 
248
 
def disable_test_log((test_log_hdlr, old_trace_file)):
 
250
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
249
251
    _bzr_logger.removeHandler(test_log_hdlr)
250
252
    test_log_hdlr.close()
 
253
    global _trace_file
 
254
    global _trace_depth
251
255
    _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)
 
256
    _trace_depth = old_trace_depth
 
257
    if not _trace_depth:
 
258
        enable_default_logging()
 
259
 
 
260
 
 
261
def report_exception(exc_info, err_file):
 
262
    exc_type, exc_object, exc_tb = exc_info
 
263
    # Log the full traceback to ~/.bzr.log
 
264
    log_exception_quietly()
 
265
    if (isinstance(exc_object, IOError)
 
266
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
 
267
        print >>err_file, "bzr: broken pipe"
 
268
    elif isinstance(exc_object, KeyboardInterrupt):
 
269
        print >>err_file, "bzr: interrupted"
 
270
    elif getattr(exc_object, 'is_user_error', False):
 
271
        report_user_error(exc_info, err_file)
 
272
    elif isinstance(exc_object, (OSError, IOError)):
 
273
        # Might be nice to catch all of these and show them as something more
 
274
        # specific, but there are too many cases at the moment.
 
275
        report_user_error(exc_info, err_file)
 
276
    else:
 
277
        report_bug(exc_info, err_file)
 
278
 
 
279
 
 
280
# TODO: Should these be specially encoding the output?
 
281
def report_user_error(exc_info, err_file):
 
282
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
 
283
 
 
284
 
 
285
def report_bug(exc_info, err_file):
 
286
    """Report an exception that probably indicates a bug in bzr"""
 
287
    import traceback
 
288
    exc_type, exc_object, exc_tb = exc_info
 
289
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
 
290
        exc_type.__module__, exc_type.__name__, exc_object)
 
291
    print >>err_file
 
292
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
293
    print >>err_file
 
294
    print >>err_file, 'bzr %s on python %s (%s)' % \
 
295
                       (bzrlib.__version__,
 
296
                        '.'.join(map(str, sys.version_info)),
 
297
                        sys.platform)
 
298
    print >>err_file, 'arguments: %r' % sys.argv
 
299
    print >>err_file
 
300
    print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"