← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Martin Packman
  • Date: 2012-01-05 09:50:04 UTC
  • mfrom: (6424 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6426.
  • Revision ID: martin.packman@canonical.com-20120105095004-mia9xb7y0efmto0v
Merge bzr.dev to resolve conflicts in bzrlib.builtins

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
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
111
112
 
112
113
    :return: None
113
114
    """
114
 
    # FIXME note always emits utf-8, regardless of the terminal encoding
115
 
    #
116
115
    # FIXME: clearing the ui and then going through the abstract logging
117
116
    # framework is whack; we should probably have a logging Handler that
118
117
    # deals with terminal output if needed.
285
284
    """
286
285
    start_time = osutils.format_local_date(_bzr_log_start_time,
287
286
                                           timezone='local')
288
 
    # create encoded wrapper around stderr
289
287
    bzr_log_file = _open_bzr_log()
290
288
    if bzr_log_file is not None:
291
289
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
294
292
        r'%Y-%m-%d %H:%M:%S')
295
293
    # after hooking output into bzr_log, we also need to attach a stderr
296
294
    # handler, writing only at level info and with encoding
297
 
    term_encoding = osutils.get_terminal_encoding()
298
 
    writer_factory = codecs.getwriter(term_encoding)
299
 
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
300
 
    stderr_handler = logging.StreamHandler(encoded_stderr)
301
 
    stderr_handler.setLevel(logging.INFO)
 
295
    stderr_handler = EncodedStreamHandler(sys.stderr,
 
296
        osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
302
297
    logging.getLogger('bzr').addHandler(stderr_handler)
303
298
    return memento
304
299
 
313
308
    """
314
309
    global _trace_file
315
310
    # make a new handler
316
 
    new_handler = logging.StreamHandler(to_file)
317
 
    new_handler.setLevel(logging.DEBUG)
 
311
    new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
318
312
    if log_format is None:
319
313
        log_format = '%(levelname)8s  %(message)s'
320
314
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
491
485
        print_exception(exc_info, err_file)
492
486
        return errors.EXIT_ERROR
493
487
    exc_type, exc_object, exc_tb = exc_info
494
 
    if (isinstance(exc_object, IOError)
495
 
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
496
 
        err_file.write("bzr: broken pipe\n")
497
 
        return errors.EXIT_ERROR
498
 
    elif isinstance(exc_object, KeyboardInterrupt):
 
488
    if isinstance(exc_object, KeyboardInterrupt):
499
489
        err_file.write("bzr: interrupted\n")
500
490
        return errors.EXIT_ERROR
501
491
    elif isinstance(exc_object, MemoryError):
513
503
    elif not getattr(exc_object, 'internal_error', True):
514
504
        report_user_error(exc_info, err_file)
515
505
        return errors.EXIT_ERROR
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"):
 
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
519
510
        # Might be nice to catch all of these and show them as something more
520
511
        # specific, but there are too many cases at the moment.
521
512
        report_user_error(exc_info, err_file)
559
550
    try:
560
551
        sys.stdout.flush()
561
552
        sys.stderr.flush()
 
553
    except ValueError, e:
 
554
        # On Windows, I get ValueError calling stdout.flush() on a closed
 
555
        # handle
 
556
        pass
562
557
    except IOError, e:
563
558
        import errno
564
559
        if e.errno in [errno.EINVAL, errno.EPIPE]:
574
569
        _trace_file.flush()
575
570
 
576
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
 
577
615
class Config(object):
578
616
    """Configuration of message tracing in bzrlib.
579
617