/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

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
"""Messages and logging for bazaar-ng.
 
17
"""Messages and logging.
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 quiet mode, only warnings and
37
 
above are shown.  In debug mode, stderr gets debug messages too.
 
36
list of files processed by add and commit.  In debug mode, stderr gets debug messages too.
38
37
 
39
38
Errors that terminate an operation are generally passed back as exceptions;
40
39
others may be just emitted as messages.
59
58
import logging
60
59
import os
61
60
import sys
62
 
import re
63
61
import time
64
62
 
65
63
from bzrlib.lazy_import import lazy_import
72
70
 
73
71
import bzrlib
74
72
 
 
73
from bzrlib.symbol_versioning import (
 
74
    deprecated_function,
 
75
    deprecated_in,
 
76
    )
 
77
 
75
78
lazy_import(globals(), """
76
79
from bzrlib import (
77
80
    debug,
79
82
    osutils,
80
83
    plugin,
81
84
    symbol_versioning,
 
85
    ui,
82
86
    )
83
87
""")
84
88
 
123
127
    _bzr_logger.warning(*args, **kwargs)
124
128
 
125
129
 
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
 
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)
132
154
 
133
155
 
134
156
def mutter(fmt, *args):
135
157
    if _trace_file is None:
136
158
        return
 
159
    # XXX: Don't check this every time; instead anyone who closes the file
 
160
    # ought to deregister it.  We can tolerate None.
137
161
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
138
162
        return
139
163
 
152
176
        out = fmt % tuple(real_args)
153
177
    else:
154
178
        out = fmt
155
 
    timestamp = '%0.3f  ' % (time.time() - _bzr_log_start_time,)
 
179
    now = time.time()
 
180
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
156
181
    out = timestamp + out + '\n'
157
182
    _trace_file.write(out)
158
 
    # no need to flush here, the trace file is now linebuffered when it's
159
 
    # opened.
 
183
    # there's no explicit flushing; the file is typically line buffered.
160
184
 
161
185
 
162
186
def mutter_callsite(stacklevel, fmt, *args):
168
192
    :param args: A list of substitution variables.
169
193
    """
170
194
    outf = StringIO()
171
 
    traceback.print_stack(limit=stacklevel + 1, file=outf)
 
195
    if stacklevel is None:
 
196
        limit = None
 
197
    else:
 
198
        limit = stacklevel + 1
 
199
    traceback.print_stack(limit=limit, file=outf)
172
200
    formatted_lines = outf.getvalue().splitlines()
173
201
    formatted_stack = '\n'.join(formatted_lines[:-2])
174
202
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
201
229
 
202
230
 
203
231
def _open_bzr_log():
204
 
    """Open the .bzr.log trace file.  
 
232
    """Open the .bzr.log trace file.
205
233
 
206
234
    If the log is more than a particular length, the old file is renamed to
207
235
    .bzr.log.old and a new file is started.  Otherwise, we append to the
210
238
    This sets the global _bzr_log_filename.
211
239
    """
212
240
    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
 
213
268
    _bzr_log_filename = _get_bzr_log_filename()
214
269
    _rollover_trace_maybe(_bzr_log_filename)
215
270
    try:
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
 
271
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
218
272
        bzr_log_file.write('\n')
219
273
        if bzr_log_file.tell() <= 2:
220
274
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
221
275
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
222
276
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
 
277
 
223
278
        return bzr_log_file
224
 
    except IOError, e:
225
 
        warning("failed to open trace file: %s" % (e))
 
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,))
226
287
    # TODO: What should happen if we fail to open the trace file?  Maybe the
227
288
    # objects should be pointed at /dev/null or the equivalent?  Currently
228
289
    # returns None which will cause failures later.
 
290
    return None
229
291
 
230
292
 
231
293
def enable_default_logging():
232
294
    """Configure default logging: messages to stderr and debug to .bzr.log
233
 
    
 
295
 
234
296
    This should only be called once per process.
235
297
 
236
298
    Non-command-line programs embedding bzrlib do not need to call this.  They
237
299
    can instead either pass a file to _push_log_file, or act directly on
238
300
    logging.getLogger("bzr").
239
 
    
 
301
 
240
302
    Output can be redirected away by calling _push_log_file.
241
303
    """
 
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')
242
309
    # create encoded wrapper around stderr
243
310
    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')
244
313
    push_log_file(bzr_log_file,
245
314
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
246
315
        r'%Y-%m-%d %H:%M:%S')
247
316
    # after hooking output into bzr_log, we also need to attach a stderr
248
317
    # handler, writing only at level info and with encoding
249
 
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
 
318
    writer_factory = codecs.getwriter(term_encoding)
250
319
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
251
320
    stderr_handler = logging.StreamHandler(encoded_stderr)
252
321
    stderr_handler.setLevel(logging.INFO)
258
327
 
259
328
    :param to_file: A file-like object to which messages will be sent.
260
329
 
261
 
    :returns: A memento that should be passed to _pop_log_file to restore the 
 
330
    :returns: A memento that should be passed to _pop_log_file to restore the
262
331
    previously active logging.
263
332
    """
264
333
    global _trace_file
293
362
    """Undo changes to logging/tracing done by _push_log_file.
294
363
 
295
364
    This flushes, but does not close the trace file.
296
 
    
 
365
 
297
366
    Takes the memento returned from _push_log_file."""
298
 
    assert magic == 'log_memento'
299
367
    global _trace_file
300
368
    _trace_file = old_trace_file
301
369
    bzr_logger = logging.getLogger('bzr')
307
375
    new_trace_file.flush()
308
376
 
309
377
 
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
 
 
325
378
def log_exception_quietly():
326
379
    """Log the last exception to the trace file only.
327
380
 
328
 
    Used for exceptions that occur internally and that may be 
329
 
    interesting to developers but not to users.  For example, 
 
381
    Used for exceptions that occur internally and that may be
 
382
    interesting to developers but not to users.  For example,
330
383
    errors loading plugins.
331
384
    """
332
385
    mutter(traceback.format_exc())
340
393
    global _verbosity_level
341
394
    _verbosity_level = level
342
395
    _update_logging_level(level < 0)
 
396
    ui.ui_factory.be_quiet(level < 0)
343
397
 
344
398
 
345
399
def get_verbosity_level():
351
405
 
352
406
 
353
407
def be_quiet(quiet=True):
354
 
    # Perhaps this could be deprecated now ...
355
408
    if quiet:
356
409
        set_verbosity_level(-1)
357
410
    else:
376
429
    return _verbosity_level > 0
377
430
 
378
431
 
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
 
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
386
462
 
387
463
 
388
464
def report_exception(exc_info, err_file):
392
468
 
393
469
    :return: The appropriate exit code for this error.
394
470
    """
395
 
    exc_type, exc_object, exc_tb = exc_info
396
471
    # Log the full traceback to ~/.bzr.log
397
472
    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
398
477
    if (isinstance(exc_object, IOError)
399
478
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
400
479
        err_file.write("bzr: broken pipe\n")
402
481
    elif isinstance(exc_object, KeyboardInterrupt):
403
482
        err_file.write("bzr: interrupted\n")
404
483
        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
405
492
    elif not getattr(exc_object, 'internal_error', True):
406
493
        report_user_error(exc_info, err_file)
407
494
        return errors.EXIT_ERROR
415
502
        return errors.EXIT_INTERNAL_ERROR
416
503
 
417
504
 
 
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
 
418
513
# TODO: Should these be specially encoding the output?
419
 
def report_user_error(exc_info, err_file):
 
514
def report_user_error(exc_info, err_file, advice=None):
420
515
    """Report to err_file an error that's not an internal error.
421
516
 
422
517
    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.
423
522
    """
424
 
    if 'error' in debug.debug_flags:
425
 
        report_bug(exc_info, err_file)
426
 
        return
427
523
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
 
524
    if advice:
 
525
        err_file.write("%s\n" % (advice,))
428
526
 
429
527
 
430
528
def report_bug(exc_info, err_file):
431
529
    """Report an exception that probably indicates a bug in bzr"""
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
 
""")
 
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()