← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

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):
225
238
    This sets the global _bzr_log_filename.
226
239
    """
227
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
 
228
268
    _bzr_log_filename = _get_bzr_log_filename()
229
269
    _rollover_trace_maybe(_bzr_log_filename)
230
270
    try:
231
 
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
232
 
        # 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)
233
272
        bzr_log_file.write('\n')
234
273
        if bzr_log_file.tell() <= 2:
235
274
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
236
275
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
237
276
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
 
277
 
238
278
        return bzr_log_file
239
 
    except IOError, e:
240
 
        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,))
241
287
    # TODO: What should happen if we fail to open the trace file?  Maybe the
242
288
    # objects should be pointed at /dev/null or the equivalent?  Currently
243
289
    # returns None which will cause failures later.
347
393
    global _verbosity_level
348
394
    _verbosity_level = level
349
395
    _update_logging_level(level < 0)
 
396
    ui.ui_factory.be_quiet(level < 0)
350
397
 
351
398
 
352
399
def get_verbosity_level():
358
405
 
359
406
 
360
407
def be_quiet(quiet=True):
361
 
    # Perhaps this could be deprecated now ...
362
408
    if quiet:
363
409
        set_verbosity_level(-1)
364
410
    else:
422
468
 
423
469
    :return: The appropriate exit code for this error.
424
470
    """
425
 
    exc_type, exc_object, exc_tb = exc_info
426
471
    # Log the full traceback to ~/.bzr.log
427
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
428
477
    if (isinstance(exc_object, IOError)
429
478
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
430
479
        err_file.write("bzr: broken pipe\n")
432
481
    elif isinstance(exc_object, KeyboardInterrupt):
433
482
        err_file.write("bzr: interrupted\n")
434
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
435
487
    elif isinstance(exc_object, ImportError) \
436
488
        and str(exc_object).startswith("No module named "):
437
489
        report_user_error(exc_info, err_file,
468
520
    :param advice: Extra advice to the user to be printed following the
469
521
        exception.
470
522
    """
471
 
    if 'error' in debug.debug_flags:
472
 
        print_exception(exc_info, err_file)
473
 
        return
474
523
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
475
524
    if advice:
476
525
        err_file.write("%s\n" % (advice,))
478
527
 
479
528
def report_bug(exc_info, err_file):
480
529
    """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
 
""")
 
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()