~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

- ignore .swp files from upload

Show diffs side-by-side

added added

removed removed

Lines of Context:
13
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
14
14
 
15
15
 
16
 
 
17
 
# TODO: Could probably replace this with something based on Python logging
18
 
# module.
19
 
 
20
 
 
21
 
 
22
 
 
23
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
24
 
__author__ = "Martin Pool <mbp@canonical.com>"
25
 
 
26
 
 
27
16
"""Messages and logging for bazaar-ng
28
17
 
29
 
Nothing is actually logged unless you call bzrlib.open_tracefile().
 
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.
30
27
"""
31
28
 
32
29
 
33
 
import sys, os
34
 
 
35
 
######################################################################
36
 
# messages and logging
37
 
 
38
 
global _tracefile, _starttime
39
 
_tracefile = None
40
 
 
41
 
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
42
 
_starttime = None
43
 
 
44
 
# If false, notes also go to stdout; should replace this with --silent
45
 
# at some point.
46
 
silent = False
47
 
 
48
 
 
49
 
# fix this if we ever fork within python
50
 
_mypid = os.getpid()
51
 
_logprefix = '[%d] ' % _mypid
52
 
 
53
 
 
54
 
def _write_trace(msg):
55
 
    if 0:
56
 
        if _tracefile:
57
 
            _tracefile.write(_logprefix + msg + '\n')
58
 
 
59
 
 
60
 
def warning(msg):
61
 
    sys.stderr.write('bzr: warning: ' + msg + '\n')
62
 
    _write_trace('warning: ' + msg)
63
 
 
64
 
 
65
 
mutter = _write_trace
66
 
 
67
 
 
68
 
def note(msg):
69
 
    b = '* ' + str(msg) + '\n'
70
 
    if not silent:
71
 
        sys.stderr.write(b)
72
 
    _write_trace('note: ' + msg)
73
 
 
74
 
 
75
 
def log_error(msg):
76
 
    sys.stderr.write(msg + '\n')
77
 
    _write_trace(msg)
78
 
 
 
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
 
 
36
 
 
37
import sys
 
38
import os
 
39
import logging
 
40
import traceback
 
41
 
 
42
 
 
43
_file_handler = None
 
44
_stderr_handler = None
 
45
 
 
46
 
 
47
class QuietFormatter(logging.Formatter):
 
48
    """Formatter that supresses the details of errors.
 
49
 
 
50
    This is used by default on stderr so as not to scare the user.
 
51
    """
 
52
    # At first I tried overriding formatException to suppress the
 
53
    # exception details, but that has global effect: no loggers
 
54
    # can get the exception details is we suppress them here.
 
55
 
 
56
    def format(self, record):
 
57
        if record.levelno >= logging.WARNING:
 
58
            s = 'bzr: ' + record.levelname + ': '
 
59
        else:
 
60
            s = ''
 
61
            
 
62
        s += record.getMessage()
 
63
 
 
64
        ##import textwrap
 
65
        ##s = textwrap.fill(s)
 
66
            
 
67
        if record.exc_info:
 
68
            # give just a summary of the exception, not the whole thing
 
69
            exinfo = traceback.extract_tb(record.exc_info[2])
 
70
            # the format of this string matches one of the REs
 
71
            s += '\n'
 
72
            s += ('  at %s line %d, in %s()\n' % exinfo[-1][:3])
 
73
            s += '  see ~/.bzr.log for debug information'
 
74
 
 
75
        return s
 
76
        
 
77
 
 
78
 
 
79
 
 
80
################
 
81
# configure convenient aliases for output routines
 
82
 
 
83
_bzr_logger = logging.getLogger('bzr')
 
84
_bzr_logger.setLevel(logging.DEBUG) 
 
85
 
 
86
info = note = _bzr_logger.info
 
87
warning =   _bzr_logger.warning
 
88
log_error = _bzr_logger.error
 
89
error =     _bzr_logger.error
 
90
mutter =    _bzr_logger.debug
 
91
debug =     _bzr_logger.debug
 
92
 
 
93
 
 
94
 
 
95
 
 
96
# we do the rollover using this code, rather than the default from python
 
97
# logging, because we only want to rollover at program startup, not on each
 
98
# message.  maybe that's not a good enough reason.
79
99
 
80
100
def _rollover_trace_maybe(trace_fname):
81
101
    import stat
85
105
            return
86
106
        old_fname = trace_fname + '.old'
87
107
 
88
 
        try:
89
 
            # must remove before rename on windows
90
 
            os.remove(old_fname)
91
 
        except OSError:
92
 
            pass
 
108
        from osutils import rename
 
109
        rename(trace_fname, old_fname)
93
110
 
94
 
        try:
95
 
            # might fail if in use on windows
96
 
            os.rename(trace_fname, old_fname)
97
 
        except OSError:
98
 
            pass
99
111
    except OSError:
100
112
        return
101
113
 
102
114
 
103
115
 
104
 
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
 
116
def open_tracefile(tracefilename='~/.bzr.log'):
105
117
    # Messages are always written to here, so that we have some
106
118
    # information if something goes wrong.  In a future version this
107
119
    # file will be removed on successful completion.
108
 
    global _starttime, _tracefile
 
120
    global _file_handler
109
121
    import stat, codecs
110
122
 
111
 
    _starttime = os.times()[4]
112
 
 
113
123
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
114
124
    _rollover_trace_maybe(trace_fname)
115
125
 
116
126
    # buffering=1 means line buffered
117
127
    try:
118
 
        _tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
119
 
        t = _tracefile
120
 
 
121
 
        if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
122
 
            t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
123
 
            t.write("you can delete or truncate this file, or include sections in\n")
124
 
            t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
125
 
 
126
 
        import bzrlib
127
 
        _write_trace('bzr %s invoked on python %s (%s)'
128
 
                     % (bzrlib.__version__,
129
 
                        '.'.join(map(str, sys.version_info)),
130
 
                        sys.platform))
131
 
 
132
 
        _write_trace('  arguments: %r' % argv)
133
 
        _write_trace('  working dir: ' + os.getcwdu())
 
128
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
 
129
 
 
130
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
 
131
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
132
            tf.write("you can delete or truncate this file, or include sections in\n")
 
133
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
134
        
 
135
        _file_handler = logging.StreamHandler(tf)
 
136
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
137
        datefmt = r'%a %H:%M:%S'
 
138
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
139
        _file_handler.setLevel(logging.DEBUG)
 
140
        logging.getLogger('').addHandler(_file_handler)
 
141
 
134
142
    except IOError, e:
135
143
        warning("failed to open trace file: %s" % (e))
136
144
 
137
 
def close_trace():
138
 
    times = os.times()
139
 
    mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
140
 
           % (times[:4] + ((times[4] - _starttime),)))
141
 
 
142
 
 
143
 
 
144
 
def log_exception():
145
 
    """Log the last exception into the trace file."""
146
 
    import cgitb
147
 
    s = cgitb.text(sys.exc_info())
148
 
    for l in s.split('\n'):
149
 
        _write_trace(l)
150
 
        
151
 
    
 
145
 
 
146
def log_startup(argv):
 
147
    import bzrlib
 
148
 
 
149
    debug('bzr %s invoked on python %s (%s)',
 
150
          bzrlib.__version__,
 
151
          '.'.join(map(str, sys.version_info)),
 
152
          sys.platform)
 
153
 
 
154
    debug('  arguments: %r', argv)
 
155
    debug('  working dir: %s', os.getcwdu())
 
156
 
 
157
 
 
158
def log_exception(msg=None):
 
159
    """Log the last exception into the trace file.
 
160
 
 
161
    The exception string representation is used as the error
 
162
    summary, unless msg is given.
 
163
    """
 
164
    command = ' '.join(repr(arg) for arg in sys.argv)
 
165
    prefix = "command: %s\npwd: %s\n" % (command, os.getcwd())
 
166
    if msg == None:
 
167
        ei = sys.exc_info()
 
168
        msg = str(ei[1])
 
169
    if msg and (msg[-1] == '\n'):
 
170
        msg = msg[:-1]
 
171
    ## msg = "(%s) %s" % (str(type(ei[1])), msg)
 
172
    _bzr_logger.exception(prefix + msg)
 
173
 
 
174
 
 
175
 
 
176
def enable_default_logging():
 
177
    """Configure default logging to stderr and .bzr.log"""
 
178
    global _stderr_handler, _file_handler
 
179
 
 
180
    _stderr_handler = logging.StreamHandler()
 
181
    _stderr_handler.setFormatter(QuietFormatter())
 
182
 
 
183
    if not _file_handler:
 
184
        open_tracefile()
 
185
 
 
186
    if os.environ.get('BZR_DEBUG'):
 
187
        level = logging.DEBUG
 
188
    else:
 
189
        level = logging.INFO
 
190
 
 
191
    _stderr_handler.setLevel(logging.INFO)
 
192
    _file_handler.setLevel(level)
 
193
 
 
194
    logging.getLogger('').addHandler(_stderr_handler)
 
195
 
 
196
 
 
197
def disable_default_logging():
 
198
    """Turn off default log handlers.
 
199
 
 
200
    This is intended to be used by the test framework, which doesn't
 
201
    want leakage from the code-under-test into the main logs.
 
202
    """
 
203
 
 
204
    l = logging.getLogger('')
 
205
    l.removeHandler(_stderr_handler)
 
206
    if _file_handler:
 
207
        l.removeHandler(_file_handler)