← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Robert Collins
  • Date: 2006-05-24 08:14:45 UTC
  • mfrom: (1725.1.1 benchmark)
  • mto: (1725.2.6 commit)
  • mto: This revision was merged to the branch mainline in revision 1729.
  • Revision ID: robertc@robertcollins.net-20060524081445-c046b4406ffc8dfa
(rbc)Merge in benchmark --lsprof-timed lsprofiling feature. (Robert Collins, Martin Pool).

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
4
 
# This program is free software; you can redistribute it and/or modify
5
 
# it under the terms of the GNU General Public License as published by
6
 
# the Free Software Foundation; either version 2 of the License, or
7
 
# (at your option) any later version.
8
 
 
9
 
# This program is distributed in the hope that it will be useful,
10
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
 
# GNU General Public License for more details.
13
 
 
14
 
# You should have received a copy of the GNU General Public License
15
 
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
 
 
18
 
 
19
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
 
__author__ = "Martin Pool <mbp@canonical.com>"
 
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.
 
33
"""
 
34
 
 
35
# TODO: in debug mode, stderr should get full tracebacks and also
 
36
# debug messages.  (Is this really needed?)
 
37
 
 
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.
21
41
 
22
42
 
23
43
import sys
24
 
 
25
 
######################################################################
26
 
# messages and logging
27
 
 
28
 
# Messages are always written to here, so that we have some
29
 
# information if something goes wrong.  In a future version this
30
 
# file will be removed on successful completion.
31
 
_tracefile = file('.bzr.log', 'at')
32
 
 
33
 
## TODO: If --verbose is given then write to both stderr and
34
 
## _tracefile; perhaps replace _tracefile with a tee thing.
35
 
 
36
 
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
37
 
 
38
 
 
39
 
# If false, notes also go to stdout; should replace this with --silent
40
 
# at some point.
41
 
silent = False
42
 
 
43
 
verbose = False
44
 
 
45
 
 
46
 
def mutter(msg):
47
 
    _tracefile.write(msg)
48
 
    _tracefile.write('\n')
49
 
    _tracefile.flush()
50
 
    if verbose:
51
 
        sys.stderr.write('- ' + msg + '\n')
52
 
 
53
 
 
54
 
def note(msg):
55
 
    b = '* ' + str(msg) + '\n'
56
 
    if not silent:
57
 
        sys.stderr.write(b)
58
 
    _tracefile.write(b)
59
 
    _tracefile.flush()
60
 
 
61
 
 
62
 
def log_error(msg):
63
 
    sys.stderr.write(msg)
64
 
    _tracefile.write(msg)
65
 
    _tracefile.flush()
 
44
import os
 
45
import logging
 
46
 
 
47
import bzrlib
 
48
from bzrlib.errors import BzrError, BzrNewError
 
49
 
 
50
 
 
51
_file_handler = None
 
52
_stderr_handler = None
 
53
_stderr_quiet = False
 
54
_trace_file = None
 
55
_trace_depth = 0
 
56
_bzr_log_file = None
 
57
 
 
58
 
 
59
class QuietFormatter(logging.Formatter):
 
60
    """Formatter that supresses the details of errors.
 
61
 
 
62
    This is used by default on stderr so as not to scare the user.
 
63
    """
 
64
    # At first I tried overriding formatException to suppress the
 
65
    # exception details, but that has global effect: no loggers
 
66
    # can get the exception details is we suppress them here.
 
67
 
 
68
    def format(self, record):
 
69
        if record.levelno >= logging.WARNING:
 
70
            s = 'bzr: ' + record.levelname + ': '
 
71
        else:
 
72
            s = ''
 
73
        s += record.getMessage()
 
74
        if record.exc_info:
 
75
            s += '\n' + format_exception_short(record.exc_info)
 
76
        return s
 
77
        
 
78
# configure convenient aliases for output routines
 
79
 
 
80
_bzr_logger = logging.getLogger('bzr')
 
81
 
 
82
def note(*args, **kwargs):
 
83
    import bzrlib.ui
 
84
    bzrlib.ui.ui_factory.clear_term()
 
85
    _bzr_logger.info(*args, **kwargs)
 
86
 
 
87
def warning(*args, **kwargs):
 
88
    import bzrlib.ui
 
89
    bzrlib.ui.ui_factory.clear_term()
 
90
    _bzr_logger.warning(*args, **kwargs)
 
91
 
 
92
info = note
 
93
log_error = _bzr_logger.error
 
94
error =     _bzr_logger.error
 
95
 
 
96
 
 
97
def mutter(fmt, *args):
 
98
    if _trace_file is None:
 
99
        return
 
100
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
 
101
        return
 
102
    if len(args) > 0:
 
103
        out = fmt % args
 
104
    else:
 
105
        out = fmt
 
106
    out += '\n'
 
107
    _trace_file.write(out)
 
108
debug = mutter
 
109
 
 
110
 
 
111
def _rollover_trace_maybe(trace_fname):
 
112
    import stat
 
113
    try:
 
114
        size = os.stat(trace_fname)[stat.ST_SIZE]
 
115
        if size <= 4 << 20:
 
116
            return
 
117
        old_fname = trace_fname + '.old'
 
118
        from osutils import rename
 
119
        rename(trace_fname, old_fname)
 
120
    except OSError:
 
121
        return
 
122
 
 
123
 
 
124
def open_tracefile(tracefilename='~/.bzr.log'):
 
125
    # Messages are always written to here, so that we have some
 
126
    # information if something goes wrong.  In a future version this
 
127
    # file will be removed on successful completion.
 
128
    global _file_handler, _bzr_log_file
 
129
    import stat, codecs
 
130
 
 
131
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
 
132
    _rollover_trace_maybe(trace_fname)
 
133
    try:
 
134
        LINE_BUFFERED = 1
 
135
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
136
        _bzr_log_file = tf
 
137
        if tf.tell() == 0:
 
138
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
139
            tf.write("you can delete or truncate this file, or include sections in\n")
 
140
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
141
        _file_handler = logging.StreamHandler(tf)
 
142
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
143
        datefmt = r'%a %H:%M:%S'
 
144
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
145
        _file_handler.setLevel(logging.DEBUG)
 
146
        logging.getLogger('').addHandler(_file_handler)
 
147
    except IOError, e:
 
148
        warning("failed to open trace file: %s" % (e))
 
149
 
 
150
 
 
151
def log_startup(argv):
 
152
    debug('\n\nbzr %s invoked on python %s (%s)',
 
153
          bzrlib.__version__,
 
154
          '.'.join(map(str, sys.version_info)),
 
155
          sys.platform)
 
156
    debug('  arguments: %r', argv)
 
157
    debug('  working dir: %r', os.getcwdu())
 
158
 
 
159
 
 
160
def log_exception(msg=None):
 
161
    """Log the last exception to stderr and the trace file.
 
162
 
 
163
    The exception string representation is used as the error
 
164
    summary, unless msg is given.
 
165
    """
 
166
    if msg:
 
167
        error(msg)
 
168
    else:
 
169
        exc_str = format_exception_short(sys.exc_info())
 
170
        error(exc_str)
 
171
    log_exception_quietly()
 
172
 
 
173
 
 
174
def log_exception_quietly():
 
175
    """Log the last exception to the trace file only.
 
176
 
 
177
    Used for exceptions that occur internally and that may be 
 
178
    interesting to developers but not to users.  For example, 
 
179
    errors loading plugins.
 
180
    """
 
181
    import traceback
 
182
    debug(traceback.format_exc())
 
183
 
 
184
 
 
185
def enable_default_logging():
 
186
    """Configure default logging to stderr and .bzr.log"""
 
187
    # FIXME: if this is run twice, things get confused
 
188
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
189
    _stderr_handler = logging.StreamHandler()
 
190
    _stderr_handler.setFormatter(QuietFormatter())
 
191
    logging.getLogger('').addHandler(_stderr_handler)
 
192
    _stderr_handler.setLevel(logging.INFO)
 
193
    if not _file_handler:
 
194
        open_tracefile()
 
195
    _trace_file = _bzr_log_file
 
196
    if _file_handler:
 
197
        _file_handler.setLevel(logging.DEBUG)
 
198
    _bzr_logger.setLevel(logging.DEBUG) 
 
199
 
 
200
 
 
201
 
 
202
def be_quiet(quiet=True):
 
203
    global _stderr_handler, _stderr_quiet
 
204
    
 
205
    _stderr_quiet = quiet
 
206
    if quiet:
 
207
        _stderr_handler.setLevel(logging.WARNING)
 
208
    else:
 
209
        _stderr_handler.setLevel(logging.INFO)
 
210
 
 
211
 
 
212
def is_quiet():
 
213
    global _stderr_quiet
 
214
    return _stderr_quiet
 
215
 
 
216
 
 
217
def disable_default_logging():
 
218
    """Turn off default log handlers.
 
219
 
 
220
    This is intended to be used by the test framework, which doesn't
 
221
    want leakage from the code-under-test into the main logs.
 
222
    """
 
223
 
 
224
    l = logging.getLogger('')
 
225
    l.removeHandler(_stderr_handler)
 
226
    if _file_handler:
 
227
        l.removeHandler(_file_handler)
 
228
    _trace_file = None
 
229
 
 
230
 
 
231
def enable_test_log(to_file):
 
232
    """Redirect logging to a temporary file for a test
 
233
    
 
234
    returns an opaque reference that should be passed to disable_test_log
 
235
    after the test completes.
 
236
    """
 
237
    disable_default_logging()
 
238
    global _trace_file
 
239
    global _trace_depth
 
240
    hdlr = logging.StreamHandler(to_file)
 
241
    hdlr.setLevel(logging.DEBUG)
 
242
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
243
    _bzr_logger.addHandler(hdlr)
 
244
    _bzr_logger.setLevel(logging.DEBUG)
 
245
    result = hdlr, _trace_file, _trace_depth
 
246
    _trace_file = to_file
 
247
    _trace_depth += 1
 
248
    return result
 
249
 
 
250
 
 
251
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
252
    _bzr_logger.removeHandler(test_log_hdlr)
 
253
    test_log_hdlr.close()
 
254
    global _trace_file
 
255
    global _trace_depth
 
256
    _trace_file = old_trace_file
 
257
    _trace_depth = old_trace_depth
 
258
    if not _trace_depth:
 
259
        enable_default_logging()
 
260
 
 
261
 
 
262
def format_exception_short(exc_info):
 
263
    """Make a short string form of an exception.
 
264
 
 
265
    This is used for display to stderr.  It specially handles exception
 
266
    classes without useful string methods.
 
267
 
 
268
    The result has no trailing newline.
 
269
 
 
270
    exc_info - typically an exception from sys.exc_info()
 
271
    """
 
272
    exc_type, exc_object, exc_tb = exc_info
 
273
    try:
 
274
        if exc_type is None:
 
275
            return '(no exception)'
 
276
        if isinstance(exc_object, (BzrError, BzrNewError)):
 
277
            return str(exc_object)
 
278
        else:
 
279
            import traceback
 
280
            tb = traceback.extract_tb(exc_tb)
 
281
            msg = '%s: %s' % (exc_type, exc_object)
 
282
            if msg[-1] == '\n':
 
283
                msg = msg[:-1]
 
284
            if tb:
 
285
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
 
286
            return msg
 
287
    except Exception, formatting_exc:
 
288
        # XXX: is this really better than just letting it run up?
 
289
        return '(error formatting exception of type %s: %s)' \
 
290
                % (exc_type, formatting_exc)