/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: Robert Collins
  • Date: 2007-04-19 05:21:37 UTC
  • mto: (2425.1.2 integration)
  • mto: This revision was merged to the branch mainline in revision 2427.
  • Revision ID: robertc@robertcollins.net-20070419052137-vsncwlmi8epl5eel
Update existing builtin commands help text to use _see_also. (Robert Collins)

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 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
import os
43
54
import sys
44
 
import os
 
55
import re
 
56
 
 
57
from bzrlib.lazy_import import lazy_import
 
58
lazy_import(globals(), """
 
59
import errno
45
60
import logging
 
61
""")
46
62
 
47
63
import bzrlib
48
 
from bzrlib.errors import BzrError, BzrNewError
 
64
from bzrlib.symbol_versioning import (deprecated_function,
 
65
        zero_nine,
 
66
        )
49
67
 
 
68
lazy_import(globals(), """
 
69
from bzrlib import debug
 
70
""")
50
71
 
51
72
_file_handler = None
52
73
_stderr_handler = None
53
74
_stderr_quiet = False
54
75
_trace_file = None
 
76
_trace_depth = 0
55
77
_bzr_log_file = None
56
78
 
57
79
 
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
80
# configure convenient aliases for output routines
78
81
 
79
82
_bzr_logger = logging.getLogger('bzr')
80
83
 
81
84
def note(*args, **kwargs):
 
85
    # FIXME note always emits utf-8, regardless of the terminal encoding
82
86
    import bzrlib.ui
83
87
    bzrlib.ui.ui_factory.clear_term()
84
88
    _bzr_logger.info(*args, **kwargs)
96
100
def mutter(fmt, *args):
97
101
    if _trace_file is None:
98
102
        return
99
 
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
 
103
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
100
104
        return
 
105
 
 
106
    if isinstance(fmt, unicode):
 
107
        fmt = fmt.encode('utf8')
 
108
 
101
109
    if len(args) > 0:
102
 
        out = fmt % args
 
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)
103
119
    else:
104
120
        out = fmt
105
121
    out += '\n'
106
122
    _trace_file.write(out)
107
 
debug = mutter
 
123
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
124
    #_trace_file.flush()
108
125
 
109
126
 
110
127
def _rollover_trace_maybe(trace_fname):
120
137
        return
121
138
 
122
139
 
123
 
def open_tracefile(tracefilename='~/.bzr.log'):
 
140
def open_tracefile(tracefilename=None):
124
141
    # Messages are always written to here, so that we have some
125
142
    # information if something goes wrong.  In a future version this
126
143
    # file will be removed on successful completion.
127
144
    global _file_handler, _bzr_log_file
128
 
    import stat, codecs
129
 
 
130
 
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
 
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)
131
156
    _rollover_trace_maybe(trace_fname)
132
157
    try:
133
158
        LINE_BUFFERED = 1
134
 
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
159
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
160
        tf = open(trace_fname, 'at', LINE_BUFFERED)
135
161
        _bzr_log_file = tf
136
 
        if tf.tell() == 0:
137
 
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
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")
138
166
            tf.write("you can delete or truncate this file, or include sections in\n")
139
 
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
167
            tf.write("bug reports to bazaar@lists.canonical.com\n\n")
140
168
        _file_handler = logging.StreamHandler(tf)
141
169
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
142
170
        datefmt = r'%a %H:%M:%S'
147
175
        warning("failed to open trace file: %s" % (e))
148
176
 
149
177
 
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
 
 
 
178
@deprecated_function(zero_nine)
159
179
def log_exception(msg=None):
160
180
    """Log the last exception to stderr and the trace file.
161
181
 
162
182
    The exception string representation is used as the error
163
183
    summary, unless msg is given.
 
184
 
 
185
    Please see log_exception_quietly() for the replacement API.
164
186
    """
165
187
    if msg:
166
188
        error(msg)
167
 
    else:
168
 
        exc_str = format_exception_short(sys.exc_info())
169
 
        error(exc_str)
170
189
    log_exception_quietly()
171
190
 
172
191
 
178
197
    errors loading plugins.
179
198
    """
180
199
    import traceback
181
 
    debug(traceback.format_exc())
 
200
    mutter(traceback.format_exc())
182
201
 
183
202
 
184
203
def enable_default_logging():
186
205
    # FIXME: if this is run twice, things get confused
187
206
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
188
207
    _stderr_handler = logging.StreamHandler()
189
 
    _stderr_handler.setFormatter(QuietFormatter())
190
208
    logging.getLogger('').addHandler(_stderr_handler)
191
209
    _stderr_handler.setLevel(logging.INFO)
192
210
    if not _file_handler:
194
212
    _trace_file = _bzr_log_file
195
213
    if _file_handler:
196
214
        _file_handler.setLevel(logging.DEBUG)
197
 
    _bzr_logger.setLevel(logging.DEBUG) 
198
 
 
 
215
    _bzr_logger.setLevel(logging.DEBUG)
199
216
 
200
217
 
201
218
def be_quiet(quiet=True):
231
248
    """Redirect logging to a temporary file for a test
232
249
    
233
250
    returns an opaque reference that should be passed to disable_test_log
234
 
    after the test complete.
 
251
    after the test completes.
235
252
    """
236
253
    disable_default_logging()
237
254
    global _trace_file
 
255
    global _trace_depth
238
256
    hdlr = logging.StreamHandler(to_file)
239
257
    hdlr.setLevel(logging.DEBUG)
240
258
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
241
259
    _bzr_logger.addHandler(hdlr)
242
260
    _bzr_logger.setLevel(logging.DEBUG)
243
 
    result = hdlr, _trace_file
 
261
    result = hdlr, _trace_file, _trace_depth
244
262
    _trace_file = to_file
 
263
    _trace_depth += 1
245
264
    return result
246
265
 
247
266
 
248
 
def disable_test_log((test_log_hdlr, old_trace_file)):
 
267
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
249
268
    _bzr_logger.removeHandler(test_log_hdlr)
250
269
    test_log_hdlr.close()
 
270
    global _trace_file
 
271
    global _trace_depth
251
272
    _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()
 
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.
264
302
    """
 
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
265
312
    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)
 
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"