/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-14 03:50: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-20071114035056-72l6odzpby4bcmub
First cut at new look User Guide including chapters 1 and 2

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