← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Blake Winton
  • Date: 2007-10-16 16:02:01 UTC
  • mto: This revision was merged to the branch mainline in revision 2921.
  • Revision ID: bwinton@latte.ca-20071016160201-os2bci2ujf7in7an
Change 'print >> f,'s to 'f.write('s.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
#
1
3
# This program is free software; you can redistribute it and/or modify
2
4
# it under the terms of the GNU General Public License as published by
3
5
# the Free Software Foundation; either version 2 of the License, or
4
6
# (at your option) any later version.
5
 
 
 
7
#
6
8
# This program is distributed in the hope that it will be useful,
7
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9
11
# GNU General Public License for more details.
10
 
 
 
12
#
11
13
# You should have received a copy of the GNU General Public License
12
14
# along with this program; if not, write to the Free Software
13
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
14
16
 
15
 
 
16
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
17
 
__author__ = "Martin Pool <mbp@canonical.com>"
18
 
 
19
 
 
20
 
"""Messages and logging for bazaar-ng
21
 
 
22
 
Nothing is actually logged unless you call bzrlib.open_tracefile().
 
17
"""Messages and logging for bazaar-ng.
 
18
 
 
19
Messages are supplied by callers as a string-formatting template, plus values
 
20
to be inserted into it.  The actual %-formatting is deferred to the log
 
21
library so that it doesn't need to be done for messages that won't be emitted.
 
22
 
 
23
Messages are classified by severity levels: critical, error, warning, info,
 
24
and debug.
 
25
 
 
26
They can be sent to two places: to stderr, and to ~/.bzr.log.  For purposes
 
27
such as running the test suite, they can also be redirected away from both of
 
28
those two places to another location.
 
29
 
 
30
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
 
31
This trace file is always in UTF-8, regardless of the user's default encoding,
 
32
so that we can always rely on writing any message.
 
33
 
 
34
Output to stderr depends on the mode chosen by the user.  By default, messages
 
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 quiet mode, only warnings and
 
37
above are shown.  In debug mode, stderr gets debug messages too.
 
38
 
 
39
Errors that terminate an operation are generally passed back as exceptions;
 
40
others may be just emitted as messages.
 
41
 
 
42
Exceptions are reported in a brief form to stderr so as not to look scary.
 
43
BzrErrors are required to be able to format themselves into a properly
 
44
explanatory message.  This is not true for builtin exceptions such as
 
45
KeyError, which typically just str to "0".  They're printed in a different
 
46
form.
23
47
"""
24
48
 
25
 
 
26
 
import sys, os
27
 
 
28
 
######################################################################
29
 
# messages and logging
30
 
 
31
 
global _tracefile, _starttime
32
 
_tracefile = None
33
 
 
34
 
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
35
 
_starttime = None
36
 
 
37
 
# If false, notes also go to stdout; should replace this with --silent
38
 
# at some point.
39
 
silent = False
40
 
 
41
 
 
42
 
# fix this if we ever fork within python
43
 
_mypid = os.getpid()
44
 
_logprefix = '[%d] ' % _mypid
45
 
 
46
 
 
47
 
def _write_trace(msg):
48
 
    if _tracefile:
49
 
        _tracefile.write(_logprefix + msg + '\n')
50
 
 
51
 
 
52
 
def warning(msg):
53
 
    sys.stderr.write('bzr: warning: ' + msg + '\n')
54
 
    _write_trace('warning: ' + msg)
55
 
 
56
 
 
57
 
mutter = _write_trace
58
 
 
59
 
 
60
 
def note(msg):
61
 
    b = '* ' + str(msg) + '\n'
62
 
    if not silent:
63
 
        sys.stderr.write(b)
64
 
    _write_trace('note: ' + msg)
65
 
 
66
 
 
67
 
def log_error(msg):
68
 
    sys.stderr.write(msg + '\n')
69
 
    _write_trace(msg)
 
49
# FIXME: Unfortunately it turns out that python's logging module
 
50
# is quite expensive, even when the message is not printed by any handlers.
 
51
# We should perhaps change back to just simply doing it here.
 
52
 
 
53
import os
 
54
import sys
 
55
import re
 
56
 
 
57
from bzrlib.lazy_import import lazy_import
 
58
lazy_import(globals(), """
 
59
from cStringIO import StringIO
 
60
import errno
 
61
import locale
 
62
import logging
 
63
import traceback
 
64
""")
 
65
 
 
66
import bzrlib
 
67
 
 
68
lazy_import(globals(), """
 
69
from bzrlib import (
 
70
    debug,
 
71
    errors,
 
72
    osutils,
 
73
    plugin,
 
74
    )
 
75
""")
 
76
 
 
77
_file_handler = None
 
78
_stderr_handler = None
 
79
_verbosity_level = 0
 
80
_trace_file = None
 
81
_trace_depth = 0
 
82
_bzr_log_file = None
 
83
_bzr_log_filename = None
 
84
 
 
85
 
 
86
# configure convenient aliases for output routines
 
87
 
 
88
_bzr_logger = logging.getLogger('bzr')
 
89
 
 
90
def note(*args, **kwargs):
 
91
    # FIXME note always emits utf-8, regardless of the terminal encoding
 
92
    import bzrlib.ui
 
93
    bzrlib.ui.ui_factory.clear_term()
 
94
    _bzr_logger.info(*args, **kwargs)
 
95
 
 
96
def warning(*args, **kwargs):
 
97
    import bzrlib.ui
 
98
    bzrlib.ui.ui_factory.clear_term()
 
99
    _bzr_logger.warning(*args, **kwargs)
 
100
 
 
101
info = note
 
102
log_error = _bzr_logger.error
 
103
error =     _bzr_logger.error
 
104
 
 
105
 
 
106
def mutter(fmt, *args):
 
107
    if _trace_file is None:
 
108
        return
 
109
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
 
110
        return
 
111
 
 
112
    if isinstance(fmt, unicode):
 
113
        fmt = fmt.encode('utf8')
 
114
 
 
115
    if len(args) > 0:
 
116
        # It seems that if we do ascii % (unicode, ascii) we can
 
117
        # get a unicode cannot encode ascii error, so make sure that "fmt"
 
118
        # is a unicode string
 
119
        real_args = []
 
120
        for arg in args:
 
121
            if isinstance(arg, unicode):
 
122
                arg = arg.encode('utf8')
 
123
            real_args.append(arg)
 
124
        out = fmt % tuple(real_args)
 
125
    else:
 
126
        out = fmt
 
127
    out += '\n'
 
128
    _trace_file.write(out)
 
129
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
130
    #_trace_file.flush()
 
131
 
 
132
 
 
133
def mutter_callsite(stacklevel, fmt, *args):
 
134
    """Perform a mutter of fmt and args, logging the call trace.
 
135
 
 
136
    :param stacklevel: The number of frames to show. None will show all
 
137
        frames.
 
138
    :param fmt: The format string to pass to mutter.
 
139
    :param args: A list of substitution variables.
 
140
    """
 
141
    outf = StringIO()
 
142
    traceback.print_stack(limit=stacklevel + 1, file=outf)
 
143
    formatted_lines = outf.getvalue().splitlines()
 
144
    formatted_stack = '\n'.join(formatted_lines[:-2])
 
145
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
70
146
 
71
147
 
72
148
def _rollover_trace_maybe(trace_fname):
76
152
        if size <= 4 << 20:
77
153
            return
78
154
        old_fname = trace_fname + '.old'
79
 
 
80
 
        try:
81
 
            # must remove before rename on windows
82
 
            os.remove(old_fname)
83
 
        except OSError:
84
 
            pass
85
 
 
86
 
        try:
87
 
            # might fail if in use on windows
88
 
            os.rename(trace_fname, old_fname)
89
 
        except OSError:
90
 
            pass
 
155
        osutils.rename(trace_fname, old_fname)
91
156
    except OSError:
92
157
        return
93
158
 
94
159
 
95
 
 
96
 
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
 
160
def open_tracefile(tracefilename=None):
97
161
    # Messages are always written to here, so that we have some
98
162
    # information if something goes wrong.  In a future version this
99
163
    # file will be removed on successful completion.
100
 
    global _starttime, _tracefile
101
 
    import stat, codecs
102
 
 
103
 
    _starttime = os.times()[4]
104
 
 
105
 
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
106
 
    _rollover_trace_maybe(trace_fname)
107
 
 
108
 
    # buffering=1 means line buffered
 
164
    global _file_handler, _bzr_log_file, _bzr_log_filename
 
165
    import codecs
 
166
 
 
167
    if tracefilename is None:
 
168
        if sys.platform == 'win32':
 
169
            from bzrlib import win32utils
 
170
            home = win32utils.get_home_location()
 
171
        else:
 
172
            home = os.path.expanduser('~')
 
173
        _bzr_log_filename = os.path.join(home, '.bzr.log')
 
174
    else:
 
175
        _bzr_log_filename = tracefilename
 
176
 
 
177
    _bzr_log_filename = os.path.expanduser(_bzr_log_filename)
 
178
    _rollover_trace_maybe(_bzr_log_filename)
109
179
    try:
110
 
        _tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
111
 
        t = _tracefile
112
 
 
113
 
        if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
114
 
            t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
115
 
            t.write("you can delete or truncate this file, or include sections in\n")
116
 
            t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
117
 
 
118
 
        import bzrlib
119
 
        _write_trace('bzr %s invoked on python %s (%s)'
120
 
                     % (bzrlib.__version__,
121
 
                        '.'.join(map(str, sys.version_info)),
122
 
                        sys.platform))
123
 
 
124
 
        _write_trace('  arguments: %r' % argv)
125
 
        _write_trace('  working dir: ' + os.getcwdu())
 
180
        LINE_BUFFERED = 1
 
181
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
182
        tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
 
183
        _bzr_log_file = tf
 
184
        # tf.tell() on windows always return 0 until some writing done
 
185
        tf.write('\n')
 
186
        if tf.tell() <= 2:
 
187
            tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
 
188
            tf.write("you can delete or truncate this file, or include sections in\n")
 
189
            tf.write("bug reports to bazaar@lists.canonical.com\n\n")
 
190
        _file_handler = logging.StreamHandler(tf)
 
191
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
192
        datefmt = r'%a %H:%M:%S'
 
193
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
194
        _file_handler.setLevel(logging.DEBUG)
 
195
        logging.getLogger('').addHandler(_file_handler)
126
196
    except IOError, e:
127
197
        warning("failed to open trace file: %s" % (e))
128
198
 
129
 
def close_trace():
130
 
    times = os.times()
131
 
    mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
132
 
           % (times[:4] + ((times[4] - _starttime),)))
133
 
 
134
 
 
135
 
 
136
 
def log_exception():
137
 
    """Log the last exception into the trace file."""
138
 
    import cgitb
139
 
    s = cgitb.text(sys.exc_info())
140
 
    for l in s.split('\n'):
141
 
        _write_trace(l)
142
 
        
 
199
 
 
200
def log_exception_quietly():
 
201
    """Log the last exception to the trace file only.
 
202
 
 
203
    Used for exceptions that occur internally and that may be 
 
204
    interesting to developers but not to users.  For example, 
 
205
    errors loading plugins.
 
206
    """
 
207
    import traceback
 
208
    mutter(traceback.format_exc())
 
209
 
 
210
 
 
211
def enable_default_logging():
 
212
    """Configure default logging to stderr and .bzr.log"""
 
213
    # FIXME: if this is run twice, things get confused
 
214
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
215
    _stderr_handler = logging.StreamHandler()
 
216
    logging.getLogger('').addHandler(_stderr_handler)
 
217
    _stderr_handler.setLevel(logging.INFO)
 
218
    if not _file_handler:
 
219
        open_tracefile()
 
220
    _trace_file = _bzr_log_file
 
221
    if _file_handler:
 
222
        _file_handler.setLevel(logging.DEBUG)
 
223
    _bzr_logger.setLevel(logging.DEBUG)
 
224
 
 
225
 
 
226
def set_verbosity_level(level):
 
227
    """Set the verbosity level.
 
228
 
 
229
    :param level: -ve for quiet, 0 for normal, +ve for verbose
 
230
    """
 
231
    global _verbosity_level
 
232
    _verbosity_level = level
 
233
    _update_logging_level(level < 0)
 
234
 
 
235
 
 
236
def get_verbosity_level():
 
237
    """Get the verbosity level.
 
238
 
 
239
    See set_verbosity_level() for values.
 
240
    """
 
241
    return _verbosity_level
 
242
 
 
243
 
 
244
def be_quiet(quiet=True):
 
245
    # Perhaps this could be deprecated now ...
 
246
    if quiet:
 
247
        set_verbosity_level(-1)
 
248
    else:
 
249
        set_verbosity_level(0)
 
250
 
 
251
 
 
252
def _update_logging_level(quiet=True):
 
253
    """Hide INFO messages if quiet."""
 
254
    if quiet:
 
255
        _stderr_handler.setLevel(logging.WARNING)
 
256
    else:
 
257
        _stderr_handler.setLevel(logging.INFO)
 
258
 
 
259
 
 
260
def is_quiet():
 
261
    """Is the verbosity level negative?"""
 
262
    return _verbosity_level < 0
 
263
 
 
264
 
 
265
def is_verbose():
 
266
    """Is the verbosity level positive?"""
 
267
    return _verbosity_level > 0
 
268
 
 
269
 
 
270
def disable_default_logging():
 
271
    """Turn off default log handlers.
 
272
 
 
273
    This is intended to be used by the test framework, which doesn't
 
274
    want leakage from the code-under-test into the main logs.
 
275
    """
 
276
 
 
277
    l = logging.getLogger('')
 
278
    l.removeHandler(_stderr_handler)
 
279
    if _file_handler:
 
280
        l.removeHandler(_file_handler)
 
281
    _trace_file = None
 
282
 
 
283
 
 
284
def enable_test_log(to_file):
 
285
    """Redirect logging to a temporary file for a test
143
286
    
 
287
    returns an opaque reference that should be passed to disable_test_log
 
288
    after the test completes.
 
289
    """
 
290
    disable_default_logging()
 
291
    global _trace_file
 
292
    global _trace_depth
 
293
    hdlr = logging.StreamHandler(to_file)
 
294
    hdlr.setLevel(logging.DEBUG)
 
295
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
296
    _bzr_logger.addHandler(hdlr)
 
297
    _bzr_logger.setLevel(logging.DEBUG)
 
298
    result = hdlr, _trace_file, _trace_depth
 
299
    _trace_file = to_file
 
300
    _trace_depth += 1
 
301
    return result
 
302
 
 
303
 
 
304
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
305
    _bzr_logger.removeHandler(test_log_hdlr)
 
306
    test_log_hdlr.close()
 
307
    global _trace_file
 
308
    global _trace_depth
 
309
    _trace_file = old_trace_file
 
310
    _trace_depth = old_trace_depth
 
311
    if not _trace_depth:
 
312
        enable_default_logging()
 
313
 
 
314
 
 
315
def report_exception(exc_info, err_file):
 
316
    """Report an exception to err_file (typically stderr) and to .bzr.log.
 
317
 
 
318
    This will show either a full traceback or a short message as appropriate.
 
319
 
 
320
    :return: The appropriate exit code for this error.
 
321
    """
 
322
    exc_type, exc_object, exc_tb = exc_info
 
323
    # Log the full traceback to ~/.bzr.log
 
324
    log_exception_quietly()
 
325
    if (isinstance(exc_object, IOError)
 
326
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
 
327
        err_file.write("bzr: broken pipe\n")
 
328
        return errors.EXIT_ERROR
 
329
    elif isinstance(exc_object, KeyboardInterrupt):
 
330
        err_file.write("bzr: interrupted\n")
 
331
        return errors.EXIT_ERROR
 
332
    elif not getattr(exc_object, 'internal_error', True):
 
333
        report_user_error(exc_info, err_file)
 
334
        return errors.EXIT_ERROR
 
335
    elif isinstance(exc_object, (OSError, IOError)):
 
336
        # Might be nice to catch all of these and show them as something more
 
337
        # specific, but there are too many cases at the moment.
 
338
        report_user_error(exc_info, err_file)
 
339
        return errors.EXIT_ERROR
 
340
    else:
 
341
        report_bug(exc_info, err_file)
 
342
        return errors.EXIT_INTERNAL_ERROR
 
343
 
 
344
 
 
345
# TODO: Should these be specially encoding the output?
 
346
def report_user_error(exc_info, err_file):
 
347
    """Report to err_file an error that's not an internal error.
 
348
 
 
349
    These don't get a traceback unless -Derror was given.
 
350
    """
 
351
    if 'error' in debug.debug_flags:
 
352
        report_bug(exc_info, err_file)
 
353
        return
 
354
    err_file.write("bzr: ERROR:" + ' ' + str(exc_info[1]) + '\n')
 
355
 
 
356
 
 
357
def report_bug(exc_info, err_file):
 
358
    """Report an exception that probably indicates a bug in bzr"""
 
359
    import traceback
 
360
    exc_type, exc_object, exc_tb = exc_info
 
361
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
 
362
        exc_type.__module__, exc_type.__name__, exc_object))
 
363
    err_file.write('\n')
 
364
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
365
    err_file.write('\n')
 
366
    err_file.write('bzr %s on python %s (%s)\n' % \
 
367
                       (bzrlib.__version__,
 
368
                        '.'.join(map(str, sys.version_info)),
 
369
                        sys.platform))
 
370
    err_file.write('arguments: %r\n' % sys.argv)
 
371
    err_file.write(
 
372
        'encoding: %r, fsenc: %r, lang: %r\n' % (
 
373
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
 
374
            os.environ.get('LANG')))
 
375
    err_file.write("plugins:\n")
 
376
    for name, a_plugin in sorted(plugin.plugins().items()):
 
377
        err_file.write("  %-20s %s [%s]\n" %
 
378
            (name, a_plugin.path(), a_plugin.__version__))
 
379
    err_file.write(
 
380
        "\n"
 
381
        "** Please send this report to bazaar@lists.ubuntu.com\n"
 
382
        "   with a description of what you were doing when the\n"
 
383
        "   error occurred.\n"
 
384
        )