~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

Update news and readme

- better explanation of dependencies

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
3
1
# This program is free software; you can redistribute it and/or modify
4
2
# it under the terms of the GNU General Public License as published by
5
3
# the Free Software Foundation; either version 2 of the License, or
6
4
# (at your option) any later version.
7
 
#
 
5
 
8
6
# This program is distributed in the hope that it will be useful,
9
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
9
# GNU General Public License for more details.
12
 
#
 
10
 
13
11
# You should have received a copy of the GNU General Public License
14
12
# along with this program; if not, write to the Free Software
15
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
14
 
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.
 
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.
47
27
"""
48
28
 
 
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
 
49
36
# FIXME: Unfortunately it turns out that python's logging module
50
37
# is quite expensive, even when the message is not printed by any handlers.
51
38
# We should perhaps change back to just simply doing it here.
52
39
 
 
40
 
 
41
import sys
53
42
import os
54
 
import sys
55
 
import re
56
 
 
57
 
from bzrlib.lazy_import import lazy_import
58
 
lazy_import(globals(), """
59
 
import errno
60
43
import logging
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
 
""")
 
44
import traceback
 
45
 
71
46
 
72
47
_file_handler = None
73
48
_stderr_handler = None
74
 
_stderr_quiet = False
75
 
_trace_file = None
76
 
_trace_depth = 0
77
 
_bzr_log_file = None
78
 
_bzr_log_filename = None
79
 
 
80
 
 
 
49
 
 
50
 
 
51
class QuietFormatter(logging.Formatter):
 
52
    """Formatter that supresses the details of errors.
 
53
 
 
54
    This is used by default on stderr so as not to scare the user.
 
55
    """
 
56
    # At first I tried overriding formatException to suppress the
 
57
    # exception details, but that has global effect: no loggers
 
58
    # can get the exception details is we suppress them here.
 
59
 
 
60
    def format(self, record):
 
61
        if record.levelno >= logging.WARNING:
 
62
            s = 'bzr: ' + record.levelname + ': '
 
63
        else:
 
64
            s = ''
 
65
            
 
66
        s += record.getMessage()
 
67
 
 
68
        ##import textwrap
 
69
        ##s = textwrap.fill(s)
 
70
            
 
71
        if record.exc_info:
 
72
            # give just a summary of the exception, not the whole thing
 
73
            exinfo = traceback.extract_tb(record.exc_info[2])
 
74
            # the format of this string matches one of the REs
 
75
            s += '\n'
 
76
            s += ('  at %s line %d, in %s()\n' % exinfo[-1][:3])
 
77
            s += '  see ~/.bzr.log for debug information'
 
78
 
 
79
        return s
 
80
        
 
81
 
 
82
 
 
83
 
 
84
################
81
85
# configure convenient aliases for output routines
82
86
 
83
87
_bzr_logger = logging.getLogger('bzr')
84
 
 
85
 
def note(*args, **kwargs):
86
 
    # FIXME note always emits utf-8, regardless of the terminal encoding
87
 
    import bzrlib.ui
88
 
    bzrlib.ui.ui_factory.clear_term()
89
 
    _bzr_logger.info(*args, **kwargs)
90
 
 
91
 
def warning(*args, **kwargs):
92
 
    import bzrlib.ui
93
 
    bzrlib.ui.ui_factory.clear_term()
94
 
    _bzr_logger.warning(*args, **kwargs)
95
 
 
96
 
info = note
 
88
_bzr_logger.setLevel(logging.DEBUG) 
 
89
 
 
90
info = note = _bzr_logger.info
 
91
warning =   _bzr_logger.warning
97
92
log_error = _bzr_logger.error
98
93
error =     _bzr_logger.error
99
 
 
100
 
 
101
 
def mutter(fmt, *args):
102
 
    if _trace_file is None:
103
 
        return
104
 
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
105
 
        return
106
 
 
107
 
    if isinstance(fmt, unicode):
108
 
        fmt = fmt.encode('utf8')
109
 
 
110
 
    if len(args) > 0:
111
 
        # It seems that if we do ascii % (unicode, ascii) we can
112
 
        # get a unicode cannot encode ascii error, so make sure that "fmt"
113
 
        # is a unicode string
114
 
        real_args = []
115
 
        for arg in args:
116
 
            if isinstance(arg, unicode):
117
 
                arg = arg.encode('utf8')
118
 
            real_args.append(arg)
119
 
        out = fmt % tuple(real_args)
120
 
    else:
121
 
        out = fmt
122
 
    out += '\n'
123
 
    _trace_file.write(out)
124
 
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
125
 
    #_trace_file.flush()
126
 
 
 
94
mutter =    _bzr_logger.debug
 
95
debug =     _bzr_logger.debug
 
96
 
 
97
 
 
98
 
 
99
 
 
100
# we do the rollover using this code, rather than the default from python
 
101
# logging, because we only want to rollover at program startup, not on each
 
102
# message.  maybe that's not a good enough reason.
127
103
 
128
104
def _rollover_trace_maybe(trace_fname):
129
105
    import stat
132
108
        if size <= 4 << 20:
133
109
            return
134
110
        old_fname = trace_fname + '.old'
 
111
 
135
112
        from osutils import rename
136
113
        rename(trace_fname, old_fname)
 
114
 
137
115
    except OSError:
138
116
        return
139
117
 
140
118
 
141
 
def open_tracefile(tracefilename=None):
 
119
 
 
120
def open_tracefile(tracefilename='~/.bzr.log'):
142
121
    # Messages are always written to here, so that we have some
143
122
    # information if something goes wrong.  In a future version this
144
123
    # file will be removed on successful completion.
145
 
    global _file_handler, _bzr_log_file, _bzr_log_filename
146
 
    import codecs
147
 
 
148
 
    if tracefilename is None:
149
 
        if sys.platform == 'win32':
150
 
            from bzrlib import win32utils
151
 
            home = win32utils.get_home_location()
152
 
        else:
153
 
            home = os.path.expanduser('~')
154
 
        _bzr_log_filename = os.path.join(home, '.bzr.log')
155
 
 
156
 
    _bzr_log_filename = os.path.expanduser(_bzr_log_filename)
157
 
    _rollover_trace_maybe(_bzr_log_filename)
 
124
    global _file_handler
 
125
    import stat, codecs
 
126
 
 
127
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
 
128
    _rollover_trace_maybe(trace_fname)
 
129
 
 
130
    # buffering=1 means line buffered
158
131
    try:
159
 
        LINE_BUFFERED = 1
160
 
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
161
 
        tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
162
 
        _bzr_log_file = tf
163
 
        # tf.tell() on windows always return 0 until some writing done
164
 
        tf.write('\n')
165
 
        if tf.tell() <= 2:
166
 
            tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
 
132
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
 
133
 
 
134
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
 
135
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
167
136
            tf.write("you can delete or truncate this file, or include sections in\n")
168
 
            tf.write("bug reports to bazaar@lists.canonical.com\n\n")
 
137
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
138
        
169
139
        _file_handler = logging.StreamHandler(tf)
170
140
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
171
141
        datefmt = r'%a %H:%M:%S'
172
142
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
173
143
        _file_handler.setLevel(logging.DEBUG)
174
144
        logging.getLogger('').addHandler(_file_handler)
 
145
 
175
146
    except IOError, e:
176
147
        warning("failed to open trace file: %s" % (e))
177
148
 
178
149
 
179
 
@deprecated_function(zero_nine)
 
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: %r', os.getcwdu())
 
160
 
 
161
 
180
162
def log_exception(msg=None):
181
 
    """Log the last exception to stderr and the trace file.
 
163
    """Log the last exception into the trace file.
182
164
 
183
165
    The exception string representation is used as the error
184
166
    summary, unless msg is given.
185
 
 
186
 
    Please see log_exception_quietly() for the replacement API.
187
 
    """
188
 
    if msg:
189
 
        error(msg)
190
 
    log_exception_quietly()
191
 
 
192
 
 
193
 
def log_exception_quietly():
194
 
    """Log the last exception to the trace file only.
195
 
 
196
 
    Used for exceptions that occur internally and that may be 
197
 
    interesting to developers but not to users.  For example, 
198
 
    errors loading plugins.
199
 
    """
200
 
    import traceback
201
 
    mutter(traceback.format_exc())
 
167
    """
 
168
    cmd_repr = ' '.join(repr(arg) for arg in sys.argv)
 
169
    cmd_info = '\n  command: %s\n  pwd: %s' \
 
170
        % (cmd_repr, os.getcwd())
 
171
    if msg == None:
 
172
        ei = sys.exc_info()
 
173
        msg = str(ei[1])
 
174
    if msg and (msg[-1] == '\n'):
 
175
        msg = msg[:-1]
 
176
    ## msg = "(%s) %s" % (str(type(ei[1])), msg)
 
177
    _bzr_logger.exception(msg + cmd_info)
 
178
 
202
179
 
203
180
 
204
181
def enable_default_logging():
205
182
    """Configure default logging to stderr and .bzr.log"""
206
 
    # FIXME: if this is run twice, things get confused
207
 
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
183
    global _stderr_handler, _file_handler
 
184
 
208
185
    _stderr_handler = logging.StreamHandler()
209
 
    logging.getLogger('').addHandler(_stderr_handler)
210
 
    _stderr_handler.setLevel(logging.INFO)
 
186
    _stderr_handler.setFormatter(QuietFormatter())
 
187
 
211
188
    if not _file_handler:
212
189
        open_tracefile()
213
 
    _trace_file = _bzr_log_file
214
 
    if _file_handler:
215
 
        _file_handler.setLevel(logging.DEBUG)
216
 
    _bzr_logger.setLevel(logging.DEBUG)
217
 
 
218
 
 
219
 
def be_quiet(quiet=True):
220
 
    global _stderr_handler, _stderr_quiet
221
 
    
222
 
    _stderr_quiet = quiet
223
 
    if quiet:
224
 
        _stderr_handler.setLevel(logging.WARNING)
 
190
 
 
191
    if os.environ.get('BZR_DEBUG'):
 
192
        level = logging.DEBUG
225
193
    else:
226
 
        _stderr_handler.setLevel(logging.INFO)
227
 
 
228
 
 
229
 
def is_quiet():
230
 
    global _stderr_quiet
231
 
    return _stderr_quiet
 
194
        level = logging.INFO
 
195
 
 
196
    _stderr_handler.setLevel(logging.INFO)
 
197
    _file_handler.setLevel(level)
 
198
 
 
199
    logging.getLogger('').addHandler(_stderr_handler)
232
200
 
233
201
 
234
202
def disable_default_logging():
242
210
    l.removeHandler(_stderr_handler)
243
211
    if _file_handler:
244
212
        l.removeHandler(_file_handler)
245
 
    _trace_file = None
246
 
 
247
 
 
248
 
def enable_test_log(to_file):
249
 
    """Redirect logging to a temporary file for a test
250
 
    
251
 
    returns an opaque reference that should be passed to disable_test_log
252
 
    after the test completes.
253
 
    """
254
 
    disable_default_logging()
255
 
    global _trace_file
256
 
    global _trace_depth
257
 
    hdlr = logging.StreamHandler(to_file)
258
 
    hdlr.setLevel(logging.DEBUG)
259
 
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
260
 
    _bzr_logger.addHandler(hdlr)
261
 
    _bzr_logger.setLevel(logging.DEBUG)
262
 
    result = hdlr, _trace_file, _trace_depth
263
 
    _trace_file = to_file
264
 
    _trace_depth += 1
265
 
    return result
266
 
 
267
 
 
268
 
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
269
 
    _bzr_logger.removeHandler(test_log_hdlr)
270
 
    test_log_hdlr.close()
271
 
    global _trace_file
272
 
    global _trace_depth
273
 
    _trace_file = old_trace_file
274
 
    _trace_depth = old_trace_depth
275
 
    if not _trace_depth:
276
 
        enable_default_logging()
277
 
 
278
 
 
279
 
def report_exception(exc_info, err_file):
280
 
    exc_type, exc_object, exc_tb = exc_info
281
 
    # Log the full traceback to ~/.bzr.log
282
 
    log_exception_quietly()
283
 
    if (isinstance(exc_object, IOError)
284
 
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
285
 
        print >>err_file, "bzr: broken pipe"
286
 
    elif isinstance(exc_object, KeyboardInterrupt):
287
 
        print >>err_file, "bzr: interrupted"
288
 
    elif not getattr(exc_object, 'internal_error', True):
289
 
        report_user_error(exc_info, err_file)
290
 
    elif isinstance(exc_object, (OSError, IOError)):
291
 
        # Might be nice to catch all of these and show them as something more
292
 
        # specific, but there are too many cases at the moment.
293
 
        report_user_error(exc_info, err_file)
294
 
    else:
295
 
        report_bug(exc_info, err_file)
296
 
 
297
 
 
298
 
# TODO: Should these be specially encoding the output?
299
 
def report_user_error(exc_info, err_file):
300
 
    """Report to err_file an error that's not an internal error.
301
 
 
302
 
    These don't get a traceback unless -Derror was given.
303
 
    """
304
 
    if 'error' in debug.debug_flags:
305
 
        report_bug(exc_info, err_file)
306
 
        return
307
 
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
308
 
 
309
 
 
310
 
def report_bug(exc_info, err_file):
311
 
    """Report an exception that probably indicates a bug in bzr"""
312
 
    import traceback
313
 
    exc_type, exc_object, exc_tb = exc_info
314
 
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
315
 
        exc_type.__module__, exc_type.__name__, exc_object)
316
 
    print >>err_file
317
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
318
 
    print >>err_file
319
 
    print >>err_file, 'bzr %s on python %s (%s)' % \
320
 
                       (bzrlib.__version__,
321
 
                        '.'.join(map(str, sys.version_info)),
322
 
                        sys.platform)
323
 
    print >>err_file, 'arguments: %r' % sys.argv
324
 
    print >>err_file
325
 
    print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"