~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Wouter van Heyst
  • Date: 2007-01-18 18:37:21 UTC
  • mto: (2234.3.3 0.14)
  • mto: This revision was merged to the branch mainline in revision 2243.
  • Revision ID: larstiq@larstiq.dyndns.org-20070118183721-78uzxifyyyoqxja9
(Alexander Belchenko) add windows installer check for python2.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 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
 
"""Messages and logging for bazaar-ng
17
 
 
18
 
Messages are sent out through the Python logging library.
19
 
 
20
 
They can be sent to two places: to stderr, and to ~/.bzr.log.
21
 
 
22
 
~/.bzr.log gets all messages, and tracebacks of all uncaught
23
 
exceptions.
24
 
 
25
 
Normally stderr only gets messages of level INFO and higher, and gets
26
 
only a summary of exceptions, not the traceback.
 
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.
27
47
"""
28
48
 
29
 
 
30
 
# TODO: in debug mode, stderr should get full tracebacks and also
31
 
# debug messages.  (Is this really needed?)
32
 
 
33
 
# TODO: When running the test suites, we should add an additional
34
 
# logger that sends messages into the test log file.
35
 
 
36
 
 
 
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
37
54
import sys
38
 
import os
 
55
import re
 
56
 
 
57
from bzrlib.lazy_import import lazy_import
 
58
lazy_import(globals(), """
 
59
import errno
39
60
import logging
40
 
import traceback
41
 
 
 
61
""")
 
62
 
 
63
import bzrlib
 
64
from bzrlib.symbol_versioning import (deprecated_function,
 
65
        zero_nine,
 
66
        )
 
67
 
 
68
lazy_import(globals(), """
 
69
from bzrlib import debug
 
70
""")
42
71
 
43
72
_file_handler = None
44
73
_stderr_handler = None
45
 
 
46
 
 
47
 
class QuietFormatter(logging.Formatter):
48
 
    """Formatter that supresses the details of errors.
49
 
 
50
 
    This is used by default on stderr so as not to scare the user.
51
 
    """
52
 
    # At first I tried overriding formatException to suppress the
53
 
    # exception details, but that has global effect: no loggers
54
 
    # can get the exception details is we suppress them here.
55
 
 
56
 
    def format(self, record):
57
 
        s = 'bzr: '
58
 
        if record.levelno >= logging.WARNING:
59
 
            s += record.levelname + ': '
60
 
            
61
 
        s += record.getMessage() 
62
 
            
63
 
        if record.exc_info:
64
 
            # give just a summary of the exception, not the whole thing
65
 
            exinfo = traceback.extract_tb(record.exc_info[2])
66
 
            # the format of this string matches one of the REs
67
 
            s += '\n'
68
 
            s += ('  at %s line %d, in %s()\n' % exinfo[-1][:3])
69
 
            s += '  see ~/.bzr.log for debug information'
70
 
 
71
 
        return s
72
 
        
73
 
 
74
 
 
75
 
 
76
 
################
 
74
_stderr_quiet = False
 
75
_trace_file = None
 
76
_trace_depth = 0
 
77
_bzr_log_file = None
 
78
 
 
79
 
77
80
# configure convenient aliases for output routines
78
81
 
79
82
_bzr_logger = logging.getLogger('bzr')
80
 
_bzr_logger.setLevel(logging.DEBUG) 
81
 
 
82
 
info = note = _bzr_logger.info
83
 
warning =   _bzr_logger.warning
 
83
 
 
84
def note(*args, **kwargs):
 
85
    # FIXME note always emits utf-8, regardless of the terminal encoding
 
86
    import bzrlib.ui
 
87
    bzrlib.ui.ui_factory.clear_term()
 
88
    _bzr_logger.info(*args, **kwargs)
 
89
 
 
90
def warning(*args, **kwargs):
 
91
    import bzrlib.ui
 
92
    bzrlib.ui.ui_factory.clear_term()
 
93
    _bzr_logger.warning(*args, **kwargs)
 
94
 
 
95
info = note
84
96
log_error = _bzr_logger.error
85
97
error =     _bzr_logger.error
86
 
mutter =    _bzr_logger.debug
87
 
debug =     _bzr_logger.debug
88
 
 
89
 
 
90
 
 
91
 
 
92
 
# we do the rollover using this code, rather than the default from python
93
 
# logging, because we only want to rollover at program startup, not on each
94
 
# message.  maybe that's not a good enough reason.
 
98
 
 
99
 
 
100
def mutter(fmt, *args):
 
101
    if _trace_file is None:
 
102
        return
 
103
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
 
104
        return
 
105
 
 
106
    if isinstance(fmt, unicode):
 
107
        fmt = fmt.encode('utf8')
 
108
 
 
109
    if len(args) > 0:
 
110
        # It seems that if we do ascii % (unicode, ascii) we can
 
111
        # get a unicode cannot encode ascii error, so make sure that "fmt"
 
112
        # is a unicode string
 
113
        real_args = []
 
114
        for arg in args:
 
115
            if isinstance(arg, unicode):
 
116
                arg = arg.encode('utf8')
 
117
            real_args.append(arg)
 
118
        out = fmt % tuple(real_args)
 
119
    else:
 
120
        out = fmt
 
121
    out += '\n'
 
122
    _trace_file.write(out)
 
123
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
124
    #_trace_file.flush()
 
125
 
95
126
 
96
127
def _rollover_trace_maybe(trace_fname):
97
128
    import stat
100
131
        if size <= 4 << 20:
101
132
            return
102
133
        old_fname = trace_fname + '.old'
103
 
 
104
 
        try:
105
 
            # must remove before rename on windows
106
 
            os.remove(old_fname)
107
 
        except OSError:
108
 
            pass
109
 
 
110
 
        try:
111
 
            # might fail if in use on windows
112
 
            os.rename(trace_fname, old_fname)
113
 
        except OSError:
114
 
            pass
 
134
        from osutils import rename
 
135
        rename(trace_fname, old_fname)
115
136
    except OSError:
116
137
        return
117
138
 
118
139
 
119
 
 
120
140
def open_tracefile(tracefilename='~/.bzr.log'):
121
141
    # Messages are always written to here, so that we have some
122
142
    # information if something goes wrong.  In a future version this
123
143
    # file will be removed on successful completion.
124
 
    global _file_handler
125
 
    import stat, codecs
 
144
    global _file_handler, _bzr_log_file
 
145
    import codecs
126
146
 
127
147
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
148
    _rollover_trace_maybe(trace_fname)
129
 
 
130
 
    # buffering=1 means line buffered
131
149
    try:
132
 
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
133
 
 
134
 
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
 
150
        LINE_BUFFERED = 1
 
151
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
152
        tf = open(trace_fname, 'at', LINE_BUFFERED)
 
153
        _bzr_log_file = tf
 
154
        if tf.tell() == 0:
135
155
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
136
156
            tf.write("you can delete or truncate this file, or include sections in\n")
137
 
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
138
 
        
 
157
            tf.write("bug reports to bazaar@lists.canonical.com\n\n")
139
158
        _file_handler = logging.StreamHandler(tf)
140
159
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
160
        datefmt = r'%a %H:%M:%S'
142
161
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
162
        _file_handler.setLevel(logging.DEBUG)
144
163
        logging.getLogger('').addHandler(_file_handler)
145
 
 
146
164
    except IOError, e:
147
165
        warning("failed to open trace file: %s" % (e))
148
166
 
149
167
 
150
 
def log_startup(argv):
151
 
    import bzrlib
152
 
 
153
 
    debug('bzr %s invoked on python %s (%s)',
154
 
          bzrlib.__version__,
155
 
          '.'.join(map(str, sys.version_info)),
156
 
          sys.platform)
157
 
 
158
 
    debug('  arguments: %r', argv)
159
 
    debug('  working dir: %s', os.getcwdu())
160
 
 
161
 
 
 
168
@deprecated_function(zero_nine)
162
169
def log_exception(msg=None):
163
 
    """Log the last exception into the trace file.
 
170
    """Log the last exception to stderr and the trace file.
164
171
 
165
172
    The exception string representation is used as the error
166
173
    summary, unless msg is given.
167
174
    """
168
 
    if msg == None:
169
 
        ei = sys.exc_info()
170
 
        msg = str(ei[1])
171
 
 
172
 
    if msg and (msg[-1] == '\n'):
173
 
        msg = msg[:-1]
174
 
        
175
 
    _bzr_logger.exception(msg)
176
 
 
 
175
    if msg:
 
176
        error(msg)
 
177
    log_exception_quietly()
 
178
 
 
179
 
 
180
def log_exception_quietly():
 
181
    """Log the last exception to the trace file only.
 
182
 
 
183
    Used for exceptions that occur internally and that may be 
 
184
    interesting to developers but not to users.  For example, 
 
185
    errors loading plugins.
 
186
    """
 
187
    import traceback
 
188
    mutter(traceback.format_exc())
177
189
 
178
190
 
179
191
def enable_default_logging():
180
192
    """Configure default logging to stderr and .bzr.log"""
181
 
    global _stderr_handler, _file_handler
182
 
 
 
193
    # FIXME: if this is run twice, things get confused
 
194
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
183
195
    _stderr_handler = logging.StreamHandler()
184
 
 
 
196
    logging.getLogger('').addHandler(_stderr_handler)
 
197
    _stderr_handler.setLevel(logging.INFO)
185
198
    if not _file_handler:
186
 
        open_tracefile()                # also adds it
187
 
 
188
 
    debug_flag = False
189
 
    try:
190
 
        debug_flag = bool(os.environ['BZR_DEBUG'])
191
 
    except:
192
 
        pass
193
 
        
194
 
    if debug_flag:
195
 
        level = logging.DEBUG
196
 
        fmt = '%(levelname)8s: %(message)s'
197
 
        _stderr_handler.setFormatter(logging.Formatter(fmt))
 
199
        open_tracefile()
 
200
    _trace_file = _bzr_log_file
 
201
    if _file_handler:
 
202
        _file_handler.setLevel(logging.DEBUG)
 
203
    _bzr_logger.setLevel(logging.DEBUG)
 
204
 
 
205
 
 
206
def be_quiet(quiet=True):
 
207
    global _stderr_handler, _stderr_quiet
 
208
    
 
209
    _stderr_quiet = quiet
 
210
    if quiet:
 
211
        _stderr_handler.setLevel(logging.WARNING)
198
212
    else:
199
 
        level = logging.INFO
200
 
        # show only summary of exceptions
201
 
        _stderr_handler.setFormatter(QuietFormatter())
202
 
 
203
 
    _stderr_handler.setLevel(level)
204
 
    _file_handler.setLevel(level)
205
 
 
206
 
    logging.getLogger('').addHandler(_stderr_handler)
207
 
 
 
213
        _stderr_handler.setLevel(logging.INFO)
 
214
 
 
215
 
 
216
def is_quiet():
 
217
    global _stderr_quiet
 
218
    return _stderr_quiet
208
219
 
209
220
 
210
221
def disable_default_logging():
218
229
    l.removeHandler(_stderr_handler)
219
230
    if _file_handler:
220
231
        l.removeHandler(_file_handler)
 
232
    _trace_file = None
 
233
 
 
234
 
 
235
def enable_test_log(to_file):
 
236
    """Redirect logging to a temporary file for a test
 
237
    
 
238
    returns an opaque reference that should be passed to disable_test_log
 
239
    after the test completes.
 
240
    """
 
241
    disable_default_logging()
 
242
    global _trace_file
 
243
    global _trace_depth
 
244
    hdlr = logging.StreamHandler(to_file)
 
245
    hdlr.setLevel(logging.DEBUG)
 
246
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
247
    _bzr_logger.addHandler(hdlr)
 
248
    _bzr_logger.setLevel(logging.DEBUG)
 
249
    result = hdlr, _trace_file, _trace_depth
 
250
    _trace_file = to_file
 
251
    _trace_depth += 1
 
252
    return result
 
253
 
 
254
 
 
255
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
256
    _bzr_logger.removeHandler(test_log_hdlr)
 
257
    test_log_hdlr.close()
 
258
    global _trace_file
 
259
    global _trace_depth
 
260
    _trace_file = old_trace_file
 
261
    _trace_depth = old_trace_depth
 
262
    if not _trace_depth:
 
263
        enable_default_logging()
 
264
 
 
265
 
 
266
def report_exception(exc_info, err_file):
 
267
    exc_type, exc_object, exc_tb = exc_info
 
268
    # Log the full traceback to ~/.bzr.log
 
269
    log_exception_quietly()
 
270
    if (isinstance(exc_object, IOError)
 
271
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
 
272
        print >>err_file, "bzr: broken pipe"
 
273
    elif isinstance(exc_object, KeyboardInterrupt):
 
274
        print >>err_file, "bzr: interrupted"
 
275
    elif not getattr(exc_object, 'internal_error', True):
 
276
        report_user_error(exc_info, err_file)
 
277
    elif isinstance(exc_object, (OSError, IOError)):
 
278
        # Might be nice to catch all of these and show them as something more
 
279
        # specific, but there are too many cases at the moment.
 
280
        report_user_error(exc_info, err_file)
 
281
    else:
 
282
        report_bug(exc_info, err_file)
 
283
 
 
284
 
 
285
# TODO: Should these be specially encoding the output?
 
286
def report_user_error(exc_info, err_file):
 
287
    """Report to err_file an error that's not an internal error.
 
288
 
 
289
    These don't get a traceback unless -Derror was given.
 
290
    """
 
291
    if 'error' in debug.debug_flags:
 
292
        report_bug(exc_info, err_file)
 
293
        return
 
294
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
 
295
 
 
296
 
 
297
def report_bug(exc_info, err_file):
 
298
    """Report an exception that probably indicates a bug in bzr"""
 
299
    import traceback
 
300
    exc_type, exc_object, exc_tb = exc_info
 
301
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
 
302
        exc_type.__module__, exc_type.__name__, exc_object)
 
303
    print >>err_file
 
304
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
305
    print >>err_file
 
306
    print >>err_file, 'bzr %s on python %s (%s)' % \
 
307
                       (bzrlib.__version__,
 
308
                        '.'.join(map(str, sys.version_info)),
 
309
                        sys.platform)
 
310
    print >>err_file, 'arguments: %r' % sys.argv
 
311
    print >>err_file
 
312
    print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"