← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: John Arbash Meinel
  • Date: 2006-05-30 04:44:48 UTC
  • mto: (1711.2.26 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1734.
  • Revision ID: john@arbash-meinel.com-20060530044448-81612e2e57c3991f
Update documentation and TODO for compare_trees

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008 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
 
#
53
 
# On the other hand, as of 1.2 we generally only call the mutter() statement
54
 
# if (according to debug_flags) we actually intend to write it.  So the
55
 
# increased cost of logging.py is not so bad, and we could standardize on
56
 
# that.
57
 
 
58
 
import codecs
 
41
 
 
42
 
 
43
import sys
 
44
import os
59
45
import logging
60
 
import os
61
 
import sys
62
 
import re
63
 
import time
64
 
 
65
 
from bzrlib.lazy_import import lazy_import
66
 
lazy_import(globals(), """
67
 
from cStringIO import StringIO
68
 
import errno
69
 
import locale
70
 
import traceback
71
 
""")
72
46
 
73
47
import bzrlib
74
 
 
75
 
lazy_import(globals(), """
76
 
from bzrlib import (
77
 
    debug,
78
 
    errors,
79
 
    osutils,
80
 
    plugin,
81
 
    symbol_versioning,
82
 
    )
83
 
""")
84
 
 
85
 
 
86
 
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
87
 
# is quiet; >0 is verbose.
88
 
_verbosity_level = 0
89
 
 
90
 
# File-like object where mutter/debug output is currently sent.  Can be
91
 
# changed by _push_log_file etc.  This is directly manipulated by some
92
 
# external code; maybe there should be functions to do that more precisely
93
 
# than push/pop_log_file.
 
48
from bzrlib.errors import BzrError, BzrNewError
 
49
 
 
50
 
 
51
_file_handler = None
 
52
_stderr_handler = None
 
53
_stderr_quiet = False
94
54
_trace_file = None
95
 
 
96
 
# Absolute path for ~/.bzr.log.  Not changed even if the log/trace output is
97
 
# redirected elsewhere.  Used to show the location in --version.
98
 
_bzr_log_filename = None
99
 
 
100
 
# The time the first message was written to the trace file, so that we can
101
 
# show relative times since startup.
102
 
_bzr_log_start_time = bzrlib._start_time
103
 
 
104
 
 
105
 
# held in a global for quick reference
 
55
_trace_depth = 0
 
56
_bzr_log_file = None
 
57
 
 
58
 
 
59
class QuietFormatter(logging.Formatter):
 
60
    """Formatter that supresses the details of errors.
 
61
 
 
62
    This is used by default on stderr so as not to scare the user.
 
63
    """
 
64
    # At first I tried overriding formatException to suppress the
 
65
    # exception details, but that has global effect: no loggers
 
66
    # can get the exception details is we suppress them here.
 
67
 
 
68
    def format(self, record):
 
69
        if record.levelno >= logging.WARNING:
 
70
            s = 'bzr: ' + record.levelname + ': '
 
71
        else:
 
72
            s = ''
 
73
        s += record.getMessage()
 
74
        if record.exc_info:
 
75
            s += '\n' + format_exception_short(record.exc_info)
 
76
        return s
 
77
        
 
78
# configure convenient aliases for output routines
 
79
 
106
80
_bzr_logger = logging.getLogger('bzr')
107
81
 
108
 
 
109
82
def note(*args, **kwargs):
110
 
    # FIXME note always emits utf-8, regardless of the terminal encoding
111
 
    #
112
 
    # FIXME: clearing the ui and then going through the abstract logging
113
 
    # framework is whack; we should probably have a logging Handler that
114
 
    # deals with terminal output if needed.
115
83
    import bzrlib.ui
116
84
    bzrlib.ui.ui_factory.clear_term()
117
85
    _bzr_logger.info(*args, **kwargs)
118
86
 
119
 
 
120
87
def warning(*args, **kwargs):
121
88
    import bzrlib.ui
122
89
    bzrlib.ui.ui_factory.clear_term()
123
90
    _bzr_logger.warning(*args, **kwargs)
124
91
 
125
 
 
126
 
# configure convenient aliases for output routines
127
 
#
128
 
# TODO: deprecate them, have one name for each.
129
92
info = note
130
93
log_error = _bzr_logger.error
131
94
error =     _bzr_logger.error
134
97
def mutter(fmt, *args):
135
98
    if _trace_file is None:
136
99
        return
137
 
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
 
100
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
138
101
        return
139
 
 
140
 
    if isinstance(fmt, unicode):
141
 
        fmt = fmt.encode('utf8')
142
 
 
143
102
    if len(args) > 0:
144
 
        # It seems that if we do ascii % (unicode, ascii) we can
145
 
        # get a unicode cannot encode ascii error, so make sure that "fmt"
146
 
        # is a unicode string
147
 
        real_args = []
148
 
        for arg in args:
149
 
            if isinstance(arg, unicode):
150
 
                arg = arg.encode('utf8')
151
 
            real_args.append(arg)
152
 
        out = fmt % tuple(real_args)
 
103
        out = fmt % args
153
104
    else:
154
105
        out = fmt
155
 
    timestamp = '%0.3f  ' % (time.time() - _bzr_log_start_time,)
156
 
    out = timestamp + out + '\n'
 
106
    out += '\n'
157
107
    _trace_file.write(out)
158
 
    # no need to flush here, the trace file is now linebuffered when it's
159
 
    # opened.
160
 
 
161
 
 
162
 
def mutter_callsite(stacklevel, fmt, *args):
163
 
    """Perform a mutter of fmt and args, logging the call trace.
164
 
 
165
 
    :param stacklevel: The number of frames to show. None will show all
166
 
        frames.
167
 
    :param fmt: The format string to pass to mutter.
168
 
    :param args: A list of substitution variables.
169
 
    """
170
 
    outf = StringIO()
171
 
    if stacklevel is None:
172
 
        limit = None
173
 
    else:
174
 
        limit = stacklevel + 1
175
 
    traceback.print_stack(limit=limit, file=outf)
176
 
    formatted_lines = outf.getvalue().splitlines()
177
 
    formatted_stack = '\n'.join(formatted_lines[:-2])
178
 
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
 
108
debug = mutter
179
109
 
180
110
 
181
111
def _rollover_trace_maybe(trace_fname):
185
115
        if size <= 4 << 20:
186
116
            return
187
117
        old_fname = trace_fname + '.old'
188
 
        osutils.rename(trace_fname, old_fname)
 
118
        from osutils import rename
 
119
        rename(trace_fname, old_fname)
189
120
    except OSError:
190
121
        return
191
122
 
192
123
 
193
 
def _get_bzr_log_filename():
194
 
    bzr_log = os.environ.get('BZR_LOG')
195
 
    if bzr_log:
196
 
        return bzr_log
197
 
    home = os.environ.get('BZR_HOME')
198
 
    if home is None:
199
 
        if sys.platform == 'win32':
200
 
            from bzrlib import win32utils
201
 
            home = win32utils.get_home_location()
202
 
        else:
203
 
            home = os.path.expanduser('~')
204
 
    return os.path.join(home, '.bzr.log')
205
 
 
206
 
 
207
 
def _open_bzr_log():
208
 
    """Open the .bzr.log trace file.  
209
 
 
210
 
    If the log is more than a particular length, the old file is renamed to
211
 
    .bzr.log.old and a new file is started.  Otherwise, we append to the
212
 
    existing file.
213
 
 
214
 
    This sets the global _bzr_log_filename.
215
 
    """
216
 
    global _bzr_log_filename
217
 
    _bzr_log_filename = _get_bzr_log_filename()
218
 
    _rollover_trace_maybe(_bzr_log_filename)
 
124
def open_tracefile(tracefilename='~/.bzr.log'):
 
125
    # Messages are always written to here, so that we have some
 
126
    # information if something goes wrong.  In a future version this
 
127
    # file will be removed on successful completion.
 
128
    global _file_handler, _bzr_log_file
 
129
    import stat, codecs
 
130
 
 
131
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
 
132
    _rollover_trace_maybe(trace_fname)
219
133
    try:
220
 
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
221
 
        # bzr_log_file.tell() on windows always return 0 until some writing done
222
 
        bzr_log_file.write('\n')
223
 
        if bzr_log_file.tell() <= 2:
224
 
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
225
 
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
226
 
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
227
 
        return bzr_log_file
 
134
        LINE_BUFFERED = 1
 
135
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
136
        _bzr_log_file = tf
 
137
        if tf.tell() == 0:
 
138
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
139
            tf.write("you can delete or truncate this file, or include sections in\n")
 
140
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
141
        _file_handler = logging.StreamHandler(tf)
 
142
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
143
        datefmt = r'%a %H:%M:%S'
 
144
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
145
        _file_handler.setLevel(logging.DEBUG)
 
146
        logging.getLogger('').addHandler(_file_handler)
228
147
    except IOError, e:
229
148
        warning("failed to open trace file: %s" % (e))
230
 
    # TODO: What should happen if we fail to open the trace file?  Maybe the
231
 
    # objects should be pointed at /dev/null or the equivalent?  Currently
232
 
    # returns None which will cause failures later.
233
 
 
234
 
 
235
 
def enable_default_logging():
236
 
    """Configure default logging: messages to stderr and debug to .bzr.log
237
 
    
238
 
    This should only be called once per process.
239
 
 
240
 
    Non-command-line programs embedding bzrlib do not need to call this.  They
241
 
    can instead either pass a file to _push_log_file, or act directly on
242
 
    logging.getLogger("bzr").
243
 
    
244
 
    Output can be redirected away by calling _push_log_file.
245
 
    """
246
 
    # create encoded wrapper around stderr
247
 
    bzr_log_file = _open_bzr_log()
248
 
    push_log_file(bzr_log_file,
249
 
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
250
 
        r'%Y-%m-%d %H:%M:%S')
251
 
    # after hooking output into bzr_log, we also need to attach a stderr
252
 
    # handler, writing only at level info and with encoding
253
 
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
254
 
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
255
 
    stderr_handler = logging.StreamHandler(encoded_stderr)
256
 
    stderr_handler.setLevel(logging.INFO)
257
 
    logging.getLogger('bzr').addHandler(stderr_handler)
258
 
 
259
 
 
260
 
def push_log_file(to_file, log_format=None, date_format=None):
261
 
    """Intercept log and trace messages and send them to a file.
262
 
 
263
 
    :param to_file: A file-like object to which messages will be sent.
264
 
 
265
 
    :returns: A memento that should be passed to _pop_log_file to restore the 
266
 
    previously active logging.
267
 
    """
268
 
    global _trace_file
269
 
    # make a new handler
270
 
    new_handler = logging.StreamHandler(to_file)
271
 
    new_handler.setLevel(logging.DEBUG)
272
 
    if log_format is None:
273
 
        log_format = '%(levelname)8s  %(message)s'
274
 
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
275
 
    # save and remove any existing log handlers
276
 
    bzr_logger = logging.getLogger('bzr')
277
 
    old_handlers = bzr_logger.handlers[:]
278
 
    del bzr_logger.handlers[:]
279
 
    # set that as the default logger
280
 
    bzr_logger.addHandler(new_handler)
281
 
    bzr_logger.setLevel(logging.DEBUG)
282
 
    # TODO: check if any changes are needed to the root logger
283
 
    #
284
 
    # TODO: also probably need to save and restore the level on bzr_logger.
285
 
    # but maybe we can avoid setting the logger level altogether, and just set
286
 
    # the level on the handler?
287
 
    #
288
 
    # save the old trace file
289
 
    old_trace_file = _trace_file
290
 
    # send traces to the new one
291
 
    _trace_file = to_file
292
 
    result = new_handler, _trace_file
293
 
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
294
 
 
295
 
 
296
 
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
297
 
    """Undo changes to logging/tracing done by _push_log_file.
298
 
 
299
 
    This flushes, but does not close the trace file.
300
 
    
301
 
    Takes the memento returned from _push_log_file."""
302
 
    global _trace_file
303
 
    _trace_file = old_trace_file
304
 
    bzr_logger = logging.getLogger('bzr')
305
 
    bzr_logger.removeHandler(new_handler)
306
 
    # must be closed, otherwise logging will try to close it atexit, and the
307
 
    # file will likely already be closed underneath.
308
 
    new_handler.close()
309
 
    bzr_logger.handlers = old_handlers
310
 
    new_trace_file.flush()
311
 
 
312
 
 
313
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
314
 
def enable_test_log(to_file):
315
 
    """Redirect logging to a temporary file for a test
316
 
    
317
 
    :returns: an opaque reference that should be passed to disable_test_log
318
 
    after the test completes.
319
 
    """
320
 
    return push_log_file(to_file)
321
 
 
322
 
 
323
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
324
 
def disable_test_log(memento):
325
 
    return pop_log_file(memento)
 
149
 
 
150
 
 
151
def log_startup(argv):
 
152
    debug('\n\nbzr %s invoked on python %s (%s)',
 
153
          bzrlib.__version__,
 
154
          '.'.join(map(str, sys.version_info)),
 
155
          sys.platform)
 
156
    debug('  arguments: %r', argv)
 
157
    debug('  working dir: %r', os.getcwdu())
 
158
 
 
159
 
 
160
def log_exception(msg=None):
 
161
    """Log the last exception to stderr and the trace file.
 
162
 
 
163
    The exception string representation is used as the error
 
164
    summary, unless msg is given.
 
165
    """
 
166
    if msg:
 
167
        error(msg)
 
168
    else:
 
169
        exc_str = format_exception_short(sys.exc_info())
 
170
        error(exc_str)
 
171
    log_exception_quietly()
326
172
 
327
173
 
328
174
def log_exception_quietly():
332
178
    interesting to developers but not to users.  For example, 
333
179
    errors loading plugins.
334
180
    """
335
 
    mutter(traceback.format_exc())
336
 
 
337
 
 
338
 
def set_verbosity_level(level):
339
 
    """Set the verbosity level.
340
 
 
341
 
    :param level: -ve for quiet, 0 for normal, +ve for verbose
342
 
    """
343
 
    global _verbosity_level
344
 
    _verbosity_level = level
345
 
    _update_logging_level(level < 0)
346
 
 
347
 
 
348
 
def get_verbosity_level():
349
 
    """Get the verbosity level.
350
 
 
351
 
    See set_verbosity_level() for values.
352
 
    """
353
 
    return _verbosity_level
 
181
    import traceback
 
182
    debug(traceback.format_exc())
 
183
 
 
184
 
 
185
def enable_default_logging():
 
186
    """Configure default logging to stderr and .bzr.log"""
 
187
    # FIXME: if this is run twice, things get confused
 
188
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
189
    _stderr_handler = logging.StreamHandler()
 
190
    _stderr_handler.setFormatter(QuietFormatter())
 
191
    logging.getLogger('').addHandler(_stderr_handler)
 
192
    _stderr_handler.setLevel(logging.INFO)
 
193
    if not _file_handler:
 
194
        open_tracefile()
 
195
    _trace_file = _bzr_log_file
 
196
    if _file_handler:
 
197
        _file_handler.setLevel(logging.DEBUG)
 
198
    _bzr_logger.setLevel(logging.DEBUG) 
 
199
 
354
200
 
355
201
 
356
202
def be_quiet(quiet=True):
357
 
    # Perhaps this could be deprecated now ...
358
 
    if quiet:
359
 
        set_verbosity_level(-1)
360
 
    else:
361
 
        set_verbosity_level(0)
362
 
 
363
 
 
364
 
def _update_logging_level(quiet=True):
365
 
    """Hide INFO messages if quiet."""
366
 
    if quiet:
367
 
        _bzr_logger.setLevel(logging.WARNING)
368
 
    else:
369
 
        _bzr_logger.setLevel(logging.INFO)
 
203
    global _stderr_handler, _stderr_quiet
 
204
    
 
205
    _stderr_quiet = quiet
 
206
    if quiet:
 
207
        _stderr_handler.setLevel(logging.WARNING)
 
208
    else:
 
209
        _stderr_handler.setLevel(logging.INFO)
370
210
 
371
211
 
372
212
def is_quiet():
373
 
    """Is the verbosity level negative?"""
374
 
    return _verbosity_level < 0
375
 
 
376
 
 
377
 
def is_verbose():
378
 
    """Is the verbosity level positive?"""
379
 
    return _verbosity_level > 0
380
 
 
381
 
 
382
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
213
    global _stderr_quiet
 
214
    return _stderr_quiet
 
215
 
 
216
 
383
217
def disable_default_logging():
384
218
    """Turn off default log handlers.
385
219
 
386
 
    Don't call this method, use _push_log_file and _pop_log_file instead.
387
 
    """
388
 
    pass
389
 
 
390
 
 
391
 
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
392
 
 
393
 
def debug_memory(message='', short=True):
394
 
    """Write out a memory dump."""
395
 
    try:
396
 
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
397
 
    except IOError:
398
 
        return
399
 
    try:
400
 
        status = status_file.read()
401
 
    finally:
402
 
        status_file.close()
403
 
    if message:
404
 
        note(message)
405
 
    for line in status.splitlines():
406
 
        if not short:
407
 
            note(line)
 
220
    This is intended to be used by the test framework, which doesn't
 
221
    want leakage from the code-under-test into the main logs.
 
222
    """
 
223
 
 
224
    l = logging.getLogger('')
 
225
    l.removeHandler(_stderr_handler)
 
226
    if _file_handler:
 
227
        l.removeHandler(_file_handler)
 
228
    _trace_file = None
 
229
 
 
230
 
 
231
def enable_test_log(to_file):
 
232
    """Redirect logging to a temporary file for a test
 
233
    
 
234
    returns an opaque reference that should be passed to disable_test_log
 
235
    after the test completes.
 
236
    """
 
237
    disable_default_logging()
 
238
    global _trace_file
 
239
    global _trace_depth
 
240
    hdlr = logging.StreamHandler(to_file)
 
241
    hdlr.setLevel(logging.DEBUG)
 
242
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
243
    _bzr_logger.addHandler(hdlr)
 
244
    _bzr_logger.setLevel(logging.DEBUG)
 
245
    result = hdlr, _trace_file, _trace_depth
 
246
    _trace_file = to_file
 
247
    _trace_depth += 1
 
248
    return result
 
249
 
 
250
 
 
251
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
252
    _bzr_logger.removeHandler(test_log_hdlr)
 
253
    test_log_hdlr.close()
 
254
    global _trace_file
 
255
    global _trace_depth
 
256
    _trace_file = old_trace_file
 
257
    _trace_depth = old_trace_depth
 
258
    if not _trace_depth:
 
259
        enable_default_logging()
 
260
 
 
261
 
 
262
def format_exception_short(exc_info):
 
263
    """Make a short string form of an exception.
 
264
 
 
265
    This is used for display to stderr.  It specially handles exception
 
266
    classes without useful string methods.
 
267
 
 
268
    The result has no trailing newline.
 
269
 
 
270
    exc_info - typically an exception from sys.exc_info()
 
271
    """
 
272
    exc_type, exc_object, exc_tb = exc_info
 
273
    try:
 
274
        if exc_type is None:
 
275
            return '(no exception)'
 
276
        if isinstance(exc_object, (BzrError, BzrNewError)):
 
277
            return str(exc_object)
408
278
        else:
409
 
            for field in _short_fields:
410
 
                if line.startswith(field):
411
 
                    note(line)
412
 
                    break
413
 
 
414
 
 
415
 
def report_exception(exc_info, err_file):
416
 
    """Report an exception to err_file (typically stderr) and to .bzr.log.
417
 
 
418
 
    This will show either a full traceback or a short message as appropriate.
419
 
 
420
 
    :return: The appropriate exit code for this error.
421
 
    """
422
 
    exc_type, exc_object, exc_tb = exc_info
423
 
    # Log the full traceback to ~/.bzr.log
424
 
    log_exception_quietly()
425
 
    if (isinstance(exc_object, IOError)
426
 
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
427
 
        err_file.write("bzr: broken pipe\n")
428
 
        return errors.EXIT_ERROR
429
 
    elif isinstance(exc_object, KeyboardInterrupt):
430
 
        err_file.write("bzr: interrupted\n")
431
 
        return errors.EXIT_ERROR
432
 
    elif isinstance(exc_object, ImportError) \
433
 
        and str(exc_object).startswith("No module named "):
434
 
        report_user_error(exc_info, err_file,
435
 
            'You may need to install this Python library separately.')
436
 
        return errors.EXIT_ERROR
437
 
    elif not getattr(exc_object, 'internal_error', True):
438
 
        report_user_error(exc_info, err_file)
439
 
        return errors.EXIT_ERROR
440
 
    elif isinstance(exc_object, (OSError, IOError)):
441
 
        # Might be nice to catch all of these and show them as something more
442
 
        # specific, but there are too many cases at the moment.
443
 
        report_user_error(exc_info, err_file)
444
 
        return errors.EXIT_ERROR
445
 
    else:
446
 
        report_bug(exc_info, err_file)
447
 
        return errors.EXIT_INTERNAL_ERROR
448
 
 
449
 
 
450
 
def print_exception(exc_info, err_file):
451
 
    exc_type, exc_object, exc_tb = exc_info
452
 
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
453
 
        exc_type.__module__, exc_type.__name__, exc_object))
454
 
    err_file.write('\n')
455
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
456
 
 
457
 
 
458
 
# TODO: Should these be specially encoding the output?
459
 
def report_user_error(exc_info, err_file, advice=None):
460
 
    """Report to err_file an error that's not an internal error.
461
 
 
462
 
    These don't get a traceback unless -Derror was given.
463
 
 
464
 
    :param exc_info: 3-tuple from sys.exc_info()
465
 
    :param advice: Extra advice to the user to be printed following the
466
 
        exception.
467
 
    """
468
 
    if 'error' in debug.debug_flags:
469
 
        print_exception(exc_info, err_file)
470
 
        return
471
 
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
472
 
    if advice:
473
 
        err_file.write("%s\n" % (advice,))
474
 
 
475
 
 
476
 
def report_bug(exc_info, err_file):
477
 
    """Report an exception that probably indicates a bug in bzr"""
478
 
    print_exception(exc_info, err_file)
479
 
    err_file.write('\n')
480
 
    err_file.write('bzr %s on python %s (%s)\n' % \
481
 
                       (bzrlib.__version__,
482
 
                        bzrlib._format_version_tuple(sys.version_info),
483
 
                        sys.platform))
484
 
    err_file.write('arguments: %r\n' % sys.argv)
485
 
    err_file.write(
486
 
        'encoding: %r, fsenc: %r, lang: %r\n' % (
487
 
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
488
 
            os.environ.get('LANG')))
489
 
    err_file.write("plugins:\n")
490
 
    for name, a_plugin in sorted(plugin.plugins().items()):
491
 
        err_file.write("  %-20s %s [%s]\n" %
492
 
            (name, a_plugin.path(), a_plugin.__version__))
493
 
    err_file.write(
494
 
"""\
495
 
*** Bazaar has encountered an internal error.
496
 
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
497
 
    including this traceback, and a description of what you
498
 
    were doing when the error occurred.
499
 
""")
 
279
            import traceback
 
280
            tb = traceback.extract_tb(exc_tb)
 
281
            msg = '%s: %s' % (exc_type, exc_object)
 
282
            if msg[-1] == '\n':
 
283
                msg = msg[:-1]
 
284
            if tb:
 
285
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
 
286
            return msg
 
287
    except Exception, formatting_exc:
 
288
        # XXX: is this really better than just letting it run up?
 
289
        return '(error formatting exception of type %s: %s)' \
 
290
                % (exc_type, formatting_exc)