← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Aaron Bentley
  • Date: 2007-06-19 14:49:06 UTC
  • mto: This revision was merged to the branch mainline in revision 2537.
  • Revision ID: abentley@panoramicfeedback.com-20070619144906-zx160g6h377j729h
Fix handling of null revision

Show diffs side-by-side

added added

removed removed

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