/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: Ian Clatworthy
  • Date: 2007-11-28 00:07:56 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071128000756-kqm8iqmc9281roii
more cleanups and creation of tutorials directory

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, 2007 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
53
import codecs
58
54
import logging
59
55
import os
60
56
import sys
61
 
import time
 
57
import re
62
58
 
63
59
from bzrlib.lazy_import import lazy_import
64
60
lazy_import(globals(), """
70
66
 
71
67
import bzrlib
72
68
 
73
 
from bzrlib.symbol_versioning import (
74
 
    deprecated_function,
75
 
    deprecated_in,
76
 
    )
77
 
 
78
69
lazy_import(globals(), """
79
70
from bzrlib import (
80
71
    debug,
81
72
    errors,
82
73
    osutils,
83
74
    plugin,
84
 
    symbol_versioning,
85
 
    ui,
86
75
    )
87
76
""")
88
77
 
89
 
 
90
 
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
91
 
# is quiet; >0 is verbose.
 
78
_file_handler = None
 
79
_stderr_handler = None
92
80
_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.
98
81
_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.
 
82
_trace_depth = 0
 
83
_bzr_log_file = None
102
84
_bzr_log_filename = None
103
85
 
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
 
86
 
 
87
# configure convenient aliases for output routines
 
88
 
110
89
_bzr_logger = logging.getLogger('bzr')
111
90
 
112
91
 
113
92
def note(*args, **kwargs):
114
 
    """Output a note to the user.
115
 
 
116
 
    Takes the same parameters as logging.info.
117
 
    :return: None
118
 
    """
119
93
    # FIXME note always emits utf-8, regardless of the terminal encoding
120
 
    #
121
 
    # FIXME: clearing the ui and then going through the abstract logging
122
 
    # framework is whack; we should probably have a logging Handler that
123
 
    # deals with terminal output if needed.
124
94
    import bzrlib.ui
125
95
    bzrlib.ui.ui_factory.clear_term()
126
96
    _bzr_logger.info(*args, **kwargs)
127
97
 
128
 
 
129
98
def warning(*args, **kwargs):
130
99
    import bzrlib.ui
131
100
    bzrlib.ui.ui_factory.clear_term()
132
101
    _bzr_logger.warning(*args, **kwargs)
133
102
 
134
 
 
135
 
@deprecated_function(deprecated_in((2, 1, 0)))
136
 
def info(*args, **kwargs):
137
 
    """Deprecated: use trace.note instead."""
138
 
    note(*args, **kwargs)
139
 
 
140
 
 
141
 
@deprecated_function(deprecated_in((2, 1, 0)))
142
 
def log_error(*args, **kwargs):
143
 
    """Deprecated: use bzrlib.trace.show_error instead"""
144
 
    _bzr_logger.error(*args, **kwargs)
145
 
 
146
 
 
147
 
@deprecated_function(deprecated_in((2, 1, 0)))
148
 
def error(*args, **kwargs):
149
 
    """Deprecated: use bzrlib.trace.show_error instead"""
150
 
    _bzr_logger.error(*args, **kwargs)
151
 
 
152
 
 
153
 
def show_error(*args, **kwargs):
154
 
    """Show an error message to the user.
155
 
 
156
 
    Don't use this for exceptions, use report_exception instead.
157
 
    """
158
 
    _bzr_logger.error(*args, **kwargs)
 
103
info = note
 
104
log_error = _bzr_logger.error
 
105
error =     _bzr_logger.error
159
106
 
160
107
 
161
108
def mutter(fmt, *args):
162
109
    if _trace_file is None:
163
110
        return
164
 
    # XXX: Don't check this every time; instead anyone who closes the file
165
 
    # ought to deregister it.  We can tolerate None.
166
111
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
167
112
        return
168
113
 
181
126
        out = fmt % tuple(real_args)
182
127
    else:
183
128
        out = fmt
184
 
    now = time.time()
185
 
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
186
 
    out = timestamp + out + '\n'
 
129
    out += '\n'
187
130
    _trace_file.write(out)
188
 
    # there's no explicit flushing; the file is typically line buffered.
 
131
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
132
    #_trace_file.flush()
189
133
 
190
134
 
191
135
def mutter_callsite(stacklevel, fmt, *args):
197
141
    :param args: A list of substitution variables.
198
142
    """
199
143
    outf = StringIO()
200
 
    if stacklevel is None:
201
 
        limit = None
202
 
    else:
203
 
        limit = stacklevel + 1
204
 
    traceback.print_stack(limit=limit, file=outf)
 
144
    traceback.print_stack(limit=stacklevel + 1, file=outf)
205
145
    formatted_lines = outf.getvalue().splitlines()
206
146
    formatted_stack = '\n'.join(formatted_lines[:-2])
207
147
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
219
159
        return
220
160
 
221
161
 
222
 
def _get_bzr_log_filename():
223
 
    bzr_log = os.environ.get('BZR_LOG')
224
 
    if bzr_log:
225
 
        return bzr_log
226
 
    home = os.environ.get('BZR_HOME')
227
 
    if home is None:
 
162
def open_tracefile(tracefilename=None):
 
163
    # Messages are always written to here, so that we have some
 
164
    # information if something goes wrong.  In a future version this
 
165
    # file will be removed on successful completion.
 
166
    global _file_handler, _bzr_log_file, _bzr_log_filename
 
167
    import codecs
 
168
 
 
169
    if tracefilename is None:
228
170
        if sys.platform == 'win32':
229
171
            from bzrlib import win32utils
230
172
            home = win32utils.get_home_location()
231
173
        else:
232
174
            home = os.path.expanduser('~')
233
 
    return os.path.join(home, '.bzr.log')
234
 
 
235
 
 
236
 
def _open_bzr_log():
237
 
    """Open the .bzr.log trace file.
238
 
 
239
 
    If the log is more than a particular length, the old file is renamed to
240
 
    .bzr.log.old and a new file is started.  Otherwise, we append to the
241
 
    existing file.
242
 
 
243
 
    This sets the global _bzr_log_filename.
244
 
    """
245
 
    global _bzr_log_filename
246
 
 
247
 
    def _open_or_create_log_file(filename):
248
 
        """Open existing log file, or create with ownership and permissions
249
 
 
250
 
        It inherits the ownership and permissions (masked by umask) from
251
 
        the containing directory to cope better with being run under sudo
252
 
        with $HOME still set to the user's homedir.
253
 
        """
254
 
        flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
255
 
        while True:
256
 
            try:
257
 
                fd = os.open(filename, flags)
258
 
                break
259
 
            except OSError, e:
260
 
                if e.errno != errno.ENOENT:
261
 
                    raise
262
 
            try:
263
 
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
264
 
            except OSError, e:
265
 
                if e.errno != errno.EEXIST:
266
 
                    raise
267
 
            else:
268
 
                osutils.copy_ownership_from_path(filename)
269
 
                break
270
 
        return os.fdopen(fd, 'at', 0) # unbuffered
271
 
 
272
 
 
273
 
    _bzr_log_filename = _get_bzr_log_filename()
 
175
        _bzr_log_filename = os.path.join(home, '.bzr.log')
 
176
    else:
 
177
        _bzr_log_filename = tracefilename
 
178
 
 
179
    _bzr_log_filename = os.path.expanduser(_bzr_log_filename)
274
180
    _rollover_trace_maybe(_bzr_log_filename)
275
181
    try:
276
 
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
277
 
        bzr_log_file.write('\n')
278
 
        if bzr_log_file.tell() <= 2:
279
 
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
280
 
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
281
 
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
282
 
 
283
 
        return bzr_log_file
284
 
 
285
 
    except EnvironmentError, e:
286
 
        # If we are failing to open the log, then most likely logging has not
287
 
        # been set up yet. So we just write to stderr rather than using
288
 
        # 'warning()'. If we using warning(), users get the unhelpful 'no
289
 
        # handlers registered for "bzr"' when something goes wrong on the
290
 
        # server. (bug #503886)
291
 
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
292
 
    # TODO: What should happen if we fail to open the trace file?  Maybe the
293
 
    # objects should be pointed at /dev/null or the equivalent?  Currently
294
 
    # returns None which will cause failures later.
295
 
    return None
296
 
 
297
 
 
298
 
def enable_default_logging():
299
 
    """Configure default logging: messages to stderr and debug to .bzr.log
300
 
 
301
 
    This should only be called once per process.
302
 
 
303
 
    Non-command-line programs embedding bzrlib do not need to call this.  They
304
 
    can instead either pass a file to _push_log_file, or act directly on
305
 
    logging.getLogger("bzr").
306
 
 
307
 
    Output can be redirected away by calling _push_log_file.
308
 
    """
309
 
    # Do this before we open the log file, so we prevent
310
 
    # get_terminal_encoding() from mutter()ing multiple times
311
 
    term_encoding = osutils.get_terminal_encoding()
312
 
    start_time = osutils.format_local_date(_bzr_log_start_time,
313
 
                                           timezone='local')
314
 
    # create encoded wrapper around stderr
315
 
    bzr_log_file = _open_bzr_log()
316
 
    if bzr_log_file is not None:
317
 
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
318
 
    push_log_file(bzr_log_file,
319
 
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
 
        r'%Y-%m-%d %H:%M:%S')
321
 
    # after hooking output into bzr_log, we also need to attach a stderr
322
 
    # handler, writing only at level info and with encoding
323
 
    writer_factory = codecs.getwriter(term_encoding)
324
 
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
325
 
    stderr_handler = logging.StreamHandler(encoded_stderr)
326
 
    stderr_handler.setLevel(logging.INFO)
327
 
    logging.getLogger('bzr').addHandler(stderr_handler)
328
 
 
329
 
 
330
 
def push_log_file(to_file, log_format=None, date_format=None):
331
 
    """Intercept log and trace messages and send them to a file.
332
 
 
333
 
    :param to_file: A file-like object to which messages will be sent.
334
 
 
335
 
    :returns: A memento that should be passed to _pop_log_file to restore the
336
 
    previously active logging.
337
 
    """
338
 
    global _trace_file
339
 
    # make a new handler
340
 
    new_handler = logging.StreamHandler(to_file)
341
 
    new_handler.setLevel(logging.DEBUG)
342
 
    if log_format is None:
343
 
        log_format = '%(levelname)8s  %(message)s'
344
 
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
345
 
    # save and remove any existing log handlers
346
 
    bzr_logger = logging.getLogger('bzr')
347
 
    old_handlers = bzr_logger.handlers[:]
348
 
    del bzr_logger.handlers[:]
349
 
    # set that as the default logger
350
 
    bzr_logger.addHandler(new_handler)
351
 
    bzr_logger.setLevel(logging.DEBUG)
352
 
    # TODO: check if any changes are needed to the root logger
353
 
    #
354
 
    # TODO: also probably need to save and restore the level on bzr_logger.
355
 
    # but maybe we can avoid setting the logger level altogether, and just set
356
 
    # the level on the handler?
357
 
    #
358
 
    # save the old trace file
359
 
    old_trace_file = _trace_file
360
 
    # send traces to the new one
361
 
    _trace_file = to_file
362
 
    result = new_handler, _trace_file
363
 
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
364
 
 
365
 
 
366
 
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
367
 
    """Undo changes to logging/tracing done by _push_log_file.
368
 
 
369
 
    This flushes, but does not close the trace file.
370
 
 
371
 
    Takes the memento returned from _push_log_file."""
372
 
    global _trace_file
373
 
    _trace_file = old_trace_file
374
 
    bzr_logger = logging.getLogger('bzr')
375
 
    bzr_logger.removeHandler(new_handler)
376
 
    # must be closed, otherwise logging will try to close it atexit, and the
377
 
    # file will likely already be closed underneath.
378
 
    new_handler.close()
379
 
    bzr_logger.handlers = old_handlers
380
 
    new_trace_file.flush()
 
182
        LINE_BUFFERED = 1
 
183
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
184
        tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
 
185
        _bzr_log_file = tf
 
186
        # tf.tell() on windows always return 0 until some writing done
 
187
        tf.write('\n')
 
188
        if tf.tell() <= 2:
 
189
            tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
 
190
            tf.write("you can delete or truncate this file, or include sections in\n")
 
191
            tf.write("bug reports to bazaar@lists.canonical.com\n\n")
 
192
        _file_handler = logging.StreamHandler(tf)
 
193
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
194
        datefmt = r'%a %H:%M:%S'
 
195
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
196
        _file_handler.setLevel(logging.DEBUG)
 
197
        logging.getLogger('').addHandler(_file_handler)
 
198
    except IOError, e:
 
199
        warning("failed to open trace file: %s" % (e))
381
200
 
382
201
 
383
202
def log_exception_quietly():
384
203
    """Log the last exception to the trace file only.
385
204
 
386
 
    Used for exceptions that occur internally and that may be
387
 
    interesting to developers but not to users.  For example,
 
205
    Used for exceptions that occur internally and that may be 
 
206
    interesting to developers but not to users.  For example, 
388
207
    errors loading plugins.
389
208
    """
 
209
    import traceback
390
210
    mutter(traceback.format_exc())
391
211
 
392
212
 
 
213
def enable_default_logging():
 
214
    """Configure default logging to stderr and .bzr.log"""
 
215
    # FIXME: if this is run twice, things get confused
 
216
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
217
    # create encoded wrapper around stderr
 
218
    stderr = codecs.getwriter(osutils.get_terminal_encoding())(sys.stderr,
 
219
        errors='replace')
 
220
    _stderr_handler = logging.StreamHandler(stderr)
 
221
    logging.getLogger('').addHandler(_stderr_handler)
 
222
    _stderr_handler.setLevel(logging.INFO)
 
223
    if not _file_handler:
 
224
        open_tracefile()
 
225
    _trace_file = _bzr_log_file
 
226
    if _file_handler:
 
227
        _file_handler.setLevel(logging.DEBUG)
 
228
    _bzr_logger.setLevel(logging.DEBUG)
 
229
 
 
230
 
393
231
def set_verbosity_level(level):
394
232
    """Set the verbosity level.
395
233
 
398
236
    global _verbosity_level
399
237
    _verbosity_level = level
400
238
    _update_logging_level(level < 0)
401
 
    ui.ui_factory.be_quiet(level < 0)
402
239
 
403
240
 
404
241
def get_verbosity_level():
410
247
 
411
248
 
412
249
def be_quiet(quiet=True):
 
250
    # Perhaps this could be deprecated now ...
413
251
    if quiet:
414
252
        set_verbosity_level(-1)
415
253
    else:
419
257
def _update_logging_level(quiet=True):
420
258
    """Hide INFO messages if quiet."""
421
259
    if quiet:
422
 
        _bzr_logger.setLevel(logging.WARNING)
 
260
        _stderr_handler.setLevel(logging.WARNING)
423
261
    else:
424
 
        _bzr_logger.setLevel(logging.INFO)
 
262
        _stderr_handler.setLevel(logging.INFO)
425
263
 
426
264
 
427
265
def is_quiet():
434
272
    return _verbosity_level > 0
435
273
 
436
274
 
437
 
def debug_memory(message='', short=True):
438
 
    """Write out a memory dump."""
439
 
    if sys.platform == 'win32':
440
 
        from bzrlib import win32utils
441
 
        win32utils.debug_memory_win32api(message=message, short=short)
442
 
    else:
443
 
        _debug_memory_proc(message=message, short=short)
444
 
 
445
 
 
446
 
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
447
 
 
448
 
def _debug_memory_proc(message='', short=True):
449
 
    try:
450
 
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
451
 
    except IOError:
452
 
        return
453
 
    try:
454
 
        status = status_file.read()
455
 
    finally:
456
 
        status_file.close()
457
 
    if message:
458
 
        note(message)
459
 
    for line in status.splitlines():
460
 
        if not short:
461
 
            note(line)
462
 
        else:
463
 
            for field in _short_fields:
464
 
                if line.startswith(field):
465
 
                    note(line)
466
 
                    break
 
275
def disable_default_logging():
 
276
    """Turn off default log handlers.
 
277
 
 
278
    This is intended to be used by the test framework, which doesn't
 
279
    want leakage from the code-under-test into the main logs.
 
280
    """
 
281
 
 
282
    l = logging.getLogger('')
 
283
    l.removeHandler(_stderr_handler)
 
284
    if _file_handler:
 
285
        l.removeHandler(_file_handler)
 
286
    _trace_file = None
 
287
 
 
288
 
 
289
def enable_test_log(to_file):
 
290
    """Redirect logging to a temporary file for a test
 
291
    
 
292
    returns an opaque reference that should be passed to disable_test_log
 
293
    after the test completes.
 
294
    """
 
295
    disable_default_logging()
 
296
    global _trace_file
 
297
    global _trace_depth
 
298
    hdlr = logging.StreamHandler(to_file)
 
299
    hdlr.setLevel(logging.DEBUG)
 
300
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
301
    _bzr_logger.addHandler(hdlr)
 
302
    _bzr_logger.setLevel(logging.DEBUG)
 
303
    result = hdlr, _trace_file, _trace_depth
 
304
    _trace_file = to_file
 
305
    _trace_depth += 1
 
306
    return result
 
307
 
 
308
 
 
309
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
310
    _bzr_logger.removeHandler(test_log_hdlr)
 
311
    test_log_hdlr.close()
 
312
    global _trace_file
 
313
    global _trace_depth
 
314
    _trace_file = old_trace_file
 
315
    _trace_depth = old_trace_depth
 
316
    if not _trace_depth:
 
317
        enable_default_logging()
467
318
 
468
319
 
469
320
def report_exception(exc_info, err_file):
473
324
 
474
325
    :return: The appropriate exit code for this error.
475
326
    """
 
327
    exc_type, exc_object, exc_tb = exc_info
476
328
    # Log the full traceback to ~/.bzr.log
477
329
    log_exception_quietly()
478
 
    if 'error' in debug.debug_flags:
479
 
        print_exception(exc_info, err_file)
480
 
        return errors.EXIT_ERROR
481
 
    exc_type, exc_object, exc_tb = exc_info
482
330
    if (isinstance(exc_object, IOError)
483
331
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
484
332
        err_file.write("bzr: broken pipe\n")
486
334
    elif isinstance(exc_object, KeyboardInterrupt):
487
335
        err_file.write("bzr: interrupted\n")
488
336
        return errors.EXIT_ERROR
489
 
    elif isinstance(exc_object, MemoryError):
490
 
        err_file.write("bzr: out of memory\n")
491
 
        return errors.EXIT_ERROR
492
 
    elif isinstance(exc_object, ImportError) \
493
 
        and str(exc_object).startswith("No module named "):
494
 
        report_user_error(exc_info, err_file,
495
 
            'You may need to install this Python library separately.')
496
 
        return errors.EXIT_ERROR
497
337
    elif not getattr(exc_object, 'internal_error', True):
498
338
        report_user_error(exc_info, err_file)
499
339
        return errors.EXIT_ERROR
507
347
        return errors.EXIT_INTERNAL_ERROR
508
348
 
509
349
 
510
 
def print_exception(exc_info, err_file):
511
 
    exc_type, exc_object, exc_tb = exc_info
512
 
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
513
 
        exc_type.__module__, exc_type.__name__, exc_object))
514
 
    err_file.write('\n')
515
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
516
 
 
517
 
 
518
350
# TODO: Should these be specially encoding the output?
519
 
def report_user_error(exc_info, err_file, advice=None):
 
351
def report_user_error(exc_info, err_file):
520
352
    """Report to err_file an error that's not an internal error.
521
353
 
522
354
    These don't get a traceback unless -Derror was given.
523
 
 
524
 
    :param exc_info: 3-tuple from sys.exc_info()
525
 
    :param advice: Extra advice to the user to be printed following the
526
 
        exception.
527
355
    """
 
356
    if 'error' in debug.debug_flags:
 
357
        report_bug(exc_info, err_file)
 
358
        return
528
359
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
529
 
    if advice:
530
 
        err_file.write("%s\n" % (advice,))
531
360
 
532
361
 
533
362
def report_bug(exc_info, err_file):
534
363
    """Report an exception that probably indicates a bug in bzr"""
535
 
    from bzrlib.crash import report_bug
536
 
    report_bug(exc_info, err_file)
537
 
 
538
 
 
539
 
def _flush_stdout_stderr():
540
 
    # installed into an atexit hook by bzrlib.initialize()
541
 
    try:
542
 
        sys.stdout.flush()
543
 
        sys.stderr.flush()
544
 
    except IOError, e:
545
 
        import errno
546
 
        if e.errno in [errno.EINVAL, errno.EPIPE]:
547
 
            pass
548
 
        else:
549
 
            raise
550
 
 
551
 
 
552
 
def _flush_trace():
553
 
    # run from atexit hook
554
 
    global _trace_file
555
 
    if _trace_file:
556
 
        _trace_file.flush()
 
364
    import traceback
 
365
    exc_type, exc_object, exc_tb = exc_info
 
366
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
 
367
        exc_type.__module__, exc_type.__name__, exc_object))
 
368
    err_file.write('\n')
 
369
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
370
    err_file.write('\n')
 
371
    err_file.write('bzr %s on python %s (%s)\n' % \
 
372
                       (bzrlib.__version__,
 
373
                        '.'.join(map(str, sys.version_info)),
 
374
                        sys.platform))
 
375
    err_file.write('arguments: %r\n' % sys.argv)
 
376
    err_file.write(
 
377
        'encoding: %r, fsenc: %r, lang: %r\n' % (
 
378
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
 
379
            os.environ.get('LANG')))
 
380
    err_file.write("plugins:\n")
 
381
    for name, a_plugin in sorted(plugin.plugins().items()):
 
382
        err_file.write("  %-20s %s [%s]\n" %
 
383
            (name, a_plugin.path(), a_plugin.__version__))
 
384
    err_file.write(
 
385
        "\n"
 
386
        "** Please send this report to bazaar@lists.ubuntu.com\n"
 
387
        "   with a description of what you were doing when the\n"
 
388
        "   error occurred.\n"
 
389
        )