← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

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
 
107
111
 
108
112
 
109
113
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
    """
110
120
    # FIXME note always emits utf-8, regardless of the terminal encoding
111
121
    #
112
122
    # FIXME: clearing the ui and then going through the abstract logging
123
133
    _bzr_logger.warning(*args, **kwargs)
124
134
 
125
135
 
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
 
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)
 
160
 
135
161
 
136
162
def mutter(fmt, *args):
137
 
    global _last_mutter_flush_time
138
163
    if _trace_file is None:
139
164
        return
 
165
    # XXX: Don't check this every time; instead anyone who closes the file
 
166
    # ought to deregister it.  We can tolerate None.
140
167
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
141
168
        return
142
169
 
159
186
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
160
187
    out = timestamp + out + '\n'
161
188
    _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
 
189
    # there's no explicit flushing; the file is typically line buffered.
171
190
 
172
191
 
173
192
def mutter_callsite(stacklevel, fmt, *args):
225
244
    This sets the global _bzr_log_filename.
226
245
    """
227
246
    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
 
228
274
    _bzr_log_filename = _get_bzr_log_filename()
229
275
    _rollover_trace_maybe(_bzr_log_filename)
230
276
    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
 
277
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
233
278
        bzr_log_file.write('\n')
234
279
        if bzr_log_file.tell() <= 2:
235
280
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
236
281
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
237
282
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
 
283
 
238
284
        return bzr_log_file
239
 
    except IOError, e:
240
 
        warning("failed to open trace file: %s" % (e))
 
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,))
241
293
    # TODO: What should happen if we fail to open the trace file?  Maybe the
242
294
    # objects should be pointed at /dev/null or the equivalent?  Currently
243
295
    # returns None which will cause failures later.
254
306
    logging.getLogger("bzr").
255
307
 
256
308
    Output can be redirected away by calling _push_log_file.
 
309
 
 
310
    :return: A memento from push_log_file for restoring the log state.
257
311
    """
258
 
    # Do this before we open the log file, so we prevent
259
 
    # get_terminal_encoding() from mutter()ing multiple times
260
 
    term_encoding = osutils.get_terminal_encoding()
261
312
    start_time = osutils.format_local_date(_bzr_log_start_time,
262
313
                                           timezone='local')
263
314
    # create encoded wrapper around stderr
264
315
    bzr_log_file = _open_bzr_log()
265
316
    if bzr_log_file is not None:
266
317
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
267
 
    push_log_file(bzr_log_file,
 
318
    memento = push_log_file(bzr_log_file,
268
319
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
269
320
        r'%Y-%m-%d %H:%M:%S')
270
321
    # after hooking output into bzr_log, we also need to attach a stderr
271
322
    # handler, writing only at level info and with encoding
 
323
    term_encoding = osutils.get_terminal_encoding()
272
324
    writer_factory = codecs.getwriter(term_encoding)
273
325
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
274
326
    stderr_handler = logging.StreamHandler(encoded_stderr)
275
327
    stderr_handler.setLevel(logging.INFO)
276
328
    logging.getLogger('bzr').addHandler(stderr_handler)
 
329
    return memento
277
330
 
278
331
 
279
332
def push_log_file(to_file, log_format=None, date_format=None):
315
368
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
316
369
    """Undo changes to logging/tracing done by _push_log_file.
317
370
 
318
 
    This flushes, but does not close the trace file.
 
371
    This flushes, but does not close the trace file (so that anything that was
 
372
    in it is output.
319
373
 
320
374
    Takes the memento returned from _push_log_file."""
321
375
    global _trace_file
322
376
    _trace_file = old_trace_file
323
377
    bzr_logger = logging.getLogger('bzr')
324
378
    bzr_logger.removeHandler(new_handler)
325
 
    # must be closed, otherwise logging will try to close it atexit, and the
 
379
    # must be closed, otherwise logging will try to close it at exit, and the
326
380
    # file will likely already be closed underneath.
327
381
    new_handler.close()
328
382
    bzr_logger.handlers = old_handlers
329
 
    new_trace_file.flush()
 
383
    if new_trace_file is not None:
 
384
        new_trace_file.flush()
330
385
 
331
386
 
332
387
def log_exception_quietly():
347
402
    global _verbosity_level
348
403
    _verbosity_level = level
349
404
    _update_logging_level(level < 0)
 
405
    ui.ui_factory.be_quiet(level < 0)
350
406
 
351
407
 
352
408
def get_verbosity_level():
358
414
 
359
415
 
360
416
def be_quiet(quiet=True):
361
 
    # Perhaps this could be deprecated now ...
362
417
    if quiet:
363
418
        set_verbosity_level(-1)
364
419
    else:
422
477
 
423
478
    :return: The appropriate exit code for this error.
424
479
    """
425
 
    exc_type, exc_object, exc_tb = exc_info
426
480
    # Log the full traceback to ~/.bzr.log
427
481
    log_exception_quietly()
 
482
    if 'error' in debug.debug_flags:
 
483
        print_exception(exc_info, err_file)
 
484
        return errors.EXIT_ERROR
 
485
    exc_type, exc_object, exc_tb = exc_info
428
486
    if (isinstance(exc_object, IOError)
429
487
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
430
488
        err_file.write("bzr: broken pipe\n")
432
490
    elif isinstance(exc_object, KeyboardInterrupt):
433
491
        err_file.write("bzr: interrupted\n")
434
492
        return errors.EXIT_ERROR
 
493
    elif isinstance(exc_object, MemoryError):
 
494
        err_file.write("bzr: out of memory\n")
 
495
        return errors.EXIT_ERROR
435
496
    elif isinstance(exc_object, ImportError) \
436
497
        and str(exc_object).startswith("No module named "):
437
498
        report_user_error(exc_info, err_file,
440
501
    elif not getattr(exc_object, 'internal_error', True):
441
502
        report_user_error(exc_info, err_file)
442
503
        return errors.EXIT_ERROR
443
 
    elif isinstance(exc_object, (OSError, IOError)):
 
504
    elif isinstance(exc_object, (OSError, IOError)) or (
 
505
        # GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
 
506
        exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
444
507
        # Might be nice to catch all of these and show them as something more
445
508
        # specific, but there are too many cases at the moment.
446
509
        report_user_error(exc_info, err_file)
468
531
    :param advice: Extra advice to the user to be printed following the
469
532
        exception.
470
533
    """
471
 
    if 'error' in debug.debug_flags:
472
 
        print_exception(exc_info, err_file)
473
 
        return
474
534
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
475
535
    if advice:
476
536
        err_file.write("%s\n" % (advice,))
478
538
 
479
539
def report_bug(exc_info, err_file):
480
540
    """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
 
""")
 
541
    from bzrlib.crash import report_bug
 
542
    report_bug(exc_info, err_file)
 
543
 
 
544
 
 
545
def _flush_stdout_stderr():
 
546
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
 
547
    try:
 
548
        sys.stdout.flush()
 
549
        sys.stderr.flush()
 
550
    except IOError, e:
 
551
        import errno
 
552
        if e.errno in [errno.EINVAL, errno.EPIPE]:
 
553
            pass
 
554
        else:
 
555
            raise
 
556
 
 
557
 
 
558
def _flush_trace():
 
559
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
 
560
    global _trace_file
 
561
    if _trace_file:
 
562
        _trace_file.flush()
 
563
 
 
564
 
 
565
class Config(object):
 
566
    """Configuration of message tracing in bzrlib.
 
567
 
 
568
    This implements the context manager protocol and should manage any global
 
569
    variables still used. The default config used is DefaultConfig, but
 
570
    embedded uses of bzrlib may wish to use a custom manager.
 
571
    """
 
572
 
 
573
    def __enter__(self):
 
574
        return self # This is bound to the 'as' clause in a with statement.
 
575
 
 
576
    def __exit__(self, exc_type, exc_val, exc_tb):
 
577
        return False # propogate exceptions.
 
578
 
 
579
 
 
580
class DefaultConfig(Config):
 
581
    """A default configuration for tracing of messages in bzrlib.
 
582
 
 
583
    This implements the context manager protocol.
 
584
    """
 
585
 
 
586
    def __enter__(self):
 
587
        self._original_filename = _bzr_log_filename
 
588
        self._original_state = enable_default_logging()
 
589
        return self # This is bound to the 'as' clause in a with statement.
 
590
 
 
591
    def __exit__(self, exc_type, exc_val, exc_tb):
 
592
        pop_log_file(self._original_state)
 
593
        global _bzr_log_filename
 
594
        _bzr_log_filename = self._original_filename
 
595
        return False # propogate exceptions.