← 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: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

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-2011 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
67
65
from cStringIO import StringIO
68
66
import errno
69
67
import locale
 
68
import tempfile
70
69
import traceback
71
70
""")
72
71
 
77
76
    debug,
78
77
    errors,
79
78
    osutils,
80
 
    plugin,
81
 
    symbol_versioning,
 
79
    ui,
82
80
    )
83
81
""")
84
82
 
107
105
 
108
106
 
109
107
def note(*args, **kwargs):
 
108
    """Output a note to the user.
 
109
 
 
110
    Takes the same parameters as logging.info.
 
111
 
 
112
    :return: None
 
113
    """
110
114
    # FIXME note always emits utf-8, regardless of the terminal encoding
111
115
    #
112
116
    # FIXME: clearing the ui and then going through the abstract logging
113
117
    # framework is whack; we should probably have a logging Handler that
114
118
    # deals with terminal output if needed.
115
 
    import bzrlib.ui
116
 
    bzrlib.ui.ui_factory.clear_term()
 
119
    ui.ui_factory.clear_term()
117
120
    _bzr_logger.info(*args, **kwargs)
118
121
 
119
122
 
120
123
def warning(*args, **kwargs):
121
 
    import bzrlib.ui
122
 
    bzrlib.ui.ui_factory.clear_term()
 
124
    ui.ui_factory.clear_term()
123
125
    _bzr_logger.warning(*args, **kwargs)
124
126
 
125
127
 
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
 
128
def show_error(*args, **kwargs):
 
129
    """Show an error message to the user.
 
130
 
 
131
    Don't use this for exceptions, use report_exception instead.
 
132
    """
 
133
    _bzr_logger.error(*args, **kwargs)
132
134
 
133
135
 
134
136
def mutter(fmt, *args):
135
137
    if _trace_file is None:
136
138
        return
 
139
    # XXX: Don't check this every time; instead anyone who closes the file
 
140
    # ought to deregister it.  We can tolerate None.
137
141
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
138
142
        return
139
143
 
152
156
        out = fmt % tuple(real_args)
153
157
    else:
154
158
        out = fmt
155
 
    timestamp = '%0.3f  ' % (time.time() - _bzr_log_start_time,)
 
159
    now = time.time()
 
160
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
156
161
    out = timestamp + out + '\n'
157
162
    _trace_file.write(out)
158
 
    # no need to flush here, the trace file is now linebuffered when it's
159
 
    # opened.
 
163
    # there's no explicit flushing; the file is typically line buffered.
160
164
 
161
165
 
162
166
def mutter_callsite(stacklevel, fmt, *args):
205
209
 
206
210
 
207
211
def _open_bzr_log():
208
 
    """Open the .bzr.log trace file.  
 
212
    """Open the .bzr.log trace file.
209
213
 
210
214
    If the log is more than a particular length, the old file is renamed to
211
215
    .bzr.log.old and a new file is started.  Otherwise, we append to the
214
218
    This sets the global _bzr_log_filename.
215
219
    """
216
220
    global _bzr_log_filename
 
221
 
 
222
    def _open_or_create_log_file(filename):
 
223
        """Open existing log file, or create with ownership and permissions
 
224
 
 
225
        It inherits the ownership and permissions (masked by umask) from
 
226
        the containing directory to cope better with being run under sudo
 
227
        with $HOME still set to the user's homedir.
 
228
        """
 
229
        flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
 
230
        while True:
 
231
            try:
 
232
                fd = os.open(filename, flags)
 
233
                break
 
234
            except OSError, e:
 
235
                if e.errno != errno.ENOENT:
 
236
                    raise
 
237
            try:
 
238
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
 
239
            except OSError, e:
 
240
                if e.errno != errno.EEXIST:
 
241
                    raise
 
242
            else:
 
243
                osutils.copy_ownership_from_path(filename)
 
244
                break
 
245
        return os.fdopen(fd, 'at', 0) # unbuffered
 
246
 
 
247
 
217
248
    _bzr_log_filename = _get_bzr_log_filename()
218
249
    _rollover_trace_maybe(_bzr_log_filename)
219
250
    try:
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
 
251
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
222
252
        bzr_log_file.write('\n')
223
253
        if bzr_log_file.tell() <= 2:
224
254
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
225
255
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
226
256
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
 
257
 
227
258
        return bzr_log_file
228
 
    except IOError, e:
229
 
        warning("failed to open trace file: %s" % (e))
 
259
 
 
260
    except EnvironmentError, e:
 
261
        # If we are failing to open the log, then most likely logging has not
 
262
        # been set up yet. So we just write to stderr rather than using
 
263
        # 'warning()'. If we using warning(), users get the unhelpful 'no
 
264
        # handlers registered for "bzr"' when something goes wrong on the
 
265
        # server. (bug #503886)
 
266
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
230
267
    # TODO: What should happen if we fail to open the trace file?  Maybe the
231
268
    # objects should be pointed at /dev/null or the equivalent?  Currently
232
269
    # returns None which will cause failures later.
 
270
    return None
233
271
 
234
272
 
235
273
def enable_default_logging():
236
274
    """Configure default logging: messages to stderr and debug to .bzr.log
237
 
    
 
275
 
238
276
    This should only be called once per process.
239
277
 
240
278
    Non-command-line programs embedding bzrlib do not need to call this.  They
241
279
    can instead either pass a file to _push_log_file, or act directly on
242
280
    logging.getLogger("bzr").
243
 
    
 
281
 
244
282
    Output can be redirected away by calling _push_log_file.
 
283
 
 
284
    :return: A memento from push_log_file for restoring the log state.
245
285
    """
 
286
    start_time = osutils.format_local_date(_bzr_log_start_time,
 
287
                                           timezone='local')
246
288
    # create encoded wrapper around stderr
247
289
    bzr_log_file = _open_bzr_log()
248
 
    push_log_file(bzr_log_file,
 
290
    if bzr_log_file is not None:
 
291
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
 
292
    memento = push_log_file(bzr_log_file,
249
293
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
250
294
        r'%Y-%m-%d %H:%M:%S')
251
295
    # after hooking output into bzr_log, we also need to attach a stderr
252
296
    # handler, writing only at level info and with encoding
253
 
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
 
297
    term_encoding = osutils.get_terminal_encoding()
 
298
    writer_factory = codecs.getwriter(term_encoding)
254
299
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
255
300
    stderr_handler = logging.StreamHandler(encoded_stderr)
256
301
    stderr_handler.setLevel(logging.INFO)
257
302
    logging.getLogger('bzr').addHandler(stderr_handler)
 
303
    return memento
258
304
 
259
305
 
260
306
def push_log_file(to_file, log_format=None, date_format=None):
262
308
 
263
309
    :param to_file: A file-like object to which messages will be sent.
264
310
 
265
 
    :returns: A memento that should be passed to _pop_log_file to restore the 
266
 
    previously active logging.
 
311
    :returns: A memento that should be passed to _pop_log_file to restore the
 
312
        previously active logging.
267
313
    """
268
314
    global _trace_file
269
315
    # make a new handler
296
342
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
297
343
    """Undo changes to logging/tracing done by _push_log_file.
298
344
 
299
 
    This flushes, but does not close the trace file.
300
 
    
 
345
    This flushes, but does not close the trace file (so that anything that was
 
346
    in it is output.
 
347
 
301
348
    Takes the memento returned from _push_log_file."""
302
349
    global _trace_file
303
350
    _trace_file = old_trace_file
304
351
    bzr_logger = logging.getLogger('bzr')
305
352
    bzr_logger.removeHandler(new_handler)
306
 
    # must be closed, otherwise logging will try to close it atexit, and the
 
353
    # must be closed, otherwise logging will try to close it at exit, and the
307
354
    # file will likely already be closed underneath.
308
355
    new_handler.close()
309
356
    bzr_logger.handlers = old_handlers
310
 
    new_trace_file.flush()
311
 
 
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)
 
357
    if new_trace_file is not None:
 
358
        new_trace_file.flush()
326
359
 
327
360
 
328
361
def log_exception_quietly():
329
362
    """Log the last exception to the trace file only.
330
363
 
331
 
    Used for exceptions that occur internally and that may be 
332
 
    interesting to developers but not to users.  For example, 
 
364
    Used for exceptions that occur internally and that may be
 
365
    interesting to developers but not to users.  For example,
333
366
    errors loading plugins.
334
367
    """
335
368
    mutter(traceback.format_exc())
343
376
    global _verbosity_level
344
377
    _verbosity_level = level
345
378
    _update_logging_level(level < 0)
 
379
    ui.ui_factory.be_quiet(level < 0)
346
380
 
347
381
 
348
382
def get_verbosity_level():
354
388
 
355
389
 
356
390
def be_quiet(quiet=True):
357
 
    # Perhaps this could be deprecated now ...
358
391
    if quiet:
359
392
        set_verbosity_level(-1)
360
393
    else:
379
412
    return _verbosity_level > 0
380
413
 
381
414
 
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
389
 
 
390
 
 
391
 
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
392
 
 
393
415
def debug_memory(message='', short=True):
394
416
    """Write out a memory dump."""
 
417
    if sys.platform == 'win32':
 
418
        from bzrlib import win32utils
 
419
        win32utils.debug_memory_win32api(message=message, short=short)
 
420
    else:
 
421
        _debug_memory_proc(message=message, short=short)
 
422
 
 
423
 
 
424
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
 
425
 
 
426
def _debug_memory_proc(message='', short=True):
395
427
    try:
396
428
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
397
429
    except IOError:
411
443
                    note(line)
412
444
                    break
413
445
 
 
446
def _dump_memory_usage(err_file):
 
447
    try:
 
448
        try:
 
449
            fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
 
450
            dump_file = os.fdopen(fd, 'w')
 
451
            from meliae import scanner
 
452
            scanner.dump_gc_objects(dump_file)
 
453
            err_file.write("Memory dumped to %s\n" % name)
 
454
        except ImportError:
 
455
            err_file.write("Dumping memory requires meliae module.\n")
 
456
            log_exception_quietly()
 
457
        except:
 
458
            err_file.write("Exception while dumping memory.\n")
 
459
            log_exception_quietly()
 
460
    finally:
 
461
        if dump_file is not None:
 
462
            dump_file.close()
 
463
        elif fd is not None:
 
464
            os.close(fd)
 
465
 
 
466
 
 
467
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
 
468
    """Give name of error class including module for non-builtin exceptions
 
469
 
 
470
    If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
 
471
    also omit the module prefix.
 
472
    """
 
473
    class_name = eclass.__name__
 
474
    module_name = eclass.__module__
 
475
    if module_name in ("exceptions", "__main__") or (
 
476
            unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
 
477
        return class_name
 
478
    return "%s.%s" % (module_name, class_name)
 
479
 
414
480
 
415
481
def report_exception(exc_info, err_file):
416
482
    """Report an exception to err_file (typically stderr) and to .bzr.log.
419
485
 
420
486
    :return: The appropriate exit code for this error.
421
487
    """
422
 
    exc_type, exc_object, exc_tb = exc_info
423
488
    # Log the full traceback to ~/.bzr.log
424
489
    log_exception_quietly()
 
490
    if 'error' in debug.debug_flags:
 
491
        print_exception(exc_info, err_file)
 
492
        return errors.EXIT_ERROR
 
493
    exc_type, exc_object, exc_tb = exc_info
425
494
    if (isinstance(exc_object, IOError)
426
495
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
427
496
        err_file.write("bzr: broken pipe\n")
429
498
    elif isinstance(exc_object, KeyboardInterrupt):
430
499
        err_file.write("bzr: interrupted\n")
431
500
        return errors.EXIT_ERROR
 
501
    elif isinstance(exc_object, MemoryError):
 
502
        err_file.write("bzr: out of memory\n")
 
503
        if 'mem_dump' in debug.debug_flags:
 
504
            _dump_memory_usage(err_file)
 
505
        else:
 
506
            err_file.write("Use -Dmem_dump to dump memory to a file.\n")
 
507
        return errors.EXIT_ERROR
432
508
    elif isinstance(exc_object, ImportError) \
433
509
        and str(exc_object).startswith("No module named "):
434
510
        report_user_error(exc_info, err_file,
437
513
    elif not getattr(exc_object, 'internal_error', True):
438
514
        report_user_error(exc_info, err_file)
439
515
        return errors.EXIT_ERROR
440
 
    elif isinstance(exc_object, (OSError, IOError)):
 
516
    elif isinstance(exc_object, (OSError, IOError)) or (
 
517
        # GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
 
518
        exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
441
519
        # Might be nice to catch all of these and show them as something more
442
520
        # specific, but there are too many cases at the moment.
443
521
        report_user_error(exc_info, err_file)
465
543
    :param advice: Extra advice to the user to be printed following the
466
544
        exception.
467
545
    """
468
 
    if 'error' in debug.debug_flags:
469
 
        print_exception(exc_info, err_file)
470
 
        return
471
546
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
472
547
    if advice:
473
548
        err_file.write("%s\n" % (advice,))
475
550
 
476
551
def report_bug(exc_info, err_file):
477
552
    """Report an exception that probably indicates a bug in bzr"""
478
 
    print_exception(exc_info, err_file)
479
 
    err_file.write('\n')
480
 
    err_file.write('bzr %s on python %s (%s)\n' % \
481
 
                       (bzrlib.__version__,
482
 
                        bzrlib._format_version_tuple(sys.version_info),
483
 
                        sys.platform))
484
 
    err_file.write('arguments: %r\n' % sys.argv)
485
 
    err_file.write(
486
 
        'encoding: %r, fsenc: %r, lang: %r\n' % (
487
 
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
488
 
            os.environ.get('LANG')))
489
 
    err_file.write("plugins:\n")
490
 
    for name, a_plugin in sorted(plugin.plugins().items()):
491
 
        err_file.write("  %-20s %s [%s]\n" %
492
 
            (name, a_plugin.path(), a_plugin.__version__))
493
 
    err_file.write(
494
 
"""\
495
 
*** Bazaar has encountered an internal error.
496
 
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
497
 
    including this traceback, and a description of what you
498
 
    were doing when the error occurred.
499
 
""")
 
553
    from bzrlib.crash import report_bug
 
554
    report_bug(exc_info, err_file)
 
555
 
 
556
 
 
557
def _flush_stdout_stderr():
 
558
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
 
559
    try:
 
560
        sys.stdout.flush()
 
561
        sys.stderr.flush()
 
562
    except IOError, e:
 
563
        import errno
 
564
        if e.errno in [errno.EINVAL, errno.EPIPE]:
 
565
            pass
 
566
        else:
 
567
            raise
 
568
 
 
569
 
 
570
def _flush_trace():
 
571
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
 
572
    global _trace_file
 
573
    if _trace_file:
 
574
        _trace_file.flush()
 
575
 
 
576
 
 
577
class Config(object):
 
578
    """Configuration of message tracing in bzrlib.
 
579
 
 
580
    This implements the context manager protocol and should manage any global
 
581
    variables still used. The default config used is DefaultConfig, but
 
582
    embedded uses of bzrlib may wish to use a custom manager.
 
583
    """
 
584
 
 
585
    def __enter__(self):
 
586
        return self # This is bound to the 'as' clause in a with statement.
 
587
 
 
588
    def __exit__(self, exc_type, exc_val, exc_tb):
 
589
        return False # propogate exceptions.
 
590
 
 
591
 
 
592
class DefaultConfig(Config):
 
593
    """A default configuration for tracing of messages in bzrlib.
 
594
 
 
595
    This implements the context manager protocol.
 
596
    """
 
597
 
 
598
    def __enter__(self):
 
599
        self._original_filename = _bzr_log_filename
 
600
        self._original_state = enable_default_logging()
 
601
        return self # This is bound to the 'as' clause in a with statement.
 
602
 
 
603
    def __exit__(self, exc_type, exc_val, exc_tb):
 
604
        pop_log_file(self._original_state)
 
605
        global _bzr_log_filename
 
606
        _bzr_log_filename = self._original_filename
 
607
        return False # propogate exceptions.