← 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: 2010-04-23 08:51:52 UTC
  • mfrom: (5131.2.6 support_OO_flag)
  • mto: This revision was merged to the branch mainline in revision 5179.
  • Revision ID: v.ladeuil+lp@free.fr-20100423085152-uoewc1vnkwqhw0pj
Manually assign docstrings to command objects, so that they work with python -OO

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
14
14
# along with this program; if not, write to the Free Software
15
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
132
 
 
133
 
 
134
 
_last_mutter_flush_time = None
 
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)
 
154
 
135
155
 
136
156
def mutter(fmt, *args):
137
 
    global _last_mutter_flush_time
138
157
    if _trace_file is None:
139
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.
140
161
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
141
162
        return
142
163
 
159
180
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
160
181
    out = timestamp + out + '\n'
161
182
    _trace_file.write(out)
162
 
    # We flush if we haven't flushed for a few seconds. We don't want to flush
163
 
    # on every mutter, but when a command takes a while, it can be nice to see
164
 
    # updates in the debug log.
165
 
    if (_last_mutter_flush_time is None
166
 
        or (now - _last_mutter_flush_time) > 2.0):
167
 
        flush = getattr(_trace_file, 'flush', None)
168
 
        if flush is not None:
169
 
            flush()
170
 
        _last_mutter_flush_time = now
 
183
    # there's no explicit flushing; the file is typically line buffered.
171
184
 
172
185
 
173
186
def mutter_callsite(stacklevel, fmt, *args):
228
241
    _bzr_log_filename = _get_bzr_log_filename()
229
242
    _rollover_trace_maybe(_bzr_log_filename)
230
243
    try:
231
 
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
 
244
        buffering = 0 # unbuffered
 
245
        bzr_log_file = osutils.open_with_ownership(_bzr_log_filename, 'at', buffering)
232
246
        # bzr_log_file.tell() on windows always return 0 until some writing done
233
247
        bzr_log_file.write('\n')
234
248
        if bzr_log_file.tell() <= 2:
235
249
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
236
250
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
237
251
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
 
252
 
238
253
        return bzr_log_file
 
254
 
239
255
    except IOError, e:
240
 
        warning("failed to open trace file: %s" % (e))
 
256
        # If we are failing to open the log, then most likely logging has not
 
257
        # been set up yet. So we just write to stderr rather than using
 
258
        # 'warning()'. If we using warning(), users get the unhelpful 'no
 
259
        # handlers registered for "bzr"' when something goes wrong on the
 
260
        # server. (bug #503886)
 
261
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
241
262
    # TODO: What should happen if we fail to open the trace file?  Maybe the
242
263
    # objects should be pointed at /dev/null or the equivalent?  Currently
243
264
    # returns None which will cause failures later.
347
368
    global _verbosity_level
348
369
    _verbosity_level = level
349
370
    _update_logging_level(level < 0)
 
371
    ui.ui_factory.be_quiet(level < 0)
350
372
 
351
373
 
352
374
def get_verbosity_level():
358
380
 
359
381
 
360
382
def be_quiet(quiet=True):
361
 
    # Perhaps this could be deprecated now ...
362
383
    if quiet:
363
384
        set_verbosity_level(-1)
364
385
    else:
422
443
 
423
444
    :return: The appropriate exit code for this error.
424
445
    """
425
 
    exc_type, exc_object, exc_tb = exc_info
426
446
    # Log the full traceback to ~/.bzr.log
427
447
    log_exception_quietly()
 
448
    if 'error' in debug.debug_flags:
 
449
        print_exception(exc_info, err_file)
 
450
        return errors.EXIT_ERROR
 
451
    exc_type, exc_object, exc_tb = exc_info
428
452
    if (isinstance(exc_object, IOError)
429
453
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
430
454
        err_file.write("bzr: broken pipe\n")
432
456
    elif isinstance(exc_object, KeyboardInterrupt):
433
457
        err_file.write("bzr: interrupted\n")
434
458
        return errors.EXIT_ERROR
 
459
    elif isinstance(exc_object, MemoryError):
 
460
        err_file.write("bzr: out of memory\n")
 
461
        return errors.EXIT_ERROR
435
462
    elif isinstance(exc_object, ImportError) \
436
463
        and str(exc_object).startswith("No module named "):
437
464
        report_user_error(exc_info, err_file,
468
495
    :param advice: Extra advice to the user to be printed following the
469
496
        exception.
470
497
    """
471
 
    if 'error' in debug.debug_flags:
472
 
        print_exception(exc_info, err_file)
473
 
        return
474
498
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
475
499
    if advice:
476
500
        err_file.write("%s\n" % (advice,))
478
502
 
479
503
def report_bug(exc_info, err_file):
480
504
    """Report an exception that probably indicates a bug in bzr"""
481
 
    print_exception(exc_info, err_file)
482
 
    err_file.write('\n')
483
 
    err_file.write('bzr %s on python %s (%s)\n' % \
484
 
                       (bzrlib.__version__,
485
 
                        bzrlib._format_version_tuple(sys.version_info),
486
 
                        sys.platform))
487
 
    err_file.write('arguments: %r\n' % sys.argv)
488
 
    err_file.write(
489
 
        'encoding: %r, fsenc: %r, lang: %r\n' % (
490
 
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
491
 
            os.environ.get('LANG')))
492
 
    err_file.write("plugins:\n")
493
 
    for name, a_plugin in sorted(plugin.plugins().items()):
494
 
        err_file.write("  %-20s %s [%s]\n" %
495
 
            (name, a_plugin.path(), a_plugin.__version__))
496
 
    err_file.write(
497
 
"""\
498
 
*** Bazaar has encountered an internal error.
499
 
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
500
 
    including this traceback, and a description of what you
501
 
    were doing when the error occurred.
502
 
""")
 
505
    from bzrlib.crash import report_bug
 
506
    report_bug(exc_info, err_file)
 
507
 
 
508
 
 
509
def _flush_stdout_stderr():
 
510
    # installed into an atexit hook by bzrlib.initialize()
 
511
    try:
 
512
        sys.stdout.flush()
 
513
        sys.stderr.flush()
 
514
    except IOError, e:
 
515
        import errno
 
516
        if e.errno in [errno.EINVAL, errno.EPIPE]:
 
517
            pass
 
518
        else:
 
519
            raise
 
520
 
 
521
 
 
522
def _flush_trace():
 
523
    # run from atexit hook
 
524
    global _trace_file
 
525
    if _trace_file:
 
526
        _trace_file.flush()