/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: Robert Collins
  • Date: 2010-05-11 08:44:59 UTC
  • mfrom: (5221 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511084459-pb0uinna9zs3wu59
Merge trunk - resolve conflicts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
 
1
# Copyright (C) 2005-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
"""Messages and logging for bazaar-ng.
 
17
"""Messages and logging.
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 quiet mode, only warnings and
37
 
above are shown.  In debug mode, stderr gets debug messages too.
 
36
list of files processed by add and commit.  In debug mode, stderr gets debug messages too.
38
37
 
39
38
Errors that terminate an operation are generally passed back as exceptions;
40
39
others may be just emitted as messages.
49
48
# FIXME: Unfortunately it turns out that python's logging module
50
49
# is quite expensive, even when the message is not printed by any handlers.
51
50
# We should perhaps change back to just simply doing it here.
52
 
 
53
 
 
54
 
import errno
 
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
 
 
57
import codecs
 
58
import logging
55
59
import os
56
60
import sys
57
 
import logging
 
61
import time
 
62
 
 
63
from bzrlib.lazy_import import lazy_import
 
64
lazy_import(globals(), """
 
65
from cStringIO import StringIO
 
66
import errno
 
67
import locale
 
68
import traceback
 
69
""")
58
70
 
59
71
import bzrlib
60
 
from bzrlib.errors import BzrError, BzrNewError
61
 
from bzrlib.symbol_versioning import (deprecated_function,
62
 
        zero_nine,
63
 
        )
64
 
 
65
 
_file_handler = None
66
 
_stderr_handler = None
67
 
_stderr_quiet = False
 
72
 
 
73
from bzrlib.symbol_versioning import (
 
74
    deprecated_function,
 
75
    deprecated_in,
 
76
    )
 
77
 
 
78
lazy_import(globals(), """
 
79
from bzrlib import (
 
80
    debug,
 
81
    errors,
 
82
    osutils,
 
83
    plugin,
 
84
    symbol_versioning,
 
85
    ui,
 
86
    )
 
87
""")
 
88
 
 
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.
68
98
_trace_file = None
69
 
_trace_depth = 0
70
 
_bzr_log_file = None
71
 
 
72
 
 
73
 
# configure convenient aliases for output routines
74
 
 
 
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
75
110
_bzr_logger = logging.getLogger('bzr')
76
111
 
 
112
 
77
113
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
    """
78
120
    # 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.
79
125
    import bzrlib.ui
80
126
    bzrlib.ui.ui_factory.clear_term()
81
127
    _bzr_logger.info(*args, **kwargs)
82
128
 
 
129
 
83
130
def warning(*args, **kwargs):
84
131
    import bzrlib.ui
85
132
    bzrlib.ui.ui_factory.clear_term()
86
133
    _bzr_logger.warning(*args, **kwargs)
87
134
 
88
 
info = note
89
 
log_error = _bzr_logger.error
90
 
error =     _bzr_logger.error
 
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)
91
160
 
92
161
 
93
162
def mutter(fmt, *args):
94
163
    if _trace_file is None:
95
164
        return
 
165
    # XXX: Don't check this every time; instead anyone who closes the file
 
166
    # ought to deregister it.  We can tolerate None.
96
167
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
97
168
        return
98
169
 
111
182
        out = fmt % tuple(real_args)
112
183
    else:
113
184
        out = fmt
114
 
    out += '\n'
 
185
    now = time.time()
 
186
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
 
187
    out = timestamp + out + '\n'
115
188
    _trace_file.write(out)
116
 
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
117
 
    #_trace_file.flush()
118
 
debug = mutter
 
189
    # there's no explicit flushing; the file is typically line buffered.
 
190
 
 
191
 
 
192
def mutter_callsite(stacklevel, fmt, *args):
 
193
    """Perform a mutter of fmt and args, logging the call trace.
 
194
 
 
195
    :param stacklevel: The number of frames to show. None will show all
 
196
        frames.
 
197
    :param fmt: The format string to pass to mutter.
 
198
    :param args: A list of substitution variables.
 
199
    """
 
200
    outf = StringIO()
 
201
    if stacklevel is None:
 
202
        limit = None
 
203
    else:
 
204
        limit = stacklevel + 1
 
205
    traceback.print_stack(limit=limit, file=outf)
 
206
    formatted_lines = outf.getvalue().splitlines()
 
207
    formatted_stack = '\n'.join(formatted_lines[:-2])
 
208
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
119
209
 
120
210
 
121
211
def _rollover_trace_maybe(trace_fname):
125
215
        if size <= 4 << 20:
126
216
            return
127
217
        old_fname = trace_fname + '.old'
128
 
        from osutils import rename
129
 
        rename(trace_fname, old_fname)
 
218
        osutils.rename(trace_fname, old_fname)
130
219
    except OSError:
131
220
        return
132
221
 
133
222
 
134
 
def open_tracefile(tracefilename='~/.bzr.log'):
135
 
    # Messages are always written to here, so that we have some
136
 
    # information if something goes wrong.  In a future version this
137
 
    # file will be removed on successful completion.
138
 
    global _file_handler, _bzr_log_file
139
 
    import codecs
140
 
 
141
 
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
142
 
    _rollover_trace_maybe(trace_fname)
 
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:
 
229
        if sys.platform == 'win32':
 
230
            from bzrlib import win32utils
 
231
            home = win32utils.get_home_location()
 
232
        else:
 
233
            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()
 
275
    _rollover_trace_maybe(_bzr_log_filename)
143
276
    try:
144
 
        LINE_BUFFERED = 1
145
 
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
146
 
        tf = open(trace_fname, 'at', LINE_BUFFERED)
147
 
        _bzr_log_file = tf
148
 
        if tf.tell() == 0:
149
 
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
150
 
            tf.write("you can delete or truncate this file, or include sections in\n")
151
 
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
152
 
        _file_handler = logging.StreamHandler(tf)
153
 
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
154
 
        datefmt = r'%a %H:%M:%S'
155
 
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
156
 
        _file_handler.setLevel(logging.DEBUG)
157
 
        logging.getLogger('').addHandler(_file_handler)
158
 
    except IOError, e:
159
 
        warning("failed to open trace file: %s" % (e))
160
 
 
161
 
 
162
 
@deprecated_function(zero_nine)
163
 
def log_exception(msg=None):
164
 
    """Log the last exception to stderr and the trace file.
165
 
 
166
 
    The exception string representation is used as the error
167
 
    summary, unless msg is given.
168
 
    """
169
 
    if msg:
170
 
        error(msg)
171
 
    else:
172
 
        exc_str = format_exception_short(sys.exc_info())
173
 
        error(exc_str)
174
 
    log_exception_quietly()
 
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()
175
382
 
176
383
 
177
384
def log_exception_quietly():
178
385
    """Log the last exception to the trace file only.
179
386
 
180
 
    Used for exceptions that occur internally and that may be 
181
 
    interesting to developers but not to users.  For example, 
 
387
    Used for exceptions that occur internally and that may be
 
388
    interesting to developers but not to users.  For example,
182
389
    errors loading plugins.
183
390
    """
184
 
    import traceback
185
 
    debug(traceback.format_exc())
186
 
 
187
 
 
188
 
def enable_default_logging():
189
 
    """Configure default logging to stderr and .bzr.log"""
190
 
    # FIXME: if this is run twice, things get confused
191
 
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
192
 
    _stderr_handler = logging.StreamHandler()
193
 
    logging.getLogger('').addHandler(_stderr_handler)
194
 
    _stderr_handler.setLevel(logging.INFO)
195
 
    if not _file_handler:
196
 
        open_tracefile()
197
 
    _trace_file = _bzr_log_file
198
 
    if _file_handler:
199
 
        _file_handler.setLevel(logging.DEBUG)
200
 
    _bzr_logger.setLevel(logging.DEBUG)
 
391
    mutter(traceback.format_exc())
 
392
 
 
393
 
 
394
def set_verbosity_level(level):
 
395
    """Set the verbosity level.
 
396
 
 
397
    :param level: -ve for quiet, 0 for normal, +ve for verbose
 
398
    """
 
399
    global _verbosity_level
 
400
    _verbosity_level = level
 
401
    _update_logging_level(level < 0)
 
402
    ui.ui_factory.be_quiet(level < 0)
 
403
 
 
404
 
 
405
def get_verbosity_level():
 
406
    """Get the verbosity level.
 
407
 
 
408
    See set_verbosity_level() for values.
 
409
    """
 
410
    return _verbosity_level
201
411
 
202
412
 
203
413
def be_quiet(quiet=True):
204
 
    global _stderr_handler, _stderr_quiet
205
 
    
206
 
    _stderr_quiet = quiet
207
 
    if quiet:
208
 
        _stderr_handler.setLevel(logging.WARNING)
209
 
    else:
210
 
        _stderr_handler.setLevel(logging.INFO)
 
414
    if quiet:
 
415
        set_verbosity_level(-1)
 
416
    else:
 
417
        set_verbosity_level(0)
 
418
 
 
419
 
 
420
def _update_logging_level(quiet=True):
 
421
    """Hide INFO messages if quiet."""
 
422
    if quiet:
 
423
        _bzr_logger.setLevel(logging.WARNING)
 
424
    else:
 
425
        _bzr_logger.setLevel(logging.INFO)
211
426
 
212
427
 
213
428
def is_quiet():
214
 
    global _stderr_quiet
215
 
    return _stderr_quiet
216
 
 
217
 
 
218
 
def disable_default_logging():
219
 
    """Turn off default log handlers.
220
 
 
221
 
    This is intended to be used by the test framework, which doesn't
222
 
    want leakage from the code-under-test into the main logs.
223
 
    """
224
 
 
225
 
    l = logging.getLogger('')
226
 
    l.removeHandler(_stderr_handler)
227
 
    if _file_handler:
228
 
        l.removeHandler(_file_handler)
229
 
    _trace_file = None
230
 
 
231
 
 
232
 
def enable_test_log(to_file):
233
 
    """Redirect logging to a temporary file for a test
234
 
    
235
 
    returns an opaque reference that should be passed to disable_test_log
236
 
    after the test completes.
237
 
    """
238
 
    disable_default_logging()
239
 
    global _trace_file
240
 
    global _trace_depth
241
 
    hdlr = logging.StreamHandler(to_file)
242
 
    hdlr.setLevel(logging.DEBUG)
243
 
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
244
 
    _bzr_logger.addHandler(hdlr)
245
 
    _bzr_logger.setLevel(logging.DEBUG)
246
 
    result = hdlr, _trace_file, _trace_depth
247
 
    _trace_file = to_file
248
 
    _trace_depth += 1
249
 
    return result
250
 
 
251
 
 
252
 
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
253
 
    _bzr_logger.removeHandler(test_log_hdlr)
254
 
    test_log_hdlr.close()
255
 
    global _trace_file
256
 
    global _trace_depth
257
 
    _trace_file = old_trace_file
258
 
    _trace_depth = old_trace_depth
259
 
    if not _trace_depth:
260
 
        enable_default_logging()
 
429
    """Is the verbosity level negative?"""
 
430
    return _verbosity_level < 0
 
431
 
 
432
 
 
433
def is_verbose():
 
434
    """Is the verbosity level positive?"""
 
435
    return _verbosity_level > 0
 
436
 
 
437
 
 
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
261
468
 
262
469
 
263
470
def report_exception(exc_info, err_file):
264
 
    exc_type, exc_object, exc_tb = exc_info
 
471
    """Report an exception to err_file (typically stderr) and to .bzr.log.
 
472
 
 
473
    This will show either a full traceback or a short message as appropriate.
 
474
 
 
475
    :return: The appropriate exit code for this error.
 
476
    """
265
477
    # Log the full traceback to ~/.bzr.log
266
478
    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
267
483
    if (isinstance(exc_object, IOError)
268
484
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
269
 
        print >>err_file, "bzr: broken pipe"
 
485
        err_file.write("bzr: broken pipe\n")
 
486
        return errors.EXIT_ERROR
270
487
    elif isinstance(exc_object, KeyboardInterrupt):
271
 
        print >>err_file, "bzr: interrupted"
272
 
    elif getattr(exc_object, 'is_user_error', False):
 
488
        err_file.write("bzr: interrupted\n")
 
489
        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
    elif not getattr(exc_object, 'internal_error', True):
273
499
        report_user_error(exc_info, err_file)
 
500
        return errors.EXIT_ERROR
274
501
    elif isinstance(exc_object, (OSError, IOError)):
275
502
        # Might be nice to catch all of these and show them as something more
276
503
        # specific, but there are too many cases at the moment.
277
504
        report_user_error(exc_info, err_file)
 
505
        return errors.EXIT_ERROR
278
506
    else:
279
507
        report_bug(exc_info, err_file)
 
508
        return errors.EXIT_INTERNAL_ERROR
 
509
 
 
510
 
 
511
def print_exception(exc_info, err_file):
 
512
    exc_type, exc_object, exc_tb = exc_info
 
513
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
 
514
        exc_type.__module__, exc_type.__name__, exc_object))
 
515
    err_file.write('\n')
 
516
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
280
517
 
281
518
 
282
519
# TODO: Should these be specially encoding the output?
283
 
def report_user_error(exc_info, err_file):
284
 
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
 
520
def report_user_error(exc_info, err_file, advice=None):
 
521
    """Report to err_file an error that's not an internal error.
 
522
 
 
523
    These don't get a traceback unless -Derror was given.
 
524
 
 
525
    :param exc_info: 3-tuple from sys.exc_info()
 
526
    :param advice: Extra advice to the user to be printed following the
 
527
        exception.
 
528
    """
 
529
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
 
530
    if advice:
 
531
        err_file.write("%s\n" % (advice,))
285
532
 
286
533
 
287
534
def report_bug(exc_info, err_file):
288
535
    """Report an exception that probably indicates a bug in bzr"""
289
 
    import traceback
290
 
    exc_type, exc_object, exc_tb = exc_info
291
 
    print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
292
 
    print >>err_file
293
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
294
 
    print >>err_file
295
 
    print >>err_file, 'bzr %s on python %s (%s)' % \
296
 
                       (bzrlib.__version__,
297
 
                        '.'.join(map(str, sys.version_info)),
298
 
                        sys.platform)
299
 
    print >>err_file, 'arguments: %r' % sys.argv
300
 
    print >>err_file
301
 
    print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
 
536
    from bzrlib.crash import report_bug
 
537
    report_bug(exc_info, err_file)
 
538
 
 
539
 
 
540
def _flush_stdout_stderr():
 
541
    # installed into an atexit hook by bzrlib.initialize()
 
542
    try:
 
543
        sys.stdout.flush()
 
544
        sys.stderr.flush()
 
545
    except IOError, e:
 
546
        import errno
 
547
        if e.errno in [errno.EINVAL, errno.EPIPE]:
 
548
            pass
 
549
        else:
 
550
            raise
 
551
 
 
552
 
 
553
def _flush_trace():
 
554
    # run from atexit hook
 
555
    global _trace_file
 
556
    if _trace_file:
 
557
        _trace_file.flush()