← 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-07-17 01:08:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3546.
  • Revision ID: ian.clatworthy@canonical.com-20080717010821-qg05ah7iobvl8hin
workaround docutils dot-in-option name bug (Mark Hammond)

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):
235
205
 
236
206
 
237
207
def _open_bzr_log():
238
 
    """Open the .bzr.log trace file.
 
208
    """Open the .bzr.log trace file.  
239
209
 
240
210
    If the log is more than a particular length, the old file is renamed to
241
211
    .bzr.log.old and a new file is started.  Otherwise, we append to the
244
214
    This sets the global _bzr_log_filename.
245
215
    """
246
216
    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
217
    _bzr_log_filename = _get_bzr_log_filename()
275
218
    _rollover_trace_maybe(_bzr_log_filename)
276
219
    try:
277
 
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
 
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
278
222
        bzr_log_file.write('\n')
279
223
        if bzr_log_file.tell() <= 2:
280
224
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
225
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
226
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
283
 
 
284
227
        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,))
 
228
    except IOError, e:
 
229
        warning("failed to open trace file: %s" % (e))
293
230
    # TODO: What should happen if we fail to open the trace file?  Maybe the
294
231
    # objects should be pointed at /dev/null or the equivalent?  Currently
295
232
    # returns None which will cause failures later.
296
 
    return None
297
233
 
298
234
 
299
235
def enable_default_logging():
300
236
    """Configure default logging: messages to stderr and debug to .bzr.log
301
 
 
 
237
    
302
238
    This should only be called once per process.
303
239
 
304
240
    Non-command-line programs embedding bzrlib do not need to call this.  They
305
241
    can instead either pass a file to _push_log_file, or act directly on
306
242
    logging.getLogger("bzr").
307
 
 
 
243
    
308
244
    Output can be redirected away by calling _push_log_file.
309
245
    """
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
246
    # create encoded wrapper around stderr
316
247
    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
248
    push_log_file(bzr_log_file,
320
249
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
250
        r'%Y-%m-%d %H:%M:%S')
322
251
    # after hooking output into bzr_log, we also need to attach a stderr
323
252
    # handler, writing only at level info and with encoding
324
 
    writer_factory = codecs.getwriter(term_encoding)
 
253
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
325
254
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
255
    stderr_handler = logging.StreamHandler(encoded_stderr)
327
256
    stderr_handler.setLevel(logging.INFO)
333
262
 
334
263
    :param to_file: A file-like object to which messages will be sent.
335
264
 
336
 
    :returns: A memento that should be passed to _pop_log_file to restore the
 
265
    :returns: A memento that should be passed to _pop_log_file to restore the 
337
266
    previously active logging.
338
267
    """
339
268
    global _trace_file
368
297
    """Undo changes to logging/tracing done by _push_log_file.
369
298
 
370
299
    This flushes, but does not close the trace file.
371
 
 
 
300
    
372
301
    Takes the memento returned from _push_log_file."""
373
302
    global _trace_file
374
303
    _trace_file = old_trace_file
381
310
    new_trace_file.flush()
382
311
 
383
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
 
 
327
 
384
328
def log_exception_quietly():
385
329
    """Log the last exception to the trace file only.
386
330
 
387
 
    Used for exceptions that occur internally and that may be
388
 
    interesting to developers but not to users.  For example,
 
331
    Used for exceptions that occur internally and that may be 
 
332
    interesting to developers but not to users.  For example, 
389
333
    errors loading plugins.
390
334
    """
391
335
    mutter(traceback.format_exc())
399
343
    global _verbosity_level
400
344
    _verbosity_level = level
401
345
    _update_logging_level(level < 0)
402
 
    ui.ui_factory.be_quiet(level < 0)
403
346
 
404
347
 
405
348
def get_verbosity_level():
411
354
 
412
355
 
413
356
def be_quiet(quiet=True):
 
357
    # Perhaps this could be deprecated now ...
414
358
    if quiet:
415
359
        set_verbosity_level(-1)
416
360
    else:
435
379
    return _verbosity_level > 0
436
380
 
437
381
 
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
 
382
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
383
def disable_default_logging():
 
384
    """Turn off default log handlers.
 
385
 
 
386
    Don't call this method, use _push_log_file and _pop_log_file instead.
 
387
    """
 
388
    pass
468
389
 
469
390
 
470
391
def report_exception(exc_info, err_file):
474
395
 
475
396
    :return: The appropriate exit code for this error.
476
397
    """
 
398
    exc_type, exc_object, exc_tb = exc_info
477
399
    # Log the full traceback to ~/.bzr.log
478
400
    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
401
    if (isinstance(exc_object, IOError)
484
402
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
485
403
        err_file.write("bzr: broken pipe\n")
487
405
    elif isinstance(exc_object, KeyboardInterrupt):
488
406
        err_file.write("bzr: interrupted\n")
489
407
        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
408
    elif isinstance(exc_object, ImportError) \
494
409
        and str(exc_object).startswith("No module named "):
495
410
        report_user_error(exc_info, err_file,
526
441
    :param advice: Extra advice to the user to be printed following the
527
442
        exception.
528
443
    """
 
444
    if 'error' in debug.debug_flags:
 
445
        print_exception(exc_info, err_file)
 
446
        return
529
447
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
530
448
    if advice:
531
449
        err_file.write("%s\n" % (advice,))
533
451
 
534
452
def report_bug(exc_info, err_file):
535
453
    """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()
 
454
    print_exception(exc_info, err_file)
 
455
    err_file.write('\n')
 
456
    err_file.write('bzr %s on python %s (%s)\n' % \
 
457
                       (bzrlib.__version__,
 
458
                        bzrlib._format_version_tuple(sys.version_info),
 
459
                        sys.platform))
 
460
    err_file.write('arguments: %r\n' % sys.argv)
 
461
    err_file.write(
 
462
        'encoding: %r, fsenc: %r, lang: %r\n' % (
 
463
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
 
464
            os.environ.get('LANG')))
 
465
    err_file.write("plugins:\n")
 
466
    for name, a_plugin in sorted(plugin.plugins().items()):
 
467
        err_file.write("  %-20s %s [%s]\n" %
 
468
            (name, a_plugin.path(), a_plugin.__version__))
 
469
    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
""")