← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Martin Pool
  • Date: 2007-04-04 06:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404061731-tt2xrzllqhbodn83
Contents of TODO file moved into bug tracker

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005-2010 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(*args, **kwargs):
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
 
 
242
 
    def _open_or_create_log_file(filename):
243
 
        """Open existing log file, or create with ownership and permissions
244
 
 
245
 
        It inherits the ownership and permissions (masked by umask) from
246
 
        the containing directory to cope better with being run under sudo
247
 
        with $HOME still set to the user's homedir.
248
 
        """
249
 
        flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
250
 
        while True:
251
 
            try:
252
 
                fd = os.open(filename, flags)
253
 
                break
254
 
            except OSError, e:
255
 
                if e.errno != errno.ENOENT:
256
 
                    raise
257
 
            try:
258
 
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
259
 
            except OSError, e:
260
 
                if e.errno != errno.EEXIST:
261
 
                    raise
262
 
            else:
263
 
                osutils.copy_ownership_from_path(filename)
264
 
                break
265
 
        return os.fdopen(fd, 'at', 0) # unbuffered
266
 
 
267
 
 
268
 
    _bzr_log_filename = _get_bzr_log_filename()
269
 
    _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)
270
157
    try:
271
 
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
272
 
        bzr_log_file.write('\n')
273
 
        if bzr_log_file.tell() <= 2:
274
 
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
275
 
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
276
 
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
277
 
 
278
 
        return bzr_log_file
279
 
 
280
 
    except EnvironmentError, e:
281
 
        # If we are failing to open the log, then most likely logging has not
282
 
        # been set up yet. So we just write to stderr rather than using
283
 
        # 'warning()'. If we using warning(), users get the unhelpful 'no
284
 
        # handlers registered for "bzr"' when something goes wrong on the
285
 
        # server. (bug #503886)
286
 
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
287
 
    # TODO: What should happen if we fail to open the trace file?  Maybe the
288
 
    # objects should be pointed at /dev/null or the equivalent?  Currently
289
 
    # returns None which will cause failures later.
290
 
    return None
291
 
 
292
 
 
293
 
def enable_default_logging():
294
 
    """Configure default logging: messages to stderr and debug to .bzr.log
295
 
 
296
 
    This should only be called once per process.
297
 
 
298
 
    Non-command-line programs embedding bzrlib do not need to call this.  They
299
 
    can instead either pass a file to _push_log_file, or act directly on
300
 
    logging.getLogger("bzr").
301
 
 
302
 
    Output can be redirected away by calling _push_log_file.
303
 
    """
304
 
    # Do this before we open the log file, so we prevent
305
 
    # get_terminal_encoding() from mutter()ing multiple times
306
 
    term_encoding = osutils.get_terminal_encoding()
307
 
    start_time = osutils.format_local_date(_bzr_log_start_time,
308
 
                                           timezone='local')
309
 
    # create encoded wrapper around stderr
310
 
    bzr_log_file = _open_bzr_log()
311
 
    if bzr_log_file is not None:
312
 
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
313
 
    push_log_file(bzr_log_file,
314
 
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
315
 
        r'%Y-%m-%d %H:%M:%S')
316
 
    # after hooking output into bzr_log, we also need to attach a stderr
317
 
    # handler, writing only at level info and with encoding
318
 
    writer_factory = codecs.getwriter(term_encoding)
319
 
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
320
 
    stderr_handler = logging.StreamHandler(encoded_stderr)
321
 
    stderr_handler.setLevel(logging.INFO)
322
 
    logging.getLogger('bzr').addHandler(stderr_handler)
323
 
 
324
 
 
325
 
def push_log_file(to_file, log_format=None, date_format=None):
326
 
    """Intercept log and trace messages and send them to a file.
327
 
 
328
 
    :param to_file: A file-like object to which messages will be sent.
329
 
 
330
 
    :returns: A memento that should be passed to _pop_log_file to restore the
331
 
    previously active logging.
332
 
    """
333
 
    global _trace_file
334
 
    # make a new handler
335
 
    new_handler = logging.StreamHandler(to_file)
336
 
    new_handler.setLevel(logging.DEBUG)
337
 
    if log_format is None:
338
 
        log_format = '%(levelname)8s  %(message)s'
339
 
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
340
 
    # save and remove any existing log handlers
341
 
    bzr_logger = logging.getLogger('bzr')
342
 
    old_handlers = bzr_logger.handlers[:]
343
 
    del bzr_logger.handlers[:]
344
 
    # set that as the default logger
345
 
    bzr_logger.addHandler(new_handler)
346
 
    bzr_logger.setLevel(logging.DEBUG)
347
 
    # TODO: check if any changes are needed to the root logger
348
 
    #
349
 
    # TODO: also probably need to save and restore the level on bzr_logger.
350
 
    # but maybe we can avoid setting the logger level altogether, and just set
351
 
    # the level on the handler?
352
 
    #
353
 
    # save the old trace file
354
 
    old_trace_file = _trace_file
355
 
    # send traces to the new one
356
 
    _trace_file = to_file
357
 
    result = new_handler, _trace_file
358
 
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
359
 
 
360
 
 
361
 
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
362
 
    """Undo changes to logging/tracing done by _push_log_file.
363
 
 
364
 
    This flushes, but does not close the trace file.
365
 
 
366
 
    Takes the memento returned from _push_log_file."""
367
 
    global _trace_file
368
 
    _trace_file = old_trace_file
369
 
    bzr_logger = logging.getLogger('bzr')
370
 
    bzr_logger.removeHandler(new_handler)
371
 
    # must be closed, otherwise logging will try to close it atexit, and the
372
 
    # file will likely already be closed underneath.
373
 
    new_handler.close()
374
 
    bzr_logger.handlers = old_handlers
375
 
    new_trace_file.flush()
 
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)
 
174
    except IOError, e:
 
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
    if msg:
 
186
        error(msg)
 
187
    log_exception_quietly()
376
188
 
377
189
 
378
190
def log_exception_quietly():
379
191
    """Log the last exception to the trace file only.
380
192
 
381
 
    Used for exceptions that occur internally and that may be
382
 
    interesting to developers but not to users.  For example,
 
193
    Used for exceptions that occur internally and that may be 
 
194
    interesting to developers but not to users.  For example, 
383
195
    errors loading plugins.
384
196
    """
 
197
    import traceback
385
198
    mutter(traceback.format_exc())
386
199
 
387
200
 
388
 
def set_verbosity_level(level):
389
 
    """Set the verbosity level.
390
 
 
391
 
    :param level: -ve for quiet, 0 for normal, +ve for verbose
392
 
    """
393
 
    global _verbosity_level
394
 
    _verbosity_level = level
395
 
    _update_logging_level(level < 0)
396
 
    ui.ui_factory.be_quiet(level < 0)
397
 
 
398
 
 
399
 
def get_verbosity_level():
400
 
    """Get the verbosity level.
401
 
 
402
 
    See set_verbosity_level() for values.
403
 
    """
404
 
    return _verbosity_level
 
201
def enable_default_logging():
 
202
    """Configure default logging to stderr and .bzr.log"""
 
203
    # FIXME: if this is run twice, things get confused
 
204
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
205
    _stderr_handler = logging.StreamHandler()
 
206
    logging.getLogger('').addHandler(_stderr_handler)
 
207
    _stderr_handler.setLevel(logging.INFO)
 
208
    if not _file_handler:
 
209
        open_tracefile()
 
210
    _trace_file = _bzr_log_file
 
211
    if _file_handler:
 
212
        _file_handler.setLevel(logging.DEBUG)
 
213
    _bzr_logger.setLevel(logging.DEBUG)
405
214
 
406
215
 
407
216
def be_quiet(quiet=True):
408
 
    if quiet:
409
 
        set_verbosity_level(-1)
410
 
    else:
411
 
        set_verbosity_level(0)
412
 
 
413
 
 
414
 
def _update_logging_level(quiet=True):
415
 
    """Hide INFO messages if quiet."""
416
 
    if quiet:
417
 
        _bzr_logger.setLevel(logging.WARNING)
418
 
    else:
419
 
        _bzr_logger.setLevel(logging.INFO)
 
217
    global _stderr_handler, _stderr_quiet
 
218
    
 
219
    _stderr_quiet = quiet
 
220
    if quiet:
 
221
        _stderr_handler.setLevel(logging.WARNING)
 
222
    else:
 
223
        _stderr_handler.setLevel(logging.INFO)
420
224
 
421
225
 
422
226
def is_quiet():
423
 
    """Is the verbosity level negative?"""
424
 
    return _verbosity_level < 0
425
 
 
426
 
 
427
 
def is_verbose():
428
 
    """Is the verbosity level positive?"""
429
 
    return _verbosity_level > 0
430
 
 
431
 
 
432
 
def debug_memory(message='', short=True):
433
 
    """Write out a memory dump."""
434
 
    if sys.platform == 'win32':
435
 
        from bzrlib import win32utils
436
 
        win32utils.debug_memory_win32api(message=message, short=short)
437
 
    else:
438
 
        _debug_memory_proc(message=message, short=short)
439
 
 
440
 
 
441
 
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
442
 
 
443
 
def _debug_memory_proc(message='', short=True):
444
 
    try:
445
 
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
446
 
    except IOError:
447
 
        return
448
 
    try:
449
 
        status = status_file.read()
450
 
    finally:
451
 
        status_file.close()
452
 
    if message:
453
 
        note(message)
454
 
    for line in status.splitlines():
455
 
        if not short:
456
 
            note(line)
457
 
        else:
458
 
            for field in _short_fields:
459
 
                if line.startswith(field):
460
 
                    note(line)
461
 
                    break
 
227
    global _stderr_quiet
 
228
    return _stderr_quiet
 
229
 
 
230
 
 
231
def disable_default_logging():
 
232
    """Turn off default log handlers.
 
233
 
 
234
    This is intended to be used by the test framework, which doesn't
 
235
    want leakage from the code-under-test into the main logs.
 
236
    """
 
237
 
 
238
    l = logging.getLogger('')
 
239
    l.removeHandler(_stderr_handler)
 
240
    if _file_handler:
 
241
        l.removeHandler(_file_handler)
 
242
    _trace_file = None
 
243
 
 
244
 
 
245
def enable_test_log(to_file):
 
246
    """Redirect logging to a temporary file for a test
 
247
    
 
248
    returns an opaque reference that should be passed to disable_test_log
 
249
    after the test completes.
 
250
    """
 
251
    disable_default_logging()
 
252
    global _trace_file
 
253
    global _trace_depth
 
254
    hdlr = logging.StreamHandler(to_file)
 
255
    hdlr.setLevel(logging.DEBUG)
 
256
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
257
    _bzr_logger.addHandler(hdlr)
 
258
    _bzr_logger.setLevel(logging.DEBUG)
 
259
    result = hdlr, _trace_file, _trace_depth
 
260
    _trace_file = to_file
 
261
    _trace_depth += 1
 
262
    return result
 
263
 
 
264
 
 
265
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
266
    _bzr_logger.removeHandler(test_log_hdlr)
 
267
    test_log_hdlr.close()
 
268
    global _trace_file
 
269
    global _trace_depth
 
270
    _trace_file = old_trace_file
 
271
    _trace_depth = old_trace_depth
 
272
    if not _trace_depth:
 
273
        enable_default_logging()
462
274
 
463
275
 
464
276
def report_exception(exc_info, err_file):
465
 
    """Report an exception to err_file (typically stderr) and to .bzr.log.
466
 
 
467
 
    This will show either a full traceback or a short message as appropriate.
468
 
 
469
 
    :return: The appropriate exit code for this error.
470
 
    """
 
277
    exc_type, exc_object, exc_tb = exc_info
471
278
    # Log the full traceback to ~/.bzr.log
472
279
    log_exception_quietly()
473
 
    if 'error' in debug.debug_flags:
474
 
        print_exception(exc_info, err_file)
475
 
        return errors.EXIT_ERROR
476
 
    exc_type, exc_object, exc_tb = exc_info
477
280
    if (isinstance(exc_object, IOError)
478
281
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
479
 
        err_file.write("bzr: broken pipe\n")
480
 
        return errors.EXIT_ERROR
 
282
        print >>err_file, "bzr: broken pipe"
481
283
    elif isinstance(exc_object, KeyboardInterrupt):
482
 
        err_file.write("bzr: interrupted\n")
483
 
        return errors.EXIT_ERROR
484
 
    elif isinstance(exc_object, MemoryError):
485
 
        err_file.write("bzr: out of memory\n")
486
 
        return errors.EXIT_ERROR
487
 
    elif isinstance(exc_object, ImportError) \
488
 
        and str(exc_object).startswith("No module named "):
489
 
        report_user_error(exc_info, err_file,
490
 
            'You may need to install this Python library separately.')
491
 
        return errors.EXIT_ERROR
 
284
        print >>err_file, "bzr: interrupted"
492
285
    elif not getattr(exc_object, 'internal_error', True):
493
286
        report_user_error(exc_info, err_file)
494
 
        return errors.EXIT_ERROR
495
287
    elif isinstance(exc_object, (OSError, IOError)):
496
288
        # Might be nice to catch all of these and show them as something more
497
289
        # specific, but there are too many cases at the moment.
498
290
        report_user_error(exc_info, err_file)
499
 
        return errors.EXIT_ERROR
500
291
    else:
501
292
        report_bug(exc_info, err_file)
502
 
        return errors.EXIT_INTERNAL_ERROR
503
 
 
504
 
 
505
 
def print_exception(exc_info, err_file):
506
 
    exc_type, exc_object, exc_tb = exc_info
507
 
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
508
 
        exc_type.__module__, exc_type.__name__, exc_object))
509
 
    err_file.write('\n')
510
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
511
293
 
512
294
 
513
295
# TODO: Should these be specially encoding the output?
514
 
def report_user_error(exc_info, err_file, advice=None):
 
296
def report_user_error(exc_info, err_file):
515
297
    """Report to err_file an error that's not an internal error.
516
298
 
517
299
    These don't get a traceback unless -Derror was given.
518
 
 
519
 
    :param exc_info: 3-tuple from sys.exc_info()
520
 
    :param advice: Extra advice to the user to be printed following the
521
 
        exception.
522
300
    """
523
 
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
524
 
    if advice:
525
 
        err_file.write("%s\n" % (advice,))
 
301
    if 'error' in debug.debug_flags:
 
302
        report_bug(exc_info, err_file)
 
303
        return
 
304
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
526
305
 
527
306
 
528
307
def report_bug(exc_info, err_file):
529
308
    """Report an exception that probably indicates a bug in bzr"""
530
 
    from bzrlib.crash import report_bug
531
 
    report_bug(exc_info, err_file)
532
 
 
533
 
 
534
 
def _flush_stdout_stderr():
535
 
    # installed into an atexit hook by bzrlib.initialize()
536
 
    try:
537
 
        sys.stdout.flush()
538
 
        sys.stderr.flush()
539
 
    except IOError, e:
540
 
        import errno
541
 
        if e.errno in [errno.EINVAL, errno.EPIPE]:
542
 
            pass
543
 
        else:
544
 
            raise
545
 
 
546
 
 
547
 
def _flush_trace():
548
 
    # run from atexit hook
549
 
    global _trace_file
550
 
    if _trace_file:
551
 
        _trace_file.flush()
 
309
    import traceback
 
310
    exc_type, exc_object, exc_tb = exc_info
 
311
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
 
312
        exc_type.__module__, exc_type.__name__, exc_object)
 
313
    print >>err_file
 
314
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
315
    print >>err_file
 
316
    print >>err_file, 'bzr %s on python %s (%s)' % \
 
317
                       (bzrlib.__version__,
 
318
                        '.'.join(map(str, sys.version_info)),
 
319
                        sys.platform)
 
320
    print >>err_file, 'arguments: %r' % sys.argv
 
321
    print >>err_file
 
322
    print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"