Refactor nag functionality in to NagTimer class.

gclient_utils.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Generic utils."""
 
 import codecs
 import logging
 import os
 import Queue
@@ skipping 307 matching lines @@
 
 
 def MakeFileAnnotated(fileobj, include_zero=False):
   if getattr(fileobj, 'annotated', None):
     return fileobj
   return Annotated(fileobj)
 
 
 def CheckCallAndFilter(args, stdout=None, filter_fn=None,
                        print_stdout=None, call_filter_on_first_line=False,
-                       **kwargs):
+                       nag_timer=None, nag_max=None, **kwargs):
   """Runs a command and calls back a filter function if needed.
 
   Accepts all subprocess2.Popen() parameters plus:
     print_stdout: If True, the command's stdout is forwarded to stdout.
     filter_fn: A function taking a single string argument called with each line
                of the subprocess2's output. Each line has the trailing newline
                character trimmed.
     stdout: Can be any bufferable output.
 
   stderr is always redirected to stdout.
   """
   assert print_stdout or filter_fn
   stdout = stdout or sys.stdout
   filter_fn = filter_fn or (lambda x: None)
   kid = subprocess2.Popen(
       args, bufsize=0, stdout=subprocess2.PIPE, stderr=subprocess2.STDOUT,
       **kwargs)
 
   # Do a flush of stdout before we begin reading from the subprocess2's stdout
   stdout.flush()
 
+  nag = None
+  if nag_timer:
+    # Hack thread.index to force correct annotation.
+    index = getattr(threading.currentThread(), 'index', 0)
+    def _nag_cb(elapsed):
+      setattr(threading.currentThread(), 'index', index)
+      stdout.write('  No output for %.0f seconds from command:\n' % elapsed)
+      stdout.write('    %s\n' % kid.cmd_str)
+      if (nag_max and
+          int('%.0f' % (elapsed / nag_timer)) >= nag_max):
+        stdout.write('  ... killing it!\n')
+        kid.kill()
+    nag = subprocess2.NagTimer(nag_timer, _nag_cb)
+    nag.start()
+
   # Also, we need to forward stdout to prevent weird re-ordering of output.
   # This has to be done on a per byte basis to make sure it is not buffered:
   # normally buffering is done for each line, but if svn requests input, no
   # end-of-line character is output after the prompt and it would not show up.
   try:
     in_byte = kid.stdout.read(1)
     if in_byte:
+      if nag:
+        nag.event()
       if call_filter_on_first_line:
         filter_fn(None)
       in_line = ''
       while in_byte:
         if in_byte != '\r':
           if print_stdout:
             stdout.write(in_byte)
           if in_byte != '\n':
             in_line += in_byte
           else:
             filter_fn(in_line)
             in_line = ''
         else:
           filter_fn(in_line)
           in_line = ''
         in_byte = kid.stdout.read(1)
+        if in_byte and nag:
+          nag.event()
       # Flush the rest of buffered output. This is only an issue with
       # stdout/stderr not ending with a \n.
       if len(in_line):
         filter_fn(in_line)
     rv = kid.wait()
   except KeyboardInterrupt:
     print >> sys.stderr, 'Failed while running "%s"' % ' '.join(args)
     raise
+  finally:
+    if nag:
+      nag.cancel()
 
   if rv:
     raise subprocess2.CalledProcessError(
         rv, args, kwargs.get('cwd', None), None, None)
   return 0
 
 
 def FindGclientRoot(from_dir, filename='.gclient'):
   """Tries to find the gclient root."""
   real_from_dir = os.path.realpath(from_dir)
@@ skipping 373 matching lines @@
 
   Python on OSX 10.6 raises a NotImplementedError exception.
   """
   try:
     import multiprocessing
     return multiprocessing.cpu_count()
   except:  # pylint: disable=W0702
     # Mac OS 10.6 only
     # pylint: disable=E1101
     return int(os.sysconf('SC_NPROCESSORS_ONLN'))