/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

(jelmer) Convert bzrlib.smtp_connection to use config stacks. (Jelmer
 Vernooij)

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-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
45
45
form.
46
46
"""
47
47
 
 
48
from __future__ import absolute_import
 
49
 
48
50
# FIXME: Unfortunately it turns out that python's logging module
49
51
# is quite expensive, even when the message is not printed by any handlers.
50
52
# We should perhaps change back to just simply doing it here.
54
56
# increased cost of logging.py is not so bad, and we could standardize on
55
57
# that.
56
58
 
57
 
import codecs
58
59
import logging
59
60
import os
60
61
import sys
65
66
from cStringIO import StringIO
66
67
import errno
67
68
import locale
 
69
import tempfile
68
70
import traceback
69
71
""")
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,
81
78
    errors,
82
79
    osutils,
83
 
    plugin,
84
 
    symbol_versioning,
85
80
    ui,
86
81
    )
87
82
""")
117
112
 
118
113
    :return: None
119
114
    """
120
 
    # FIXME note always emits utf-8, regardless of the terminal encoding
121
 
    #
122
115
    # FIXME: clearing the ui and then going through the abstract logging
123
116
    # framework is whack; we should probably have a logging Handler that
124
117
    # deals with terminal output if needed.
125
 
    import bzrlib.ui
126
 
    bzrlib.ui.ui_factory.clear_term()
 
118
    ui.ui_factory.clear_term()
127
119
    _bzr_logger.info(*args, **kwargs)
128
120
 
129
121
 
130
122
def warning(*args, **kwargs):
131
 
    import bzrlib.ui
132
 
    bzrlib.ui.ui_factory.clear_term()
 
123
    ui.ui_factory.clear_term()
133
124
    _bzr_logger.warning(*args, **kwargs)
134
125
 
135
126
 
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
127
def show_error(*args, **kwargs):
155
128
    """Show an error message to the user.
156
129
 
306
279
    logging.getLogger("bzr").
307
280
 
308
281
    Output can be redirected away by calling _push_log_file.
 
282
 
 
283
    :return: A memento from push_log_file for restoring the log state.
309
284
    """
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
285
    start_time = osutils.format_local_date(_bzr_log_start_time,
314
286
                                           timezone='local')
315
 
    # create encoded wrapper around stderr
316
287
    bzr_log_file = _open_bzr_log()
317
288
    if bzr_log_file is not None:
318
289
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
319
 
    push_log_file(bzr_log_file,
 
290
    memento = push_log_file(bzr_log_file,
320
291
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
292
        r'%Y-%m-%d %H:%M:%S')
322
293
    # after hooking output into bzr_log, we also need to attach a stderr
323
294
    # handler, writing only at level info and with encoding
324
 
    writer_factory = codecs.getwriter(term_encoding)
325
 
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
 
    stderr_handler = logging.StreamHandler(encoded_stderr)
327
 
    stderr_handler.setLevel(logging.INFO)
 
295
    stderr_handler = EncodedStreamHandler(sys.stderr,
 
296
        osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
328
297
    logging.getLogger('bzr').addHandler(stderr_handler)
 
298
    return memento
329
299
 
330
300
 
331
301
def push_log_file(to_file, log_format=None, date_format=None):
334
304
    :param to_file: A file-like object to which messages will be sent.
335
305
 
336
306
    :returns: A memento that should be passed to _pop_log_file to restore the
337
 
    previously active logging.
 
307
        previously active logging.
338
308
    """
339
309
    global _trace_file
340
310
    # make a new handler
341
 
    new_handler = logging.StreamHandler(to_file)
342
 
    new_handler.setLevel(logging.DEBUG)
 
311
    new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
343
312
    if log_format is None:
344
313
        log_format = '%(levelname)8s  %(message)s'
345
314
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
367
336
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
368
337
    """Undo changes to logging/tracing done by _push_log_file.
369
338
 
370
 
    This flushes, but does not close the trace file.
 
339
    This flushes, but does not close the trace file (so that anything that was
 
340
    in it is output.
371
341
 
372
342
    Takes the memento returned from _push_log_file."""
373
343
    global _trace_file
374
344
    _trace_file = old_trace_file
375
345
    bzr_logger = logging.getLogger('bzr')
376
346
    bzr_logger.removeHandler(new_handler)
377
 
    # must be closed, otherwise logging will try to close it atexit, and the
 
347
    # must be closed, otherwise logging will try to close it at exit, and the
378
348
    # file will likely already be closed underneath.
379
349
    new_handler.close()
380
350
    bzr_logger.handlers = old_handlers
381
 
    new_trace_file.flush()
 
351
    if new_trace_file is not None:
 
352
        new_trace_file.flush()
382
353
 
383
354
 
384
355
def log_exception_quietly():
466
437
                    note(line)
467
438
                    break
468
439
 
 
440
def _dump_memory_usage(err_file):
 
441
    try:
 
442
        try:
 
443
            fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
 
444
            dump_file = os.fdopen(fd, 'w')
 
445
            from meliae import scanner
 
446
            scanner.dump_gc_objects(dump_file)
 
447
            err_file.write("Memory dumped to %s\n" % name)
 
448
        except ImportError:
 
449
            err_file.write("Dumping memory requires meliae module.\n")
 
450
            log_exception_quietly()
 
451
        except:
 
452
            err_file.write("Exception while dumping memory.\n")
 
453
            log_exception_quietly()
 
454
    finally:
 
455
        if dump_file is not None:
 
456
            dump_file.close()
 
457
        elif fd is not None:
 
458
            os.close(fd)
 
459
 
 
460
 
 
461
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
 
462
    """Give name of error class including module for non-builtin exceptions
 
463
 
 
464
    If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
 
465
    also omit the module prefix.
 
466
    """
 
467
    class_name = eclass.__name__
 
468
    module_name = eclass.__module__
 
469
    if module_name in ("exceptions", "__main__") or (
 
470
            unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
 
471
        return class_name
 
472
    return "%s.%s" % (module_name, class_name)
 
473
 
469
474
 
470
475
def report_exception(exc_info, err_file):
471
476
    """Report an exception to err_file (typically stderr) and to .bzr.log.
480
485
        print_exception(exc_info, err_file)
481
486
        return errors.EXIT_ERROR
482
487
    exc_type, exc_object, exc_tb = exc_info
483
 
    if (isinstance(exc_object, IOError)
484
 
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
485
 
        err_file.write("bzr: broken pipe\n")
486
 
        return errors.EXIT_ERROR
487
 
    elif isinstance(exc_object, KeyboardInterrupt):
 
488
    if isinstance(exc_object, KeyboardInterrupt):
488
489
        err_file.write("bzr: interrupted\n")
489
490
        return errors.EXIT_ERROR
490
491
    elif isinstance(exc_object, MemoryError):
491
492
        err_file.write("bzr: out of memory\n")
 
493
        if 'mem_dump' in debug.debug_flags:
 
494
            _dump_memory_usage(err_file)
 
495
        else:
 
496
            err_file.write("Use -Dmem_dump to dump memory to a file.\n")
492
497
        return errors.EXIT_ERROR
493
498
    elif isinstance(exc_object, ImportError) \
494
499
        and str(exc_object).startswith("No module named "):
498
503
    elif not getattr(exc_object, 'internal_error', True):
499
504
        report_user_error(exc_info, err_file)
500
505
        return errors.EXIT_ERROR
501
 
    elif isinstance(exc_object, (OSError, IOError)):
 
506
    elif osutils.is_environment_error(exc_object):
 
507
        if getattr(exc_object, 'errno', None) == errno.EPIPE:
 
508
            err_file.write("bzr: broken pipe\n")
 
509
            return errors.EXIT_ERROR
502
510
        # Might be nice to catch all of these and show them as something more
503
511
        # specific, but there are too many cases at the moment.
504
512
        report_user_error(exc_info, err_file)
538
546
 
539
547
 
540
548
def _flush_stdout_stderr():
541
 
    # installed into an atexit hook by bzrlib.initialize()
 
549
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
542
550
    try:
543
551
        sys.stdout.flush()
544
552
        sys.stderr.flush()
 
553
    except ValueError, e:
 
554
        # On Windows, I get ValueError calling stdout.flush() on a closed
 
555
        # handle
 
556
        pass
545
557
    except IOError, e:
546
558
        import errno
547
559
        if e.errno in [errno.EINVAL, errno.EPIPE]:
551
563
 
552
564
 
553
565
def _flush_trace():
554
 
    # run from atexit hook
 
566
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
555
567
    global _trace_file
556
568
    if _trace_file:
557
569
        _trace_file.flush()
 
570
 
 
571
 
 
572
class EncodedStreamHandler(logging.Handler):
 
573
    """Robustly write logging events to a stream using the specified encoding
 
574
 
 
575
    Messages are expected to be formatted to unicode, but UTF-8 byte strings
 
576
    are also accepted. An error during formatting or a str message in another
 
577
    encoding will be quitely noted as an error in the Bazaar log file.
 
578
 
 
579
    The stream is not closed so sys.stdout or sys.stderr may be passed.
 
580
    """
 
581
 
 
582
    def __init__(self, stream, encoding=None, errors='strict', level=0):
 
583
        logging.Handler.__init__(self, level)
 
584
        self.stream = stream
 
585
        if encoding is None:
 
586
            encoding = getattr(stream, "encoding", "ascii")
 
587
        self.encoding = encoding
 
588
        self.errors = errors
 
589
 
 
590
    def flush(self):
 
591
        flush = getattr(self.stream, "flush", None)
 
592
        if flush is not None:
 
593
            flush()
 
594
 
 
595
    def emit(self, record):
 
596
        try:
 
597
            line = self.format(record)
 
598
            if not isinstance(line, unicode):
 
599
                line = line.decode("utf-8")
 
600
            self.stream.write(line.encode(self.encoding, self.errors) + "\n")
 
601
        except Exception:
 
602
            log_exception_quietly()
 
603
            # Try saving the details that would have been logged in some form
 
604
            msg = args = "<Unformattable>"
 
605
            try:
 
606
                msg = repr(record.msg).encode("ascii")
 
607
                args = repr(record.args).encode("ascii")
 
608
            except Exception:
 
609
                pass
 
610
            # Using mutter() bypasses the logging module and writes directly
 
611
            # to the file so there's no danger of getting into a loop here.
 
612
            mutter("Logging record unformattable: %s %% %s", msg, args)
 
613
 
 
614
 
 
615
class Config(object):
 
616
    """Configuration of message tracing in bzrlib.
 
617
 
 
618
    This implements the context manager protocol and should manage any global
 
619
    variables still used. The default config used is DefaultConfig, but
 
620
    embedded uses of bzrlib may wish to use a custom manager.
 
621
    """
 
622
 
 
623
    def __enter__(self):
 
624
        return self # This is bound to the 'as' clause in a with statement.
 
625
 
 
626
    def __exit__(self, exc_type, exc_val, exc_tb):
 
627
        return False # propogate exceptions.
 
628
 
 
629
 
 
630
class DefaultConfig(Config):
 
631
    """A default configuration for tracing of messages in bzrlib.
 
632
 
 
633
    This implements the context manager protocol.
 
634
    """
 
635
 
 
636
    def __enter__(self):
 
637
        self._original_filename = _bzr_log_filename
 
638
        self._original_state = enable_default_logging()
 
639
        return self # This is bound to the 'as' clause in a with statement.
 
640
 
 
641
    def __exit__(self, exc_type, exc_val, exc_tb):
 
642
        pop_log_file(self._original_state)
 
643
        global _bzr_log_filename
 
644
        _bzr_log_filename = self._original_filename
 
645
        return False # propogate exceptions.