/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
1185.43.10 by Martin Pool
Remove need for BZR_DEBUG to get debug info in trace file.
1
# Copyright (C) 2005, Canonical Ltd
1 by mbp at sourcefrog
import from baz patch-364
2
1185.33.6 by Martin Pool
Code and tests for shorter formatting of error messages
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.
1185.33.51 by Martin Pool
Fix trace of non-ascii messages, and add test.
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.
1185.33.6 by Martin Pool
Code and tests for shorter formatting of error messages
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.
344 by Martin Pool
- It's not an error to use the library without
33
"""
34
1097 by Martin Pool
- send trace messages out through python logging module
35
# TODO: in debug mode, stderr should get full tracebacks and also
36
# debug messages.  (Is this really needed?)
37
1185.16.74 by Martin Pool
doc
38
# FIXME: Unfortunately it turns out that python's logging module
39
# is quite expensive, even when the message is not printed by any handlers.
40
# We should perhaps change back to just simply doing it here.
41
1097 by Martin Pool
- send trace messages out through python logging module
42
43
import sys
44
import os
45
import logging
46
1185.33.8 by Martin Pool
Cleanup exception formatting stuff
47
import bzrlib
1185.33.7 by Martin Pool
Better formatting of builtin errors
48
from bzrlib.errors import BzrNewError
49
1097 by Martin Pool
- send trace messages out through python logging module
50
1101 by Martin Pool
- add global definition to quieten pychecker
51
_file_handler = None
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
52
_stderr_handler = None
1185.33.42 by Martin Pool
[patch] make --quiet a global option (robey)
53
_stderr_quiet = False
1185.43.7 by Martin Pool
Do debug messages not through python logging
54
_trace_file = None
55
_bzr_log_file = None
56
1097 by Martin Pool
- send trace messages out through python logging module
57
class QuietFormatter(logging.Formatter):
58
    """Formatter that supresses the details of errors.
59
60
    This is used by default on stderr so as not to scare the user.
61
    """
62
    # At first I tried overriding formatException to suppress the
63
    # exception details, but that has global effect: no loggers
64
    # can get the exception details is we suppress them here.
65
66
    def format(self, record):
67
        if record.levelno >= logging.WARNING:
1393.1.57 by Martin Pool
- no 'bzr' prefix on info messages
68
            s = 'bzr: ' + record.levelname + ': '
69
        else:
70
            s = ''
1289 by Martin Pool
- wrap wide strings when showing exceptions
71
        s += record.getMessage()
1097 by Martin Pool
- send trace messages out through python logging module
72
        if record.exc_info:
1185.33.8 by Martin Pool
Cleanup exception formatting stuff
73
            s += '\n' + format_exception_short(record.exc_info)
1097 by Martin Pool
- send trace messages out through python logging module
74
        return s
75
        
76
# configure convenient aliases for output routines
77
78
_bzr_logger = logging.getLogger('bzr')
79
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
80
info = note = _bzr_logger.info
1097 by Martin Pool
- send trace messages out through python logging module
81
warning =   _bzr_logger.warning
82
log_error = _bzr_logger.error
83
error =     _bzr_logger.error
1185.43.7 by Martin Pool
Do debug messages not through python logging
84
85
86
def mutter(fmt, *args):
1185.43.10 by Martin Pool
Remove need for BZR_DEBUG to get debug info in trace file.
87
    if _trace_file is None:
88
        return
89
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
90
        return
91
    if len(args) > 0:
1185.33.51 by Martin Pool
Fix trace of non-ascii messages, and add test.
92
        out = fmt % args
1185.43.10 by Martin Pool
Remove need for BZR_DEBUG to get debug info in trace file.
93
    else:
1185.33.51 by Martin Pool
Fix trace of non-ascii messages, and add test.
94
        out = fmt
95
    out += '\n'
96
    if isinstance(out, unicode):
97
        out = out.encode('utf-8')
98
    _trace_file.write(out)
1185.43.7 by Martin Pool
Do debug messages not through python logging
99
debug = mutter
1097 by Martin Pool
- send trace messages out through python logging module
100
1185.43.10 by Martin Pool
Remove need for BZR_DEBUG to get debug info in trace file.
101
261 by Martin Pool
- auto-rollover of .bzr.log
102
def _rollover_trace_maybe(trace_fname):
359 by Martin Pool
- pychecker fixups
103
    import stat
261 by Martin Pool
- auto-rollover of .bzr.log
104
    try:
105
        size = os.stat(trace_fname)[stat.ST_SIZE]
333 by Martin Pool
- allow trace file to grow up to 4MB
106
        if size <= 4 << 20:
261 by Martin Pool
- auto-rollover of .bzr.log
107
            return
108
        old_fname = trace_fname + '.old'
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
109
        from osutils import rename
110
        rename(trace_fname, old_fname)
261 by Martin Pool
- auto-rollover of .bzr.log
111
    except OSError:
112
        return
113
114
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
115
def open_tracefile(tracefilename='~/.bzr.log'):
59 by mbp at sourcefrog
lift out tracefile creation code
116
    # Messages are always written to here, so that we have some
117
    # information if something goes wrong.  In a future version this
118
    # file will be removed on successful completion.
1185.43.7 by Martin Pool
Do debug messages not through python logging
119
    global _file_handler, _bzr_log_file
359 by Martin Pool
- pychecker fixups
120
    import stat, codecs
59 by mbp at sourcefrog
lift out tracefile creation code
121
397 by Martin Pool
- open_tracefile takes a tracefilename parameter
122
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
261 by Martin Pool
- auto-rollover of .bzr.log
123
    _rollover_trace_maybe(trace_fname)
403 by Martin Pool
- Don't give an error if the trace file can't be opened
124
    try:
1185.33.11 by Martin Pool
Code format cleanups
125
        LINE_BUFFERED = 1
126
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
1185.43.7 by Martin Pool
Do debug messages not through python logging
127
        _bzr_log_file = tf
1185.43.10 by Martin Pool
Remove need for BZR_DEBUG to get debug info in trace file.
128
        if tf.tell() == 0:
1100 by Martin Pool
- fix name error reported by Andrew Bennetts
129
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
130
            tf.write("you can delete or truncate this file, or include sections in\n")
131
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
1097 by Martin Pool
- send trace messages out through python logging module
132
        _file_handler = logging.StreamHandler(tf)
133
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
134
        datefmt = r'%a %H:%M:%S'
135
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
136
        _file_handler.setLevel(logging.DEBUG)
137
        logging.getLogger('').addHandler(_file_handler)
403 by Martin Pool
- Don't give an error if the trace file can't be opened
138
    except IOError, e:
139
        warning("failed to open trace file: %s" % (e))
260 by Martin Pool
- remove atexit() dependency for writing out execution times
140
1097 by Martin Pool
- send trace messages out through python logging module
141
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
142
def log_startup(argv):
1185.43.7 by Martin Pool
Do debug messages not through python logging
143
    debug('\n\nbzr %s invoked on python %s (%s)',
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
144
          bzrlib.__version__,
145
          '.'.join(map(str, sys.version_info)),
146
          sys.platform)
147
    debug('  arguments: %r', argv)
1185.16.73 by Martin Pool
- in error messages, show cwd as repr in case it's in unicode
148
    debug('  working dir: %r', os.getcwdu())
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
149
1097 by Martin Pool
- send trace messages out through python logging module
150
151
def log_exception(msg=None):
1185.16.82 by mbp at sourcefrog
- give a quieter warning if a plugin can't be loaded
152
    """Log the last exception to stderr and the trace file.
1097 by Martin Pool
- send trace messages out through python logging module
153
154
    The exception string representation is used as the error
155
    summary, unless msg is given.
156
    """
1185.33.8 by Martin Pool
Cleanup exception formatting stuff
157
    if msg:
1185.43.9 by Martin Pool
Make logging of errors go through our trace functions
158
        error(msg)
159
    else:
160
        exc_str = format_exception_short(sys.exc_info())
161
        error(exc_str)
162
    log_exception_quietly()
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
163
164
1185.16.82 by mbp at sourcefrog
- give a quieter warning if a plugin can't be loaded
165
def log_exception_quietly():
166
    """Log the last exception to the trace file only.
167
168
    Used for exceptions that occur internally and that may be 
169
    interesting to developers but not to users.  For example, 
170
    errors loading plugins.
171
    """
1185.33.11 by Martin Pool
Code format cleanups
172
    import traceback
1185.16.82 by mbp at sourcefrog
- give a quieter warning if a plugin can't be loaded
173
    debug(traceback.format_exc())
174
175
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
176
def enable_default_logging():
177
    """Configure default logging to stderr and .bzr.log"""
1185.43.9 by Martin Pool
Make logging of errors go through our trace functions
178
    # FIXME: if this is run twice, things get confused
1185.43.7 by Martin Pool
Do debug messages not through python logging
179
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
180
    _stderr_handler = logging.StreamHandler()
1359 by Martin Pool
- merge in new BZR_NOISY vs BZR_DEBUG stuff from main
181
    _stderr_handler.setFormatter(QuietFormatter())
1185.34.2 by Jelmer Vernooij
Don't quite when tracefile can't be opened. Display warning
182
    logging.getLogger('').addHandler(_stderr_handler)
1359 by Martin Pool
- merge in new BZR_NOISY vs BZR_DEBUG stuff from main
183
    _stderr_handler.setLevel(logging.INFO)
1185.34.2 by Jelmer Vernooij
Don't quite when tracefile can't be opened. Display warning
184
    if not _file_handler:
185
        open_tracefile()
1185.43.7 by Martin Pool
Do debug messages not through python logging
186
    _trace_file = _bzr_log_file
1185.34.2 by Jelmer Vernooij
Don't quite when tracefile can't be opened. Display warning
187
    if _file_handler:
1185.43.10 by Martin Pool
Remove need for BZR_DEBUG to get debug info in trace file.
188
        _file_handler.setLevel(logging.DEBUG)
189
    _bzr_logger.setLevel(logging.DEBUG) 
190
1359 by Martin Pool
- merge in new BZR_NOISY vs BZR_DEBUG stuff from main
191
1185.33.42 by Martin Pool
[patch] make --quiet a global option (robey)
192
193
def be_quiet(quiet=True):
194
    global _stderr_handler, _stderr_quiet
195
    
196
    _stderr_quiet = quiet
197
    if quiet:
198
        _stderr_handler.setLevel(logging.WARNING)
199
    else:
200
        _stderr_handler.setLevel(logging.INFO)
201
202
203
def is_quiet():
204
    global _stderr_quiet
205
    return _stderr_quiet
206
207
1111 by Martin Pool
- add functions to enable and disable default logging, so that we can
208
def disable_default_logging():
209
    """Turn off default log handlers.
210
211
    This is intended to be used by the test framework, which doesn't
212
    want leakage from the code-under-test into the main logs.
213
    """
1112 by Martin Pool
- disable standard logging to .bzr.log and stderr while running
214
215
    l = logging.getLogger('')
216
    l.removeHandler(_stderr_handler)
217
    if _file_handler:
218
        l.removeHandler(_file_handler)
1185.43.7 by Martin Pool
Do debug messages not through python logging
219
    _trace_file = None
1185.33.6 by Martin Pool
Code and tests for shorter formatting of error messages
220
221
1185.33.13 by Martin Pool
Hide more stuff in bzrlib.trace
222
def enable_test_log(to_file):
223
    """Redirect logging to a temporary file for a test"""
224
    disable_default_logging()
1185.43.7 by Martin Pool
Do debug messages not through python logging
225
    global _test_log_hdlr, _trace_file
1185.33.13 by Martin Pool
Hide more stuff in bzrlib.trace
226
    hdlr = logging.StreamHandler(to_file)
227
    hdlr.setLevel(logging.DEBUG)
228
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
1185.43.1 by Martin Pool
Remove direct logging calls from selftest
229
    _bzr_logger.addHandler(hdlr)
230
    _bzr_logger.setLevel(logging.DEBUG)
1185.33.13 by Martin Pool
Hide more stuff in bzrlib.trace
231
    _test_log_hdlr = hdlr
1185.43.7 by Martin Pool
Do debug messages not through python logging
232
    _trace_file = to_file
1185.33.13 by Martin Pool
Hide more stuff in bzrlib.trace
233
234
235
def disable_test_log():
1185.43.1 by Martin Pool
Remove direct logging calls from selftest
236
    _bzr_logger.removeHandler(_test_log_hdlr)
1185.43.7 by Martin Pool
Do debug messages not through python logging
237
    _trace_file = None
1185.33.13 by Martin Pool
Hide more stuff in bzrlib.trace
238
    enable_default_logging()
239
240
1185.33.8 by Martin Pool
Cleanup exception formatting stuff
241
def format_exception_short(exc_info):
1185.33.6 by Martin Pool
Code and tests for shorter formatting of error messages
242
    """Make a short string form of an exception.
243
244
    This is used for display to stderr.  It specially handles exception
245
    classes without useful string methods.
1185.33.7 by Martin Pool
Better formatting of builtin errors
246
247
    The result has no trailing newline.
1185.33.8 by Martin Pool
Cleanup exception formatting stuff
248
249
    exc_info - typically an exception from sys.exc_info()
1185.33.6 by Martin Pool
Code and tests for shorter formatting of error messages
250
    """
1185.33.8 by Martin Pool
Cleanup exception formatting stuff
251
    exc_type, exc_object, exc_tb = exc_info
1185.33.17 by Martin Pool
[merge] aaron, various fixes
252
    try:
253
        if exc_type is None:
254
            return '(no exception)'
255
        if isinstance(exc_object, BzrNewError):
256
            return str(exc_object)
257
        else:
258
            import traceback
259
            tb = traceback.extract_tb(exc_tb)
260
            msg = '%s: %s' % (exc_type, exc_object)
261
            if msg[-1] == '\n':
262
                msg = msg[:-1]
263
            if tb:
264
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
265
            return msg
266
    except:
267
        return '(error formatting exception of type %s)' % exc_type