~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-06-30 18:28:17 UTC
  • mfrom: (5967.10.2 test-cat)
  • Revision ID: pqm@pqm.ubuntu.com-20110630182817-83a5q9r9rxfkdn8r
(mbp) don't use subprocesses for testing cat (Martin Pool)

Show diffs side-by-side

added added

removed removed

Lines of Context:
45
45
form.
46
46
"""
47
47
 
48
 
from __future__ import absolute_import
49
 
 
50
48
# FIXME: Unfortunately it turns out that python's logging module
51
49
# is quite expensive, even when the message is not printed by any handlers.
52
50
# We should perhaps change back to just simply doing it here.
56
54
# increased cost of logging.py is not so bad, and we could standardize on
57
55
# that.
58
56
 
 
57
import codecs
59
58
import logging
60
59
import os
61
60
import sys
72
71
 
73
72
import bzrlib
74
73
 
 
74
from bzrlib.symbol_versioning import (
 
75
    deprecated_function,
 
76
    deprecated_in,
 
77
    )
 
78
 
75
79
lazy_import(globals(), """
76
80
from bzrlib import (
77
81
    debug,
112
116
 
113
117
    :return: None
114
118
    """
 
119
    # FIXME note always emits utf-8, regardless of the terminal encoding
 
120
    #
115
121
    # FIXME: clearing the ui and then going through the abstract logging
116
122
    # framework is whack; we should probably have a logging Handler that
117
123
    # deals with terminal output if needed.
124
130
    _bzr_logger.warning(*args, **kwargs)
125
131
 
126
132
 
 
133
@deprecated_function(deprecated_in((2, 1, 0)))
 
134
def info(*args, **kwargs):
 
135
    """Deprecated: use trace.note instead."""
 
136
    note(*args, **kwargs)
 
137
 
 
138
 
 
139
@deprecated_function(deprecated_in((2, 1, 0)))
 
140
def log_error(*args, **kwargs):
 
141
    """Deprecated: use bzrlib.trace.show_error instead"""
 
142
    _bzr_logger.error(*args, **kwargs)
 
143
 
 
144
 
 
145
@deprecated_function(deprecated_in((2, 1, 0)))
 
146
def error(*args, **kwargs):
 
147
    """Deprecated: use bzrlib.trace.show_error instead"""
 
148
    _bzr_logger.error(*args, **kwargs)
 
149
 
 
150
 
127
151
def show_error(*args, **kwargs):
128
152
    """Show an error message to the user.
129
153
 
194
218
 
195
219
 
196
220
def _get_bzr_log_filename():
197
 
    bzr_log = osutils.path_from_environ('BZR_LOG')
 
221
    bzr_log = os.environ.get('BZR_LOG')
198
222
    if bzr_log:
199
223
        return bzr_log
200
 
    home = osutils.path_from_environ('BZR_HOME')
 
224
    home = os.environ.get('BZR_HOME')
201
225
    if home is None:
202
 
        # GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
203
 
        #                over what would be better. On windows, bug 240550
204
 
        #                suggests LOCALAPPDATA be used instead.
205
 
        home = osutils._get_home_dir()
 
226
        if sys.platform == 'win32':
 
227
            from bzrlib import win32utils
 
228
            home = win32utils.get_home_location()
 
229
        else:
 
230
            home = os.path.expanduser('~')
206
231
    return os.path.join(home, '.bzr.log')
207
232
 
208
233
 
283
308
    """
284
309
    start_time = osutils.format_local_date(_bzr_log_start_time,
285
310
                                           timezone='local')
 
311
    # create encoded wrapper around stderr
286
312
    bzr_log_file = _open_bzr_log()
287
313
    if bzr_log_file is not None:
288
314
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
291
317
        r'%Y-%m-%d %H:%M:%S')
292
318
    # after hooking output into bzr_log, we also need to attach a stderr
293
319
    # handler, writing only at level info and with encoding
294
 
    stderr_handler = EncodedStreamHandler(sys.stderr,
295
 
        osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
 
320
    term_encoding = osutils.get_terminal_encoding()
 
321
    writer_factory = codecs.getwriter(term_encoding)
 
322
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
 
323
    stderr_handler = logging.StreamHandler(encoded_stderr)
 
324
    stderr_handler.setLevel(logging.INFO)
296
325
    logging.getLogger('bzr').addHandler(stderr_handler)
297
326
    return memento
298
327
 
307
336
    """
308
337
    global _trace_file
309
338
    # make a new handler
310
 
    new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
 
339
    new_handler = logging.StreamHandler(to_file)
 
340
    new_handler.setLevel(logging.DEBUG)
311
341
    if log_format is None:
312
342
        log_format = '%(levelname)8s  %(message)s'
313
343
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
484
514
        print_exception(exc_info, err_file)
485
515
        return errors.EXIT_ERROR
486
516
    exc_type, exc_object, exc_tb = exc_info
487
 
    if isinstance(exc_object, KeyboardInterrupt):
 
517
    if (isinstance(exc_object, IOError)
 
518
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
 
519
        err_file.write("bzr: broken pipe\n")
 
520
        return errors.EXIT_ERROR
 
521
    elif isinstance(exc_object, KeyboardInterrupt):
488
522
        err_file.write("bzr: interrupted\n")
489
523
        return errors.EXIT_ERROR
490
524
    elif isinstance(exc_object, MemoryError):
502
536
    elif not getattr(exc_object, 'internal_error', True):
503
537
        report_user_error(exc_info, err_file)
504
538
        return errors.EXIT_ERROR
505
 
    elif osutils.is_environment_error(exc_object):
506
 
        if getattr(exc_object, 'errno', None) == errno.EPIPE:
507
 
            err_file.write("bzr: broken pipe\n")
508
 
            return errors.EXIT_ERROR
 
539
    elif isinstance(exc_object, (OSError, IOError)) or (
 
540
        # GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
 
541
        exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
509
542
        # Might be nice to catch all of these and show them as something more
510
543
        # specific, but there are too many cases at the moment.
511
544
        report_user_error(exc_info, err_file)
549
582
    try:
550
583
        sys.stdout.flush()
551
584
        sys.stderr.flush()
552
 
    except ValueError, e:
553
 
        # On Windows, I get ValueError calling stdout.flush() on a closed
554
 
        # handle
555
 
        pass
556
585
    except IOError, e:
557
586
        import errno
558
587
        if e.errno in [errno.EINVAL, errno.EPIPE]:
568
597
        _trace_file.flush()
569
598
 
570
599
 
571
 
class EncodedStreamHandler(logging.Handler):
572
 
    """Robustly write logging events to a stream using the specified encoding
573
 
 
574
 
    Messages are expected to be formatted to unicode, but UTF-8 byte strings
575
 
    are also accepted. An error during formatting or a str message in another
576
 
    encoding will be quitely noted as an error in the Bazaar log file.
577
 
 
578
 
    The stream is not closed so sys.stdout or sys.stderr may be passed.
579
 
    """
580
 
 
581
 
    def __init__(self, stream, encoding=None, errors='strict', level=0):
582
 
        logging.Handler.__init__(self, level)
583
 
        self.stream = stream
584
 
        if encoding is None:
585
 
            encoding = getattr(stream, "encoding", "ascii")
586
 
        self.encoding = encoding
587
 
        self.errors = errors
588
 
 
589
 
    def flush(self):
590
 
        flush = getattr(self.stream, "flush", None)
591
 
        if flush is not None:
592
 
            flush()
593
 
 
594
 
    def emit(self, record):
595
 
        try:
596
 
            line = self.format(record)
597
 
            if not isinstance(line, unicode):
598
 
                line = line.decode("utf-8")
599
 
            self.stream.write(line.encode(self.encoding, self.errors) + "\n")
600
 
        except Exception:
601
 
            log_exception_quietly()
602
 
            # Try saving the details that would have been logged in some form
603
 
            msg = args = "<Unformattable>"
604
 
            try:
605
 
                msg = repr(record.msg).encode("ascii")
606
 
                args = repr(record.args).encode("ascii")
607
 
            except Exception:
608
 
                pass
609
 
            # Using mutter() bypasses the logging module and writes directly
610
 
            # to the file so there's no danger of getting into a loop here.
611
 
            mutter("Logging record unformattable: %s %% %s", msg, args)
612
 
 
613
 
 
614
600
class Config(object):
615
601
    """Configuration of message tracing in bzrlib.
616
602