← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Martin Pool
  • Date: 2005-08-25 05:58:05 UTC
  • mfrom: (974.1.36)
  • Revision ID: mbp@sourcefrog.net-20050825055805-8c892bc3c2d75131
- merge aaron's merge improvements:

  * When merging, pull in all missing revisions from the source
    branch. 

  * Detect common ancestors by looking at the whole ancestry graph, 
    rather than just mainline history.

  Some changes to reconcile this with parallel updates to the test and
  trace code.

aaron.bentley@utoronto.ca-20050823052551-f3401a8b57d9126f

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
1
# This program is free software; you can redistribute it and/or modify
5
2
# it under the terms of the GNU General Public License as published by
6
3
# the Free Software Foundation; either version 2 of the License, or
16
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
14
 
18
15
 
19
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
 
__author__ = "Martin Pool <mbp@canonical.com>"
 
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.
 
27
"""
 
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.
21
35
 
22
36
 
23
37
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()
 
38
import os
 
39
import logging
 
40
import traceback
 
41
 
 
42
 
 
43
_file_handler = None
 
44
 
 
45
 
 
46
class QuietFormatter(logging.Formatter):
 
47
    """Formatter that supresses the details of errors.
 
48
 
 
49
    This is used by default on stderr so as not to scare the user.
 
50
    """
 
51
    # At first I tried overriding formatException to suppress the
 
52
    # exception details, but that has global effect: no loggers
 
53
    # can get the exception details is we suppress them here.
 
54
 
 
55
    def format(self, record):
 
56
        s = 'bzr: '
 
57
        if record.levelno >= logging.WARNING:
 
58
            s += record.levelname + ': '
 
59
            
 
60
        s += record.getMessage() 
 
61
            
 
62
        if record.exc_info:
 
63
            # give just a summary of the exception, not the whole thing
 
64
            exinfo = traceback.extract_tb(record.exc_info[2])
 
65
            # the format of this string matches one of the REs
 
66
            s += '\n'
 
67
            s += ('  at %s line %d, in %s()\n' % exinfo[-1][:3])
 
68
            s += '  see ~/.bzr.log for debug information'
 
69
 
 
70
        return s
 
71
        
 
72
################
 
73
# configure default handler to stderr
 
74
 
 
75
_stderr_handler = logging.StreamHandler()
 
76
_stderr_handler.setFormatter(QuietFormatter())
 
77
 
 
78
if os.environ.get('BZR_DEBUG'):
 
79
    _stderr_handler.setLevel(logging.DEBUG)
 
80
else:
 
81
    _stderr_handler.setLevel(logging.INFO)
 
82
 
 
83
logging.getLogger('').addHandler(_stderr_handler)
 
84
 
 
85
 
 
86
 
 
87
################
 
88
# configure convenient aliases for output routines
 
89
 
 
90
_bzr_logger = logging.getLogger('bzr')
 
91
_bzr_logger.setLevel(logging.DEBUG) 
 
92
 
 
93
note =      _bzr_logger.info
 
94
warning =   _bzr_logger.warning
 
95
log_error = _bzr_logger.error
 
96
error =     _bzr_logger.error
 
97
mutter =    _bzr_logger.debug
 
98
debug =     _bzr_logger.debug
 
99
 
 
100
 
 
101
 
 
102
 
 
103
# we do the rollover using this code, rather than the default from python
 
104
# logging, because we only want to rollover at program startup, not on each
 
105
# message.  maybe that's not a good enough reason.
 
106
 
 
107
def _rollover_trace_maybe(trace_fname):
 
108
    import stat
 
109
    try:
 
110
        size = os.stat(trace_fname)[stat.ST_SIZE]
 
111
        if size <= 4 << 20:
 
112
            return
 
113
        old_fname = trace_fname + '.old'
 
114
 
 
115
        try:
 
116
            # must remove before rename on windows
 
117
            os.remove(old_fname)
 
118
        except OSError:
 
119
            pass
 
120
 
 
121
        try:
 
122
            # might fail if in use on windows
 
123
            os.rename(trace_fname, old_fname)
 
124
        except OSError:
 
125
            pass
 
126
    except OSError:
 
127
        return
 
128
 
 
129
 
 
130
 
 
131
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
 
132
    # Messages are always written to here, so that we have some
 
133
    # information if something goes wrong.  In a future version this
 
134
    # file will be removed on successful completion.
 
135
    global _file_handler
 
136
    import stat, codecs
 
137
 
 
138
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
 
139
    _rollover_trace_maybe(trace_fname)
 
140
 
 
141
    # buffering=1 means line buffered
 
142
    try:
 
143
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
 
144
 
 
145
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
 
146
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
147
            tf.write("you can delete or truncate this file, or include sections in\n")
 
148
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
149
        
 
150
        _file_handler = logging.StreamHandler(tf)
 
151
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
152
        datefmt = r'%a %H:%M:%S'
 
153
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
154
        _file_handler.setLevel(logging.DEBUG)
 
155
        logging.getLogger('').addHandler(_file_handler)
 
156
 
 
157
        import bzrlib
 
158
        
 
159
        debug('bzr %s invoked on python %s (%s)'
 
160
              % (bzrlib.__version__,
 
161
                 '.'.join(map(str, sys.version_info)),
 
162
                 sys.platform))
 
163
 
 
164
        debug('  arguments: %r' % argv)
 
165
        debug('  working dir: ' + os.getcwdu())
 
166
    except IOError, e:
 
167
        warning("failed to open trace file: %s" % (e))
 
168
 
 
169
 
 
170
 
 
171
def log_exception(msg=None):
 
172
    """Log the last exception into the trace file.
 
173
 
 
174
    The exception string representation is used as the error
 
175
    summary, unless msg is given.
 
176
    """
 
177
    if msg == None:
 
178
        ei = sys.exc_info()
 
179
        msg = str(ei[1])
 
180
 
 
181
    if msg[-1] == '\n':
 
182
        msg = msg[:-1]
 
183
        
 
184
    _bzr_logger.exception(msg)