/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: Alexander Belchenko
  • Date: 2008-02-07 08:47:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3230.
  • Revision ID: bialix@ukr.net-20080207084727-2eis03c4f2zf9inw
If BZR_HOME environment variable is defined then default location for .bzr.log trace file is ``$BZR_HOME/.bzr.log`` (required for proper testing BZR_LOG environment variable).

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
 
57
import re
61
58
import time
62
59
 
63
60
from bzrlib.lazy_import import lazy_import
70
67
 
71
68
import bzrlib
72
69
 
73
 
from bzrlib.symbol_versioning import (
74
 
    deprecated_function,
75
 
    deprecated_in,
76
 
    )
77
 
 
78
70
lazy_import(globals(), """
79
71
from bzrlib import (
80
72
    debug,
81
73
    errors,
82
74
    osutils,
83
75
    plugin,
84
 
    symbol_versioning,
85
 
    ui,
86
76
    )
87
77
""")
88
78
 
89
 
 
90
 
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
91
 
# is quiet; >0 is verbose.
 
79
_file_handler = None
 
80
_stderr_handler = None
92
81
_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
82
_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.
 
83
_trace_depth = 0
 
84
_bzr_log_file = None
102
85
_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
 
86
_start_time = bzrlib._start_time
 
87
 
 
88
 
 
89
# configure convenient aliases for output routines
 
90
 
110
91
_bzr_logger = logging.getLogger('bzr')
111
92
 
112
93
 
113
94
def note(*args, **kwargs):
114
95
    # 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
96
    import bzrlib.ui
120
97
    bzrlib.ui.ui_factory.clear_term()
121
98
    _bzr_logger.info(*args, **kwargs)
122
99
 
123
 
 
124
100
def warning(*args, **kwargs):
125
101
    import bzrlib.ui
126
102
    bzrlib.ui.ui_factory.clear_term()
127
103
    _bzr_logger.warning(*args, **kwargs)
128
104
 
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)
 
105
info = note
 
106
log_error = _bzr_logger.error
 
107
error =     _bzr_logger.error
154
108
 
155
109
 
156
110
def mutter(fmt, *args):
157
111
    if _trace_file is None:
158
112
        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
113
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
162
114
        return
163
115
 
176
128
        out = fmt % tuple(real_args)
177
129
    else:
178
130
        out = fmt
179
 
    now = time.time()
180
 
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
 
131
    timestamp = '%0.3f  ' % (time.time() - _start_time,)
181
132
    out = timestamp + out + '\n'
182
133
    _trace_file.write(out)
183
 
    # there's no explicit flushing; the file is typically line buffered.
 
134
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
135
    #_trace_file.flush()
184
136
 
185
137
 
186
138
def mutter_callsite(stacklevel, fmt, *args):
192
144
    :param args: A list of substitution variables.
193
145
    """
194
146
    outf = StringIO()
195
 
    if stacklevel is None:
196
 
        limit = None
197
 
    else:
198
 
        limit = stacklevel + 1
199
 
    traceback.print_stack(limit=limit, file=outf)
 
147
    traceback.print_stack(limit=stacklevel + 1, file=outf)
200
148
    formatted_lines = outf.getvalue().splitlines()
201
149
    formatted_stack = '\n'.join(formatted_lines[:-2])
202
150
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
214
162
        return
215
163
 
216
164
 
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:
223
 
        if sys.platform == 'win32':
224
 
            from bzrlib import win32utils
225
 
            home = win32utils.get_home_location()
226
 
        else:
227
 
            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
 
165
def open_tracefile(tracefilename=None):
 
166
    # Messages are always written to here, so that we have some
 
167
    # information if something goes wrong.  In a future version this
 
168
    # file will be removed on successful completion.
 
169
    global _file_handler, _bzr_log_file, _bzr_log_filename
 
170
    import codecs
 
171
 
 
172
    if tracefilename is None:
 
173
        home = os.environ.get('BZR_HOME')
 
174
        if home is None:
 
175
            if sys.platform == 'win32':
 
176
                from bzrlib import win32utils
 
177
                home = win32utils.get_home_location()
262
178
            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()
 
179
                home = os.path.expanduser('~')
 
180
        _bzr_log_filename = os.path.join(home, '.bzr.log')
 
181
    else:
 
182
        _bzr_log_filename = tracefilename
 
183
 
 
184
    _bzr_log_filename = os.path.expanduser(_bzr_log_filename)
269
185
    _rollover_trace_maybe(_bzr_log_filename)
270
186
    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()
 
187
        LINE_BUFFERED = 1
 
188
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
189
        tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
 
190
        _bzr_log_file = tf
 
191
        # tf.tell() on windows always return 0 until some writing done
 
192
        tf.write('\n')
 
193
        if tf.tell() <= 2:
 
194
            tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
 
195
            tf.write("you can delete or truncate this file, or include sections in\n")
 
196
            tf.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
 
197
        _file_handler = logging.StreamHandler(tf)
 
198
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
199
        datefmt = r'%Y-%m-%d %H:%M:%S'
 
200
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
201
        _file_handler.setLevel(logging.DEBUG)
 
202
        logging.getLogger('').addHandler(_file_handler)
 
203
    except IOError, e:
 
204
        warning("failed to open trace file: %s" % (e))
376
205
 
377
206
 
378
207
def log_exception_quietly():
379
208
    """Log the last exception to the trace file only.
380
209
 
381
 
    Used for exceptions that occur internally and that may be
382
 
    interesting to developers but not to users.  For example,
 
210
    Used for exceptions that occur internally and that may be 
 
211
    interesting to developers but not to users.  For example, 
383
212
    errors loading plugins.
384
213
    """
 
214
    import traceback
385
215
    mutter(traceback.format_exc())
386
216
 
387
217
 
 
218
def enable_default_logging(tracefilename=None):
 
219
    """Configure default logging to stderr and .bzr.log"""
 
220
    # FIXME: if this is run twice, things get confused
 
221
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
222
    # create encoded wrapper around stderr
 
223
    stderr = codecs.getwriter(osutils.get_terminal_encoding())(sys.stderr,
 
224
        errors='replace')
 
225
    _stderr_handler = logging.StreamHandler(stderr)
 
226
    logging.getLogger('').addHandler(_stderr_handler)
 
227
    _stderr_handler.setLevel(logging.INFO)
 
228
    if not _file_handler:
 
229
        open_tracefile(tracefilename)
 
230
    _trace_file = _bzr_log_file
 
231
    if _file_handler:
 
232
        _file_handler.setLevel(logging.DEBUG)
 
233
    _bzr_logger.setLevel(logging.DEBUG)
 
234
 
 
235
 
388
236
def set_verbosity_level(level):
389
237
    """Set the verbosity level.
390
238
 
393
241
    global _verbosity_level
394
242
    _verbosity_level = level
395
243
    _update_logging_level(level < 0)
396
 
    ui.ui_factory.be_quiet(level < 0)
397
244
 
398
245
 
399
246
def get_verbosity_level():
405
252
 
406
253
 
407
254
def be_quiet(quiet=True):
 
255
    # Perhaps this could be deprecated now ...
408
256
    if quiet:
409
257
        set_verbosity_level(-1)
410
258
    else:
414
262
def _update_logging_level(quiet=True):
415
263
    """Hide INFO messages if quiet."""
416
264
    if quiet:
417
 
        _bzr_logger.setLevel(logging.WARNING)
 
265
        _stderr_handler.setLevel(logging.WARNING)
418
266
    else:
419
 
        _bzr_logger.setLevel(logging.INFO)
 
267
        _stderr_handler.setLevel(logging.INFO)
420
268
 
421
269
 
422
270
def is_quiet():
429
277
    return _verbosity_level > 0
430
278
 
431
279
 
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
 
280
def disable_default_logging():
 
281
    """Turn off default log handlers.
 
282
 
 
283
    This is intended to be used by the test framework, which doesn't
 
284
    want leakage from the code-under-test into the main logs.
 
285
    """
 
286
 
 
287
    l = logging.getLogger('')
 
288
    l.removeHandler(_stderr_handler)
 
289
    if _file_handler:
 
290
        l.removeHandler(_file_handler)
 
291
    _trace_file = None
 
292
 
 
293
 
 
294
def enable_test_log(to_file):
 
295
    """Redirect logging to a temporary file for a test
 
296
    
 
297
    returns an opaque reference that should be passed to disable_test_log
 
298
    after the test completes.
 
299
    """
 
300
    disable_default_logging()
 
301
    global _trace_file
 
302
    global _trace_depth
 
303
    hdlr = logging.StreamHandler(to_file)
 
304
    hdlr.setLevel(logging.DEBUG)
 
305
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
306
    _bzr_logger.addHandler(hdlr)
 
307
    _bzr_logger.setLevel(logging.DEBUG)
 
308
    result = hdlr, _trace_file, _trace_depth
 
309
    _trace_file = to_file
 
310
    _trace_depth += 1
 
311
    return result
 
312
 
 
313
 
 
314
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
315
    _bzr_logger.removeHandler(test_log_hdlr)
 
316
    test_log_hdlr.close()
 
317
    global _trace_file
 
318
    global _trace_depth
 
319
    _trace_file = old_trace_file
 
320
    _trace_depth = old_trace_depth
 
321
    if not _trace_depth:
 
322
        enable_default_logging()
462
323
 
463
324
 
464
325
def report_exception(exc_info, err_file):
468
329
 
469
330
    :return: The appropriate exit code for this error.
470
331
    """
 
332
    exc_type, exc_object, exc_tb = exc_info
471
333
    # Log the full traceback to ~/.bzr.log
472
334
    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
335
    if (isinstance(exc_object, IOError)
478
336
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
479
337
        err_file.write("bzr: broken pipe\n")
481
339
    elif isinstance(exc_object, KeyboardInterrupt):
482
340
        err_file.write("bzr: interrupted\n")
483
341
        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
492
342
    elif not getattr(exc_object, 'internal_error', True):
493
343
        report_user_error(exc_info, err_file)
494
344
        return errors.EXIT_ERROR
502
352
        return errors.EXIT_INTERNAL_ERROR
503
353
 
504
354
 
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
 
 
512
 
 
513
355
# TODO: Should these be specially encoding the output?
514
 
def report_user_error(exc_info, err_file, advice=None):
 
356
def report_user_error(exc_info, err_file):
515
357
    """Report to err_file an error that's not an internal error.
516
358
 
517
359
    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
360
    """
 
361
    if 'error' in debug.debug_flags:
 
362
        report_bug(exc_info, err_file)
 
363
        return
523
364
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
524
 
    if advice:
525
 
        err_file.write("%s\n" % (advice,))
526
365
 
527
366
 
528
367
def report_bug(exc_info, err_file):
529
368
    """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()
 
369
    import traceback
 
370
    exc_type, exc_object, exc_tb = exc_info
 
371
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
 
372
        exc_type.__module__, exc_type.__name__, exc_object))
 
373
    err_file.write('\n')
 
374
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
375
    err_file.write('\n')
 
376
    err_file.write('bzr %s on python %s (%s)\n' % \
 
377
                       (bzrlib.__version__,
 
378
                        '.'.join(map(str, sys.version_info)),
 
379
                        sys.platform))
 
380
    err_file.write('arguments: %r\n' % sys.argv)
 
381
    err_file.write(
 
382
        'encoding: %r, fsenc: %r, lang: %r\n' % (
 
383
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
 
384
            os.environ.get('LANG')))
 
385
    err_file.write("plugins:\n")
 
386
    for name, a_plugin in sorted(plugin.plugins().items()):
 
387
        err_file.write("  %-20s %s [%s]\n" %
 
388
            (name, a_plugin.path(), a_plugin.__version__))
 
389
    err_file.write(
 
390
"""\
 
391
*** Bazaar has encountered an internal error.
 
392
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
 
393
    including this traceback, and a description of what you
 
394
    were doing when the error occurred.
 
395
""")