← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

Bugfix the symbol_versioning deprecation decorators to update the
__module__ attribute of methods and functions. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
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
 
_bzr_log_filename = None
79
 
 
80
 
 
 
56
 
 
57
 
 
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
        
81
77
# configure convenient aliases for output routines
82
78
 
83
79
_bzr_logger = logging.getLogger('bzr')
84
80
 
85
 
def note(*args, **kwargs):
86
 
    # FIXME note always emits utf-8, regardless of the terminal encoding
87
 
    import bzrlib.ui
88
 
    bzrlib.ui.ui_factory.clear_term()
89
 
    _bzr_logger.info(*args, **kwargs)
90
 
 
91
 
def warning(*args, **kwargs):
92
 
    import bzrlib.ui
93
 
    bzrlib.ui.ui_factory.clear_term()
94
 
    _bzr_logger.warning(*args, **kwargs)
95
 
 
96
 
info = note
 
81
info = note = _bzr_logger.info
 
82
warning =   _bzr_logger.warning
97
83
log_error = _bzr_logger.error
98
84
error =     _bzr_logger.error
99
85
 
101
87
def mutter(fmt, *args):
102
88
    if _trace_file is None:
103
89
        return
104
 
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
 
90
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
105
91
        return
106
 
 
107
 
    if isinstance(fmt, unicode):
108
 
        fmt = fmt.encode('utf8')
109
 
 
110
92
    if len(args) > 0:
111
 
        # It seems that if we do ascii % (unicode, ascii) we can
112
 
        # get a unicode cannot encode ascii error, so make sure that "fmt"
113
 
        # is a unicode string
114
 
        real_args = []
115
 
        for arg in args:
116
 
            if isinstance(arg, unicode):
117
 
                arg = arg.encode('utf8')
118
 
            real_args.append(arg)
119
 
        out = fmt % tuple(real_args)
 
93
        out = fmt % args
120
94
    else:
121
95
        out = fmt
122
96
    out += '\n'
123
97
    _trace_file.write(out)
124
 
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
125
 
    #_trace_file.flush()
 
98
debug = mutter
126
99
 
127
100
 
128
101
def _rollover_trace_maybe(trace_fname):
138
111
        return
139
112
 
140
113
 
141
 
def open_tracefile(tracefilename=None):
 
114
def open_tracefile(tracefilename='~/.bzr.log'):
142
115
    # Messages are always written to here, so that we have some
143
116
    # information if something goes wrong.  In a future version this
144
117
    # file will be removed on successful completion.
145
 
    global _file_handler, _bzr_log_file, _bzr_log_filename
146
 
    import codecs
147
 
 
148
 
    if tracefilename is None:
149
 
        if sys.platform == 'win32':
150
 
            from bzrlib import win32utils
151
 
            home = win32utils.get_home_location()
152
 
        else:
153
 
            home = os.path.expanduser('~')
154
 
        _bzr_log_filename = os.path.join(home, '.bzr.log')
155
 
 
156
 
    _bzr_log_filename = os.path.expanduser(_bzr_log_filename)
157
 
    _rollover_trace_maybe(_bzr_log_filename)
 
118
    global _file_handler, _bzr_log_file
 
119
    import stat, codecs
 
120
 
 
121
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
 
122
    _rollover_trace_maybe(trace_fname)
158
123
    try:
159
124
        LINE_BUFFERED = 1
160
 
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
161
 
        tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
 
125
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
162
126
        _bzr_log_file = tf
163
 
        # tf.tell() on windows always return 0 until some writing done
164
 
        tf.write('\n')
165
 
        if tf.tell() <= 2:
166
 
            tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
 
127
        if tf.tell() == 0:
 
128
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
167
129
            tf.write("you can delete or truncate this file, or include sections in\n")
168
 
            tf.write("bug reports to bazaar@lists.canonical.com\n\n")
 
130
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
169
131
        _file_handler = logging.StreamHandler(tf)
170
132
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
171
133
        datefmt = r'%a %H:%M:%S'
176
138
        warning("failed to open trace file: %s" % (e))
177
139
 
178
140
 
179
 
@deprecated_function(zero_nine)
 
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
 
180
150
def log_exception(msg=None):
181
151
    """Log the last exception to stderr and the trace file.
182
152
 
183
153
    The exception string representation is used as the error
184
154
    summary, unless msg is given.
185
 
 
186
 
    Please see log_exception_quietly() for the replacement API.
187
155
    """
188
156
    if msg:
189
157
        error(msg)
 
158
    else:
 
159
        exc_str = format_exception_short(sys.exc_info())
 
160
        error(exc_str)
190
161
    log_exception_quietly()
191
162
 
192
163
 
198
169
    errors loading plugins.
199
170
    """
200
171
    import traceback
201
 
    mutter(traceback.format_exc())
 
172
    debug(traceback.format_exc())
202
173
 
203
174
 
204
175
def enable_default_logging():
206
177
    # FIXME: if this is run twice, things get confused
207
178
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
208
179
    _stderr_handler = logging.StreamHandler()
 
180
    _stderr_handler.setFormatter(QuietFormatter())
209
181
    logging.getLogger('').addHandler(_stderr_handler)
210
182
    _stderr_handler.setLevel(logging.INFO)
211
183
    if not _file_handler:
213
185
    _trace_file = _bzr_log_file
214
186
    if _file_handler:
215
187
        _file_handler.setLevel(logging.DEBUG)
216
 
    _bzr_logger.setLevel(logging.DEBUG)
 
188
    _bzr_logger.setLevel(logging.DEBUG) 
 
189
 
217
190
 
218
191
 
219
192
def be_quiet(quiet=True):
246
219
 
247
220
 
248
221
def enable_test_log(to_file):
249
 
    """Redirect logging to a temporary file for a test
250
 
    
251
 
    returns an opaque reference that should be passed to disable_test_log
252
 
    after the test completes.
253
 
    """
 
222
    """Redirect logging to a temporary file for a test"""
254
223
    disable_default_logging()
255
 
    global _trace_file
256
 
    global _trace_depth
 
224
    global _test_log_hdlr, _trace_file
257
225
    hdlr = logging.StreamHandler(to_file)
258
226
    hdlr.setLevel(logging.DEBUG)
259
227
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
260
228
    _bzr_logger.addHandler(hdlr)
261
229
    _bzr_logger.setLevel(logging.DEBUG)
262
 
    result = hdlr, _trace_file, _trace_depth
 
230
    _test_log_hdlr = hdlr
263
231
    _trace_file = to_file
264
 
    _trace_depth += 1
265
 
    return result
266
 
 
267
 
 
268
 
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
269
 
    _bzr_logger.removeHandler(test_log_hdlr)
270
 
    test_log_hdlr.close()
271
 
    global _trace_file
272
 
    global _trace_depth
273
 
    _trace_file = old_trace_file
274
 
    _trace_depth = old_trace_depth
275
 
    if not _trace_depth:
276
 
        enable_default_logging()
277
 
 
278
 
 
279
 
def report_exception(exc_info, err_file):
280
 
    exc_type, exc_object, exc_tb = exc_info
281
 
    # Log the full traceback to ~/.bzr.log
282
 
    log_exception_quietly()
283
 
    if (isinstance(exc_object, IOError)
284
 
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
285
 
        print >>err_file, "bzr: broken pipe"
286
 
    elif isinstance(exc_object, KeyboardInterrupt):
287
 
        print >>err_file, "bzr: interrupted"
288
 
    elif not getattr(exc_object, 'internal_error', True):
289
 
        report_user_error(exc_info, err_file)
290
 
    elif isinstance(exc_object, (OSError, IOError)):
291
 
        # Might be nice to catch all of these and show them as something more
292
 
        # specific, but there are too many cases at the moment.
293
 
        report_user_error(exc_info, err_file)
294
 
    else:
295
 
        report_bug(exc_info, err_file)
296
 
 
297
 
 
298
 
# TODO: Should these be specially encoding the output?
299
 
def report_user_error(exc_info, err_file):
300
 
    """Report to err_file an error that's not an internal error.
301
 
 
302
 
    These don't get a traceback unless -Derror was given.
 
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()
303
249
    """
304
 
    if 'error' in debug.debug_flags:
305
 
        report_bug(exc_info, err_file)
306
 
        return
307
 
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
308
 
 
309
 
 
310
 
def report_bug(exc_info, err_file):
311
 
    """Report an exception that probably indicates a bug in bzr"""
312
 
    import traceback
313
250
    exc_type, exc_object, exc_tb = exc_info
314
 
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
315
 
        exc_type.__module__, exc_type.__name__, exc_object)
316
 
    print >>err_file
317
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
318
 
    print >>err_file
319
 
    print >>err_file, 'bzr %s on python %s (%s)' % \
320
 
                       (bzrlib.__version__,
321
 
                        '.'.join(map(str, sys.version_info)),
322
 
                        sys.platform)
323
 
    print >>err_file, 'arguments: %r' % sys.argv
324
 
    print >>err_file
325
 
    print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
 
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)