summaryrefslogtreecommitdiffstats
path: root/nova/process.py
diff options
context:
space:
mode:
authorJustin Santa Barbara <justinsb@justinsb-desktop>2010-08-08 12:57:33 -0700
committerJustin Santa Barbara <justinsb@justinsb-desktop>2010-08-08 12:57:33 -0700
commit0ee7d2f74a959bcf1cf611f63842302866774475 (patch)
treed4c9b97b111e0180dbc6c6a27be0f939aa462312 /nova/process.py
parent9b6f4346b575d9a20d94293e9352a7c09a8d2a7a (diff)
downloadnova-0ee7d2f74a959bcf1cf611f63842302866774475.tar.gz
nova-0ee7d2f74a959bcf1cf611f63842302866774475.tar.xz
nova-0ee7d2f74a959bcf1cf611f63842302866774475.zip
Greater compliance with pep8/pylint style checks
Diffstat (limited to 'nova/process.py')
-rw-r--r--nova/process.py108
1 files changed, 55 insertions, 53 deletions
diff --git a/nova/process.py b/nova/process.py
index 9e9de2ee8..37ab538ee 100644
--- a/nova/process.py
+++ b/nova/process.py
@@ -2,6 +2,7 @@
# Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
+# Copyright 2010 FathomDB Inc.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -20,16 +21,11 @@
Process pool, still buggy right now.
"""
-import logging
-import multiprocessing
import StringIO
from twisted.internet import defer
from twisted.internet import error
-from twisted.internet import process
from twisted.internet import protocol
from twisted.internet import reactor
-from twisted.internet import threads
-from twisted.python import failure
from nova import flags
@@ -54,8 +50,9 @@ class UnexpectedErrorOutput(IOError):
IOError.__init__(self, "got stdout: %r\nstderr: %r" % (stdout, stderr))
-# This is based on _BackRelay from twister.internal.utils, but modified to capture
-# both stdout and stderr without odd stderr handling, and also to handle stdin
+# This is based on _BackRelay from twister.internal.utils, but modified to
+# capture both stdout and stderr, without odd stderr handling, and also to
+# handle stdin
class BackRelayWithInput(protocol.ProcessProtocol):
"""
Trivial protocol for communicating with a process and turning its output
@@ -67,35 +64,37 @@ class BackRelayWithInput(protocol.ProcessProtocol):
L{_UnexpectedErrorOutput} instance and the attribute will be set to
C{None}.
- @ivar onProcessEnded: If C{terminate_on_stderr} is false and bytes are received over
- stderr, this attribute will refer to a L{Deferred} which will be called
- back when the process ends. This C{Deferred} is also associated with
- the L{_UnexpectedErrorOutput} which C{deferred} fires with earlier in
- this case so that users can determine when the process has actually
- ended, in addition to knowing when bytes have been received via stderr.
+ @ivar onProcessEnded: If C{terminate_on_stderr} is false and bytes are
+ received over stderr, this attribute will refer to a L{Deferred} which
+ will be called back when the process ends. This C{Deferred} is also
+ associated with the L{_UnexpectedErrorOutput} which C{deferred} fires
+ with earlier in this case so that users can determine when the process
+ has actually ended, in addition to knowing when bytes have been received
+ via stderr.
"""
- def __init__(self, deferred, startedDeferred=None, terminate_on_stderr=False,
- check_exit_code=True, input=None):
+ def __init__(self, deferred, started_deferred=None,
+ terminate_on_stderr=False, check_exit_code=True,
+ process_input=None):
self.deferred = deferred
self.stdout = StringIO.StringIO()
self.stderr = StringIO.StringIO()
- self.startedDeferred = startedDeferred
+ self.started_deferred = started_deferred
self.terminate_on_stderr = terminate_on_stderr
self.check_exit_code = check_exit_code
- self.input = input
+ self.process_input = process_input
+ self.on_process_ended = None
def errReceived(self, text):
- self.sterr.write(text)
+ self.stderr.write(text)
if self.terminate_on_stderr and (self.deferred is not None):
- self.onProcessEnded = defer.Deferred()
- self.deferred.errback(UnexpectedErrorOutput(stdout=self.stdout.getvalue(), stderr=self.stderr.getvalue()))
+ self.on_process_ended = defer.Deferred()
+ self.deferred.errback(UnexpectedErrorOutput(
+ stdout=self.stdout.getvalue(),
+ stderr=self.stderr.getvalue()))
self.deferred = None
self.transport.loseConnection()
- def errReceived(self, text):
- self.stderr.write(text)
-
def outReceived(self, text):
self.stdout.write(text)
@@ -107,37 +106,40 @@ class BackRelayWithInput(protocol.ProcessProtocol):
reason.trap(error.ProcessDone)
self.deferred.callback((stdout, stderr))
except:
- # This logic is a little suspicious to me (justinsb)...
- # If the callback throws an exception, then errback will be called also.
- # However, this is what the unit tests test for...
+ # NOTE(justinsb): This logic is a little suspicious to me...
+ # If the callback throws an exception, then errback will be
+ # called also. However, this is what the unit tests test for...
self.deferred.errback(UnexpectedErrorOutput(stdout, stderr))
- elif self.onProcessEnded is not None:
- self.onProcessEnded.errback(reason)
+ elif self.on_process_ended is not None:
+ self.on_process_ended.errback(reason)
def connectionMade(self):
- if self.startedDeferred:
- self.startedDeferred.callback(self)
- if self.input:
- self.transport.write(self.input)
+ if self.started_deferred:
+ self.started_deferred.callback(self)
+ if self.process_input:
+ self.transport.write(self.process_input)
self.transport.closeStdin()
-def getProcessOutput(executable, args=None, env=None, path=None, reactor=None,
- check_exit_code=True, input=None, startedDeferred=None):
- if reactor is None:
- from twisted.internet import reactor
+def get_process_output(executable, args=None, env=None, path=None,
+ process_reactor=None, check_exit_code=True,
+ process_input=None, started_deferred=None):
+ if process_reactor is None:
+ process_reactor = reactor
args = args and args or ()
env = env and env and {}
- d = defer.Deferred()
- p = BackRelayWithInput(
- d, startedDeferred=startedDeferred, check_exit_code=check_exit_code, input=input)
+ deferred = defer.Deferred()
+ process_handler = BackRelayWithInput(
+ deferred, started_deferred=started_deferred,
+ check_exit_code=check_exit_code, process_input=process_input)
# NOTE(vish): commands come in as unicode, but self.executes needs
# strings or process.spawn raises a deprecation warning
executable = str(executable)
if not args is None:
args = [str(x) for x in args]
- reactor.spawnProcess(p, executable, (executable,)+tuple(args), env, path)
- return d
+ process_reactor.spawnProcess( process_handler, executable,
+ (executable,)+tuple(args), env, path)
+ return deferred
class ProcessPool(object):
@@ -163,26 +165,26 @@ class ProcessPool(object):
return self.execute(executable, args, **kw)
def execute(self, *args, **kw):
- d = self._pool.acquire()
+ deferred = self._pool.acquire()
- def _associateProcess(proto):
- d.process = proto.transport
+ def _associate_process(proto):
+ deferred.process = proto.transport
return proto.transport
started = defer.Deferred()
- started.addCallback(_associateProcess)
- kw.setdefault('startedDeferred', started)
+ started.addCallback(_associate_process)
+ kw.setdefault('started_deferred', started)
- d.process = None
- d.started = started
+ deferred.process = None
+ deferred.started = started
- d.addCallback(lambda _: getProcessOutput(*args, **kw))
- d.addBoth(self._release)
- return d
+ deferred.addCallback(lambda _: get_process_output(*args, **kw))
+ deferred.addBoth(self._release)
+ return deferred
- def _release(self, rv=None):
+ def _release(self, retval=None):
self._pool.release()
- return rv
+ return retval
class SharedPool(object):
_instance = None