← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Vincent Ladeuil
  • Date: 2007-11-04 15:24:27 UTC
  • mto: (2961.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 2962.
  • Revision ID: v.ladeuil+lp@free.fr-20071104152427-p9k7e4toywa87wfc
Review feedback.

* doc/en/user-guide/authentication_conf.txt: 
New file. Authentication configuration file documentation.

* doc/en/user-guide/configuration.txt: 
Slight modifications, add authentication.conf reference.

* doc/en/mini-tutorial/index.txt: 
Fix make docs warning.

* doc/developers/authentication-ring.txt: 
Small cleanups noticed during
doc/en/user-guide/authentication_conf.txt redaction.

* bzrlib/transport/http/_urllib.py:
(HttpTransport_urllib._perform): Use a dict() instead of {} syntax.

* bzrlib/tests/blackbox/test_whoami.py:
(TestWhoami.test_whoami_branch): Delete BZREMAIL related tests.

* bzrlib/config.py:
(Config.username): BZREMAIL deleted, has been obsolete for more
than a year.
(AuthenticationConfig.__init__): Review feedback, since keeping a
callback as an attribute is useless, call it now and keep the
filename itself as an attribute.
(AuthenticationConfig.get_credentials): Use a dict() instead of {}
syntax.

* NEWS: 
Updated as per Martin's suggestion.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
49
49
# FIXME: Unfortunately it turns out that python's logging module
50
50
# is quite expensive, even when the message is not printed by any handlers.
51
51
# We should perhaps change back to just simply doing it here.
52
 
#
53
 
# On the other hand, as of 1.2 we generally only call the mutter() statement
54
 
# if (according to debug_flags) we actually intend to write it.  So the
55
 
# increased cost of logging.py is not so bad, and we could standardize on
56
 
# that.
57
52
 
58
 
import codecs
59
 
import logging
60
53
import os
61
54
import sys
62
55
import re
63
 
import time
64
56
 
65
57
from bzrlib.lazy_import import lazy_import
66
58
lazy_import(globals(), """
67
59
from cStringIO import StringIO
68
60
import errno
69
61
import locale
 
62
import logging
70
63
import traceback
71
64
""")
72
65
 
78
71
    errors,
79
72
    osutils,
80
73
    plugin,
81
 
    symbol_versioning,
82
74
    )
83
75
""")
84
76
 
85
 
 
86
 
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
87
 
# is quiet; >0 is verbose.
 
77
_file_handler = None
 
78
_stderr_handler = None
88
79
_verbosity_level = 0
89
 
 
90
 
# File-like object where mutter/debug output is currently sent.  Can be
91
 
# changed by _push_log_file etc.  This is directly manipulated by some
92
 
# external code; maybe there should be functions to do that more precisely
93
 
# than push/pop_log_file.
94
80
_trace_file = None
95
 
 
96
 
# Absolute path for ~/.bzr.log.  Not changed even if the log/trace output is
97
 
# redirected elsewhere.  Used to show the location in --version.
 
81
_trace_depth = 0
 
82
_bzr_log_file = None
98
83
_bzr_log_filename = None
99
84
 
100
 
# The time the first message was written to the trace file, so that we can
101
 
# show relative times since startup.
102
 
_bzr_log_start_time = bzrlib._start_time
103
 
 
104
 
 
105
 
# held in a global for quick reference
 
85
 
 
86
# configure convenient aliases for output routines
 
87
 
106
88
_bzr_logger = logging.getLogger('bzr')
107
89
 
108
 
 
109
90
def note(*args, **kwargs):
110
91
    # FIXME note always emits utf-8, regardless of the terminal encoding
111
 
    #
112
 
    # FIXME: clearing the ui and then going through the abstract logging
113
 
    # framework is whack; we should probably have a logging Handler that
114
 
    # deals with terminal output if needed.
115
92
    import bzrlib.ui
116
93
    bzrlib.ui.ui_factory.clear_term()
117
94
    _bzr_logger.info(*args, **kwargs)
118
95
 
119
 
 
120
96
def warning(*args, **kwargs):
121
97
    import bzrlib.ui
122
98
    bzrlib.ui.ui_factory.clear_term()
123
99
    _bzr_logger.warning(*args, **kwargs)
124
100
 
125
 
 
126
 
# configure convenient aliases for output routines
127
 
#
128
 
# TODO: deprecate them, have one name for each.
129
101
info = note
130
102
log_error = _bzr_logger.error
131
103
error =     _bzr_logger.error
152
124
        out = fmt % tuple(real_args)
153
125
    else:
154
126
        out = fmt
155
 
    timestamp = '%0.3f  ' % (time.time() - _bzr_log_start_time,)
156
 
    out = timestamp + out + '\n'
 
127
    out += '\n'
157
128
    _trace_file.write(out)
158
 
    # no need to flush here, the trace file is now linebuffered when it's
159
 
    # opened.
 
129
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
130
    #_trace_file.flush()
160
131
 
161
132
 
162
133
def mutter_callsite(stacklevel, fmt, *args):
168
139
    :param args: A list of substitution variables.
169
140
    """
170
141
    outf = StringIO()
171
 
    if stacklevel is None:
172
 
        limit = None
173
 
    else:
174
 
        limit = stacklevel + 1
175
 
    traceback.print_stack(limit=limit, file=outf)
 
142
    traceback.print_stack(limit=stacklevel + 1, file=outf)
176
143
    formatted_lines = outf.getvalue().splitlines()
177
144
    formatted_stack = '\n'.join(formatted_lines[:-2])
178
145
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
190
157
        return
191
158
 
192
159
 
193
 
def _get_bzr_log_filename():
194
 
    bzr_log = os.environ.get('BZR_LOG')
195
 
    if bzr_log:
196
 
        return bzr_log
197
 
    home = os.environ.get('BZR_HOME')
198
 
    if home is None:
 
160
def open_tracefile(tracefilename=None):
 
161
    # Messages are always written to here, so that we have some
 
162
    # information if something goes wrong.  In a future version this
 
163
    # file will be removed on successful completion.
 
164
    global _file_handler, _bzr_log_file, _bzr_log_filename
 
165
    import codecs
 
166
 
 
167
    if tracefilename is None:
199
168
        if sys.platform == 'win32':
200
169
            from bzrlib import win32utils
201
170
            home = win32utils.get_home_location()
202
171
        else:
203
172
            home = os.path.expanduser('~')
204
 
    return os.path.join(home, '.bzr.log')
205
 
 
206
 
 
207
 
def _open_bzr_log():
208
 
    """Open the .bzr.log trace file.  
209
 
 
210
 
    If the log is more than a particular length, the old file is renamed to
211
 
    .bzr.log.old and a new file is started.  Otherwise, we append to the
212
 
    existing file.
213
 
 
214
 
    This sets the global _bzr_log_filename.
215
 
    """
216
 
    global _bzr_log_filename
217
 
    _bzr_log_filename = _get_bzr_log_filename()
 
173
        _bzr_log_filename = os.path.join(home, '.bzr.log')
 
174
    else:
 
175
        _bzr_log_filename = tracefilename
 
176
 
 
177
    _bzr_log_filename = os.path.expanduser(_bzr_log_filename)
218
178
    _rollover_trace_maybe(_bzr_log_filename)
219
179
    try:
220
 
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
221
 
        # bzr_log_file.tell() on windows always return 0 until some writing done
222
 
        bzr_log_file.write('\n')
223
 
        if bzr_log_file.tell() <= 2:
224
 
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
225
 
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
226
 
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
227
 
        return bzr_log_file
 
180
        LINE_BUFFERED = 1
 
181
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
182
        tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
 
183
        _bzr_log_file = tf
 
184
        # tf.tell() on windows always return 0 until some writing done
 
185
        tf.write('\n')
 
186
        if tf.tell() <= 2:
 
187
            tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
 
188
            tf.write("you can delete or truncate this file, or include sections in\n")
 
189
            tf.write("bug reports to bazaar@lists.canonical.com\n\n")
 
190
        _file_handler = logging.StreamHandler(tf)
 
191
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
192
        datefmt = r'%a %H:%M:%S'
 
193
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
194
        _file_handler.setLevel(logging.DEBUG)
 
195
        logging.getLogger('').addHandler(_file_handler)
228
196
    except IOError, e:
229
197
        warning("failed to open trace file: %s" % (e))
230
 
    # TODO: What should happen if we fail to open the trace file?  Maybe the
231
 
    # objects should be pointed at /dev/null or the equivalent?  Currently
232
 
    # returns None which will cause failures later.
233
 
 
234
 
 
235
 
def enable_default_logging():
236
 
    """Configure default logging: messages to stderr and debug to .bzr.log
237
 
    
238
 
    This should only be called once per process.
239
 
 
240
 
    Non-command-line programs embedding bzrlib do not need to call this.  They
241
 
    can instead either pass a file to _push_log_file, or act directly on
242
 
    logging.getLogger("bzr").
243
 
    
244
 
    Output can be redirected away by calling _push_log_file.
245
 
    """
246
 
    # create encoded wrapper around stderr
247
 
    bzr_log_file = _open_bzr_log()
248
 
    push_log_file(bzr_log_file,
249
 
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
250
 
        r'%Y-%m-%d %H:%M:%S')
251
 
    # after hooking output into bzr_log, we also need to attach a stderr
252
 
    # handler, writing only at level info and with encoding
253
 
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
254
 
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
255
 
    stderr_handler = logging.StreamHandler(encoded_stderr)
256
 
    stderr_handler.setLevel(logging.INFO)
257
 
    logging.getLogger('bzr').addHandler(stderr_handler)
258
 
 
259
 
 
260
 
def push_log_file(to_file, log_format=None, date_format=None):
261
 
    """Intercept log and trace messages and send them to a file.
262
 
 
263
 
    :param to_file: A file-like object to which messages will be sent.
264
 
 
265
 
    :returns: A memento that should be passed to _pop_log_file to restore the 
266
 
    previously active logging.
267
 
    """
268
 
    global _trace_file
269
 
    # make a new handler
270
 
    new_handler = logging.StreamHandler(to_file)
271
 
    new_handler.setLevel(logging.DEBUG)
272
 
    if log_format is None:
273
 
        log_format = '%(levelname)8s  %(message)s'
274
 
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
275
 
    # save and remove any existing log handlers
276
 
    bzr_logger = logging.getLogger('bzr')
277
 
    old_handlers = bzr_logger.handlers[:]
278
 
    del bzr_logger.handlers[:]
279
 
    # set that as the default logger
280
 
    bzr_logger.addHandler(new_handler)
281
 
    bzr_logger.setLevel(logging.DEBUG)
282
 
    # TODO: check if any changes are needed to the root logger
283
 
    #
284
 
    # TODO: also probably need to save and restore the level on bzr_logger.
285
 
    # but maybe we can avoid setting the logger level altogether, and just set
286
 
    # the level on the handler?
287
 
    #
288
 
    # save the old trace file
289
 
    old_trace_file = _trace_file
290
 
    # send traces to the new one
291
 
    _trace_file = to_file
292
 
    result = new_handler, _trace_file
293
 
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
294
 
 
295
 
 
296
 
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
297
 
    """Undo changes to logging/tracing done by _push_log_file.
298
 
 
299
 
    This flushes, but does not close the trace file.
300
 
    
301
 
    Takes the memento returned from _push_log_file."""
302
 
    global _trace_file
303
 
    _trace_file = old_trace_file
304
 
    bzr_logger = logging.getLogger('bzr')
305
 
    bzr_logger.removeHandler(new_handler)
306
 
    # must be closed, otherwise logging will try to close it atexit, and the
307
 
    # file will likely already be closed underneath.
308
 
    new_handler.close()
309
 
    bzr_logger.handlers = old_handlers
310
 
    new_trace_file.flush()
311
 
 
312
 
 
313
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
314
 
def enable_test_log(to_file):
315
 
    """Redirect logging to a temporary file for a test
316
 
    
317
 
    :returns: an opaque reference that should be passed to disable_test_log
318
 
    after the test completes.
319
 
    """
320
 
    return push_log_file(to_file)
321
 
 
322
 
 
323
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
324
 
def disable_test_log(memento):
325
 
    return pop_log_file(memento)
326
198
 
327
199
 
328
200
def log_exception_quietly():
332
204
    interesting to developers but not to users.  For example, 
333
205
    errors loading plugins.
334
206
    """
 
207
    import traceback
335
208
    mutter(traceback.format_exc())
336
209
 
337
210
 
 
211
def enable_default_logging():
 
212
    """Configure default logging to stderr and .bzr.log"""
 
213
    # FIXME: if this is run twice, things get confused
 
214
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
215
    _stderr_handler = logging.StreamHandler()
 
216
    logging.getLogger('').addHandler(_stderr_handler)
 
217
    _stderr_handler.setLevel(logging.INFO)
 
218
    if not _file_handler:
 
219
        open_tracefile()
 
220
    _trace_file = _bzr_log_file
 
221
    if _file_handler:
 
222
        _file_handler.setLevel(logging.DEBUG)
 
223
    _bzr_logger.setLevel(logging.DEBUG)
 
224
 
 
225
 
338
226
def set_verbosity_level(level):
339
227
    """Set the verbosity level.
340
228
 
364
252
def _update_logging_level(quiet=True):
365
253
    """Hide INFO messages if quiet."""
366
254
    if quiet:
367
 
        _bzr_logger.setLevel(logging.WARNING)
 
255
        _stderr_handler.setLevel(logging.WARNING)
368
256
    else:
369
 
        _bzr_logger.setLevel(logging.INFO)
 
257
        _stderr_handler.setLevel(logging.INFO)
370
258
 
371
259
 
372
260
def is_quiet():
379
267
    return _verbosity_level > 0
380
268
 
381
269
 
382
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
383
270
def disable_default_logging():
384
271
    """Turn off default log handlers.
385
272
 
386
 
    Don't call this method, use _push_log_file and _pop_log_file instead.
387
 
    """
388
 
    pass
 
273
    This is intended to be used by the test framework, which doesn't
 
274
    want leakage from the code-under-test into the main logs.
 
275
    """
 
276
 
 
277
    l = logging.getLogger('')
 
278
    l.removeHandler(_stderr_handler)
 
279
    if _file_handler:
 
280
        l.removeHandler(_file_handler)
 
281
    _trace_file = None
 
282
 
 
283
 
 
284
def enable_test_log(to_file):
 
285
    """Redirect logging to a temporary file for a test
 
286
    
 
287
    returns an opaque reference that should be passed to disable_test_log
 
288
    after the test completes.
 
289
    """
 
290
    disable_default_logging()
 
291
    global _trace_file
 
292
    global _trace_depth
 
293
    hdlr = logging.StreamHandler(to_file)
 
294
    hdlr.setLevel(logging.DEBUG)
 
295
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
296
    _bzr_logger.addHandler(hdlr)
 
297
    _bzr_logger.setLevel(logging.DEBUG)
 
298
    result = hdlr, _trace_file, _trace_depth
 
299
    _trace_file = to_file
 
300
    _trace_depth += 1
 
301
    return result
 
302
 
 
303
 
 
304
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
305
    _bzr_logger.removeHandler(test_log_hdlr)
 
306
    test_log_hdlr.close()
 
307
    global _trace_file
 
308
    global _trace_depth
 
309
    _trace_file = old_trace_file
 
310
    _trace_depth = old_trace_depth
 
311
    if not _trace_depth:
 
312
        enable_default_logging()
389
313
 
390
314
 
391
315
def report_exception(exc_info, err_file):
405
329
    elif isinstance(exc_object, KeyboardInterrupt):
406
330
        err_file.write("bzr: interrupted\n")
407
331
        return errors.EXIT_ERROR
408
 
    elif isinstance(exc_object, ImportError) \
409
 
        and str(exc_object).startswith("No module named "):
410
 
        report_user_error(exc_info, err_file,
411
 
            'You may need to install this Python library separately.')
412
 
        return errors.EXIT_ERROR
413
332
    elif not getattr(exc_object, 'internal_error', True):
414
333
        report_user_error(exc_info, err_file)
415
334
        return errors.EXIT_ERROR
423
342
        return errors.EXIT_INTERNAL_ERROR
424
343
 
425
344
 
426
 
def print_exception(exc_info, err_file):
427
 
    exc_type, exc_object, exc_tb = exc_info
428
 
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
429
 
        exc_type.__module__, exc_type.__name__, exc_object))
430
 
    err_file.write('\n')
431
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
432
 
 
433
 
 
434
345
# TODO: Should these be specially encoding the output?
435
 
def report_user_error(exc_info, err_file, advice=None):
 
346
def report_user_error(exc_info, err_file):
436
347
    """Report to err_file an error that's not an internal error.
437
348
 
438
349
    These don't get a traceback unless -Derror was given.
439
 
 
440
 
    :param exc_info: 3-tuple from sys.exc_info()
441
 
    :param advice: Extra advice to the user to be printed following the
442
 
        exception.
443
350
    """
444
351
    if 'error' in debug.debug_flags:
445
 
        print_exception(exc_info, err_file)
 
352
        report_bug(exc_info, err_file)
446
353
        return
447
354
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
448
 
    if advice:
449
 
        err_file.write("%s\n" % (advice,))
450
355
 
451
356
 
452
357
def report_bug(exc_info, err_file):
453
358
    """Report an exception that probably indicates a bug in bzr"""
454
 
    print_exception(exc_info, err_file)
 
359
    import traceback
 
360
    exc_type, exc_object, exc_tb = exc_info
 
361
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
 
362
        exc_type.__module__, exc_type.__name__, exc_object))
 
363
    err_file.write('\n')
 
364
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
455
365
    err_file.write('\n')
456
366
    err_file.write('bzr %s on python %s (%s)\n' % \
457
367
                       (bzrlib.__version__,
458
 
                        bzrlib._format_version_tuple(sys.version_info),
 
368
                        '.'.join(map(str, sys.version_info)),
459
369
                        sys.platform))
460
370
    err_file.write('arguments: %r\n' % sys.argv)
461
371
    err_file.write(
467
377
        err_file.write("  %-20s %s [%s]\n" %
468
378
            (name, a_plugin.path(), a_plugin.__version__))
469
379
    err_file.write(
470
 
"""\
471
 
*** Bazaar has encountered an internal error.
472
 
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
473
 
    including this traceback, and a description of what you
474
 
    were doing when the error occurred.
475
 
""")
 
380
        "\n"
 
381
        "** Please send this report to bazaar@lists.ubuntu.com\n"
 
382
        "   with a description of what you were doing when the\n"
 
383
        "   error occurred.\n"
 
384
        )