Tools/Scripts/webkitpy/layout_tests/views/metered_stream.py

   1 #!/usr/bin/env python
   2 # Copyright (C) 2010, 2012 Google Inc. All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met:
   7 #
   8 #     * Redistributions of source code must retain the above copyright
   9 # notice, this list of conditions and the following disclaimer.
  10 #     * Redistributions in binary form must reproduce the above
  11 # copyright notice, this list of conditions and the following disclaimer
  12 # in the documentation and/or other materials provided with the
  13 # distribution.
  14 #     * Neither the name of Google Inc. nor the names of its
  15 # contributors may be used to endorse or promote products derived from
  16 # this software without specific prior written permission.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 import logging
  31 import os
  32 import sys
  33 import time
  34
  35
  36 LOG_HANDLER_NAME = 'MeteredStreamLogHandler'
  37
  38
  39 class MeteredStream(object):
  40     """
  41     This class implements a stream wrapper that has 'meters' as well as
  42     regular output. A 'meter' is a single line of text that can be erased
  43     and rewritten repeatedly, without producing multiple lines of output. It
  44     can be used to produce effects like progress bars.
  45     """
  46
  47     @staticmethod
  48     def _erasure(txt):
  49         num_chars = len(txt)
  50         return '\b' * num_chars + ' ' * num_chars + '\b' * num_chars
  51
  52     @staticmethod
  53     def _ensure_newline(txt):
  54         return txt if txt.endswith('\n') else txt + '\n'
  55
  56     def __init__(self, stream=None, verbose=False, logger=None, time_fn=None, pid=None):
  57         self._stream = stream or sys.stderr
  58         self._verbose = verbose
  59         self._time_fn = time_fn or time.time
  60         self._pid = pid or os.getpid()
  61
  62         self._isatty = self._stream.isatty()
  63         self._erasing = self._isatty and not verbose
  64         self._last_partial_line = ''
  65         self._last_write_time = 0.0
  66         self._throttle_delay_in_secs = 0.066 if self._erasing else 10.0
  67
  68         self._logger = logger
  69         self._log_handler = None
  70         if self._logger:
  71             log_level = logging.DEBUG if verbose else logging.INFO
  72             self._log_handler = _LogHandler(self)
  73             self._log_handler.setLevel(log_level)
  74             self._logger.addHandler(self._log_handler)
  75
  76     def __del__(self):
  77         self.cleanup()
  78
  79     def cleanup(self):
  80         if self._logger:
  81             self._logger.removeHandler(self._log_handler)
  82             self._log_handler = None
  83
  84     def write_throttled_update(self, txt):
  85         now = self._time_fn()
  86         if now - self._last_write_time >= self._throttle_delay_in_secs:
  87             self.write_update(txt, now)
  88
  89     def write_update(self, txt, now=None):
  90         self.write(txt, now)
  91         if self._erasing:
  92             self._last_partial_line = txt[txt.rfind('\n') + 1:]
  93
  94     def write(self, txt, now=None):
  95         now = now or self._time_fn()
  96         self._last_write_time = now
  97         if self._last_partial_line:
  98             self._erase_last_partial_line()
  99         if self._verbose:
 100             now_tuple = time.localtime(now)
 101             msg = '%02d:%02d:%02d.%03d %d %s' % (now_tuple.tm_hour, now_tuple.tm_min, now_tuple.tm_sec, int((now * 1000) % 1000), self._pid, self._ensure_newline(txt))
 102         elif self._isatty:
 103             msg = txt
 104         else:
 105             msg = self._ensure_newline(txt)
 106
 107         self._stream.write(msg)
 108
 109     def writeln(self, txt, now=None):
 110         self.write(self._ensure_newline(txt), now)
 111
 112     def _erase_last_partial_line(self):
 113         num_chars = len(self._last_partial_line)
 114         self._stream.write(self._erasure(self._last_partial_line))
 115         self._last_partial_line = ''
 116
 117
 118 class _LogHandler(logging.Handler):
 119     def __init__(self, meter):
 120         logging.Handler.__init__(self)
 121         self._meter = meter
 122         self.name = LOG_HANDLER_NAME
 123
 124     def emit(self, record):
 125         self._meter.writeln(record.msg, record.created)