/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Aaron Bentley
  • Date: 2007-12-29 21:43:44 UTC
  • mto: This revision was merged to the branch mainline in revision 3162.
  • Revision ID: aaron.bentley@utoronto.ca-20071229214344-f24le3b1p943rywx
Fix locking issues in revert tests

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