← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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