~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Robert Collins
  • Date: 2005-09-23 09:25:16 UTC
  • mto: (1092.3.4)
  • mto: This revision was merged to the branch mainline in revision 1390.
  • Revision ID: robertc@robertcollins.net-20050923092516-e2c3c0f31288669d
Merge what applied of Alexander Belchenko's win32 patch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, Canonical Ltd
2
 
 
3
 
"""Messages and logging for bazaar-ng.
4
 
 
5
 
Messages are supplied by callers as a string-formatting template, plus values
6
 
to be inserted into it.  The actual %-formatting is deferred to the log
7
 
library so that it doesn't need to be done for messages that won't be emitted.
8
 
 
9
 
Messages are classified by severity levels: critical, error, warning, info,
10
 
and debug.
11
 
 
12
 
They can be sent to two places: to stderr, and to ~/.bzr.log.  For purposes
13
 
such as running the test suite, they can also be redirected away from both of
14
 
those two places to another location.
15
 
 
16
 
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
17
 
This trace file is always in UTF-8, regardless of the user's default encoding,
18
 
so that we can always rely on writing any message.
19
 
 
20
 
Output to stderr depends on the mode chosen by the user.  By default, messages
21
 
of info and above are sent out, which results in progress messages such as the
22
 
list of files processed by add and commit.  In quiet mode, only warnings and
23
 
above are shown.  In debug mode, stderr gets debug messages too.
24
 
 
25
 
Errors that terminate an operation are generally passed back as exceptions;
26
 
others may be just emitted as messages.
27
 
 
28
 
Exceptions are reported in a brief form to stderr so as not to look scary.
29
 
BzrErrors are required to be able to format themselves into a properly
30
 
explanatory message.  This is not true for builtin excexceptions such as
31
 
KeyError, which typically just str to "0".  They're printed in a different
32
 
form.
 
1
# This program is free software; you can redistribute it and/or modify
 
2
# it under the terms of the GNU General Public License as published by
 
3
# the Free Software Foundation; either version 2 of the License, or
 
4
# (at your option) any later version.
 
5
 
 
6
# This program is distributed in the hope that it will be useful,
 
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
9
# GNU General Public License for more details.
 
10
 
 
11
# You should have received a copy of the GNU General Public License
 
12
# along with this program; if not, write to the Free Software
 
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
14
 
 
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.
33
27
"""
34
28
 
 
29
 
35
30
# TODO: in debug mode, stderr should get full tracebacks and also
36
31
# debug messages.  (Is this really needed?)
37
32
 
38
 
# FIXME: Unfortunately it turns out that python's logging module
39
 
# is quite expensive, even when the message is not printed by any handlers.
40
 
# We should perhaps change back to just simply doing it here.
 
33
# TODO: When running the test suites, we should add an additional
 
34
# logger that sends messages into the test log file.
41
35
 
42
36
 
43
37
import sys
44
38
import os
45
39
import logging
46
 
 
47
 
import bzrlib
48
 
from bzrlib.errors import BzrError, BzrNewError
 
40
import traceback
49
41
 
50
42
 
51
43
_file_handler = None
52
44
_stderr_handler = None
53
 
_stderr_quiet = False
54
 
_trace_file = None
55
 
_bzr_log_file = None
56
45
 
57
46
 
58
47
class QuietFormatter(logging.Formatter):
65
54
    # can get the exception details is we suppress them here.
66
55
 
67
56
    def format(self, record):
 
57
        s = 'bzr: '
68
58
        if record.levelno >= logging.WARNING:
69
 
            s = 'bzr: ' + record.levelname + ': '
70
 
        else:
71
 
            s = ''
72
 
        s += record.getMessage()
 
59
            s += record.levelname + ': '
 
60
            
 
61
        s += record.getMessage() 
 
62
            
73
63
        if record.exc_info:
74
 
            s += '\n' + format_exception_short(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
 
75
71
        return s
76
72
        
 
73
 
 
74
 
 
75
 
 
76
################
77
77
# configure convenient aliases for output routines
78
78
 
79
79
_bzr_logger = logging.getLogger('bzr')
 
80
_bzr_logger.setLevel(logging.DEBUG) 
80
81
 
81
82
info = note = _bzr_logger.info
82
83
warning =   _bzr_logger.warning
83
84
log_error = _bzr_logger.error
84
85
error =     _bzr_logger.error
85
 
 
86
 
 
87
 
def mutter(fmt, *args):
88
 
    if _trace_file is None:
89
 
        return
90
 
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
91
 
        return
92
 
    if len(args) > 0:
93
 
        out = fmt % args
94
 
    else:
95
 
        out = fmt
96
 
    out += '\n'
97
 
    if isinstance(out, unicode):
98
 
        out = out.encode('utf-8')
99
 
    _trace_file.write(out)
100
 
debug = mutter
101
 
 
 
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.
102
95
 
103
96
def _rollover_trace_maybe(trace_fname):
104
97
    import stat
107
100
        if size <= 4 << 20:
108
101
            return
109
102
        old_fname = trace_fname + '.old'
 
103
 
110
104
        from osutils import rename
111
105
        rename(trace_fname, old_fname)
 
106
 
112
107
    except OSError:
113
108
        return
114
109
 
115
110
 
 
111
 
116
112
def open_tracefile(tracefilename='~/.bzr.log'):
117
113
    # Messages are always written to here, so that we have some
118
114
    # information if something goes wrong.  In a future version this
119
115
    # file will be removed on successful completion.
120
 
    global _file_handler, _bzr_log_file
 
116
    global _file_handler
121
117
    import stat, codecs
122
118
 
123
119
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
124
120
    _rollover_trace_maybe(trace_fname)
 
121
 
 
122
    # buffering=1 means line buffered
125
123
    try:
126
 
        LINE_BUFFERED = 1
127
 
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
128
 
        _bzr_log_file = tf
129
 
        if tf.tell() == 0:
 
124
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
 
125
 
 
126
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
130
127
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
131
128
            tf.write("you can delete or truncate this file, or include sections in\n")
132
129
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
130
        
133
131
        _file_handler = logging.StreamHandler(tf)
134
132
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
135
133
        datefmt = r'%a %H:%M:%S'
136
134
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
137
135
        _file_handler.setLevel(logging.DEBUG)
138
136
        logging.getLogger('').addHandler(_file_handler)
 
137
 
139
138
    except IOError, e:
140
139
        warning("failed to open trace file: %s" % (e))
141
140
 
142
141
 
143
142
def log_startup(argv):
144
 
    debug('\n\nbzr %s invoked on python %s (%s)',
 
143
    import bzrlib
 
144
 
 
145
    debug('bzr %s invoked on python %s (%s)',
145
146
          bzrlib.__version__,
146
147
          '.'.join(map(str, sys.version_info)),
147
148
          sys.platform)
 
149
 
148
150
    debug('  arguments: %r', argv)
149
 
    debug('  working dir: %r', os.getcwdu())
 
151
    debug('  working dir: %s', os.getcwdu())
150
152
 
151
153
 
152
154
def log_exception(msg=None):
153
 
    """Log the last exception to stderr and the trace file.
 
155
    """Log the last exception into the trace file.
154
156
 
155
157
    The exception string representation is used as the error
156
158
    summary, unless msg is given.
157
159
    """
158
 
    if msg:
159
 
        error(msg)
160
 
    else:
161
 
        exc_str = format_exception_short(sys.exc_info())
162
 
        error(exc_str)
163
 
    log_exception_quietly()
164
 
 
165
 
 
166
 
def log_exception_quietly():
167
 
    """Log the last exception to the trace file only.
168
 
 
169
 
    Used for exceptions that occur internally and that may be 
170
 
    interesting to developers but not to users.  For example, 
171
 
    errors loading plugins.
172
 
    """
173
 
    import traceback
174
 
    debug(traceback.format_exc())
 
160
    if msg == None:
 
161
        ei = sys.exc_info()
 
162
        msg = str(ei[1])
 
163
 
 
164
    if msg and (msg[-1] == '\n'):
 
165
        msg = msg[:-1]
 
166
        
 
167
    _bzr_logger.exception(msg)
 
168
 
175
169
 
176
170
 
177
171
def enable_default_logging():
178
172
    """Configure default logging to stderr and .bzr.log"""
179
 
    # FIXME: if this is run twice, things get confused
180
 
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
173
    global _stderr_handler, _file_handler
 
174
 
181
175
    _stderr_handler = logging.StreamHandler()
182
176
    _stderr_handler.setFormatter(QuietFormatter())
183
 
    logging.getLogger('').addHandler(_stderr_handler)
184
 
    _stderr_handler.setLevel(logging.INFO)
 
177
 
185
178
    if not _file_handler:
186
179
        open_tracefile()
187
 
    _trace_file = _bzr_log_file
188
 
    if _file_handler:
189
 
        _file_handler.setLevel(logging.DEBUG)
190
 
    _bzr_logger.setLevel(logging.DEBUG) 
191
 
 
192
 
 
193
 
 
194
 
def be_quiet(quiet=True):
195
 
    global _stderr_handler, _stderr_quiet
196
 
    
197
 
    _stderr_quiet = quiet
198
 
    if quiet:
199
 
        _stderr_handler.setLevel(logging.WARNING)
 
180
 
 
181
    if os.environ.get('BZR_DEBUG'):
 
182
        level = logging.DEBUG
200
183
    else:
201
 
        _stderr_handler.setLevel(logging.INFO)
202
 
 
203
 
 
204
 
def is_quiet():
205
 
    global _stderr_quiet
206
 
    return _stderr_quiet
 
184
        level = logging.INFO
 
185
 
 
186
    _stderr_handler.setLevel(logging.INFO)
 
187
    _file_handler.setLevel(level)
 
188
 
 
189
    logging.getLogger('').addHandler(_stderr_handler)
207
190
 
208
191
 
209
192
def disable_default_logging():
217
200
    l.removeHandler(_stderr_handler)
218
201
    if _file_handler:
219
202
        l.removeHandler(_file_handler)
220
 
    _trace_file = None
221
 
 
222
 
 
223
 
def enable_test_log(to_file):
224
 
    """Redirect logging to a temporary file for a test"""
225
 
    disable_default_logging()
226
 
    global _test_log_hdlr, _trace_file
227
 
    hdlr = logging.StreamHandler(to_file)
228
 
    hdlr.setLevel(logging.DEBUG)
229
 
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
230
 
    _bzr_logger.addHandler(hdlr)
231
 
    _bzr_logger.setLevel(logging.DEBUG)
232
 
    _test_log_hdlr = hdlr
233
 
    _trace_file = to_file
234
 
 
235
 
 
236
 
def disable_test_log():
237
 
    _bzr_logger.removeHandler(_test_log_hdlr)
238
 
    _trace_file = None
239
 
    enable_default_logging()
240
 
 
241
 
 
242
 
def format_exception_short(exc_info):
243
 
    """Make a short string form of an exception.
244
 
 
245
 
    This is used for display to stderr.  It specially handles exception
246
 
    classes without useful string methods.
247
 
 
248
 
    The result has no trailing newline.
249
 
 
250
 
    exc_info - typically an exception from sys.exc_info()
251
 
    """
252
 
    exc_type, exc_object, exc_tb = exc_info
253
 
    try:
254
 
        if exc_type is None:
255
 
            return '(no exception)'
256
 
        if isinstance(exc_object, (BzrError, BzrNewError)):
257
 
            return str(exc_object)
258
 
        else:
259
 
            import traceback
260
 
            tb = traceback.extract_tb(exc_tb)
261
 
            msg = '%s: %s' % (exc_type, exc_object)
262
 
            if msg[-1] == '\n':
263
 
                msg = msg[:-1]
264
 
            if tb:
265
 
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
266
 
            return msg
267
 
    except Exception, formatting_exc:
268
 
        # XXX: is this really better than just letting it run up?
269
 
        return '(error formatting exception of type %s: %s)' \
270
 
                % (exc_type, formatting_exc)