← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Aaron Bentley
  • Date: 2007-02-06 14:52:16 UTC
  • mfrom: (2266 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2268.
  • Revision ID: abentley@panoramicfeedback.com-20070206145216-fcpi8o3ufvuzwbp9
Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008 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
49
49
# FIXME: Unfortunately it turns out that python's logging module
50
50
# is quite expensive, even when the message is not printed by any handlers.
51
51
# We should perhaps change back to just simply doing it here.
52
 
#
53
 
# On the other hand, as of 1.2 we generally only call the mutter() statement
54
 
# if (according to debug_flags) we actually intend to write it.  So the
55
 
# increased cost of logging.py is not so bad, and we could standardize on
56
 
# that.
57
52
 
58
 
import codecs
59
 
import logging
60
53
import os
61
54
import sys
62
55
import re
63
 
import time
64
56
 
65
57
from bzrlib.lazy_import import lazy_import
66
58
lazy_import(globals(), """
67
 
from cStringIO import StringIO
68
59
import errno
69
 
import locale
70
 
import traceback
 
60
import logging
71
61
""")
72
62
 
73
63
import bzrlib
 
64
from bzrlib.symbol_versioning import (deprecated_function,
 
65
        zero_nine,
 
66
        )
74
67
 
75
68
lazy_import(globals(), """
76
 
from bzrlib import (
77
 
    debug,
78
 
    errors,
79
 
    osutils,
80
 
    plugin,
81
 
    symbol_versioning,
82
 
    )
 
69
from bzrlib import debug
83
70
""")
84
71
 
85
 
 
86
 
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
87
 
# is quiet; >0 is verbose.
88
 
_verbosity_level = 0
89
 
 
90
 
# File-like object where mutter/debug output is currently sent.  Can be
91
 
# changed by _push_log_file etc.  This is directly manipulated by some
92
 
# external code; maybe there should be functions to do that more precisely
93
 
# than push/pop_log_file.
 
72
_file_handler = None
 
73
_stderr_handler = None
 
74
_stderr_quiet = False
94
75
_trace_file = None
95
 
 
96
 
# Absolute path for ~/.bzr.log.  Not changed even if the log/trace output is
97
 
# redirected elsewhere.  Used to show the location in --version.
98
 
_bzr_log_filename = None
99
 
 
100
 
# The time the first message was written to the trace file, so that we can
101
 
# show relative times since startup.
102
 
_bzr_log_start_time = bzrlib._start_time
103
 
 
104
 
 
105
 
# 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
 
106
82
_bzr_logger = logging.getLogger('bzr')
107
83
 
108
 
 
109
84
def note(*args, **kwargs):
110
85
    # FIXME note always emits utf-8, regardless of the terminal encoding
111
 
    #
112
 
    # FIXME: clearing the ui and then going through the abstract logging
113
 
    # framework is whack; we should probably have a logging Handler that
114
 
    # deals with terminal output if needed.
115
86
    import bzrlib.ui
116
87
    bzrlib.ui.ui_factory.clear_term()
117
88
    _bzr_logger.info(*args, **kwargs)
118
89
 
119
 
 
120
90
def warning(*args, **kwargs):
121
91
    import bzrlib.ui
122
92
    bzrlib.ui.ui_factory.clear_term()
123
93
    _bzr_logger.warning(*args, **kwargs)
124
94
 
125
 
 
126
 
# configure convenient aliases for output routines
127
 
#
128
 
# TODO: deprecate them, have one name for each.
129
95
info = note
130
96
log_error = _bzr_logger.error
131
97
error =     _bzr_logger.error
152
118
        out = fmt % tuple(real_args)
153
119
    else:
154
120
        out = fmt
155
 
    timestamp = '%0.3f  ' % (time.time() - _bzr_log_start_time,)
156
 
    out = timestamp + out + '\n'
 
121
    out += '\n'
157
122
    _trace_file.write(out)
158
 
    # no need to flush here, the trace file is now linebuffered when it's
159
 
    # opened.
160
 
 
161
 
 
162
 
def mutter_callsite(stacklevel, fmt, *args):
163
 
    """Perform a mutter of fmt and args, logging the call trace.
164
 
 
165
 
    :param stacklevel: The number of frames to show. None will show all
166
 
        frames.
167
 
    :param fmt: The format string to pass to mutter.
168
 
    :param args: A list of substitution variables.
169
 
    """
170
 
    outf = StringIO()
171
 
    if stacklevel is None:
172
 
        limit = None
173
 
    else:
174
 
        limit = stacklevel + 1
175
 
    traceback.print_stack(limit=limit, file=outf)
176
 
    formatted_lines = outf.getvalue().splitlines()
177
 
    formatted_stack = '\n'.join(formatted_lines[:-2])
178
 
    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()
179
125
 
180
126
 
181
127
def _rollover_trace_maybe(trace_fname):
185
131
        if size <= 4 << 20:
186
132
            return
187
133
        old_fname = trace_fname + '.old'
188
 
        osutils.rename(trace_fname, old_fname)
 
134
        from osutils import rename
 
135
        rename(trace_fname, old_fname)
189
136
    except OSError:
190
137
        return
191
138
 
192
139
 
193
 
def _get_bzr_log_filename():
194
 
    bzr_log = os.environ.get('BZR_LOG')
195
 
    if bzr_log:
196
 
        return bzr_log
197
 
    home = os.environ.get('BZR_HOME')
198
 
    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:
199
148
        if sys.platform == 'win32':
200
149
            from bzrlib import win32utils
201
150
            home = win32utils.get_home_location()
202
151
        else:
203
152
            home = os.path.expanduser('~')
204
 
    return os.path.join(home, '.bzr.log')
205
 
 
206
 
 
207
 
def _open_bzr_log():
208
 
    """Open the .bzr.log trace file.  
209
 
 
210
 
    If the log is more than a particular length, the old file is renamed to
211
 
    .bzr.log.old and a new file is started.  Otherwise, we append to the
212
 
    existing file.
213
 
 
214
 
    This sets the global _bzr_log_filename.
215
 
    """
216
 
    global _bzr_log_filename
217
 
    _bzr_log_filename = _get_bzr_log_filename()
218
 
    _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)
219
157
    try:
220
 
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
221
 
        # bzr_log_file.tell() on windows always return 0 until some writing done
222
 
        bzr_log_file.write('\n')
223
 
        if bzr_log_file.tell() <= 2:
224
 
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
225
 
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
226
 
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
227
 
        return bzr_log_file
 
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)
228
174
    except IOError, e:
229
175
        warning("failed to open trace file: %s" % (e))
230
 
    # TODO: What should happen if we fail to open the trace file?  Maybe the
231
 
    # objects should be pointed at /dev/null or the equivalent?  Currently
232
 
    # returns None which will cause failures later.
233
 
 
234
 
 
235
 
def enable_default_logging():
236
 
    """Configure default logging: messages to stderr and debug to .bzr.log
237
 
    
238
 
    This should only be called once per process.
239
 
 
240
 
    Non-command-line programs embedding bzrlib do not need to call this.  They
241
 
    can instead either pass a file to _push_log_file, or act directly on
242
 
    logging.getLogger("bzr").
243
 
    
244
 
    Output can be redirected away by calling _push_log_file.
245
 
    """
246
 
    # create encoded wrapper around stderr
247
 
    bzr_log_file = _open_bzr_log()
248
 
    push_log_file(bzr_log_file,
249
 
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
250
 
        r'%Y-%m-%d %H:%M:%S')
251
 
    # after hooking output into bzr_log, we also need to attach a stderr
252
 
    # handler, writing only at level info and with encoding
253
 
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
254
 
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
255
 
    stderr_handler = logging.StreamHandler(encoded_stderr)
256
 
    stderr_handler.setLevel(logging.INFO)
257
 
    logging.getLogger('bzr').addHandler(stderr_handler)
258
 
 
259
 
 
260
 
def push_log_file(to_file, log_format=None, date_format=None):
261
 
    """Intercept log and trace messages and send them to a file.
262
 
 
263
 
    :param to_file: A file-like object to which messages will be sent.
264
 
 
265
 
    :returns: A memento that should be passed to _pop_log_file to restore the 
266
 
    previously active logging.
267
 
    """
268
 
    global _trace_file
269
 
    # make a new handler
270
 
    new_handler = logging.StreamHandler(to_file)
271
 
    new_handler.setLevel(logging.DEBUG)
272
 
    if log_format is None:
273
 
        log_format = '%(levelname)8s  %(message)s'
274
 
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
275
 
    # save and remove any existing log handlers
276
 
    bzr_logger = logging.getLogger('bzr')
277
 
    old_handlers = bzr_logger.handlers[:]
278
 
    del bzr_logger.handlers[:]
279
 
    # set that as the default logger
280
 
    bzr_logger.addHandler(new_handler)
281
 
    bzr_logger.setLevel(logging.DEBUG)
282
 
    # TODO: check if any changes are needed to the root logger
283
 
    #
284
 
    # TODO: also probably need to save and restore the level on bzr_logger.
285
 
    # but maybe we can avoid setting the logger level altogether, and just set
286
 
    # the level on the handler?
287
 
    #
288
 
    # save the old trace file
289
 
    old_trace_file = _trace_file
290
 
    # send traces to the new one
291
 
    _trace_file = to_file
292
 
    result = new_handler, _trace_file
293
 
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
294
 
 
295
 
 
296
 
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
297
 
    """Undo changes to logging/tracing done by _push_log_file.
298
 
 
299
 
    This flushes, but does not close the trace file.
300
 
    
301
 
    Takes the memento returned from _push_log_file."""
302
 
    global _trace_file
303
 
    _trace_file = old_trace_file
304
 
    bzr_logger = logging.getLogger('bzr')
305
 
    bzr_logger.removeHandler(new_handler)
306
 
    # must be closed, otherwise logging will try to close it atexit, and the
307
 
    # file will likely already be closed underneath.
308
 
    new_handler.close()
309
 
    bzr_logger.handlers = old_handlers
310
 
    new_trace_file.flush()
311
 
 
312
 
 
313
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
314
 
def enable_test_log(to_file):
315
 
    """Redirect logging to a temporary file for a test
316
 
    
317
 
    :returns: an opaque reference that should be passed to disable_test_log
318
 
    after the test completes.
319
 
    """
320
 
    return push_log_file(to_file)
321
 
 
322
 
 
323
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
324
 
def disable_test_log(memento):
325
 
    return pop_log_file(memento)
 
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
    if msg:
 
186
        error(msg)
 
187
    log_exception_quietly()
326
188
 
327
189
 
328
190
def log_exception_quietly():
332
194
    interesting to developers but not to users.  For example, 
333
195
    errors loading plugins.
334
196
    """
 
197
    import traceback
335
198
    mutter(traceback.format_exc())
336
199
 
337
200
 
338
 
def set_verbosity_level(level):
339
 
    """Set the verbosity level.
340
 
 
341
 
    :param level: -ve for quiet, 0 for normal, +ve for verbose
342
 
    """
343
 
    global _verbosity_level
344
 
    _verbosity_level = level
345
 
    _update_logging_level(level < 0)
346
 
 
347
 
 
348
 
def get_verbosity_level():
349
 
    """Get the verbosity level.
350
 
 
351
 
    See set_verbosity_level() for values.
352
 
    """
353
 
    return _verbosity_level
 
201
def enable_default_logging():
 
202
    """Configure default logging to stderr and .bzr.log"""
 
203
    # FIXME: if this is run twice, things get confused
 
204
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
205
    _stderr_handler = logging.StreamHandler()
 
206
    logging.getLogger('').addHandler(_stderr_handler)
 
207
    _stderr_handler.setLevel(logging.INFO)
 
208
    if not _file_handler:
 
209
        open_tracefile()
 
210
    _trace_file = _bzr_log_file
 
211
    if _file_handler:
 
212
        _file_handler.setLevel(logging.DEBUG)
 
213
    _bzr_logger.setLevel(logging.DEBUG)
354
214
 
355
215
 
356
216
def be_quiet(quiet=True):
357
 
    # Perhaps this could be deprecated now ...
358
 
    if quiet:
359
 
        set_verbosity_level(-1)
360
 
    else:
361
 
        set_verbosity_level(0)
362
 
 
363
 
 
364
 
def _update_logging_level(quiet=True):
365
 
    """Hide INFO messages if quiet."""
366
 
    if quiet:
367
 
        _bzr_logger.setLevel(logging.WARNING)
368
 
    else:
369
 
        _bzr_logger.setLevel(logging.INFO)
 
217
    global _stderr_handler, _stderr_quiet
 
218
    
 
219
    _stderr_quiet = quiet
 
220
    if quiet:
 
221
        _stderr_handler.setLevel(logging.WARNING)
 
222
    else:
 
223
        _stderr_handler.setLevel(logging.INFO)
370
224
 
371
225
 
372
226
def is_quiet():
373
 
    """Is the verbosity level negative?"""
374
 
    return _verbosity_level < 0
375
 
 
376
 
 
377
 
def is_verbose():
378
 
    """Is the verbosity level positive?"""
379
 
    return _verbosity_level > 0
380
 
 
381
 
 
382
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
227
    global _stderr_quiet
 
228
    return _stderr_quiet
 
229
 
 
230
 
383
231
def disable_default_logging():
384
232
    """Turn off default log handlers.
385
233
 
386
 
    Don't call this method, use _push_log_file and _pop_log_file instead.
387
 
    """
388
 
    pass
 
234
    This is intended to be used by the test framework, which doesn't
 
235
    want leakage from the code-under-test into the main logs.
 
236
    """
 
237
 
 
238
    l = logging.getLogger('')
 
239
    l.removeHandler(_stderr_handler)
 
240
    if _file_handler:
 
241
        l.removeHandler(_file_handler)
 
242
    _trace_file = None
 
243
 
 
244
 
 
245
def enable_test_log(to_file):
 
246
    """Redirect logging to a temporary file for a test
 
247
    
 
248
    returns an opaque reference that should be passed to disable_test_log
 
249
    after the test completes.
 
250
    """
 
251
    disable_default_logging()
 
252
    global _trace_file
 
253
    global _trace_depth
 
254
    hdlr = logging.StreamHandler(to_file)
 
255
    hdlr.setLevel(logging.DEBUG)
 
256
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
257
    _bzr_logger.addHandler(hdlr)
 
258
    _bzr_logger.setLevel(logging.DEBUG)
 
259
    result = hdlr, _trace_file, _trace_depth
 
260
    _trace_file = to_file
 
261
    _trace_depth += 1
 
262
    return result
 
263
 
 
264
 
 
265
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
266
    _bzr_logger.removeHandler(test_log_hdlr)
 
267
    test_log_hdlr.close()
 
268
    global _trace_file
 
269
    global _trace_depth
 
270
    _trace_file = old_trace_file
 
271
    _trace_depth = old_trace_depth
 
272
    if not _trace_depth:
 
273
        enable_default_logging()
389
274
 
390
275
 
391
276
def report_exception(exc_info, err_file):
392
 
    """Report an exception to err_file (typically stderr) and to .bzr.log.
393
 
 
394
 
    This will show either a full traceback or a short message as appropriate.
395
 
 
396
 
    :return: The appropriate exit code for this error.
397
 
    """
398
277
    exc_type, exc_object, exc_tb = exc_info
399
278
    # Log the full traceback to ~/.bzr.log
400
279
    log_exception_quietly()
401
280
    if (isinstance(exc_object, IOError)
402
281
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
403
 
        err_file.write("bzr: broken pipe\n")
404
 
        return errors.EXIT_ERROR
 
282
        print >>err_file, "bzr: broken pipe"
405
283
    elif isinstance(exc_object, KeyboardInterrupt):
406
 
        err_file.write("bzr: interrupted\n")
407
 
        return errors.EXIT_ERROR
408
 
    elif isinstance(exc_object, ImportError) \
409
 
        and str(exc_object).startswith("No module named "):
410
 
        report_user_error(exc_info, err_file,
411
 
            'You may need to install this Python library separately.')
412
 
        return errors.EXIT_ERROR
 
284
        print >>err_file, "bzr: interrupted"
413
285
    elif not getattr(exc_object, 'internal_error', True):
414
286
        report_user_error(exc_info, err_file)
415
 
        return errors.EXIT_ERROR
416
287
    elif isinstance(exc_object, (OSError, IOError)):
417
288
        # Might be nice to catch all of these and show them as something more
418
289
        # specific, but there are too many cases at the moment.
419
290
        report_user_error(exc_info, err_file)
420
 
        return errors.EXIT_ERROR
421
291
    else:
422
292
        report_bug(exc_info, err_file)
423
 
        return errors.EXIT_INTERNAL_ERROR
424
 
 
425
 
 
426
 
def print_exception(exc_info, err_file):
427
 
    exc_type, exc_object, exc_tb = exc_info
428
 
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
429
 
        exc_type.__module__, exc_type.__name__, exc_object))
430
 
    err_file.write('\n')
431
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
432
293
 
433
294
 
434
295
# TODO: Should these be specially encoding the output?
435
 
def report_user_error(exc_info, err_file, advice=None):
 
296
def report_user_error(exc_info, err_file):
436
297
    """Report to err_file an error that's not an internal error.
437
298
 
438
299
    These don't get a traceback unless -Derror was given.
439
 
 
440
 
    :param exc_info: 3-tuple from sys.exc_info()
441
 
    :param advice: Extra advice to the user to be printed following the
442
 
        exception.
443
300
    """
444
301
    if 'error' in debug.debug_flags:
445
 
        print_exception(exc_info, err_file)
 
302
        report_bug(exc_info, err_file)
446
303
        return
447
 
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
448
 
    if advice:
449
 
        err_file.write("%s\n" % (advice,))
 
304
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
450
305
 
451
306
 
452
307
def report_bug(exc_info, err_file):
453
308
    """Report an exception that probably indicates a bug in bzr"""
454
 
    print_exception(exc_info, err_file)
455
 
    err_file.write('\n')
456
 
    err_file.write('bzr %s on python %s (%s)\n' % \
 
309
    import traceback
 
310
    exc_type, exc_object, exc_tb = exc_info
 
311
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
 
312
        exc_type.__module__, exc_type.__name__, exc_object)
 
313
    print >>err_file
 
314
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
315
    print >>err_file
 
316
    print >>err_file, 'bzr %s on python %s (%s)' % \
457
317
                       (bzrlib.__version__,
458
 
                        bzrlib._format_version_tuple(sys.version_info),
459
 
                        sys.platform))
460
 
    err_file.write('arguments: %r\n' % sys.argv)
461
 
    err_file.write(
462
 
        'encoding: %r, fsenc: %r, lang: %r\n' % (
463
 
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
464
 
            os.environ.get('LANG')))
465
 
    err_file.write("plugins:\n")
466
 
    for name, a_plugin in sorted(plugin.plugins().items()):
467
 
        err_file.write("  %-20s %s [%s]\n" %
468
 
            (name, a_plugin.path(), a_plugin.__version__))
469
 
    err_file.write(
470
 
"""\
471
 
*** Bazaar has encountered an internal error.
472
 
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
473
 
    including this traceback, and a description of what you
474
 
    were doing when the error occurred.
475
 
""")
 
318
                        '.'.join(map(str, sys.version_info)),
 
319
                        sys.platform)
 
320
    print >>err_file, 'arguments: %r' % sys.argv
 
321
    print >>err_file
 
322
    print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"