~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

(igc) What's New in Bazaar 2.1 document

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
1
3
# This program is free software; you can redistribute it and/or modify
2
4
# it under the terms of the GNU General Public License as published by
3
5
# the Free Software Foundation; either version 2 of the License, or
4
6
# (at your option) any later version.
5
 
 
 
7
#
6
8
# This program is distributed in the hope that it will be useful,
7
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9
11
# GNU General Public License for more details.
10
 
 
 
12
#
11
13
# You should have received a copy of the GNU General Public License
12
14
# along with this program; if not, write to the Free Software
13
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
14
 
 
15
 
 
16
 
"""Messages and logging for bazaar-ng
17
 
 
18
 
Messages are sent out through the Python logging library.
19
 
 
20
 
They can be sent to two places: to stderr, and to ~/.bzr.log.
21
 
 
22
 
~/.bzr.log gets all messages, and tracebacks of all uncaught
23
 
exceptions.
24
 
 
25
 
Normally stderr only gets messages of level INFO and higher, and gets
26
 
only a summary of exceptions, not the traceback.
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Messages and logging.
 
18
 
 
19
Messages are supplied by callers as a string-formatting template, plus values
 
20
to be inserted into it.  The actual %-formatting is deferred to the log
 
21
library so that it doesn't need to be done for messages that won't be emitted.
 
22
 
 
23
Messages are classified by severity levels: critical, error, warning, info,
 
24
and debug.
 
25
 
 
26
They can be sent to two places: to stderr, and to ~/.bzr.log.  For purposes
 
27
such as running the test suite, they can also be redirected away from both of
 
28
those two places to another location.
 
29
 
 
30
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
 
31
This trace file is always in UTF-8, regardless of the user's default encoding,
 
32
so that we can always rely on writing any message.
 
33
 
 
34
Output to stderr depends on the mode chosen by the user.  By default, messages
 
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.
 
37
 
 
38
Errors that terminate an operation are generally passed back as exceptions;
 
39
others may be just emitted as messages.
 
40
 
 
41
Exceptions are reported in a brief form to stderr so as not to look scary.
 
42
BzrErrors are required to be able to format themselves into a properly
 
43
explanatory message.  This is not true for builtin exceptions such as
 
44
KeyError, which typically just str to "0".  They're printed in a different
 
45
form.
27
46
"""
28
47
 
29
 
 
30
 
# TODO: in debug mode, stderr should get full tracebacks and also
31
 
# debug messages.  (Is this really needed?)
32
 
 
33
 
# TODO: When running the test suites, we should add an additional
34
 
# logger that sends messages into the test log file.
35
 
 
36
48
# FIXME: Unfortunately it turns out that python's logging module
37
49
# is quite expensive, even when the message is not printed by any handlers.
38
50
# We should perhaps change back to just simply doing it here.
39
 
 
40
 
 
 
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
 
59
import os
41
60
import sys
42
 
import os
43
 
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
44
68
import traceback
45
 
 
46
 
 
47
 
_file_handler = None
48
 
_stderr_handler = None
49
 
 
50
 
 
51
 
class QuietFormatter(logging.Formatter):
52
 
    """Formatter that supresses the details of errors.
53
 
 
54
 
    This is used by default on stderr so as not to scare the user.
55
 
    """
56
 
    # At first I tried overriding formatException to suppress the
57
 
    # exception details, but that has global effect: no loggers
58
 
    # can get the exception details is we suppress them here.
59
 
 
60
 
    def format(self, record):
61
 
        if record.levelno >= logging.WARNING:
62
 
            s = 'bzr: ' + record.levelname + ': '
63
 
        else:
64
 
            s = ''
65
 
            
66
 
        s += record.getMessage()
67
 
 
68
 
        ##import textwrap
69
 
        ##s = textwrap.fill(s)
70
 
            
71
 
        if record.exc_info:
72
 
            # give just a summary of the exception, not the whole thing
73
 
            exinfo = traceback.extract_tb(record.exc_info[2])
74
 
            # the format of this string matches one of the REs
75
 
            s += '\n'
76
 
            s += ('  at %s line %d, in %s()\n' % exinfo[-1][:3])
77
 
            s += '  see ~/.bzr.log for debug information'
78
 
 
79
 
        return s
80
 
        
81
 
 
82
 
 
83
 
 
84
 
################
85
 
# configure convenient aliases for output routines
86
 
 
 
69
""")
 
70
 
 
71
import bzrlib
 
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.
 
98
_trace_file = None
 
99
 
 
100
# Absolute path for ~/.bzr.log.  Not changed even if the log/trace output is
 
101
# redirected elsewhere.  Used to show the location in --version.
 
102
_bzr_log_filename = None
 
103
 
 
104
# The time the first message was written to the trace file, so that we can
 
105
# show relative times since startup.
 
106
_bzr_log_start_time = bzrlib._start_time
 
107
 
 
108
 
 
109
# held in a global for quick reference
87
110
_bzr_logger = logging.getLogger('bzr')
88
 
_bzr_logger.setLevel(logging.DEBUG) 
89
 
 
90
 
info = note = _bzr_logger.info
91
 
warning =   _bzr_logger.warning
92
 
log_error = _bzr_logger.error
93
 
error =     _bzr_logger.error
94
 
mutter =    _bzr_logger.debug
95
 
debug =     _bzr_logger.debug
96
 
 
97
 
 
98
 
 
99
 
 
100
 
# we do the rollover using this code, rather than the default from python
101
 
# logging, because we only want to rollover at program startup, not on each
102
 
# message.  maybe that's not a good enough reason.
 
111
 
 
112
 
 
113
def note(*args, **kwargs):
 
114
    # 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
    import bzrlib.ui
 
120
    bzrlib.ui.ui_factory.clear_term()
 
121
    _bzr_logger.info(*args, **kwargs)
 
122
 
 
123
 
 
124
def warning(*args, **kwargs):
 
125
    import bzrlib.ui
 
126
    bzrlib.ui.ui_factory.clear_term()
 
127
    _bzr_logger.warning(*args, **kwargs)
 
128
 
 
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(msg):
 
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)
 
154
 
 
155
 
 
156
def mutter(fmt, *args):
 
157
    if _trace_file is None:
 
158
        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
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
 
162
        return
 
163
 
 
164
    if isinstance(fmt, unicode):
 
165
        fmt = fmt.encode('utf8')
 
166
 
 
167
    if len(args) > 0:
 
168
        # It seems that if we do ascii % (unicode, ascii) we can
 
169
        # get a unicode cannot encode ascii error, so make sure that "fmt"
 
170
        # is a unicode string
 
171
        real_args = []
 
172
        for arg in args:
 
173
            if isinstance(arg, unicode):
 
174
                arg = arg.encode('utf8')
 
175
            real_args.append(arg)
 
176
        out = fmt % tuple(real_args)
 
177
    else:
 
178
        out = fmt
 
179
    now = time.time()
 
180
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
 
181
    out = timestamp + out + '\n'
 
182
    _trace_file.write(out)
 
183
    # there's no explicit flushing; the file is typically line buffered.
 
184
 
 
185
 
 
186
def mutter_callsite(stacklevel, fmt, *args):
 
187
    """Perform a mutter of fmt and args, logging the call trace.
 
188
 
 
189
    :param stacklevel: The number of frames to show. None will show all
 
190
        frames.
 
191
    :param fmt: The format string to pass to mutter.
 
192
    :param args: A list of substitution variables.
 
193
    """
 
194
    outf = StringIO()
 
195
    if stacklevel is None:
 
196
        limit = None
 
197
    else:
 
198
        limit = stacklevel + 1
 
199
    traceback.print_stack(limit=limit, file=outf)
 
200
    formatted_lines = outf.getvalue().splitlines()
 
201
    formatted_stack = '\n'.join(formatted_lines[:-2])
 
202
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
 
203
 
103
204
 
104
205
def _rollover_trace_maybe(trace_fname):
105
206
    import stat
108
209
        if size <= 4 << 20:
109
210
            return
110
211
        old_fname = trace_fname + '.old'
111
 
 
112
 
        from osutils import rename
113
 
        rename(trace_fname, old_fname)
114
 
 
 
212
        osutils.rename(trace_fname, old_fname)
115
213
    except OSError:
116
214
        return
117
215
 
118
216
 
119
 
 
120
 
def open_tracefile(tracefilename='~/.bzr.log'):
121
 
    # Messages are always written to here, so that we have some
122
 
    # information if something goes wrong.  In a future version this
123
 
    # file will be removed on successful completion.
124
 
    global _file_handler
125
 
    import stat, codecs
126
 
 
127
 
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
 
    _rollover_trace_maybe(trace_fname)
129
 
 
130
 
    # buffering=1 means line buffered
 
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
    _bzr_log_filename = _get_bzr_log_filename()
 
242
    _rollover_trace_maybe(_bzr_log_filename)
131
243
    try:
132
 
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
133
 
 
134
 
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
135
 
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
136
 
            tf.write("you can delete or truncate this file, or include sections in\n")
137
 
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
138
 
        
139
 
        _file_handler = logging.StreamHandler(tf)
140
 
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
 
        datefmt = r'%a %H:%M:%S'
142
 
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
 
        _file_handler.setLevel(logging.DEBUG)
144
 
        logging.getLogger('').addHandler(_file_handler)
145
 
 
 
244
        bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
 
245
        # bzr_log_file.tell() on windows always return 0 until some writing done
 
246
        bzr_log_file.write('\n')
 
247
        if bzr_log_file.tell() <= 2:
 
248
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
 
249
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
 
250
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
 
251
        return bzr_log_file
146
252
    except IOError, e:
147
 
        warning("failed to open trace file: %s" % (e))
148
 
 
149
 
 
150
 
def log_startup(argv):
151
 
    import bzrlib
152
 
 
153
 
    debug('bzr %s invoked on python %s (%s)',
154
 
          bzrlib.__version__,
155
 
          '.'.join(map(str, sys.version_info)),
156
 
          sys.platform)
157
 
 
158
 
    debug('  arguments: %r', argv)
159
 
    debug('  working dir: %r', os.getcwdu())
160
 
 
161
 
 
162
 
def log_exception(msg=None):
163
 
    """Log the last exception to stderr and the trace file.
164
 
 
165
 
    The exception string representation is used as the error
166
 
    summary, unless msg is given.
167
 
    """
168
 
    cmd_repr = ' '.join(repr(arg) for arg in sys.argv)
169
 
    cmd_info = '\n  command: %s\n  pwd: %s' \
170
 
        % (cmd_repr, os.getcwd())
171
 
    if msg == None:
172
 
        ei = sys.exc_info()
173
 
        msg = str(ei[1])
174
 
    if msg and (msg[-1] == '\n'):
175
 
        msg = msg[:-1]
176
 
    ## msg = "(%s) %s" % (str(type(ei[1])), msg)
177
 
    _bzr_logger.exception(msg + cmd_info)
178
 
 
 
253
        # If we are failing to open the log, then most likely logging has not
 
254
        # been set up yet. So we just write to stderr rather than using
 
255
        # 'warning()'. If we using warning(), users get the unhelpful 'no
 
256
        # handlers registered for "bzr"' when something goes wrong on the
 
257
        # server. (bug #503886)
 
258
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
 
259
    # TODO: What should happen if we fail to open the trace file?  Maybe the
 
260
    # objects should be pointed at /dev/null or the equivalent?  Currently
 
261
    # returns None which will cause failures later.
 
262
    return None
 
263
 
 
264
 
 
265
def enable_default_logging():
 
266
    """Configure default logging: messages to stderr and debug to .bzr.log
 
267
 
 
268
    This should only be called once per process.
 
269
 
 
270
    Non-command-line programs embedding bzrlib do not need to call this.  They
 
271
    can instead either pass a file to _push_log_file, or act directly on
 
272
    logging.getLogger("bzr").
 
273
 
 
274
    Output can be redirected away by calling _push_log_file.
 
275
    """
 
276
    # Do this before we open the log file, so we prevent
 
277
    # get_terminal_encoding() from mutter()ing multiple times
 
278
    term_encoding = osutils.get_terminal_encoding()
 
279
    start_time = osutils.format_local_date(_bzr_log_start_time,
 
280
                                           timezone='local')
 
281
    # create encoded wrapper around stderr
 
282
    bzr_log_file = _open_bzr_log()
 
283
    if bzr_log_file is not None:
 
284
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
 
285
    push_log_file(bzr_log_file,
 
286
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
 
287
        r'%Y-%m-%d %H:%M:%S')
 
288
    # after hooking output into bzr_log, we also need to attach a stderr
 
289
    # handler, writing only at level info and with encoding
 
290
    writer_factory = codecs.getwriter(term_encoding)
 
291
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
 
292
    stderr_handler = logging.StreamHandler(encoded_stderr)
 
293
    stderr_handler.setLevel(logging.INFO)
 
294
    logging.getLogger('bzr').addHandler(stderr_handler)
 
295
 
 
296
 
 
297
def push_log_file(to_file, log_format=None, date_format=None):
 
298
    """Intercept log and trace messages and send them to a file.
 
299
 
 
300
    :param to_file: A file-like object to which messages will be sent.
 
301
 
 
302
    :returns: A memento that should be passed to _pop_log_file to restore the
 
303
    previously active logging.
 
304
    """
 
305
    global _trace_file
 
306
    # make a new handler
 
307
    new_handler = logging.StreamHandler(to_file)
 
308
    new_handler.setLevel(logging.DEBUG)
 
309
    if log_format is None:
 
310
        log_format = '%(levelname)8s  %(message)s'
 
311
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
 
312
    # save and remove any existing log handlers
 
313
    bzr_logger = logging.getLogger('bzr')
 
314
    old_handlers = bzr_logger.handlers[:]
 
315
    del bzr_logger.handlers[:]
 
316
    # set that as the default logger
 
317
    bzr_logger.addHandler(new_handler)
 
318
    bzr_logger.setLevel(logging.DEBUG)
 
319
    # TODO: check if any changes are needed to the root logger
 
320
    #
 
321
    # TODO: also probably need to save and restore the level on bzr_logger.
 
322
    # but maybe we can avoid setting the logger level altogether, and just set
 
323
    # the level on the handler?
 
324
    #
 
325
    # save the old trace file
 
326
    old_trace_file = _trace_file
 
327
    # send traces to the new one
 
328
    _trace_file = to_file
 
329
    result = new_handler, _trace_file
 
330
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
 
331
 
 
332
 
 
333
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
 
334
    """Undo changes to logging/tracing done by _push_log_file.
 
335
 
 
336
    This flushes, but does not close the trace file.
 
337
 
 
338
    Takes the memento returned from _push_log_file."""
 
339
    global _trace_file
 
340
    _trace_file = old_trace_file
 
341
    bzr_logger = logging.getLogger('bzr')
 
342
    bzr_logger.removeHandler(new_handler)
 
343
    # must be closed, otherwise logging will try to close it atexit, and the
 
344
    # file will likely already be closed underneath.
 
345
    new_handler.close()
 
346
    bzr_logger.handlers = old_handlers
 
347
    new_trace_file.flush()
179
348
 
180
349
 
181
350
def log_exception_quietly():
182
351
    """Log the last exception to the trace file only.
183
352
 
184
 
    Used for exceptions that occur internally and that may be 
185
 
    interesting to developers but not to users.  For example, 
 
353
    Used for exceptions that occur internally and that may be
 
354
    interesting to developers but not to users.  For example,
186
355
    errors loading plugins.
187
356
    """
188
 
    debug(traceback.format_exc())
189
 
 
190
 
 
191
 
def enable_default_logging():
192
 
    """Configure default logging to stderr and .bzr.log"""
193
 
    global _stderr_handler, _file_handler
194
 
 
195
 
    _stderr_handler = logging.StreamHandler()
196
 
    _stderr_handler.setFormatter(QuietFormatter())
197
 
 
198
 
    if not _file_handler:
199
 
        open_tracefile()
200
 
 
201
 
    if os.environ.get('BZR_DEBUG'):
202
 
        level = logging.DEBUG
203
 
    else:
204
 
        level = logging.INFO
205
 
 
206
 
    _stderr_handler.setLevel(logging.INFO)
207
 
    _file_handler.setLevel(level)
208
 
 
209
 
    logging.getLogger('').addHandler(_stderr_handler)
210
 
 
211
 
 
212
 
def disable_default_logging():
213
 
    """Turn off default log handlers.
214
 
 
215
 
    This is intended to be used by the test framework, which doesn't
216
 
    want leakage from the code-under-test into the main logs.
217
 
    """
218
 
 
219
 
    l = logging.getLogger('')
220
 
    l.removeHandler(_stderr_handler)
221
 
    if _file_handler:
222
 
        l.removeHandler(_file_handler)
 
357
    mutter(traceback.format_exc())
 
358
 
 
359
 
 
360
def set_verbosity_level(level):
 
361
    """Set the verbosity level.
 
362
 
 
363
    :param level: -ve for quiet, 0 for normal, +ve for verbose
 
364
    """
 
365
    global _verbosity_level
 
366
    _verbosity_level = level
 
367
    _update_logging_level(level < 0)
 
368
    ui.ui_factory.be_quiet(level < 0)
 
369
 
 
370
 
 
371
def get_verbosity_level():
 
372
    """Get the verbosity level.
 
373
 
 
374
    See set_verbosity_level() for values.
 
375
    """
 
376
    return _verbosity_level
 
377
 
 
378
 
 
379
def be_quiet(quiet=True):
 
380
    if quiet:
 
381
        set_verbosity_level(-1)
 
382
    else:
 
383
        set_verbosity_level(0)
 
384
 
 
385
 
 
386
def _update_logging_level(quiet=True):
 
387
    """Hide INFO messages if quiet."""
 
388
    if quiet:
 
389
        _bzr_logger.setLevel(logging.WARNING)
 
390
    else:
 
391
        _bzr_logger.setLevel(logging.INFO)
 
392
 
 
393
 
 
394
def is_quiet():
 
395
    """Is the verbosity level negative?"""
 
396
    return _verbosity_level < 0
 
397
 
 
398
 
 
399
def is_verbose():
 
400
    """Is the verbosity level positive?"""
 
401
    return _verbosity_level > 0
 
402
 
 
403
 
 
404
def debug_memory(message='', short=True):
 
405
    """Write out a memory dump."""
 
406
    if sys.platform == 'win32':
 
407
        from bzrlib import win32utils
 
408
        win32utils.debug_memory_win32api(message=message, short=short)
 
409
    else:
 
410
        _debug_memory_proc(message=message, short=short)
 
411
 
 
412
 
 
413
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
 
414
 
 
415
def _debug_memory_proc(message='', short=True):
 
416
    try:
 
417
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
 
418
    except IOError:
 
419
        return
 
420
    try:
 
421
        status = status_file.read()
 
422
    finally:
 
423
        status_file.close()
 
424
    if message:
 
425
        note(message)
 
426
    for line in status.splitlines():
 
427
        if not short:
 
428
            note(line)
 
429
        else:
 
430
            for field in _short_fields:
 
431
                if line.startswith(field):
 
432
                    note(line)
 
433
                    break
 
434
 
 
435
 
 
436
def report_exception(exc_info, err_file):
 
437
    """Report an exception to err_file (typically stderr) and to .bzr.log.
 
438
 
 
439
    This will show either a full traceback or a short message as appropriate.
 
440
 
 
441
    :return: The appropriate exit code for this error.
 
442
    """
 
443
    # Log the full traceback to ~/.bzr.log
 
444
    log_exception_quietly()
 
445
    if 'error' in debug.debug_flags:
 
446
        print_exception(exc_info, err_file)
 
447
        return errors.EXIT_ERROR
 
448
    exc_type, exc_object, exc_tb = exc_info
 
449
    if (isinstance(exc_object, IOError)
 
450
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
 
451
        err_file.write("bzr: broken pipe\n")
 
452
        return errors.EXIT_ERROR
 
453
    elif isinstance(exc_object, KeyboardInterrupt):
 
454
        err_file.write("bzr: interrupted\n")
 
455
        return errors.EXIT_ERROR
 
456
    elif isinstance(exc_object, MemoryError):
 
457
        err_file.write("bzr: out of memory\n")
 
458
        return errors.EXIT_ERROR
 
459
    elif isinstance(exc_object, ImportError) \
 
460
        and str(exc_object).startswith("No module named "):
 
461
        report_user_error(exc_info, err_file,
 
462
            'You may need to install this Python library separately.')
 
463
        return errors.EXIT_ERROR
 
464
    elif not getattr(exc_object, 'internal_error', True):
 
465
        report_user_error(exc_info, err_file)
 
466
        return errors.EXIT_ERROR
 
467
    elif isinstance(exc_object, (OSError, IOError)):
 
468
        # Might be nice to catch all of these and show them as something more
 
469
        # specific, but there are too many cases at the moment.
 
470
        report_user_error(exc_info, err_file)
 
471
        return errors.EXIT_ERROR
 
472
    else:
 
473
        report_bug(exc_info, err_file)
 
474
        return errors.EXIT_INTERNAL_ERROR
 
475
 
 
476
 
 
477
def print_exception(exc_info, err_file):
 
478
    exc_type, exc_object, exc_tb = exc_info
 
479
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
 
480
        exc_type.__module__, exc_type.__name__, exc_object))
 
481
    err_file.write('\n')
 
482
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
483
 
 
484
 
 
485
# TODO: Should these be specially encoding the output?
 
486
def report_user_error(exc_info, err_file, advice=None):
 
487
    """Report to err_file an error that's not an internal error.
 
488
 
 
489
    These don't get a traceback unless -Derror was given.
 
490
 
 
491
    :param exc_info: 3-tuple from sys.exc_info()
 
492
    :param advice: Extra advice to the user to be printed following the
 
493
        exception.
 
494
    """
 
495
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
 
496
    if advice:
 
497
        err_file.write("%s\n" % (advice,))
 
498
 
 
499
 
 
500
def report_bug(exc_info, err_file):
 
501
    """Report an exception that probably indicates a bug in bzr"""
 
502
    from bzrlib.crash import report_bug
 
503
    report_bug(exc_info, err_file)