← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-11-06 16:01:48 UTC
  • mfrom: (5527.1.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20101106160148-8maemz21jbrhpzky
(vila) Move NEWS entry into the correct section (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

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