← 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: 2006-09-20 13:59:17 UTC
  • mfrom: (1551.8.25 Aaron's mergeable stuff)
  • Revision ID: pqm@pqm.ubuntu.com-20060920135917-9b085ce8e1ba0d18
Fix deprecated use of pending_merges

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