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