← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Ian Clatworthy
  • Date: 2008-03-27 07:51:10 UTC
  • mto: (3311.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3312.
  • Revision ID: ian.clatworthy@canonical.com-20080327075110-afgd7x03ybju06ez
Reduce evangelism in the User Guide

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""Messages and logging.
 
17
"""Messages and logging for bazaar-ng.
18
18
 
19
19
Messages are supplied by callers as a string-formatting template, plus values
20
20
to be inserted into it.  The actual %-formatting is deferred to the log
33
33
 
34
34
Output to stderr depends on the mode chosen by the user.  By default, messages
35
35
of info and above are sent out, which results in progress messages such as the
36
 
list of files processed by add and commit.  In debug mode, stderr gets debug messages too.
 
36
list of files processed by add and commit.  In quiet mode, only warnings and
 
37
above are shown.  In debug mode, stderr gets debug messages too.
37
38
 
38
39
Errors that terminate an operation are generally passed back as exceptions;
39
40
others may be just emitted as messages.
58
59
import logging
59
60
import os
60
61
import sys
 
62
import re
61
63
import time
62
64
 
63
65
from bzrlib.lazy_import import lazy_import
70
72
 
71
73
import bzrlib
72
74
 
73
 
from bzrlib.symbol_versioning import (
74
 
    deprecated_function,
75
 
    deprecated_in,
76
 
    )
77
 
 
78
75
lazy_import(globals(), """
79
76
from bzrlib import (
80
77
    debug,
82
79
    osutils,
83
80
    plugin,
84
81
    symbol_versioning,
85
 
    ui,
86
82
    )
87
83
""")
88
84
 
127
123
    _bzr_logger.warning(*args, **kwargs)
128
124
 
129
125
 
130
 
@deprecated_function(deprecated_in((2, 1, 0)))
131
 
def info(*args, **kwargs):
132
 
    """Deprecated: use trace.note instead."""
133
 
    note(*args, **kwargs)
134
 
 
135
 
 
136
 
@deprecated_function(deprecated_in((2, 1, 0)))
137
 
def log_error(*args, **kwargs):
138
 
    """Deprecated: use bzrlib.trace.show_error instead"""
139
 
    _bzr_logger.error(*args, **kwargs)
140
 
 
141
 
 
142
 
@deprecated_function(deprecated_in((2, 1, 0)))
143
 
def error(*args, **kwargs):
144
 
    """Deprecated: use bzrlib.trace.show_error instead"""
145
 
    _bzr_logger.error(*args, **kwargs)
146
 
 
147
 
 
148
 
def show_error(*args, **kwargs):
149
 
    """Show an error message to the user.
150
 
 
151
 
    Don't use this for exceptions, use report_exception instead.
152
 
    """
153
 
    _bzr_logger.error(*args, **kwargs)
 
126
# configure convenient aliases for output routines
 
127
#
 
128
# TODO: deprecate them, have one name for each.
 
129
info = note
 
130
log_error = _bzr_logger.error
 
131
error =     _bzr_logger.error
154
132
 
155
133
 
156
134
def mutter(fmt, *args):
157
135
    if _trace_file is None:
158
136
        return
159
 
    # XXX: Don't check this every time; instead anyone who closes the file
160
 
    # ought to deregister it.  We can tolerate None.
161
137
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
162
138
        return
163
139
 
176
152
        out = fmt % tuple(real_args)
177
153
    else:
178
154
        out = fmt
179
 
    now = time.time()
180
 
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
 
155
    timestamp = '%0.3f  ' % (time.time() - _bzr_log_start_time,)
181
156
    out = timestamp + out + '\n'
182
157
    _trace_file.write(out)
183
 
    # there's no explicit flushing; the file is typically line buffered.
 
158
    # no need to flush here, the trace file is now linebuffered when it's
 
159
    # opened.
184
160
 
185
161
 
186
162
def mutter_callsite(stacklevel, fmt, *args):
192
168
    :param args: A list of substitution variables.
193
169
    """
194
170
    outf = StringIO()
195
 
    if stacklevel is None:
196
 
        limit = None
197
 
    else:
198
 
        limit = stacklevel + 1
199
 
    traceback.print_stack(limit=limit, file=outf)
 
171
    traceback.print_stack(limit=stacklevel + 1, file=outf)
200
172
    formatted_lines = outf.getvalue().splitlines()
201
173
    formatted_stack = '\n'.join(formatted_lines[:-2])
202
174
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
229
201
 
230
202
 
231
203
def _open_bzr_log():
232
 
    """Open the .bzr.log trace file.
 
204
    """Open the .bzr.log trace file.  
233
205
 
234
206
    If the log is more than a particular length, the old file is renamed to
235
207
    .bzr.log.old and a new file is started.  Otherwise, we append to the
238
210
    This sets the global _bzr_log_filename.
239
211
    """
240
212
    global _bzr_log_filename
241
 
 
242
 
    def _open_or_create_log_file(filename):
243
 
        """Open existing log file, or create with ownership and permissions
244
 
 
245
 
        It inherits the ownership and permissions (masked by umask) from
246
 
        the containing directory to cope better with being run under sudo
247
 
        with $HOME still set to the user's homedir.
248
 
        """
249
 
        flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
250
 
        while True:
251
 
            try:
252
 
                fd = os.open(filename, flags)
253
 
                break
254
 
            except OSError, e:
255
 
                if e.errno != errno.ENOENT:
256
 
                    raise
257
 
            try:
258
 
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
259
 
            except OSError, e:
260
 
                if e.errno != errno.EEXIST:
261
 
                    raise
262
 
            else:
263
 
                osutils.copy_ownership_from_path(filename)
264
 
                break
265
 
        return os.fdopen(fd, 'at', 0) # unbuffered
266
 
 
267
 
 
268
213
    _bzr_log_filename = _get_bzr_log_filename()
269
214
    _rollover_trace_maybe(_bzr_log_filename)
270
215
    try:
271
 
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
 
216
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
 
217
        # bzr_log_file.tell() on windows always return 0 until some writing done
272
218
        bzr_log_file.write('\n')
273
219
        if bzr_log_file.tell() <= 2:
274
220
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
275
221
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
276
222
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
277
 
 
278
223
        return bzr_log_file
279
 
 
280
 
    except EnvironmentError, e:
281
 
        # If we are failing to open the log, then most likely logging has not
282
 
        # been set up yet. So we just write to stderr rather than using
283
 
        # 'warning()'. If we using warning(), users get the unhelpful 'no
284
 
        # handlers registered for "bzr"' when something goes wrong on the
285
 
        # server. (bug #503886)
286
 
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
 
224
    except IOError, e:
 
225
        warning("failed to open trace file: %s" % (e))
287
226
    # TODO: What should happen if we fail to open the trace file?  Maybe the
288
227
    # objects should be pointed at /dev/null or the equivalent?  Currently
289
228
    # returns None which will cause failures later.
290
 
    return None
291
229
 
292
230
 
293
231
def enable_default_logging():
294
232
    """Configure default logging: messages to stderr and debug to .bzr.log
295
 
 
 
233
    
296
234
    This should only be called once per process.
297
235
 
298
236
    Non-command-line programs embedding bzrlib do not need to call this.  They
299
237
    can instead either pass a file to _push_log_file, or act directly on
300
238
    logging.getLogger("bzr").
301
 
 
 
239
    
302
240
    Output can be redirected away by calling _push_log_file.
303
241
    """
304
 
    # Do this before we open the log file, so we prevent
305
 
    # get_terminal_encoding() from mutter()ing multiple times
306
 
    term_encoding = osutils.get_terminal_encoding()
307
 
    start_time = osutils.format_local_date(_bzr_log_start_time,
308
 
                                           timezone='local')
309
242
    # create encoded wrapper around stderr
310
243
    bzr_log_file = _open_bzr_log()
311
 
    if bzr_log_file is not None:
312
 
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
313
244
    push_log_file(bzr_log_file,
314
245
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
315
246
        r'%Y-%m-%d %H:%M:%S')
316
247
    # after hooking output into bzr_log, we also need to attach a stderr
317
248
    # handler, writing only at level info and with encoding
318
 
    writer_factory = codecs.getwriter(term_encoding)
 
249
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
319
250
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
320
251
    stderr_handler = logging.StreamHandler(encoded_stderr)
321
252
    stderr_handler.setLevel(logging.INFO)
327
258
 
328
259
    :param to_file: A file-like object to which messages will be sent.
329
260
 
330
 
    :returns: A memento that should be passed to _pop_log_file to restore the
 
261
    :returns: A memento that should be passed to _pop_log_file to restore the 
331
262
    previously active logging.
332
263
    """
333
264
    global _trace_file
362
293
    """Undo changes to logging/tracing done by _push_log_file.
363
294
 
364
295
    This flushes, but does not close the trace file.
365
 
 
 
296
    
366
297
    Takes the memento returned from _push_log_file."""
 
298
    assert magic == 'log_memento'
367
299
    global _trace_file
368
300
    _trace_file = old_trace_file
369
301
    bzr_logger = logging.getLogger('bzr')
375
307
    new_trace_file.flush()
376
308
 
377
309
 
 
310
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
311
def enable_test_log(to_file):
 
312
    """Redirect logging to a temporary file for a test
 
313
    
 
314
    :returns: an opaque reference that should be passed to disable_test_log
 
315
    after the test completes.
 
316
    """
 
317
    return push_log_file(to_file)
 
318
 
 
319
 
 
320
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
321
def disable_test_log(memento):
 
322
    return pop_log_file(memento)
 
323
 
 
324
 
378
325
def log_exception_quietly():
379
326
    """Log the last exception to the trace file only.
380
327
 
381
 
    Used for exceptions that occur internally and that may be
382
 
    interesting to developers but not to users.  For example,
 
328
    Used for exceptions that occur internally and that may be 
 
329
    interesting to developers but not to users.  For example, 
383
330
    errors loading plugins.
384
331
    """
385
332
    mutter(traceback.format_exc())
393
340
    global _verbosity_level
394
341
    _verbosity_level = level
395
342
    _update_logging_level(level < 0)
396
 
    ui.ui_factory.be_quiet(level < 0)
397
343
 
398
344
 
399
345
def get_verbosity_level():
405
351
 
406
352
 
407
353
def be_quiet(quiet=True):
 
354
    # Perhaps this could be deprecated now ...
408
355
    if quiet:
409
356
        set_verbosity_level(-1)
410
357
    else:
429
376
    return _verbosity_level > 0
430
377
 
431
378
 
432
 
def debug_memory(message='', short=True):
433
 
    """Write out a memory dump."""
434
 
    if sys.platform == 'win32':
435
 
        from bzrlib import win32utils
436
 
        win32utils.debug_memory_win32api(message=message, short=short)
437
 
    else:
438
 
        _debug_memory_proc(message=message, short=short)
439
 
 
440
 
 
441
 
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
442
 
 
443
 
def _debug_memory_proc(message='', short=True):
444
 
    try:
445
 
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
446
 
    except IOError:
447
 
        return
448
 
    try:
449
 
        status = status_file.read()
450
 
    finally:
451
 
        status_file.close()
452
 
    if message:
453
 
        note(message)
454
 
    for line in status.splitlines():
455
 
        if not short:
456
 
            note(line)
457
 
        else:
458
 
            for field in _short_fields:
459
 
                if line.startswith(field):
460
 
                    note(line)
461
 
                    break
 
379
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
380
def disable_default_logging():
 
381
    """Turn off default log handlers.
 
382
 
 
383
    Don't call this method, use _push_log_file and _pop_log_file instead.
 
384
    """
 
385
    pass
462
386
 
463
387
 
464
388
def report_exception(exc_info, err_file):
468
392
 
469
393
    :return: The appropriate exit code for this error.
470
394
    """
 
395
    exc_type, exc_object, exc_tb = exc_info
471
396
    # Log the full traceback to ~/.bzr.log
472
397
    log_exception_quietly()
473
 
    if 'error' in debug.debug_flags:
474
 
        print_exception(exc_info, err_file)
475
 
        return errors.EXIT_ERROR
476
 
    exc_type, exc_object, exc_tb = exc_info
477
398
    if (isinstance(exc_object, IOError)
478
399
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
479
400
        err_file.write("bzr: broken pipe\n")
481
402
    elif isinstance(exc_object, KeyboardInterrupt):
482
403
        err_file.write("bzr: interrupted\n")
483
404
        return errors.EXIT_ERROR
484
 
    elif isinstance(exc_object, MemoryError):
485
 
        err_file.write("bzr: out of memory\n")
486
 
        return errors.EXIT_ERROR
487
 
    elif isinstance(exc_object, ImportError) \
488
 
        and str(exc_object).startswith("No module named "):
489
 
        report_user_error(exc_info, err_file,
490
 
            'You may need to install this Python library separately.')
491
 
        return errors.EXIT_ERROR
492
405
    elif not getattr(exc_object, 'internal_error', True):
493
406
        report_user_error(exc_info, err_file)
494
407
        return errors.EXIT_ERROR
502
415
        return errors.EXIT_INTERNAL_ERROR
503
416
 
504
417
 
505
 
def print_exception(exc_info, err_file):
506
 
    exc_type, exc_object, exc_tb = exc_info
507
 
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
508
 
        exc_type.__module__, exc_type.__name__, exc_object))
509
 
    err_file.write('\n')
510
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
511
 
 
512
 
 
513
418
# TODO: Should these be specially encoding the output?
514
 
def report_user_error(exc_info, err_file, advice=None):
 
419
def report_user_error(exc_info, err_file):
515
420
    """Report to err_file an error that's not an internal error.
516
421
 
517
422
    These don't get a traceback unless -Derror was given.
518
 
 
519
 
    :param exc_info: 3-tuple from sys.exc_info()
520
 
    :param advice: Extra advice to the user to be printed following the
521
 
        exception.
522
423
    """
 
424
    if 'error' in debug.debug_flags:
 
425
        report_bug(exc_info, err_file)
 
426
        return
523
427
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
524
 
    if advice:
525
 
        err_file.write("%s\n" % (advice,))
526
428
 
527
429
 
528
430
def report_bug(exc_info, err_file):
529
431
    """Report an exception that probably indicates a bug in bzr"""
530
 
    from bzrlib.crash import report_bug
531
 
    report_bug(exc_info, err_file)
532
 
 
533
 
 
534
 
def _flush_stdout_stderr():
535
 
    # installed into an atexit hook by bzrlib.initialize()
536
 
    try:
537
 
        sys.stdout.flush()
538
 
        sys.stderr.flush()
539
 
    except IOError, e:
540
 
        import errno
541
 
        if e.errno in [errno.EINVAL, errno.EPIPE]:
542
 
            pass
543
 
        else:
544
 
            raise
545
 
 
546
 
 
547
 
def _flush_trace():
548
 
    # run from atexit hook
549
 
    global _trace_file
550
 
    if _trace_file:
551
 
        _trace_file.flush()
 
432
    exc_type, exc_object, exc_tb = exc_info
 
433
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
 
434
        exc_type.__module__, exc_type.__name__, exc_object))
 
435
    err_file.write('\n')
 
436
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
437
    err_file.write('\n')
 
438
    err_file.write('bzr %s on python %s (%s)\n' % \
 
439
                       (bzrlib.__version__,
 
440
                        bzrlib._format_version_tuple(sys.version_info),
 
441
                        sys.platform))
 
442
    err_file.write('arguments: %r\n' % sys.argv)
 
443
    err_file.write(
 
444
        'encoding: %r, fsenc: %r, lang: %r\n' % (
 
445
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
 
446
            os.environ.get('LANG')))
 
447
    err_file.write("plugins:\n")
 
448
    for name, a_plugin in sorted(plugin.plugins().items()):
 
449
        err_file.write("  %-20s %s [%s]\n" %
 
450
            (name, a_plugin.path(), a_plugin.__version__))
 
451
    err_file.write(
 
452
"""\
 
453
*** Bazaar has encountered an internal error.
 
454
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
 
455
    including this traceback, and a description of what you
 
456
    were doing when the error occurred.
 
457
""")