← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Alexander Belchenko
  • Date: 2007-08-10 09:04:38 UTC
  • mto: This revision was merged to the branch mainline in revision 2694.
  • Revision ID: bialix@ukr.net-20070810090438-0835xdz0rl8825qv
fixes after Ian's review

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.
 
76
_trace_depth = 0
 
77
_bzr_log_file = None
98
78
_bzr_log_filename = None
99
79
 
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
 
80
 
 
81
# configure convenient aliases for output routines
 
82
 
106
83
_bzr_logger = logging.getLogger('bzr')
107
84
 
108
 
 
109
85
def note(*args, **kwargs):
110
86
    # 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
87
    import bzrlib.ui
116
88
    bzrlib.ui.ui_factory.clear_term()
117
89
    _bzr_logger.info(*args, **kwargs)
118
90
 
119
 
 
120
91
def warning(*args, **kwargs):
121
92
    import bzrlib.ui
122
93
    bzrlib.ui.ui_factory.clear_term()
123
94
    _bzr_logger.warning(*args, **kwargs)
124
95
 
125
 
 
126
 
# configure convenient aliases for output routines
127
 
#
128
 
# TODO: deprecate them, have one name for each.
129
96
info = note
130
97
log_error = _bzr_logger.error
131
98
error =     _bzr_logger.error
152
119
        out = fmt % tuple(real_args)
153
120
    else:
154
121
        out = fmt
155
 
    timestamp = '%0.3f  ' % (time.time() - _bzr_log_start_time,)
156
 
    out = timestamp + out + '\n'
 
122
    out += '\n'
157
123
    _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
 
    traceback.print_stack(limit=stacklevel + 1, file=outf)
172
 
    formatted_lines = outf.getvalue().splitlines()
173
 
    formatted_stack = '\n'.join(formatted_lines[:-2])
174
 
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
 
124
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
125
    #_trace_file.flush()
175
126
 
176
127
 
177
128
def _rollover_trace_maybe(trace_fname):
181
132
        if size <= 4 << 20:
182
133
            return
183
134
        old_fname = trace_fname + '.old'
184
 
        osutils.rename(trace_fname, old_fname)
 
135
        from osutils import rename
 
136
        rename(trace_fname, old_fname)
185
137
    except OSError:
186
138
        return
187
139
 
188
140
 
189
 
def _get_bzr_log_filename():
190
 
    bzr_log = os.environ.get('BZR_LOG')
191
 
    if bzr_log:
192
 
        return bzr_log
193
 
    home = os.environ.get('BZR_HOME')
194
 
    if home is None:
 
141
def open_tracefile(tracefilename=None):
 
142
    # Messages are always written to here, so that we have some
 
143
    # information if something goes wrong.  In a future version this
 
144
    # file will be removed on successful completion.
 
145
    global _file_handler, _bzr_log_file, _bzr_log_filename
 
146
    import codecs
 
147
 
 
148
    if tracefilename is None:
195
149
        if sys.platform == 'win32':
196
150
            from bzrlib import win32utils
197
151
            home = win32utils.get_home_location()
198
152
        else:
199
153
            home = os.path.expanduser('~')
200
 
    return os.path.join(home, '.bzr.log')
201
 
 
202
 
 
203
 
def _open_bzr_log():
204
 
    """Open the .bzr.log trace file.  
205
 
 
206
 
    If the log is more than a particular length, the old file is renamed to
207
 
    .bzr.log.old and a new file is started.  Otherwise, we append to the
208
 
    existing file.
209
 
 
210
 
    This sets the global _bzr_log_filename.
211
 
    """
212
 
    global _bzr_log_filename
213
 
    _bzr_log_filename = _get_bzr_log_filename()
 
154
        _bzr_log_filename = os.path.join(home, '.bzr.log')
 
155
 
 
156
    _bzr_log_filename = os.path.expanduser(_bzr_log_filename)
214
157
    _rollover_trace_maybe(_bzr_log_filename)
215
158
    try:
216
 
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
217
 
        # bzr_log_file.tell() on windows always return 0 until some writing done
218
 
        bzr_log_file.write('\n')
219
 
        if bzr_log_file.tell() <= 2:
220
 
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
221
 
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
222
 
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
223
 
        return bzr_log_file
 
159
        LINE_BUFFERED = 1
 
160
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
161
        tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
 
162
        _bzr_log_file = tf
 
163
        # tf.tell() on windows always return 0 until some writing done
 
164
        tf.write('\n')
 
165
        if tf.tell() <= 2:
 
166
            tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
 
167
            tf.write("you can delete or truncate this file, or include sections in\n")
 
168
            tf.write("bug reports to bazaar@lists.canonical.com\n\n")
 
169
        _file_handler = logging.StreamHandler(tf)
 
170
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
171
        datefmt = r'%a %H:%M:%S'
 
172
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
173
        _file_handler.setLevel(logging.DEBUG)
 
174
        logging.getLogger('').addHandler(_file_handler)
224
175
    except IOError, e:
225
176
        warning("failed to open trace file: %s" % (e))
226
 
    # TODO: What should happen if we fail to open the trace file?  Maybe the
227
 
    # objects should be pointed at /dev/null or the equivalent?  Currently
228
 
    # returns None which will cause failures later.
229
 
 
230
 
 
231
 
def enable_default_logging():
232
 
    """Configure default logging: messages to stderr and debug to .bzr.log
233
 
    
234
 
    This should only be called once per process.
235
 
 
236
 
    Non-command-line programs embedding bzrlib do not need to call this.  They
237
 
    can instead either pass a file to _push_log_file, or act directly on
238
 
    logging.getLogger("bzr").
239
 
    
240
 
    Output can be redirected away by calling _push_log_file.
241
 
    """
242
 
    # create encoded wrapper around stderr
243
 
    bzr_log_file = _open_bzr_log()
244
 
    push_log_file(bzr_log_file,
245
 
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
246
 
        r'%Y-%m-%d %H:%M:%S')
247
 
    # after hooking output into bzr_log, we also need to attach a stderr
248
 
    # handler, writing only at level info and with encoding
249
 
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
250
 
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
251
 
    stderr_handler = logging.StreamHandler(encoded_stderr)
252
 
    stderr_handler.setLevel(logging.INFO)
253
 
    logging.getLogger('bzr').addHandler(stderr_handler)
254
 
 
255
 
 
256
 
def push_log_file(to_file, log_format=None, date_format=None):
257
 
    """Intercept log and trace messages and send them to a file.
258
 
 
259
 
    :param to_file: A file-like object to which messages will be sent.
260
 
 
261
 
    :returns: A memento that should be passed to _pop_log_file to restore the 
262
 
    previously active logging.
263
 
    """
264
 
    global _trace_file
265
 
    # make a new handler
266
 
    new_handler = logging.StreamHandler(to_file)
267
 
    new_handler.setLevel(logging.DEBUG)
268
 
    if log_format is None:
269
 
        log_format = '%(levelname)8s  %(message)s'
270
 
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
271
 
    # save and remove any existing log handlers
272
 
    bzr_logger = logging.getLogger('bzr')
273
 
    old_handlers = bzr_logger.handlers[:]
274
 
    del bzr_logger.handlers[:]
275
 
    # set that as the default logger
276
 
    bzr_logger.addHandler(new_handler)
277
 
    bzr_logger.setLevel(logging.DEBUG)
278
 
    # TODO: check if any changes are needed to the root logger
279
 
    #
280
 
    # TODO: also probably need to save and restore the level on bzr_logger.
281
 
    # but maybe we can avoid setting the logger level altogether, and just set
282
 
    # the level on the handler?
283
 
    #
284
 
    # save the old trace file
285
 
    old_trace_file = _trace_file
286
 
    # send traces to the new one
287
 
    _trace_file = to_file
288
 
    result = new_handler, _trace_file
289
 
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
290
 
 
291
 
 
292
 
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
293
 
    """Undo changes to logging/tracing done by _push_log_file.
294
 
 
295
 
    This flushes, but does not close the trace file.
296
 
    
297
 
    Takes the memento returned from _push_log_file."""
298
 
    assert magic == 'log_memento'
299
 
    global _trace_file
300
 
    _trace_file = old_trace_file
301
 
    bzr_logger = logging.getLogger('bzr')
302
 
    bzr_logger.removeHandler(new_handler)
303
 
    # must be closed, otherwise logging will try to close it atexit, and the
304
 
    # file will likely already be closed underneath.
305
 
    new_handler.close()
306
 
    bzr_logger.handlers = old_handlers
307
 
    new_trace_file.flush()
308
 
 
309
 
 
310
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
311
 
def enable_test_log(to_file):
312
 
    """Redirect logging to a temporary file for a test
313
 
    
314
 
    :returns: an opaque reference that should be passed to disable_test_log
315
 
    after the test completes.
316
 
    """
317
 
    return push_log_file(to_file)
318
 
 
319
 
 
320
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
321
 
def disable_test_log(memento):
322
 
    return pop_log_file(memento)
 
177
 
 
178
 
 
179
@deprecated_function(zero_nine)
 
180
def log_exception(msg=None):
 
181
    """Log the last exception to stderr and the trace file.
 
182
 
 
183
    The exception string representation is used as the error
 
184
    summary, unless msg is given.
 
185
 
 
186
    Please see log_exception_quietly() for the replacement API.
 
187
    """
 
188
    if msg:
 
189
        error(msg)
 
190
    log_exception_quietly()
323
191
 
324
192
 
325
193
def log_exception_quietly():
329
197
    interesting to developers but not to users.  For example, 
330
198
    errors loading plugins.
331
199
    """
 
200
    import traceback
332
201
    mutter(traceback.format_exc())
333
202
 
334
203
 
335
 
def set_verbosity_level(level):
336
 
    """Set the verbosity level.
337
 
 
338
 
    :param level: -ve for quiet, 0 for normal, +ve for verbose
339
 
    """
340
 
    global _verbosity_level
341
 
    _verbosity_level = level
342
 
    _update_logging_level(level < 0)
343
 
 
344
 
 
345
 
def get_verbosity_level():
346
 
    """Get the verbosity level.
347
 
 
348
 
    See set_verbosity_level() for values.
349
 
    """
350
 
    return _verbosity_level
 
204
def enable_default_logging():
 
205
    """Configure default logging to stderr and .bzr.log"""
 
206
    # FIXME: if this is run twice, things get confused
 
207
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
208
    _stderr_handler = logging.StreamHandler()
 
209
    logging.getLogger('').addHandler(_stderr_handler)
 
210
    _stderr_handler.setLevel(logging.INFO)
 
211
    if not _file_handler:
 
212
        open_tracefile()
 
213
    _trace_file = _bzr_log_file
 
214
    if _file_handler:
 
215
        _file_handler.setLevel(logging.DEBUG)
 
216
    _bzr_logger.setLevel(logging.DEBUG)
351
217
 
352
218
 
353
219
def be_quiet(quiet=True):
354
 
    # Perhaps this could be deprecated now ...
355
 
    if quiet:
356
 
        set_verbosity_level(-1)
357
 
    else:
358
 
        set_verbosity_level(0)
359
 
 
360
 
 
361
 
def _update_logging_level(quiet=True):
362
 
    """Hide INFO messages if quiet."""
363
 
    if quiet:
364
 
        _bzr_logger.setLevel(logging.WARNING)
365
 
    else:
366
 
        _bzr_logger.setLevel(logging.INFO)
 
220
    global _stderr_handler, _stderr_quiet
 
221
    
 
222
    _stderr_quiet = quiet
 
223
    if quiet:
 
224
        _stderr_handler.setLevel(logging.WARNING)
 
225
    else:
 
226
        _stderr_handler.setLevel(logging.INFO)
367
227
 
368
228
 
369
229
def is_quiet():
370
 
    """Is the verbosity level negative?"""
371
 
    return _verbosity_level < 0
372
 
 
373
 
 
374
 
def is_verbose():
375
 
    """Is the verbosity level positive?"""
376
 
    return _verbosity_level > 0
377
 
 
378
 
 
379
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
230
    global _stderr_quiet
 
231
    return _stderr_quiet
 
232
 
 
233
 
380
234
def disable_default_logging():
381
235
    """Turn off default log handlers.
382
236
 
383
 
    Don't call this method, use _push_log_file and _pop_log_file instead.
384
 
    """
385
 
    pass
 
237
    This is intended to be used by the test framework, which doesn't
 
238
    want leakage from the code-under-test into the main logs.
 
239
    """
 
240
 
 
241
    l = logging.getLogger('')
 
242
    l.removeHandler(_stderr_handler)
 
243
    if _file_handler:
 
244
        l.removeHandler(_file_handler)
 
245
    _trace_file = None
 
246
 
 
247
 
 
248
def enable_test_log(to_file):
 
249
    """Redirect logging to a temporary file for a test
 
250
    
 
251
    returns an opaque reference that should be passed to disable_test_log
 
252
    after the test completes.
 
253
    """
 
254
    disable_default_logging()
 
255
    global _trace_file
 
256
    global _trace_depth
 
257
    hdlr = logging.StreamHandler(to_file)
 
258
    hdlr.setLevel(logging.DEBUG)
 
259
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
260
    _bzr_logger.addHandler(hdlr)
 
261
    _bzr_logger.setLevel(logging.DEBUG)
 
262
    result = hdlr, _trace_file, _trace_depth
 
263
    _trace_file = to_file
 
264
    _trace_depth += 1
 
265
    return result
 
266
 
 
267
 
 
268
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
269
    _bzr_logger.removeHandler(test_log_hdlr)
 
270
    test_log_hdlr.close()
 
271
    global _trace_file
 
272
    global _trace_depth
 
273
    _trace_file = old_trace_file
 
274
    _trace_depth = old_trace_depth
 
275
    if not _trace_depth:
 
276
        enable_default_logging()
386
277
 
387
278
 
388
279
def report_exception(exc_info, err_file):
389
 
    """Report an exception to err_file (typically stderr) and to .bzr.log.
390
 
 
391
 
    This will show either a full traceback or a short message as appropriate.
392
 
 
393
 
    :return: The appropriate exit code for this error.
394
 
    """
395
280
    exc_type, exc_object, exc_tb = exc_info
396
281
    # Log the full traceback to ~/.bzr.log
397
282
    log_exception_quietly()
398
283
    if (isinstance(exc_object, IOError)
399
284
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
400
 
        err_file.write("bzr: broken pipe\n")
401
 
        return errors.EXIT_ERROR
 
285
        print >>err_file, "bzr: broken pipe"
402
286
    elif isinstance(exc_object, KeyboardInterrupt):
403
 
        err_file.write("bzr: interrupted\n")
404
 
        return errors.EXIT_ERROR
 
287
        print >>err_file, "bzr: interrupted"
405
288
    elif not getattr(exc_object, 'internal_error', True):
406
289
        report_user_error(exc_info, err_file)
407
 
        return errors.EXIT_ERROR
408
290
    elif isinstance(exc_object, (OSError, IOError)):
409
291
        # Might be nice to catch all of these and show them as something more
410
292
        # specific, but there are too many cases at the moment.
411
293
        report_user_error(exc_info, err_file)
412
 
        return errors.EXIT_ERROR
413
294
    else:
414
295
        report_bug(exc_info, err_file)
415
 
        return errors.EXIT_INTERNAL_ERROR
416
296
 
417
297
 
418
298
# TODO: Should these be specially encoding the output?
424
304
    if 'error' in debug.debug_flags:
425
305
        report_bug(exc_info, err_file)
426
306
        return
427
 
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
 
307
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
428
308
 
429
309
 
430
310
def report_bug(exc_info, err_file):
431
311
    """Report an exception that probably indicates a bug in bzr"""
 
312
    import traceback
432
313
    exc_type, exc_object, exc_tb = exc_info
433
 
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
434
 
        exc_type.__module__, exc_type.__name__, exc_object))
435
 
    err_file.write('\n')
 
314
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
 
315
        exc_type.__module__, exc_type.__name__, exc_object)
 
316
    print >>err_file
436
317
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
437
 
    err_file.write('\n')
438
 
    err_file.write('bzr %s on python %s (%s)\n' % \
 
318
    print >>err_file
 
319
    print >>err_file, 'bzr %s on python %s (%s)' % \
439
320
                       (bzrlib.__version__,
440
321
                        '.'.join(map(str, sys.version_info)),
441
 
                        sys.platform))
442
 
    err_file.write('arguments: %r\n' % sys.argv)
443
 
    err_file.write(
444
 
        'encoding: %r, fsenc: %r, lang: %r\n' % (
445
 
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
446
 
            os.environ.get('LANG')))
447
 
    err_file.write("plugins:\n")
448
 
    for name, a_plugin in sorted(plugin.plugins().items()):
449
 
        err_file.write("  %-20s %s [%s]\n" %
450
 
            (name, a_plugin.path(), a_plugin.__version__))
451
 
    err_file.write(
452
 
"""\
453
 
*** Bazaar has encountered an internal error.
454
 
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
455
 
    including this traceback, and a description of what you
456
 
    were doing when the error occurred.
457
 
""")
 
322
                        sys.platform)
 
323
    print >>err_file, 'arguments: %r' % sys.argv
 
324
    print >>err_file
 
325
    print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"