/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

Fix formatting, remove catch-all for exceptions when opening local repositories.

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.
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.
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
 
        s = 'bzr: '
58
 
        if record.levelno >= logging.WARNING:
59
 
            s += record.levelname + ': '
60
 
            
61
 
        s += record.getMessage()
62
 
 
63
 
        ##import textwrap
64
 
        ##s = textwrap.fill(s)
65
 
            
66
 
        if record.exc_info:
67
 
            # give just a summary of the exception, not the whole thing
68
 
            exinfo = traceback.extract_tb(record.exc_info[2])
69
 
            # the format of this string matches one of the REs
70
 
            s += '\n'
71
 
            s += ('  at %s line %d, in %s()\n' % exinfo[-1][:3])
72
 
            s += '  see ~/.bzr.log for debug information'
73
 
 
74
 
        return s
75
 
        
76
 
 
77
 
 
78
 
 
79
 
################
80
 
# configure convenient aliases for output routines
81
 
 
82
 
_bzr_logger = logging.getLogger('bzr')
83
 
_bzr_logger.setLevel(logging.DEBUG) 
84
 
 
85
 
info = note = _bzr_logger.info
86
 
warning =   _bzr_logger.warning
87
 
log_error = _bzr_logger.error
88
 
error =     _bzr_logger.error
89
 
mutter =    _bzr_logger.debug
90
 
debug =     _bzr_logger.debug
91
 
 
92
 
 
93
 
 
94
 
 
95
 
# we do the rollover using this code, rather than the default from python
96
 
# logging, because we only want to rollover at program startup, not on each
97
 
# message.  maybe that's not a good enough reason.
98
 
 
99
 
def _rollover_trace_maybe(trace_fname):
100
 
    import stat
101
 
    try:
102
 
        size = os.stat(trace_fname)[stat.ST_SIZE]
103
 
        if size <= 4 << 20:
104
 
            return
105
 
        old_fname = trace_fname + '.old'
106
 
 
107
 
        try:
108
 
            # must remove before rename on windows
109
 
            os.remove(old_fname)
110
 
        except OSError:
111
 
            pass
112
 
 
113
 
        try:
114
 
            # might fail if in use on windows
115
 
            os.rename(trace_fname, old_fname)
116
 
        except OSError:
117
 
            pass
118
 
    except OSError:
119
 
        return
120
 
 
121
 
 
122
 
 
123
 
def open_tracefile(tracefilename='~/.bzr.log'):
124
 
    # Messages are always written to here, so that we have some
125
 
    # information if something goes wrong.  In a future version this
126
 
    # file will be removed on successful completion.
127
 
    global _file_handler
128
 
    import stat, codecs
129
 
 
130
 
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
131
 
    _rollover_trace_maybe(trace_fname)
132
 
 
133
 
    # buffering=1 means line buffered
134
 
    try:
135
 
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
136
 
 
137
 
        if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
138
 
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
139
 
            tf.write("you can delete or truncate this file, or include sections in\n")
140
 
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
141
 
        
142
 
        _file_handler = logging.StreamHandler(tf)
143
 
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
144
 
        datefmt = r'%a %H:%M:%S'
145
 
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
146
 
        _file_handler.setLevel(logging.DEBUG)
147
 
        logging.getLogger('').addHandler(_file_handler)
148
 
 
149
 
    except IOError, e:
150
 
        warning("failed to open trace file: %s" % (e))
151
 
 
152
 
 
153
 
def log_startup(argv):
154
 
    import bzrlib
155
 
 
156
 
    debug('bzr %s invoked on python %s (%s)',
157
 
          bzrlib.__version__,
158
 
          '.'.join(map(str, sys.version_info)),
159
 
          sys.platform)
160
 
 
161
 
    debug('  arguments: %r', argv)
162
 
    debug('  working dir: %s', os.getcwdu())
163
 
 
164
 
 
165
 
def log_exception(msg=None):
166
 
    """Log the last exception into the trace file.
167
 
 
168
 
    The exception string representation is used as the error
169
 
    summary, unless msg is given.
170
 
    """
171
 
    if msg == None:
172
 
        ei = sys.exc_info()
173
 
        msg = str(ei[1])
174
 
 
175
 
    if msg and (msg[-1] == '\n'):
176
 
        msg = msg[:-1]
177
 
        
178
 
    _bzr_logger.exception(msg)
179
 
 
180
 
 
181
 
 
182
 
def enable_default_logging():
183
 
    """Configure default logging to stderr and .bzr.log"""
184
 
    global _stderr_handler, _file_handler
185
 
 
186
 
    _stderr_handler = logging.StreamHandler()
187
 
    _stderr_handler.setFormatter(QuietFormatter())
188
 
 
189
 
    if not _file_handler:
190
 
        open_tracefile()
191
 
 
192
 
    if os.environ.get('BZR_DEBUG'):
193
 
        level = logging.DEBUG
194
 
    else:
195
 
        level = logging.INFO
196
 
 
197
 
    _stderr_handler.setLevel(logging.INFO)
198
 
    _file_handler.setLevel(level)
199
 
 
200
 
    logging.getLogger('').addHandler(_stderr_handler)
201
 
 
202
 
 
203
 
 
204
 
def disable_default_logging():
205
 
    """Turn off default log handlers.
206
 
 
207
 
    This is intended to be used by the test framework, which doesn't
208
 
    want leakage from the code-under-test into the main logs.
209
 
    """
210
 
 
211
 
    l = logging.getLogger('')
212
 
    l.removeHandler(_stderr_handler)
213
 
    if _file_handler:
214
 
        l.removeHandler(_file_handler)