← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

Bugfix WorkingTree.remove to handle subtrees, and non-cwd trees

Show diffs side-by-side

added added

removed removed

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