~bzr-pqm/bzr/bzr.dev

3173.1.3 by Martin Pool
Deprecate disable_default_logging and add 1.2 deprecation marker
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
1740.5.1 by Martin Pool
When an unhandled exception occurs, write the traceback to stderr.
2
#
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
#
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
#
13
# You should have received a copy of the GNU General Public License
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
1 by mbp at sourcefrog
import from baz patch-364
16
1185.33.6 by Martin Pool
Code and tests for shorter formatting of error messages
17
"""Messages and logging for bazaar-ng.
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.
1185.33.51 by Martin Pool
Fix trace of non-ascii messages, and add test.
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.
1185.33.6 by Martin Pool
Code and tests for shorter formatting of error messages
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 quiet mode, only warnings and
37
above are shown.  In debug mode, stderr gets debug messages too.
38
39
Errors that terminate an operation are generally passed back as exceptions;
40
others may be just emitted as messages.
41
42
Exceptions are reported in a brief form to stderr so as not to look scary.
43
BzrErrors are required to be able to format themselves into a properly
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
44
explanatory message.  This is not true for builtin exceptions such as
1185.33.6 by Martin Pool
Code and tests for shorter formatting of error messages
45
KeyError, which typically just str to "0".  They're printed in a different
46
form.
344 by Martin Pool
- It's not an error to use the library without
47
"""
48
1185.16.74 by Martin Pool
doc
49
# FIXME: Unfortunately it turns out that python's logging module
50
# is quite expensive, even when the message is not printed by any handlers.
51
# We should perhaps change back to just simply doing it here.
3173.1.6 by Martin Pool
Remove _stderr_handler global
52
#
53
# On the other hand, as of 1.2 we generally only call the mutter() statement
54
# if (according to debug_flags) we actually intend to write it.  So the
55
# increased cost of logging.py is not so bad, and we could standardize on
56
# that.
1185.16.74 by Martin Pool
doc
57
2978.1.1 by Alexander Belchenko
Output to stderr with trace module now going through wrapper that takes care about terminal encoding. (#54173)
58
import codecs
59
import logging
1740.5.3 by Martin Pool
Cleanup more exception-formatting code
60
import os
1551.9.3 by Aaron Bentley
Revert buggy apport changes
61
import sys
2123.1.1 by Robert Collins
(Robert Collins) Extend the problem reporting command line UI to use
62
import re
3170.1.1 by Andrew Bennetts
Add -Dtimes, which adds a timestamp to mutters (using the time since the first mutter).
63
import time
1996.3.29 by John Arbash Meinel
don't import errors, and try to lazy import logging in bzrlib.trace
64
65
from bzrlib.lazy_import import lazy_import
66
lazy_import(globals(), """
2725.1.1 by Robert Collins
Add -Devil flag to highlight the use of problematic API calls.
67
from cStringIO import StringIO
1996.3.29 by John Arbash Meinel
don't import errors, and try to lazy import logging in bzrlib.trace
68
import errno
2842.1.1 by Martin Pool
Report locale, encodings and plugins in traceback
69
import locale
2725.1.1 by Robert Collins
Add -Devil flag to highlight the use of problematic API calls.
70
import traceback
1996.3.29 by John Arbash Meinel
don't import errors, and try to lazy import logging in bzrlib.trace
71
""")
1097 by Martin Pool
- send trace messages out through python logging module
72
1185.33.8 by Martin Pool
Cleanup exception formatting stuff
73
import bzrlib
1097 by Martin Pool
- send trace messages out through python logging module
74
2095.5.2 by Martin Pool
save commit message if commit fails (#32054)
75
lazy_import(globals(), """
2713.2.1 by Martin Pool
Return exitcode 4 if an internal error occurs
76
from bzrlib import (
77
    debug,
78
    errors,
2842.1.1 by Martin Pool
Report locale, encodings and plugins in traceback
79
    osutils,
80
    plugin,
3173.1.3 by Martin Pool
Deprecate disable_default_logging and add 1.2 deprecation marker
81
    symbol_versioning,
2713.2.1 by Martin Pool
Return exitcode 4 if an internal error occurs
82
    )
2095.5.2 by Martin Pool
save commit message if commit fails (#32054)
83
""")
84
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
85
86
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
87
# is quiet; >0 is verbose.
2768.1.2 by Ian Clatworthy
Make noise levels a scale, not just a boolean in trace.py
88
_verbosity_level = 0
3173.1.2 by Martin Pool
bzrlib.trace docs and cleanups
89
90
# File-like object where mutter/debug output is currently sent.  Can be
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
91
# changed by _push_log_file etc.  This is directly manipulated by some
92
# external code; maybe there should be functions to do that more precisely
93
# than push/pop_log_file.
1185.43.7 by Martin Pool
Do debug messages not through python logging
94
_trace_file = None
3173.1.2 by Martin Pool
bzrlib.trace docs and cleanups
95
3173.1.5 by Martin Pool
Remove global _bzr_log_file
96
# Absolute path for ~/.bzr.log.  Not changed even if the log/trace output is
97
# redirected elsewhere.  Used to show the location in --version.
2566.1.1 by Martin Pool
Show bzr.log location in bzr --version output.
98
_bzr_log_filename = None
3173.1.2 by Martin Pool
bzrlib.trace docs and cleanups
99
100
# The time the first message was written to the trace file, so that we can
101
# show relative times since startup.
3173.1.14 by Martin Pool
Merge trunk
102
_bzr_log_start_time = bzrlib._start_time
3173.1.2 by Martin Pool
bzrlib.trace docs and cleanups
103
1097 by Martin Pool
- send trace messages out through python logging module
104
3173.1.5 by Martin Pool
Remove global _bzr_log_file
105
# held in a global for quick reference
1097 by Martin Pool
- send trace messages out through python logging module
106
_bzr_logger = logging.getLogger('bzr')
107
2978.1.1 by Alexander Belchenko
Output to stderr with trace module now going through wrapper that takes care about terminal encoding. (#54173)
108
1558.8.1 by Aaron Bentley
Fix overall progress bar's interaction with 'note' and 'warning'
109
def note(*args, **kwargs):
1793.2.16 by Aaron Bentley
More notes on 'note'
110
    # FIXME note always emits utf-8, regardless of the terminal encoding
3173.1.7 by Martin Pool
Rename push/pop_log_file, and deprecate enable/disable_test_log
111
    #
112
    # FIXME: clearing the ui and then going through the abstract logging
113
    # framework is whack; we should probably have a logging Handler that
114
    # deals with terminal output if needed.
1558.8.1 by Aaron Bentley
Fix overall progress bar's interaction with 'note' and 'warning'
115
    import bzrlib.ui
116
    bzrlib.ui.ui_factory.clear_term()
117
    _bzr_logger.info(*args, **kwargs)
118
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
119
1558.8.1 by Aaron Bentley
Fix overall progress bar's interaction with 'note' and 'warning'
120
def warning(*args, **kwargs):
121
    import bzrlib.ui
122
    bzrlib.ui.ui_factory.clear_term()
123
    _bzr_logger.warning(*args, **kwargs)
124
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
125
3173.1.2 by Martin Pool
bzrlib.trace docs and cleanups
126
# configure convenient aliases for output routines
127
#
128
# TODO: deprecate them, have one name for each.
1558.8.1 by Aaron Bentley
Fix overall progress bar's interaction with 'note' and 'warning'
129
info = note
1097 by Martin Pool
- send trace messages out through python logging module
130
log_error = _bzr_logger.error
131
error =     _bzr_logger.error
1185.43.7 by Martin Pool
Do debug messages not through python logging
132
133
134
def mutter(fmt, *args):
1185.43.10 by Martin Pool
Remove need for BZR_DEBUG to get debug info in trace file.
135
    if _trace_file is None:
136
        return
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
137
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
1185.43.10 by Martin Pool
Remove need for BZR_DEBUG to get debug info in trace file.
138
        return
1948.1.9 by John Arbash Meinel
Change mutter() so that it doesn't try so hard to write out perfect utf8, instead, rather than using a utf8 file, it changes unicode to utf8 manually
139
140
    if isinstance(fmt, unicode):
141
        fmt = fmt.encode('utf8')
142
1185.43.10 by Martin Pool
Remove need for BZR_DEBUG to get debug info in trace file.
143
    if len(args) > 0:
1685.1.2 by John Arbash Meinel
Re-enabling the non_ascii tests after fixing trace.py, bzr ignore also does the right thing now
144
        # It seems that if we do ascii % (unicode, ascii) we can
145
        # get a unicode cannot encode ascii error, so make sure that "fmt"
146
        # is a unicode string
1948.1.9 by John Arbash Meinel
Change mutter() so that it doesn't try so hard to write out perfect utf8, instead, rather than using a utf8 file, it changes unicode to utf8 manually
147
        real_args = []
148
        for arg in args:
149
            if isinstance(arg, unicode):
150
                arg = arg.encode('utf8')
151
            real_args.append(arg)
152
        out = fmt % tuple(real_args)
1185.43.10 by Martin Pool
Remove need for BZR_DEBUG to get debug info in trace file.
153
    else:
1185.33.51 by Martin Pool
Fix trace of non-ascii messages, and add test.
154
        out = fmt
3173.1.14 by Martin Pool
Merge trunk
155
    timestamp = '%0.3f  ' % (time.time() - _bzr_log_start_time,)
3195.1.1 by Andrew Bennetts
Always include timestamps in the trace file (i.e. remove -Dtimes in favour of having it switched on permanently)
156
    out = timestamp + out + '\n'
1948.1.9 by John Arbash Meinel
Change mutter() so that it doesn't try so hard to write out perfect utf8, instead, rather than using a utf8 file, it changes unicode to utf8 manually
157
    _trace_file.write(out)
3173.1.14 by Martin Pool
Merge trunk
158
    # no need to flush here, the trace file is now linebuffered when it's
159
    # opened.
1097 by Martin Pool
- send trace messages out through python logging module
160
1185.43.10 by Martin Pool
Remove need for BZR_DEBUG to get debug info in trace file.
161
2725.1.1 by Robert Collins
Add -Devil flag to highlight the use of problematic API calls.
162
def mutter_callsite(stacklevel, fmt, *args):
163
    """Perform a mutter of fmt and args, logging the call trace.
164
165
    :param stacklevel: The number of frames to show. None will show all
166
        frames.
167
    :param fmt: The format string to pass to mutter.
168
    :param args: A list of substitution variables.
169
    """
170
    outf = StringIO()
171
    traceback.print_stack(limit=stacklevel + 1, file=outf)
172
    formatted_lines = outf.getvalue().splitlines()
173
    formatted_stack = '\n'.join(formatted_lines[:-2])
174
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
175
176
261 by Martin Pool
- auto-rollover of .bzr.log
177
def _rollover_trace_maybe(trace_fname):
359 by Martin Pool
- pychecker fixups
178
    import stat
261 by Martin Pool
- auto-rollover of .bzr.log
179
    try:
180
        size = os.stat(trace_fname)[stat.ST_SIZE]
333 by Martin Pool
- allow trace file to grow up to 4MB
181
        if size <= 4 << 20:
261 by Martin Pool
- auto-rollover of .bzr.log
182
            return
183
        old_fname = trace_fname + '.old'
2851.3.1 by Martin Pool
Add unit test for _rollover_trace_maybe
184
        osutils.rename(trace_fname, old_fname)
261 by Martin Pool
- auto-rollover of .bzr.log
185
    except OSError:
186
        return
187
188
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
189
def _get_bzr_log_filename():
190
    # TODO: should this be overridden by $BZR_HOME?
191
    if sys.platform == 'win32':
192
        from bzrlib import win32utils
193
        home = win32utils.get_home_location()
194
    else:
195
        home = os.path.expanduser('~')
196
    return os.path.join(home, '.bzr.log')
197
198
199
def _open_bzr_log():
3173.1.2 by Martin Pool
bzrlib.trace docs and cleanups
200
    """Open the .bzr.log trace file.  
201
202
    If the log is more than a particular length, the old file is renamed to
203
    .bzr.log.old and a new file is started.  Otherwise, we append to the
204
    existing file.
205
3173.1.5 by Martin Pool
Remove global _bzr_log_file
206
    This sets the global _bzr_log_filename.
3173.1.2 by Martin Pool
bzrlib.trace docs and cleanups
207
    """
3173.1.5 by Martin Pool
Remove global _bzr_log_file
208
    global _bzr_log_filename
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
209
    _bzr_log_filename = _get_bzr_log_filename()
2566.1.1 by Martin Pool
Show bzr.log location in bzr --version output.
210
    _rollover_trace_maybe(_bzr_log_filename)
403 by Martin Pool
- Don't give an error if the trace file can't be opened
211
    try:
3173.1.5 by Martin Pool
Remove global _bzr_log_file
212
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
213
        # bzr_log_file.tell() on windows always return 0 until some writing done
214
        bzr_log_file.write('\n')
215
        if bzr_log_file.tell() <= 2:
216
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
217
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
218
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
219
        return bzr_log_file
403 by Martin Pool
- Don't give an error if the trace file can't be opened
220
    except IOError, e:
221
        warning("failed to open trace file: %s" % (e))
3173.1.5 by Martin Pool
Remove global _bzr_log_file
222
    # TODO: What should happen if we fail to open the trace file?  Maybe the
223
    # objects should be pointed at /dev/null or the equivalent?  Currently
224
    # returns None which will cause failures later.
260 by Martin Pool
- remove atexit() dependency for writing out execution times
225
1097 by Martin Pool
- send trace messages out through python logging module
226
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
227
def enable_default_logging():
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
228
    """Configure default logging: messages to stderr and debug to .bzr.log
229
    
230
    This should only be called once per process.
3173.1.6 by Martin Pool
Remove _stderr_handler global
231
232
    Non-command-line programs embedding bzrlib do not need to call this.  They
233
    can instead either pass a file to _push_log_file, or act directly on
234
    logging.getLogger("bzr").
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
235
    
236
    Output can be redirected away by calling _push_log_file.
237
    """
2978.1.1 by Alexander Belchenko
Output to stderr with trace module now going through wrapper that takes care about terminal encoding. (#54173)
238
    # create encoded wrapper around stderr
3173.1.5 by Martin Pool
Remove global _bzr_log_file
239
    bzr_log_file = _open_bzr_log()
3173.1.11 by Martin Pool
Fix up renaming of push_log_file
240
    push_log_file(bzr_log_file,
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
241
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
242
        r'%Y-%m-%d %H:%M:%S')
243
    # after hooking output into bzr_log, we also need to attach a stderr
3173.1.6 by Martin Pool
Remove _stderr_handler global
244
    # handler, writing only at level info and with encoding
245
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
246
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
247
    stderr_handler = logging.StreamHandler(encoded_stderr)
248
    stderr_handler.setLevel(logging.INFO)
249
    logging.getLogger('bzr').addHandler(stderr_handler)
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
250
251
3173.1.7 by Martin Pool
Rename push/pop_log_file, and deprecate enable/disable_test_log
252
def push_log_file(to_file, log_format=None, date_format=None):
3173.1.1 by Martin Pool
New _push_log_file and _pop_log_file as a cleaner stack, towards a fix for #124153
253
    """Intercept log and trace messages and send them to a file.
254
3173.1.11 by Martin Pool
Fix up renaming of push_log_file
255
    :param to_file: A file-like object to which messages will be sent.
256
3173.1.1 by Martin Pool
New _push_log_file and _pop_log_file as a cleaner stack, towards a fix for #124153
257
    :returns: A memento that should be passed to _pop_log_file to restore the 
258
    previously active logging.
259
    """
260
    global _trace_file
261
    # make a new handler
262
    new_handler = logging.StreamHandler(to_file)
263
    new_handler.setLevel(logging.DEBUG)
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
264
    if log_format is None:
265
        log_format = '%(levelname)8s  %(message)s'
266
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
3173.1.1 by Martin Pool
New _push_log_file and _pop_log_file as a cleaner stack, towards a fix for #124153
267
    # save and remove any existing log handlers
268
    bzr_logger = logging.getLogger('bzr')
269
    old_handlers = bzr_logger.handlers[:]
270
    del bzr_logger.handlers[:]
271
    # set that as the default logger
272
    bzr_logger.addHandler(new_handler)
273
    bzr_logger.setLevel(logging.DEBUG)
274
    # TODO: check if any changes are needed to the root logger
275
    #
276
    # TODO: also probably need to save and restore the level on bzr_logger.
277
    # but maybe we can avoid setting the logger level altogether, and just set
278
    # the level on the handler?
279
    #
280
    # save the old trace file
281
    old_trace_file = _trace_file
282
    # send traces to the new one
283
    _trace_file = to_file
284
    result = new_handler, _trace_file
285
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
286
287
3173.1.7 by Martin Pool
Rename push/pop_log_file, and deprecate enable/disable_test_log
288
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
3173.1.1 by Martin Pool
New _push_log_file and _pop_log_file as a cleaner stack, towards a fix for #124153
289
    """Undo changes to logging/tracing done by _push_log_file.
290
291
    This flushes, but does not close the trace file.
292
    
293
    Takes the memento returned from _push_log_file."""
294
    assert magic == 'log_memento'
295
    global _trace_file
296
    _trace_file = old_trace_file
297
    bzr_logger = logging.getLogger('bzr')
298
    bzr_logger.removeHandler(new_handler)
299
    # must be closed, otherwise logging will try to close it atexit, and the
300
    # file will likely already be closed underneath.
301
    new_handler.close()
302
    bzr_logger.handlers = old_handlers
303
    new_trace_file.flush()
304
305
3173.1.7 by Martin Pool
Rename push/pop_log_file, and deprecate enable/disable_test_log
306
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
1185.33.13 by Martin Pool
Hide more stuff in bzrlib.trace
307
def enable_test_log(to_file):
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
308
    """Redirect logging to a temporary file for a test
309
    
3173.1.1 by Martin Pool
New _push_log_file and _pop_log_file as a cleaner stack, towards a fix for #124153
310
    :returns: an opaque reference that should be passed to disable_test_log
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
311
    after the test completes.
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
312
    """
3173.1.7 by Martin Pool
Rename push/pop_log_file, and deprecate enable/disable_test_log
313
    return push_log_file(to_file)
314
315
316
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
3173.1.1 by Martin Pool
New _push_log_file and _pop_log_file as a cleaner stack, towards a fix for #124153
317
def disable_test_log(memento):
3173.1.7 by Martin Pool
Rename push/pop_log_file, and deprecate enable/disable_test_log
318
    return pop_log_file(memento)
1185.33.13 by Martin Pool
Hide more stuff in bzrlib.trace
319
320
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
321
def log_exception_quietly():
322
    """Log the last exception to the trace file only.
323
324
    Used for exceptions that occur internally and that may be 
325
    interesting to developers but not to users.  For example, 
326
    errors loading plugins.
327
    """
328
    mutter(traceback.format_exc())
329
330
331
def set_verbosity_level(level):
332
    """Set the verbosity level.
333
334
    :param level: -ve for quiet, 0 for normal, +ve for verbose
335
    """
336
    global _verbosity_level
337
    _verbosity_level = level
338
    _update_logging_level(level < 0)
339
340
341
def get_verbosity_level():
342
    """Get the verbosity level.
343
344
    See set_verbosity_level() for values.
345
    """
346
    return _verbosity_level
347
348
349
def be_quiet(quiet=True):
350
    # Perhaps this could be deprecated now ...
351
    if quiet:
352
        set_verbosity_level(-1)
353
    else:
354
        set_verbosity_level(0)
355
356
357
def _update_logging_level(quiet=True):
358
    """Hide INFO messages if quiet."""
359
    if quiet:
3173.1.6 by Martin Pool
Remove _stderr_handler global
360
        _bzr_logger.setLevel(logging.WARNING)
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
361
    else:
3173.1.6 by Martin Pool
Remove _stderr_handler global
362
        _bzr_logger.setLevel(logging.INFO)
3173.1.4 by Martin Pool
Rearrange and clean up bzr trace/logging
363
364
365
def is_quiet():
366
    """Is the verbosity level negative?"""
367
    return _verbosity_level < 0
368
369
370
def is_verbose():
371
    """Is the verbosity level positive?"""
372
    return _verbosity_level > 0
373
374
375
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
376
def disable_default_logging():
377
    """Turn off default log handlers.
378
379
    Don't call this method, use _push_log_file and _pop_log_file instead.
380
    """
381
    pass
382
383
1740.5.2 by Martin Pool
Improved tests for display of exceptions.
384
def report_exception(exc_info, err_file):
2830.2.1 by Martin Pool
If TestCase.run_bzr hits an internal exception, don't catch it but rather propagate up into the test suite
385
    """Report an exception to err_file (typically stderr) and to .bzr.log.
2713.2.1 by Martin Pool
Return exitcode 4 if an internal error occurs
386
387
    This will show either a full traceback or a short message as appropriate.
388
389
    :return: The appropriate exit code for this error.
390
    """
1740.5.3 by Martin Pool
Cleanup more exception-formatting code
391
    exc_type, exc_object, exc_tb = exc_info
1711.2.86 by John Arbash Meinel
Restore logging of full traceback. Helps with debugging tests.
392
    # Log the full traceback to ~/.bzr.log
393
    log_exception_quietly()
1740.5.3 by Martin Pool
Cleanup more exception-formatting code
394
    if (isinstance(exc_object, IOError)
395
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
396
        err_file.write("bzr: broken pipe\n")
2713.2.1 by Martin Pool
Return exitcode 4 if an internal error occurs
397
        return errors.EXIT_ERROR
1740.5.3 by Martin Pool
Cleanup more exception-formatting code
398
    elif isinstance(exc_object, KeyboardInterrupt):
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
399
        err_file.write("bzr: interrupted\n")
2713.2.1 by Martin Pool
Return exitcode 4 if an internal error occurs
400
        return errors.EXIT_ERROR
2067.3.2 by Martin Pool
Error cleanup review comments:
401
    elif not getattr(exc_object, 'internal_error', True):
1740.5.6 by Martin Pool
Clean up many exception classes.
402
        report_user_error(exc_info, err_file)
2713.2.1 by Martin Pool
Return exitcode 4 if an internal error occurs
403
        return errors.EXIT_ERROR
1740.5.6 by Martin Pool
Clean up many exception classes.
404
    elif isinstance(exc_object, (OSError, IOError)):
405
        # Might be nice to catch all of these and show them as something more
406
        # specific, but there are too many cases at the moment.
1740.5.1 by Martin Pool
When an unhandled exception occurs, write the traceback to stderr.
407
        report_user_error(exc_info, err_file)
2713.2.1 by Martin Pool
Return exitcode 4 if an internal error occurs
408
        return errors.EXIT_ERROR
1740.5.1 by Martin Pool
When an unhandled exception occurs, write the traceback to stderr.
409
    else:
1551.9.3 by Aaron Bentley
Revert buggy apport changes
410
        report_bug(exc_info, err_file)
2713.2.1 by Martin Pool
Return exitcode 4 if an internal error occurs
411
        return errors.EXIT_INTERNAL_ERROR
1740.5.1 by Martin Pool
When an unhandled exception occurs, write the traceback to stderr.
412
413
414
# TODO: Should these be specially encoding the output?
415
def report_user_error(exc_info, err_file):
2095.5.1 by Martin Pool
Add new -Derror global option to always display tracebacks
416
    """Report to err_file an error that's not an internal error.
417
418
    These don't get a traceback unless -Derror was given.
419
    """
2095.5.2 by Martin Pool
save commit message if commit fails (#32054)
420
    if 'error' in debug.debug_flags:
2095.5.1 by Martin Pool
Add new -Derror global option to always display tracebacks
421
        report_bug(exc_info, err_file)
422
        return
2911.6.3 by Blake Winton
Implemented suggestions from John Arbash Meinel.
423
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
1740.5.1 by Martin Pool
When an unhandled exception occurs, write the traceback to stderr.
424
425
426
def report_bug(exc_info, err_file):
1740.5.2 by Martin Pool
Improved tests for display of exceptions.
427
    """Report an exception that probably indicates a bug in bzr"""
1740.5.1 by Martin Pool
When an unhandled exception occurs, write the traceback to stderr.
428
    exc_type, exc_object, exc_tb = exc_info
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
429
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
430
        exc_type.__module__, exc_type.__name__, exc_object))
431
    err_file.write('\n')
1740.5.2 by Martin Pool
Improved tests for display of exceptions.
432
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
433
    err_file.write('\n')
434
    err_file.write('bzr %s on python %s (%s)\n' % \
1740.5.3 by Martin Pool
Cleanup more exception-formatting code
435
                       (bzrlib.__version__,
436
                        '.'.join(map(str, sys.version_info)),
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
437
                        sys.platform))
438
    err_file.write('arguments: %r\n' % sys.argv)
2842.1.1 by Martin Pool
Report locale, encodings and plugins in traceback
439
    err_file.write(
440
        'encoding: %r, fsenc: %r, lang: %r\n' % (
441
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
442
            os.environ.get('LANG')))
2842.1.2 by Martin Pool
Also include plugin path and version in traceback
443
    err_file.write("plugins:\n")
444
    for name, a_plugin in sorted(plugin.plugins().items()):
445
        err_file.write("  %-20s %s [%s]\n" %
446
            (name, a_plugin.path(), a_plugin.__version__))
2842.1.1 by Martin Pool
Report locale, encodings and plugins in traceback
447
    err_file.write(
3092.2.1 by Martin Pool
Ask people to report bugs to Launchpad, and mention more support options
448
"""\
449
*** Bazaar has encountered an internal error.
450
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
451
    including this traceback, and a description of what you
452
    were doing when the error occurred.
453
""")