From 0de7b6932380d360e8ba55eaf87f2ac04cdd02a3 Mon Sep 17 00:00:00 2001 From: Tim McNamara Date: Sat, 14 Aug 2010 20:59:01 +0000 Subject: Whitespace Removed unnecessary whitespace. --- diff --git a/Experior.Activity/sbrpcserver.py b/Experior.Activity/sbrpcserver.py index 99514ba..cdbf602 100755 --- a/Experior.Activity/sbrpcserver.py +++ b/Experior.Activity/sbrpcserver.py @@ -36,11 +36,11 @@ except ImportError: def proxyString(): return "http://%s:%s/" % (host, str(port)) - + def rebuildMarshalledObject(obj, dictionary): for key in dictionary: setattr(obj, key, dictionary[key]) - + class sugarbotSession(): def __init__(self,ID=0): self.id = ID @@ -50,27 +50,27 @@ class sugarbotSession(): self.scriptName = "" self.failureText = {} # self.log = logging.getLogger("%s" % ID) - + def getSuccessValue(self): retval = 0 - + failed = [self.responses[k] for k in self.responses if not self.responses[k]] if failed: retval = 1 return retval - + log = property(lambda self: logging.getLogger(str(self.id))) - + class sbRpcServer(SimpleXMLRPCServer): """ Sugarbot RPC Server - + Responsible for listening on the XML-RPC port (defined as sbconfig.port). The object loads the scripts provided on the command-line as individual text lines. It then provides those lines of text over XML-RPC to the XML-RPC client. The client is responsible for parsing the lines into meaningful objects/functions. - + The list of files, as well as each file's contents, are kept entirely in memory. This may lead to issues in the future with particularly large script files, but this is currently not a problem. @@ -82,7 +82,7 @@ class sbRpcServer(SimpleXMLRPCServer): if xmlport is None: xmlport = random.randint(1024,65000) self.port = xmlport - + # Create the RPC server SimpleXMLRPCServer.__init__(self, (host, xmlport), allow_none=True, logRequests=False) @@ -93,10 +93,10 @@ class sbRpcServer(SimpleXMLRPCServer): # A listing of the filenames for each script self.listOfScripts = [] - + # Keep list of all of the clients self.clients = {0: sugarbotSession(0)} - + # Misc other stuffs... self.kill = kill self.restart = restart @@ -104,13 +104,13 @@ class sbRpcServer(SimpleXMLRPCServer): for script in scripts: self.addScript(script) - + # Register all of the functions so that callers can use them self.registerFunctions() - + # Initialize the random seed for generating client ID's self.initRandomSeed() - + def testConnectivity(self): """ This function exists so that the client can test the connection to the @@ -120,7 +120,7 @@ class sbRpcServer(SimpleXMLRPCServer): about screwing with the internal state of other stuff. """ pass - + def initRandomSeed(self): """ Initializes the random seed using os.urandom. @@ -132,13 +132,13 @@ class sbRpcServer(SimpleXMLRPCServer): except NotImplementedError: seed = time.time() random.seed(seed) - + def generateSessionID(self): """ In the event a client does not specify an identifier, provide one. """ return random.randint(0, sys.maxint) - + def initializeLogging(self): """ Initialize logging for the sbRpcServer object. This provides logging @@ -162,7 +162,7 @@ class sbRpcServer(SimpleXMLRPCServer): logging.getLogger('').addHandler(console) return logging.getLogger('sbRpcServer') - + def registerFunctions(self): """ Register the functions for use with the XML server. @@ -177,7 +177,7 @@ class sbRpcServer(SimpleXMLRPCServer): self.register_function(self.getRestartFlag) self.register_function(self.getScript) self.register_function(self.numberOfScripts) - self.register_function(self.resetClientState) + self.register_function(self.resetClientState) self.register_function(self.startScript) self.register_function(self.success) self.register_function(self.testConnectivity) @@ -187,24 +187,24 @@ class sbRpcServer(SimpleXMLRPCServer): Returns the number of scripts for execution. """ return len(self.listOfScripts) - + def haveClient(self,ID): """ Determine whether or not we have a given client in tracking. """ return self.clients.has_key(ID) - + def getClient(self, ID): """ Returns the sugarbotSession object corresponding to the provided ID. - + If such a sugarbotSession object does not exist, it is created. """ if not self.haveClient(ID): self.clients[ID] = sugarbotSession(ID) - + return self.clients[ID] - + def completionStatus(self,ID=0): """ Returns the completion status of all of the scripts as a list. @@ -212,13 +212,13 @@ class sbRpcServer(SimpleXMLRPCServer): script had a command that did not complete successfully, the return value would be: [True, False, True] - + If no failures were reported: [True, True, True] - + All values are initialized to False. If a script is still running, then at least one of the result-values will be False. - + Removes the client from tracking. When the client re-connects, it will effectively have a clean slate. """ @@ -228,18 +228,18 @@ class sbRpcServer(SimpleXMLRPCServer): self.resetClientState(ID) else: retval = None - + return retval - + def resetClientState(self, ID=0): """ Clears a client from tracking. - + When the client re-connects, it will start with a clean slate. """ if self.haveClient(ID): client = self.getClient(ID) - + # Get a completed ratio r = client.responses successes = len([r[k] for k in r if r[k] is True]) @@ -248,19 +248,19 @@ class sbRpcServer(SimpleXMLRPCServer): self.clients[ID].log.info("Disconnected [%s\%s\%s]" % \ (successes, completed, overall)) del self.clients[ID] - + def scriptOutOfBounds(self,ID): """ Checks to see if a client's script index is out-of-bounds. """ client = self.getClient(ID) - + if client.currentScript < 0: return True - + if client.currentScript >= len(self.listOfScripts): return True - + def success(self, ID=0): """ This method is called after the successful completion of a script @@ -268,41 +268,41 @@ class sbRpcServer(SimpleXMLRPCServer): client = self.getClient(ID) client.log.info("Success (%s)" % client.scriptName) client.responses[client.scriptName] = True - + def modifyTraceBackText(self, text, ID=0): """ Replaces '' with the script name in a backtrace report. - + This is useful in determining _which_ script failed execution. """ client = self.getClient(ID) - + if "File \"\"" in text: # Get the text.. replacementText = "Sugarbot Script: '%s'" % client.scriptName - + # Replace the string with the filename text = text.replace("", replacementText) return text - + def fail(self, status="No status provided", ID=0): """ This method is called if, for some reason, the client needs to disconnect prematurely. A status message/reason is required. """ client = self.getClient(ID) - + # If the client is sending us exception text, replace that select # portions of the text to be more useful. status = self.modifyTraceBackText(status, ID) - + # Print the error client.log.error("%s" % status) client.responses[client.scriptName] = False client.failureText[client.scriptName] = status - + return status - + def startScript(self,ID=0): """ Increments the internal script counter, looping back to the first @@ -311,42 +311,42 @@ class sbRpcServer(SimpleXMLRPCServer): """ # Get the client. This will create it if it does not exist. client = self.getClient(ID) - + # Next script! (Note that the value is initialized to be -1) client.currentScript += 1 - + # Prevent overflows if, for some reason, we loop back to script 0 if self.scriptOutOfBounds(ID): client.currentScript = 0 - + # Update the client's script name client.scriptName = self.listOfScripts[client.currentScript] - + # Pretty status message... client.log.info("Starting %s" % client.scriptName) # Make room for another response (default to failure) client.responses[client.scriptName] = False - + return True - + def getScript(self,ID=0): """ Returns the script that the client should execute. """ client = self.getClient(ID) client.log.info("Getting Script: %s" % client.scriptName ) - + f = open(self.listOfScripts[client.currentScript]) listOfLines = f.readlines() longString = '' for line in listOfLines: longString += line - + f.close() - + return longString - + def getActivityName(self, ID=0, which=None): """ Imports from the specified script file in order to @@ -354,65 +354,65 @@ class sbRpcServer(SimpleXMLRPCServer): client = self.getClient(ID) if which is None: which = client.currentScript - + if which == -1: raise IndexError, "Invalid script index. If calling " + \ "getActivityNameMake without arguments, make sure that " + \ "startScript gets called first." - + try: moduleName = self.listOfScripts[which] index = moduleName.find(".py") if index is not -1: moduleName = moduleName[:index] - + execStr = 'from %s import %s' % \ (moduleName, self.sugarbotActivityVar) - + evalStr = '%s' % self.sugarbotActivityVar - + exec execStr return eval(evalStr) except: raise - + def getKillFlag(self): return self.kill - + def getRestartFlag(self): return self.restart - + def addScript(self,scriptPath): """ Adds a script to the internal list of scripts. This causes the parser to load the script contents into memory for fast/easy access. """ self.listOfScripts.append(scriptPath) - + activityName = self.getActivityName(which=len(self.listOfScripts)-1 ) self.log.info("Added script %s [Activity %s]" \ % (scriptPath, activityName) ) - + def main(argv=None): p = optparse.OptionParser() p.add_option('--no-restart', dest='restart', action='store_false',default=True, help='do NOT restart sugarbot after execution has completed') p.add_option('--no-kill', dest='kill', action='store_false',default=True, help='do NOT kill sugar after all sugarbot scripts have executed') - + (options,args) = p.parse_args() - + if len(args) < 1: p.print_help() return 1 - + server = sbRpcServer(args, kill=options.kill, restart=options.restart) - + try: server.serve_forever() except KeyboardInterrupt: print 'Ctrl+C pressed, exiting...' - + if __name__ == '__main__': main() -- cgit v0.9.1