← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Olaf Conradi
  • Date: 2006-03-28 23:30:02 UTC
  • mto: (1661.1.1 bzr.mbp.remember)
  • mto: This revision was merged to the branch mainline in revision 1663.
  • Revision ID: olaf@conradi.org-20060328233002-f6262df0e19c1963
Added testcases for using pull with --remember. Moved remember code to
beginning of cmd_pull. This remembers the location in case of a failure
during pull.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
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.
 
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.
27
33
"""
28
34
 
29
 
 
30
35
# TODO: in debug mode, stderr should get full tracebacks and also
31
36
# debug messages.  (Is this really needed?)
32
37
 
33
 
# TODO: When running the test suites, we should add an additional
34
 
# logger that sends messages into the test log file.
35
 
 
36
38
# FIXME: Unfortunately it turns out that python's logging module
37
39
# is quite expensive, even when the message is not printed by any handlers.
38
40
# We should perhaps change back to just simply doing it here.
41
43
import sys
42
44
import os
43
45
import logging
44
 
import traceback
 
46
 
 
47
import bzrlib
 
48
from bzrlib.errors import BzrError, BzrNewError
45
49
 
46
50
 
47
51
_file_handler = None
48
52
_stderr_handler = None
 
53
_stderr_quiet = False
 
54
_trace_file = None
 
55
_bzr_log_file = None
49
56
 
50
57
 
51
58
class QuietFormatter(logging.Formatter):
62
69
            s = 'bzr: ' + record.levelname + ': '
63
70
        else:
64
71
            s = ''
65
 
            
66
72
        s += record.getMessage()
67
 
 
68
 
        ##import textwrap
69
 
        ##s = textwrap.fill(s)
70
 
            
71
73
        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
 
 
 
74
            s += '\n' + format_exception_short(record.exc_info)
79
75
        return s
80
76
        
81
 
 
82
 
 
83
 
 
84
 
################
85
77
# configure convenient aliases for output routines
86
78
 
87
79
_bzr_logger = logging.getLogger('bzr')
88
 
_bzr_logger.setLevel(logging.DEBUG) 
89
80
 
90
81
info = note = _bzr_logger.info
91
82
warning =   _bzr_logger.warning
92
83
log_error = _bzr_logger.error
93
84
error =     _bzr_logger.error
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.
 
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
    _trace_file.write(out)
 
98
debug = mutter
 
99
 
103
100
 
104
101
def _rollover_trace_maybe(trace_fname):
105
102
    import stat
108
105
        if size <= 4 << 20:
109
106
            return
110
107
        old_fname = trace_fname + '.old'
111
 
 
112
108
        from osutils import rename
113
109
        rename(trace_fname, old_fname)
114
 
 
115
110
    except OSError:
116
111
        return
117
112
 
118
113
 
119
 
 
120
114
def open_tracefile(tracefilename='~/.bzr.log'):
121
115
    # Messages are always written to here, so that we have some
122
116
    # information if something goes wrong.  In a future version this
123
117
    # file will be removed on successful completion.
124
 
    global _file_handler
 
118
    global _file_handler, _bzr_log_file
125
119
    import stat, codecs
126
120
 
127
121
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
122
    _rollover_trace_maybe(trace_fname)
129
 
 
130
 
    # buffering=1 means line buffered
131
123
    try:
132
 
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
133
 
 
134
 
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
 
124
        LINE_BUFFERED = 1
 
125
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
126
        _bzr_log_file = tf
 
127
        if tf.tell() == 0:
135
128
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
136
129
            tf.write("you can delete or truncate this file, or include sections in\n")
137
130
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
138
 
        
139
131
        _file_handler = logging.StreamHandler(tf)
140
132
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
133
        datefmt = r'%a %H:%M:%S'
142
134
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
135
        _file_handler.setLevel(logging.DEBUG)
144
136
        logging.getLogger('').addHandler(_file_handler)
145
 
 
146
137
    except IOError, e:
147
138
        warning("failed to open trace file: %s" % (e))
148
139
 
149
140
 
150
141
def log_startup(argv):
151
 
    import bzrlib
152
 
 
153
 
    debug('bzr %s invoked on python %s (%s)',
 
142
    debug('\n\nbzr %s invoked on python %s (%s)',
154
143
          bzrlib.__version__,
155
144
          '.'.join(map(str, sys.version_info)),
156
145
          sys.platform)
157
 
 
158
146
    debug('  arguments: %r', argv)
159
147
    debug('  working dir: %r', os.getcwdu())
160
148
 
165
153
    The exception string representation is used as the error
166
154
    summary, unless msg is given.
167
155
    """
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
 
 
 
156
    if msg:
 
157
        error(msg)
 
158
    else:
 
159
        exc_str = format_exception_short(sys.exc_info())
 
160
        error(exc_str)
 
161
    log_exception_quietly()
179
162
 
180
163
 
181
164
def log_exception_quietly():
185
168
    interesting to developers but not to users.  For example, 
186
169
    errors loading plugins.
187
170
    """
 
171
    import traceback
188
172
    debug(traceback.format_exc())
189
173
 
190
174
 
191
175
def enable_default_logging():
192
176
    """Configure default logging to stderr and .bzr.log"""
193
 
    global _stderr_handler, _file_handler
194
 
 
 
177
    # FIXME: if this is run twice, things get confused
 
178
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
195
179
    _stderr_handler = logging.StreamHandler()
196
180
    _stderr_handler.setFormatter(QuietFormatter())
197
 
 
 
181
    logging.getLogger('').addHandler(_stderr_handler)
 
182
    _stderr_handler.setLevel(logging.INFO)
198
183
    if not _file_handler:
199
184
        open_tracefile()
200
 
 
201
 
    if os.environ.get('BZR_DEBUG'):
202
 
        level = logging.DEBUG
 
185
    _trace_file = _bzr_log_file
 
186
    if _file_handler:
 
187
        _file_handler.setLevel(logging.DEBUG)
 
188
    _bzr_logger.setLevel(logging.DEBUG) 
 
189
 
 
190
 
 
191
 
 
192
def be_quiet(quiet=True):
 
193
    global _stderr_handler, _stderr_quiet
 
194
    
 
195
    _stderr_quiet = quiet
 
196
    if quiet:
 
197
        _stderr_handler.setLevel(logging.WARNING)
203
198
    else:
204
 
        level = logging.INFO
205
 
 
206
 
    _stderr_handler.setLevel(logging.INFO)
207
 
    _file_handler.setLevel(level)
208
 
 
209
 
    logging.getLogger('').addHandler(_stderr_handler)
 
199
        _stderr_handler.setLevel(logging.INFO)
 
200
 
 
201
 
 
202
def is_quiet():
 
203
    global _stderr_quiet
 
204
    return _stderr_quiet
210
205
 
211
206
 
212
207
def disable_default_logging():
220
215
    l.removeHandler(_stderr_handler)
221
216
    if _file_handler:
222
217
        l.removeHandler(_file_handler)
 
218
    _trace_file = None
 
219
 
 
220
 
 
221
def enable_test_log(to_file):
 
222
    """Redirect logging to a temporary file for a test
 
223
    
 
224
    returns an opaque reference that should be passed to disable_test_log
 
225
    after the test complete.
 
226
    """
 
227
    disable_default_logging()
 
228
    global _trace_file
 
229
    hdlr = logging.StreamHandler(to_file)
 
230
    hdlr.setLevel(logging.DEBUG)
 
231
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
232
    _bzr_logger.addHandler(hdlr)
 
233
    _bzr_logger.setLevel(logging.DEBUG)
 
234
    result = hdlr, _trace_file
 
235
    _trace_file = to_file
 
236
    return result
 
237
 
 
238
 
 
239
def disable_test_log((test_log_hdlr, old_trace_file)):
 
240
    _bzr_logger.removeHandler(test_log_hdlr)
 
241
    _trace_file = old_trace_file
 
242
    enable_default_logging()
 
243
 
 
244
 
 
245
def format_exception_short(exc_info):
 
246
    """Make a short string form of an exception.
 
247
 
 
248
    This is used for display to stderr.  It specially handles exception
 
249
    classes without useful string methods.
 
250
 
 
251
    The result has no trailing newline.
 
252
 
 
253
    exc_info - typically an exception from sys.exc_info()
 
254
    """
 
255
    exc_type, exc_object, exc_tb = exc_info
 
256
    try:
 
257
        if exc_type is None:
 
258
            return '(no exception)'
 
259
        if isinstance(exc_object, (BzrError, BzrNewError)):
 
260
            return str(exc_object)
 
261
        else:
 
262
            import traceback
 
263
            tb = traceback.extract_tb(exc_tb)
 
264
            msg = '%s: %s' % (exc_type, exc_object)
 
265
            if msg[-1] == '\n':
 
266
                msg = msg[:-1]
 
267
            if tb:
 
268
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
 
269
            return msg
 
270
    except Exception, formatting_exc:
 
271
        # XXX: is this really better than just letting it run up?
 
272
        return '(error formatting exception of type %s: %s)' \
 
273
                % (exc_type, formatting_exc)