/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

[merge] basic_io metaformat (mbp)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
 
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
 
 
18
Output to stderr depends on the mode chosen by the user.  By default, messages
 
19
of info and above are sent out, which results in progress messages such as the
 
20
list of files processed by add and commit.  In quiet mode, only warnings and
 
21
above are shown.  In debug mode, stderr gets debug messages too.
 
22
 
 
23
Errors that terminate an operation are generally passed back as exceptions;
 
24
others may be just emitted as messages.
 
25
 
 
26
Exceptions are reported in a brief form to stderr so as not to look scary.
 
27
BzrErrors are required to be able to format themselves into a properly
 
28
explanatory message.  This is not true for builtin excexceptions such as
 
29
KeyError, which typically just str to "0".  They're printed in a different
 
30
form.
 
31
"""
 
32
 
 
33
# TODO: in debug mode, stderr should get full tracebacks and also
 
34
# debug messages.  (Is this really needed?)
 
35
 
 
36
# FIXME: Unfortunately it turns out that python's logging module
 
37
# is quite expensive, even when the message is not printed by any handlers.
 
38
# We should perhaps change back to just simply doing it here.
 
39
 
 
40
 
 
41
import sys
 
42
import os
 
43
import logging
 
44
 
 
45
import bzrlib
 
46
from bzrlib.errors import BzrNewError
 
47
 
 
48
 
 
49
_file_handler = None
 
50
_stderr_handler = None
 
51
_stderr_quiet = False
 
52
_trace_file = None
 
53
_bzr_log_file = None
 
54
 
 
55
class QuietFormatter(logging.Formatter):
 
56
    """Formatter that supresses the details of errors.
 
57
 
 
58
    This is used by default on stderr so as not to scare the user.
 
59
    """
 
60
    # At first I tried overriding formatException to suppress the
 
61
    # exception details, but that has global effect: no loggers
 
62
    # can get the exception details is we suppress them here.
 
63
 
 
64
    def format(self, record):
 
65
        if record.levelno >= logging.WARNING:
 
66
            s = 'bzr: ' + record.levelname + ': '
 
67
        else:
 
68
            s = ''
 
69
        s += record.getMessage()
 
70
        if record.exc_info:
 
71
            s += '\n' + format_exception_short(record.exc_info)
 
72
        return s
 
73
        
 
74
# configure convenient aliases for output routines
 
75
 
 
76
_bzr_logger = logging.getLogger('bzr')
 
77
 
 
78
info = note = _bzr_logger.info
 
79
warning =   _bzr_logger.warning
 
80
log_error = _bzr_logger.error
 
81
error =     _bzr_logger.error
 
82
 
 
83
 
 
84
def mutter(fmt, *args):
 
85
    if _trace_file is None:
 
86
        return
 
87
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
 
88
        return
 
89
    if len(args) > 0:
 
90
        print >>_trace_file, fmt % args
 
91
    else:
 
92
        print >>_trace_file, fmt
 
93
debug = mutter
 
94
 
 
95
 
 
96
def _rollover_trace_maybe(trace_fname):
 
97
    import stat
 
98
    try:
 
99
        size = os.stat(trace_fname)[stat.ST_SIZE]
 
100
        if size <= 4 << 20:
 
101
            return
 
102
        old_fname = trace_fname + '.old'
 
103
        from osutils import rename
 
104
        rename(trace_fname, old_fname)
 
105
    except OSError:
 
106
        return
 
107
 
 
108
 
 
109
def open_tracefile(tracefilename='~/.bzr.log'):
 
110
    # Messages are always written to here, so that we have some
 
111
    # information if something goes wrong.  In a future version this
 
112
    # file will be removed on successful completion.
 
113
    global _file_handler, _bzr_log_file
 
114
    import stat, codecs
 
115
 
 
116
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
 
117
    _rollover_trace_maybe(trace_fname)
 
118
    try:
 
119
        LINE_BUFFERED = 1
 
120
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
121
        _bzr_log_file = tf
 
122
        if tf.tell() == 0:
 
123
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
124
            tf.write("you can delete or truncate this file, or include sections in\n")
 
125
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
126
        _file_handler = logging.StreamHandler(tf)
 
127
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
128
        datefmt = r'%a %H:%M:%S'
 
129
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
130
        _file_handler.setLevel(logging.DEBUG)
 
131
        logging.getLogger('').addHandler(_file_handler)
 
132
    except IOError, e:
 
133
        warning("failed to open trace file: %s" % (e))
 
134
 
 
135
 
 
136
def log_startup(argv):
 
137
    debug('\n\nbzr %s invoked on python %s (%s)',
 
138
          bzrlib.__version__,
 
139
          '.'.join(map(str, sys.version_info)),
 
140
          sys.platform)
 
141
    debug('  arguments: %r', argv)
 
142
    debug('  working dir: %r', os.getcwdu())
 
143
 
 
144
 
 
145
def log_exception(msg=None):
 
146
    """Log the last exception to stderr and the trace file.
 
147
 
 
148
    The exception string representation is used as the error
 
149
    summary, unless msg is given.
 
150
    """
 
151
    if msg:
 
152
        error(msg)
 
153
    else:
 
154
        exc_str = format_exception_short(sys.exc_info())
 
155
        error(exc_str)
 
156
    log_exception_quietly()
 
157
 
 
158
 
 
159
def log_exception_quietly():
 
160
    """Log the last exception to the trace file only.
 
161
 
 
162
    Used for exceptions that occur internally and that may be 
 
163
    interesting to developers but not to users.  For example, 
 
164
    errors loading plugins.
 
165
    """
 
166
    import traceback
 
167
    debug(traceback.format_exc())
 
168
 
 
169
 
 
170
def enable_default_logging():
 
171
    """Configure default logging to stderr and .bzr.log"""
 
172
    # FIXME: if this is run twice, things get confused
 
173
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
174
    _stderr_handler = logging.StreamHandler()
 
175
    _stderr_handler.setFormatter(QuietFormatter())
 
176
    logging.getLogger('').addHandler(_stderr_handler)
 
177
    _stderr_handler.setLevel(logging.INFO)
 
178
    if not _file_handler:
 
179
        open_tracefile()
 
180
    _trace_file = _bzr_log_file
 
181
    if _file_handler:
 
182
        _file_handler.setLevel(logging.DEBUG)
 
183
    _bzr_logger.setLevel(logging.DEBUG) 
 
184
 
 
185
 
 
186
 
 
187
def be_quiet(quiet=True):
 
188
    global _stderr_handler, _stderr_quiet
 
189
    
 
190
    _stderr_quiet = quiet
 
191
    if quiet:
 
192
        _stderr_handler.setLevel(logging.WARNING)
 
193
    else:
 
194
        _stderr_handler.setLevel(logging.INFO)
 
195
 
 
196
 
 
197
def is_quiet():
 
198
    global _stderr_quiet
 
199
    return _stderr_quiet
 
200
 
 
201
 
 
202
def disable_default_logging():
 
203
    """Turn off default log handlers.
 
204
 
 
205
    This is intended to be used by the test framework, which doesn't
 
206
    want leakage from the code-under-test into the main logs.
 
207
    """
 
208
 
 
209
    l = logging.getLogger('')
 
210
    l.removeHandler(_stderr_handler)
 
211
    if _file_handler:
 
212
        l.removeHandler(_file_handler)
 
213
    _trace_file = None
 
214
 
 
215
 
 
216
def enable_test_log(to_file):
 
217
    """Redirect logging to a temporary file for a test"""
 
218
    disable_default_logging()
 
219
    global _test_log_hdlr, _trace_file
 
220
    hdlr = logging.StreamHandler(to_file)
 
221
    hdlr.setLevel(logging.DEBUG)
 
222
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
223
    _bzr_logger.addHandler(hdlr)
 
224
    _bzr_logger.setLevel(logging.DEBUG)
 
225
    _test_log_hdlr = hdlr
 
226
    _trace_file = to_file
 
227
 
 
228
 
 
229
def disable_test_log():
 
230
    _bzr_logger.removeHandler(_test_log_hdlr)
 
231
    _trace_file = None
 
232
    enable_default_logging()
 
233
 
 
234
 
 
235
def format_exception_short(exc_info):
 
236
    """Make a short string form of an exception.
 
237
 
 
238
    This is used for display to stderr.  It specially handles exception
 
239
    classes without useful string methods.
 
240
 
 
241
    The result has no trailing newline.
 
242
 
 
243
    exc_info - typically an exception from sys.exc_info()
 
244
    """
 
245
    exc_type, exc_object, exc_tb = exc_info
 
246
    try:
 
247
        if exc_type is None:
 
248
            return '(no exception)'
 
249
        if isinstance(exc_object, BzrNewError):
 
250
            return str(exc_object)
 
251
        else:
 
252
            import traceback
 
253
            tb = traceback.extract_tb(exc_tb)
 
254
            msg = '%s: %s' % (exc_type, exc_object)
 
255
            if msg[-1] == '\n':
 
256
                msg = msg[:-1]
 
257
            if tb:
 
258
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
 
259
            return msg
 
260
    except:
 
261
        return '(error formatting exception of type %s)' % exc_type