← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

added ianc tweaks to tbzr strategy doc

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
 
111
107
 
112
108
 
113
109
def note(*args, **kwargs):
114
 
    """Output a note to the user.
115
 
 
116
 
    Takes the same parameters as logging.info.
117
 
 
118
 
    :return: None
119
 
    """
120
110
    # FIXME note always emits utf-8, regardless of the terminal encoding
121
111
    #
122
112
    # FIXME: clearing the ui and then going through the abstract logging
133
123
    _bzr_logger.warning(*args, **kwargs)
134
124
 
135
125
 
136
 
@deprecated_function(deprecated_in((2, 1, 0)))
137
 
def info(*args, **kwargs):
138
 
    """Deprecated: use trace.note instead."""
139
 
    note(*args, **kwargs)
140
 
 
141
 
 
142
 
@deprecated_function(deprecated_in((2, 1, 0)))
143
 
def log_error(*args, **kwargs):
144
 
    """Deprecated: use bzrlib.trace.show_error instead"""
145
 
    _bzr_logger.error(*args, **kwargs)
146
 
 
147
 
 
148
 
@deprecated_function(deprecated_in((2, 1, 0)))
149
 
def error(*args, **kwargs):
150
 
    """Deprecated: use bzrlib.trace.show_error instead"""
151
 
    _bzr_logger.error(*args, **kwargs)
152
 
 
153
 
 
154
 
def show_error(*args, **kwargs):
155
 
    """Show an error message to the user.
156
 
 
157
 
    Don't use this for exceptions, use report_exception instead.
158
 
    """
159
 
    _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
160
132
 
161
133
 
162
134
def mutter(fmt, *args):
163
135
    if _trace_file is None:
164
136
        return
165
 
    # XXX: Don't check this every time; instead anyone who closes the file
166
 
    # ought to deregister it.  We can tolerate None.
167
137
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
168
138
        return
169
139
 
182
152
        out = fmt % tuple(real_args)
183
153
    else:
184
154
        out = fmt
185
 
    now = time.time()
186
 
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
 
155
    timestamp = '%0.3f  ' % (time.time() - _bzr_log_start_time,)
187
156
    out = timestamp + out + '\n'
188
157
    _trace_file.write(out)
189
 
    # 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.
190
160
 
191
161
 
192
162
def mutter_callsite(stacklevel, fmt, *args):
198
168
    :param args: A list of substitution variables.
199
169
    """
200
170
    outf = StringIO()
201
 
    if stacklevel is None:
202
 
        limit = None
203
 
    else:
204
 
        limit = stacklevel + 1
205
 
    traceback.print_stack(limit=limit, file=outf)
 
171
    traceback.print_stack(limit=stacklevel + 1, file=outf)
206
172
    formatted_lines = outf.getvalue().splitlines()
207
173
    formatted_stack = '\n'.join(formatted_lines[:-2])
208
174
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
235
201
 
236
202
 
237
203
def _open_bzr_log():
238
 
    """Open the .bzr.log trace file.
 
204
    """Open the .bzr.log trace file.  
239
205
 
240
206
    If the log is more than a particular length, the old file is renamed to
241
207
    .bzr.log.old and a new file is started.  Otherwise, we append to the
244
210
    This sets the global _bzr_log_filename.
245
211
    """
246
212
    global _bzr_log_filename
247
 
 
248
 
    def _open_or_create_log_file(filename):
249
 
        """Open existing log file, or create with ownership and permissions
250
 
 
251
 
        It inherits the ownership and permissions (masked by umask) from
252
 
        the containing directory to cope better with being run under sudo
253
 
        with $HOME still set to the user's homedir.
254
 
        """
255
 
        flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
256
 
        while True:
257
 
            try:
258
 
                fd = os.open(filename, flags)
259
 
                break
260
 
            except OSError, e:
261
 
                if e.errno != errno.ENOENT:
262
 
                    raise
263
 
            try:
264
 
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
265
 
            except OSError, e:
266
 
                if e.errno != errno.EEXIST:
267
 
                    raise
268
 
            else:
269
 
                osutils.copy_ownership_from_path(filename)
270
 
                break
271
 
        return os.fdopen(fd, 'at', 0) # unbuffered
272
 
 
273
 
 
274
213
    _bzr_log_filename = _get_bzr_log_filename()
275
214
    _rollover_trace_maybe(_bzr_log_filename)
276
215
    try:
277
 
        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
278
218
        bzr_log_file.write('\n')
279
219
        if bzr_log_file.tell() <= 2:
280
220
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
221
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
222
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
283
 
 
284
223
        return bzr_log_file
285
 
 
286
 
    except EnvironmentError, e:
287
 
        # If we are failing to open the log, then most likely logging has not
288
 
        # been set up yet. So we just write to stderr rather than using
289
 
        # 'warning()'. If we using warning(), users get the unhelpful 'no
290
 
        # handlers registered for "bzr"' when something goes wrong on the
291
 
        # server. (bug #503886)
292
 
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
 
224
    except IOError, e:
 
225
        warning("failed to open trace file: %s" % (e))
293
226
    # TODO: What should happen if we fail to open the trace file?  Maybe the
294
227
    # objects should be pointed at /dev/null or the equivalent?  Currently
295
228
    # returns None which will cause failures later.
296
 
    return None
297
229
 
298
230
 
299
231
def enable_default_logging():
300
232
    """Configure default logging: messages to stderr and debug to .bzr.log
301
 
 
 
233
    
302
234
    This should only be called once per process.
303
235
 
304
236
    Non-command-line programs embedding bzrlib do not need to call this.  They
305
237
    can instead either pass a file to _push_log_file, or act directly on
306
238
    logging.getLogger("bzr").
307
 
 
 
239
    
308
240
    Output can be redirected away by calling _push_log_file.
309
241
    """
310
 
    # Do this before we open the log file, so we prevent
311
 
    # get_terminal_encoding() from mutter()ing multiple times
312
 
    term_encoding = osutils.get_terminal_encoding()
313
 
    start_time = osutils.format_local_date(_bzr_log_start_time,
314
 
                                           timezone='local')
315
242
    # create encoded wrapper around stderr
316
243
    bzr_log_file = _open_bzr_log()
317
 
    if bzr_log_file is not None:
318
 
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
319
244
    push_log_file(bzr_log_file,
320
245
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
246
        r'%Y-%m-%d %H:%M:%S')
322
247
    # after hooking output into bzr_log, we also need to attach a stderr
323
248
    # handler, writing only at level info and with encoding
324
 
    writer_factory = codecs.getwriter(term_encoding)
 
249
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
325
250
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
251
    stderr_handler = logging.StreamHandler(encoded_stderr)
327
252
    stderr_handler.setLevel(logging.INFO)
333
258
 
334
259
    :param to_file: A file-like object to which messages will be sent.
335
260
 
336
 
    :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 
337
262
    previously active logging.
338
263
    """
339
264
    global _trace_file
368
293
    """Undo changes to logging/tracing done by _push_log_file.
369
294
 
370
295
    This flushes, but does not close the trace file.
371
 
 
 
296
    
372
297
    Takes the memento returned from _push_log_file."""
373
298
    global _trace_file
374
299
    _trace_file = old_trace_file
381
306
    new_trace_file.flush()
382
307
 
383
308
 
 
309
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
310
def enable_test_log(to_file):
 
311
    """Redirect logging to a temporary file for a test
 
312
    
 
313
    :returns: an opaque reference that should be passed to disable_test_log
 
314
    after the test completes.
 
315
    """
 
316
    return push_log_file(to_file)
 
317
 
 
318
 
 
319
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
320
def disable_test_log(memento):
 
321
    return pop_log_file(memento)
 
322
 
 
323
 
384
324
def log_exception_quietly():
385
325
    """Log the last exception to the trace file only.
386
326
 
387
 
    Used for exceptions that occur internally and that may be
388
 
    interesting to developers but not to users.  For example,
 
327
    Used for exceptions that occur internally and that may be 
 
328
    interesting to developers but not to users.  For example, 
389
329
    errors loading plugins.
390
330
    """
391
331
    mutter(traceback.format_exc())
399
339
    global _verbosity_level
400
340
    _verbosity_level = level
401
341
    _update_logging_level(level < 0)
402
 
    ui.ui_factory.be_quiet(level < 0)
403
342
 
404
343
 
405
344
def get_verbosity_level():
411
350
 
412
351
 
413
352
def be_quiet(quiet=True):
 
353
    # Perhaps this could be deprecated now ...
414
354
    if quiet:
415
355
        set_verbosity_level(-1)
416
356
    else:
435
375
    return _verbosity_level > 0
436
376
 
437
377
 
438
 
def debug_memory(message='', short=True):
439
 
    """Write out a memory dump."""
440
 
    if sys.platform == 'win32':
441
 
        from bzrlib import win32utils
442
 
        win32utils.debug_memory_win32api(message=message, short=short)
443
 
    else:
444
 
        _debug_memory_proc(message=message, short=short)
445
 
 
446
 
 
447
 
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
448
 
 
449
 
def _debug_memory_proc(message='', short=True):
450
 
    try:
451
 
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
452
 
    except IOError:
453
 
        return
454
 
    try:
455
 
        status = status_file.read()
456
 
    finally:
457
 
        status_file.close()
458
 
    if message:
459
 
        note(message)
460
 
    for line in status.splitlines():
461
 
        if not short:
462
 
            note(line)
463
 
        else:
464
 
            for field in _short_fields:
465
 
                if line.startswith(field):
466
 
                    note(line)
467
 
                    break
 
378
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
379
def disable_default_logging():
 
380
    """Turn off default log handlers.
 
381
 
 
382
    Don't call this method, use _push_log_file and _pop_log_file instead.
 
383
    """
 
384
    pass
468
385
 
469
386
 
470
387
def report_exception(exc_info, err_file):
474
391
 
475
392
    :return: The appropriate exit code for this error.
476
393
    """
 
394
    exc_type, exc_object, exc_tb = exc_info
477
395
    # Log the full traceback to ~/.bzr.log
478
396
    log_exception_quietly()
479
 
    if 'error' in debug.debug_flags:
480
 
        print_exception(exc_info, err_file)
481
 
        return errors.EXIT_ERROR
482
 
    exc_type, exc_object, exc_tb = exc_info
483
397
    if (isinstance(exc_object, IOError)
484
398
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
485
399
        err_file.write("bzr: broken pipe\n")
487
401
    elif isinstance(exc_object, KeyboardInterrupt):
488
402
        err_file.write("bzr: interrupted\n")
489
403
        return errors.EXIT_ERROR
490
 
    elif isinstance(exc_object, MemoryError):
491
 
        err_file.write("bzr: out of memory\n")
492
 
        return errors.EXIT_ERROR
493
 
    elif isinstance(exc_object, ImportError) \
494
 
        and str(exc_object).startswith("No module named "):
495
 
        report_user_error(exc_info, err_file,
496
 
            'You may need to install this Python library separately.')
497
 
        return errors.EXIT_ERROR
498
404
    elif not getattr(exc_object, 'internal_error', True):
499
405
        report_user_error(exc_info, err_file)
500
406
        return errors.EXIT_ERROR
517
423
 
518
424
 
519
425
# TODO: Should these be specially encoding the output?
520
 
def report_user_error(exc_info, err_file, advice=None):
 
426
def report_user_error(exc_info, err_file):
521
427
    """Report to err_file an error that's not an internal error.
522
428
 
523
429
    These don't get a traceback unless -Derror was given.
524
 
 
525
 
    :param exc_info: 3-tuple from sys.exc_info()
526
 
    :param advice: Extra advice to the user to be printed following the
527
 
        exception.
528
430
    """
 
431
    if 'error' in debug.debug_flags:
 
432
        print_exception(exc_info, err_file)
 
433
        return
529
434
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
530
 
    if advice:
531
 
        err_file.write("%s\n" % (advice,))
532
435
 
533
436
 
534
437
def report_bug(exc_info, err_file):
535
438
    """Report an exception that probably indicates a bug in bzr"""
536
 
    from bzrlib.crash import report_bug
537
 
    report_bug(exc_info, err_file)
538
 
 
539
 
 
540
 
def _flush_stdout_stderr():
541
 
    # installed into an atexit hook by bzrlib.initialize()
542
 
    try:
543
 
        sys.stdout.flush()
544
 
        sys.stderr.flush()
545
 
    except IOError, e:
546
 
        import errno
547
 
        if e.errno in [errno.EINVAL, errno.EPIPE]:
548
 
            pass
549
 
        else:
550
 
            raise
551
 
 
552
 
 
553
 
def _flush_trace():
554
 
    # run from atexit hook
555
 
    global _trace_file
556
 
    if _trace_file:
557
 
        _trace_file.flush()
 
439
    print_exception(exc_info, err_file)
 
440
    err_file.write('\n')
 
441
    err_file.write('bzr %s on python %s (%s)\n' % \
 
442
                       (bzrlib.__version__,
 
443
                        bzrlib._format_version_tuple(sys.version_info),
 
444
                        sys.platform))
 
445
    err_file.write('arguments: %r\n' % sys.argv)
 
446
    err_file.write(
 
447
        'encoding: %r, fsenc: %r, lang: %r\n' % (
 
448
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
 
449
            os.environ.get('LANG')))
 
450
    err_file.write("plugins:\n")
 
451
    for name, a_plugin in sorted(plugin.plugins().items()):
 
452
        err_file.write("  %-20s %s [%s]\n" %
 
453
            (name, a_plugin.path(), a_plugin.__version__))
 
454
    err_file.write(
 
455
"""\
 
456
*** Bazaar has encountered an internal error.
 
457
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
 
458
    including this traceback, and a description of what you
 
459
    were doing when the error occurred.
 
460
""")