← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-09-01 17:29:56 UTC
  • mfrom: (1711.9.14 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060901172956-71246cfb9bf153f8
(vila) cleanup http changes

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
 
info = note = _bzr_logger.info
82
 
warning =   _bzr_logger.warning
 
77
def note(*args, **kwargs):
 
78
    # FIXME note always emits utf-8, regardless of the terminal encoding
 
79
    import bzrlib.ui
 
80
    bzrlib.ui.ui_factory.clear_term()
 
81
    _bzr_logger.info(*args, **kwargs)
 
82
 
 
83
def warning(*args, **kwargs):
 
84
    import bzrlib.ui
 
85
    bzrlib.ui.ui_factory.clear_term()
 
86
    _bzr_logger.warning(*args, **kwargs)
 
87
 
 
88
info = note
83
89
log_error = _bzr_logger.error
84
90
error =     _bzr_logger.error
85
91
 
89
95
        return
90
96
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
91
97
        return
 
98
 
 
99
    if isinstance(fmt, unicode):
 
100
        fmt = fmt.encode('utf8')
 
101
 
92
102
    if len(args) > 0:
93
 
        out = fmt % args
 
103
        # It seems that if we do ascii % (unicode, ascii) we can
 
104
        # get a unicode cannot encode ascii error, so make sure that "fmt"
 
105
        # is a unicode string
 
106
        real_args = []
 
107
        for arg in args:
 
108
            if isinstance(arg, unicode):
 
109
                arg = arg.encode('utf8')
 
110
            real_args.append(arg)
 
111
        out = fmt % tuple(real_args)
94
112
    else:
95
113
        out = fmt
96
114
    out += '\n'
97
115
    _trace_file.write(out)
 
116
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
117
    #_trace_file.flush()
98
118
debug = mutter
99
119
 
100
120
 
116
136
    # information if something goes wrong.  In a future version this
117
137
    # file will be removed on successful completion.
118
138
    global _file_handler, _bzr_log_file
119
 
    import stat, codecs
 
139
    import codecs
120
140
 
121
141
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
122
142
    _rollover_trace_maybe(trace_fname)
123
143
    try:
124
144
        LINE_BUFFERED = 1
125
 
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
145
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
146
        tf = open(trace_fname, 'at', LINE_BUFFERED)
126
147
        _bzr_log_file = tf
127
148
        if tf.tell() == 0:
128
149
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
138
159
        warning("failed to open trace file: %s" % (e))
139
160
 
140
161
 
141
 
def log_startup(argv):
142
 
    debug('\n\nbzr %s invoked on python %s (%s)',
143
 
          bzrlib.__version__,
144
 
          '.'.join(map(str, sys.version_info)),
145
 
          sys.platform)
146
 
    debug('  arguments: %r', argv)
147
 
    debug('  working dir: %r', os.getcwdu())
148
 
 
149
 
 
 
162
@deprecated_function(zero_nine)
150
163
def log_exception(msg=None):
151
164
    """Log the last exception to stderr and the trace file.
152
165
 
177
190
    # FIXME: if this is run twice, things get confused
178
191
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
179
192
    _stderr_handler = logging.StreamHandler()
180
 
    _stderr_handler.setFormatter(QuietFormatter())
181
193
    logging.getLogger('').addHandler(_stderr_handler)
182
194
    _stderr_handler.setLevel(logging.INFO)
183
195
    if not _file_handler:
185
197
    _trace_file = _bzr_log_file
186
198
    if _file_handler:
187
199
        _file_handler.setLevel(logging.DEBUG)
188
 
    _bzr_logger.setLevel(logging.DEBUG) 
189
 
 
 
200
    _bzr_logger.setLevel(logging.DEBUG)
190
201
 
191
202
 
192
203
def be_quiet(quiet=True):
219
230
 
220
231
 
221
232
def enable_test_log(to_file):
222
 
    """Redirect logging to a temporary file for a test"""
 
233
    """Redirect logging to a temporary file for a test
 
234
    
 
235
    returns an opaque reference that should be passed to disable_test_log
 
236
    after the test completes.
 
237
    """
223
238
    disable_default_logging()
224
 
    global _test_log_hdlr, _trace_file
 
239
    global _trace_file
 
240
    global _trace_depth
225
241
    hdlr = logging.StreamHandler(to_file)
226
242
    hdlr.setLevel(logging.DEBUG)
227
243
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
228
244
    _bzr_logger.addHandler(hdlr)
229
245
    _bzr_logger.setLevel(logging.DEBUG)
230
 
    _test_log_hdlr = hdlr
 
246
    result = hdlr, _trace_file, _trace_depth
231
247
    _trace_file = to_file
232
 
 
233
 
 
234
 
def disable_test_log():
235
 
    _bzr_logger.removeHandler(_test_log_hdlr)
236
 
    _trace_file = None
237
 
    enable_default_logging()
238
 
 
239
 
 
240
 
def format_exception_short(exc_info):
241
 
    """Make a short string form of an exception.
242
 
 
243
 
    This is used for display to stderr.  It specially handles exception
244
 
    classes without useful string methods.
245
 
 
246
 
    The result has no trailing newline.
247
 
 
248
 
    exc_info - typically an exception from sys.exc_info()
249
 
    """
250
 
    exc_type, exc_object, exc_tb = exc_info
251
 
    try:
252
 
        if exc_type is None:
253
 
            return '(no exception)'
254
 
        if isinstance(exc_object, (BzrError, BzrNewError)):
255
 
            return str(exc_object)
256
 
        else:
257
 
            import traceback
258
 
            tb = traceback.extract_tb(exc_tb)
259
 
            msg = '%s: %s' % (exc_type, exc_object)
260
 
            if msg[-1] == '\n':
261
 
                msg = msg[:-1]
262
 
            if tb:
263
 
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
264
 
            return msg
265
 
    except Exception, formatting_exc:
266
 
        # XXX: is this really better than just letting it run up?
267
 
        return '(error formatting exception of type %s: %s)' \
268
 
                % (exc_type, formatting_exc)
 
248
    _trace_depth += 1
 
249
    return result
 
250
 
 
251
 
 
252
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
253
    _bzr_logger.removeHandler(test_log_hdlr)
 
254
    test_log_hdlr.close()
 
255
    global _trace_file
 
256
    global _trace_depth
 
257
    _trace_file = old_trace_file
 
258
    _trace_depth = old_trace_depth
 
259
    if not _trace_depth:
 
260
        enable_default_logging()
 
261
 
 
262
 
 
263
def report_exception(exc_info, err_file):
 
264
    exc_type, exc_object, exc_tb = exc_info
 
265
    # Log the full traceback to ~/.bzr.log
 
266
    log_exception_quietly()
 
267
    if (isinstance(exc_object, IOError)
 
268
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
 
269
        print >>err_file, "bzr: broken pipe"
 
270
    elif isinstance(exc_object, KeyboardInterrupt):
 
271
        print >>err_file, "bzr: interrupted"
 
272
    elif getattr(exc_object, 'is_user_error', False):
 
273
        report_user_error(exc_info, err_file)
 
274
    elif isinstance(exc_object, (OSError, IOError)):
 
275
        # Might be nice to catch all of these and show them as something more
 
276
        # specific, but there are too many cases at the moment.
 
277
        report_user_error(exc_info, err_file)
 
278
    else:
 
279
        report_bug(exc_info, err_file)
 
280
 
 
281
 
 
282
# TODO: Should these be specially encoding the output?
 
283
def report_user_error(exc_info, err_file):
 
284
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
 
285
 
 
286
 
 
287
def report_bug(exc_info, err_file):
 
288
    """Report an exception that probably indicates a bug in bzr"""
 
289
    import traceback
 
290
    exc_type, exc_object, exc_tb = exc_info
 
291
    print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
 
292
    print >>err_file
 
293
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
294
    print >>err_file
 
295
    print >>err_file, 'bzr %s on python %s (%s)' % \
 
296
                       (bzrlib.__version__,
 
297
                        '.'.join(map(str, sys.version_info)),
 
298
                        sys.platform)
 
299
    print >>err_file, 'arguments: %r' % sys.argv
 
300
    print >>err_file
 
301
    print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"