a bit of cleanup in the manifold{api,result} area
authorThierry Parmentelat <thierry.parmentelat@inria.fr>
Mon, 30 Mar 2015 12:28:17 +0000 (14:28 +0200)
committerThierry Parmentelat <thierry.parmentelat@inria.fr>
Mon, 30 Mar 2015 12:28:17 +0000 (14:28 +0200)
+ using format() instead of %

auth/manifoldbackend.py
manifoldapi/manifoldapi.py
manifoldapi/manifoldresult.py

index c7ac7fa..d965a55 100644 (file)
@@ -31,7 +31,7 @@ class ManifoldBackend:
                 logger.error("GetSession failed", sessions_result.error())
                 return
             session = sessions[0]
-            logger.debug("SESSION : %s" % session)
+            logger.debug("SESSION : {}".format(session))
             
             # Change to session authentication
             api.auth = {'AuthMethod': 'session', 'session': session['session']}
@@ -45,16 +45,17 @@ class ManifoldBackend:
                 logger.error("GetPersons failed",persons_result.error())
                 return
             person = persons[0]
-            logger.debug("PERSON : %s" % person)
-            #logger.info("%s %s <%s> logged in" % (person['config']['first_name'], person['config']['last_name'], person['config']['email']))
+            logger.debug("PERSON : {}".format(person))
+            #logger.info("{} {} <{}> logged in"\
+            #    .format(person['config']['first_name'], person['config']['last_name'], person['config']['email']))
 
             request.session['manifold'] = {'auth': api.auth, 'person': person, 'expires': session['expires']}
-        except ManifoldException, e:
-            logger.error("Manifold Auth Backend: %s" % e.manifold_result)
-        except Exception, e:
-            logger.error("Manifold Auth Backend: %s" % e)
-            #import traceback
-            #traceback.print_exc()
+        except ManifoldException as e:
+            logger.error("ManifoldException in Auth Backend: {}".format(e.manifold_result))
+        except Exception as e:
+            logger.error("Exception in Manifold Auth Backend: {}".format(e))
+            import traceback
+            traceback.print_exc()
             return None
 
         try:
index 9a99991..d2b8ae0 100644 (file)
@@ -1,14 +1,18 @@
 # Manifold API Python interface
-import copy, xmlrpclib, ssl
-from myslice.settings import config, logger, DEBUG
+from __future__ import print_function
+
+import copy
+import xmlrpclib
+import ssl
 
 from django.contrib import messages
 from django.shortcuts import redirect
-from manifoldresult import ManifoldResult, ManifoldCode, ManifoldException
+
 from manifold.core.result_value import ResultValue
 
-debug_deep=False
-#debug_deep=True
+from manifoldresult import ManifoldResult, ManifoldCode, ManifoldException, truncate_result
+
+from myslice.settings import config, logger
 
 class ManifoldAPI:
 
@@ -25,7 +29,8 @@ class ManifoldAPI:
         # Manifold uses a self signed certificate
         # https://www.python.org/dev/peps/pep-0476/
         if hasattr(ssl, '_create_unverified_context'): 
-            self.server = xmlrpclib.Server(self.url, verbose=False, allow_none=True, context=ssl._create_unverified_context())
+            self.server = xmlrpclib.Server(self.url, verbose=False, allow_none=True,
+                                           context=ssl._create_unverified_context())
         else :
             self.server = xmlrpclib.Server(self.url, verbose=False, allow_none=True)
 
@@ -39,52 +44,41 @@ class ManifoldAPI:
 
         def func(*args, **kwds):
             import time
-            
             start = time.time()
+            
+            # the message to display
+            auth_message = "<AuthMethod not set in {}>".format(auth) if 'AuthMethod' not in self.auth \
+                           else "[session]" if self.auth['AuthMethod'] == 'session' \
+                           else "user:{}".format(self.auth['Username']) if self.auth['AuthMethod'] == 'password' \
+                           else "anonymous" if self.auth['AuthMethod'] == 'anonymous' \
+                           else "[???]" + "{}".format(self.auth)
+            end_message = "MANIFOLD {}( {}( {} ) ) with auth={} to {}"\
+                          .format(methodName,
+                                  args[0]['action'] or '', 
+                                  args[0]['object'] or '',
+                                  auth_message,
+                                  self.url)
             try:
-                
-                #logger.debug("MANIFOLD %s( %s( %s ) ) to %s" % (methodName, args[0]['action'], args[0]['object'], self.url))
-                
-                if ('Username' in self.auth) :
-                    username = self.auth['Username']
-                else :
-                    username = "-"
-                
                 args += ({ 'authentication': self.auth },)
-                                
                 result = getattr(self.server, methodName)(*args, **kwds)
-                
-                logger.debug("MANIFOLD %s( %s( %s ) ) as %s to %s executed in %s seconds -> %s" % 
-                             (methodName, 
-                              args[0]['action'] or '', 
-                              args[0]['object'] or '',
-                              username,
-                              self.url, 
-                              (time.time() - start),
-                              args))
-
+                logger.debug("{} executed in {} seconds -> {}"\
+                             .format(end_message, time.time() - start, truncate_result(result)))
                 return ResultValue(**result)
 
-            except Exception, error:
-                if True: 
-                    print "===== xmlrpc catch-all exception:", error
-                    import traceback
-                    traceback.print_exc(limit=3)
+            except Exception as error:
+                print("===== xmlrpc catch-all exception:", error)
+                import traceback
+                traceback.print_exc(limit=3)
                 
                 if "Connection refused" in error:
                     raise ManifoldException ( ManifoldResult (code=ManifoldCode.SERVER_UNREACHABLE,
-                                                              output="%s answered %s" % (self.url,error)))
+                                                              output="{} answered {}".format(self.url, error)))
                 # otherwise
-                logger.error("MANIFOLD %s( %s( %s ) ) as %s to %s executed in %s seconds -> %s" % 
-                             (methodName, 
-                              args[0]['action'] or '', 
-                              args[0]['object'] or '',
-                              username,
-                              self.url, 
-                              (time.time() - start),
-                              args))
-                logger.error("MANIFOLD %s", error)
-                raise ManifoldException ( ManifoldResult (code = ManifoldCode.SERVER_UNREACHABLE, output = "%s" % error) )
+                logger.error("{} FAILED - executed in {} seconds"\
+                             .format(end_message, time.time() - start)) 
+                logger.error("MANIFOLD {}".format(error))
+                raise ManifoldException ( ManifoldResult (code = ManifoldCode.SERVER_UNREACHABLE,
+                                                          output = "{}".format(error)))
 
         return func
 
@@ -92,8 +86,8 @@ def _execute_query(request, query, manifold_api_session_auth):
     
     manifold_api = ManifoldAPI(auth = manifold_api_session_auth)
     
-    logger.debug("MANIFOLD QUERY : %s" % " ".join(str(query).split()))
-    #logger.debug("MANIFOLD DICT : %s" % query.to_dict())
+    logger.debug("MANIFOLD QUERY : {}".format(" ".join(str(query).split())))
+    #logger.debug("MANIFOLD DICT : {}".format(query.to_dict()))
     result = manifold_api.forward(query.to_dict())
     if result['code'] == 2:
         # this is gross; at the very least we need to logout() 
@@ -103,10 +97,10 @@ def _execute_query(request, query, manifold_api_session_auth):
         del request.session['manifold']
         # Flush django session
         request.session.flush()
-        #raise Exception, 'Error running query: %r' % result
+        #raise Exception, 'Error running query: {}'.format(result)
     
     if result['code'] == 1:
-        log.warning("MANIFOLD : %s" % result['description'])
+        log.warning("MANIFOLD : {}".format(result['description']))
 
     # XXX Handle errors
     #Error running query: {'origin': [0, 'XMLRPCAPI'], 'code': 2, 'description': 'No such session: No row was found for one()', 'traceback': 'Traceback (most recent call last):\n  File "/usr/local/lib/python2.7/dist-packages/manifold/core/xmlrpc_api.py", line 68, in xmlrpc_forward\n    user = Auth(auth).check()\n  File "/usr/local/lib/python2.7/dist-packages/manifold/auth/__init__.py", line 245, in check\n    return self.auth_method.check()\n  File "/usr/local/lib/python2.7/dist-packages/manifold/auth/__init__.py", line 95, in check\n    raise AuthenticationFailure, "No such session: %s" % e\nAuthenticationFailure: No such session: No row was found for one()\n', 'type': 2, 'ts': None, 'value': None}
@@ -126,5 +120,8 @@ def execute_query(request, query):
 
 def execute_admin_query(request, query):
     admin_user, admin_password = config.manifold_admin_user_password()
+    if not admin_user or not admin_password:
+        logger.error("""CONFIG: you need to setup admin_user and admin_password in myslice.ini
+Some functions won't work properly until you do so""")
     admin_auth = {'AuthMethod': 'password', 'Username': admin_user, 'AuthString': admin_password}
     return _execute_query(request, query, admin_auth)
index 4ffe072..3680864 100644 (file)
@@ -1,3 +1,4 @@
+# black magic to define enums
 def enum(*sequential, **named):
     enums = dict(zip(sequential, range(len(sequential))), **named)
     return type('Enum', (), enums)
@@ -10,47 +11,65 @@ ManifoldCode = enum (
     SERVER_UNREACHABLE=3,
 )
 
+def truncate(result, length=50):
+    plain = "{}".format(result)
+    if len(plain) <= length-3:
+        return plain
+    else:
+        return plain[:(length-3)]+'...'
+
 _messages_ = { -1 : "Unknown", 0: "OK", 1: "Session Expired", 2: "Not Implemented", 3: "Backend server unreachable"}
 
+def truncate_result(result, length=50):
+    self = result
+    code = self['code']
+    result = "[MFresult {} (code={})".format(_messages_.get(code, "???"), code)
+    if code == 0:
+        value = self['value']
+        if isinstance(value, list):
+            result += " [value=list with {} elts]".format(len(value))
+        elif isinstance(value, dict):
+            result += " [value=dict with keys {}]".format(value.keys())
+        else:
+            result += " [value={}: {}]".format(type(value).__name__, value)
+    elif 'output' in self:
+        result += " [output={}]".format(self['output'])
+    else:
+        result += "<no output>"
+    result += "]"
+    return truncate(result, 60)
+
 # being a dict this can be used with json.dumps
 class ManifoldResult (dict):
     def __init__ (self, code=ManifoldCode.SUCCESS, value=None, output=""):
-        self['code']=code
-        self['value']=value
-        self['output']=output
+        self['code'] = code
+        self['value'] = value
+        self['output'] = output
         self['description'] = '' # Jordan: needed by javascript code
 
     def from_json (self, json_string):
         d=json.dumps(json_string)
-        for k in ['code','value','output']:
-            self[k]=d[k]
+        for k in ['code', 'value', 'output']:
+            self[k] = d[k]
 
     # raw accessors
-    def code (self): return self['code']
-    def output (self): return self['output']
+    def code (self):
+        return self['code']
+    def output (self):
+        return self['output']
 
     # this returns None if there's a problem, the value otherwise
     def ok_value (self):
-        if self['code']==ManifoldCode.SUCCESS:
+        if self['code'] == ManifoldCode.SUCCESS:
             return self['value']
 
     # both data in a single string
     def error (self):
-        return "code=%s -- %s"%(self['code'],self['output'])
+        return "code={} -- {}".format(self['code'], self['output'])
     
 
     def __repr__ (self):
-        code=self['code']
-        result="[MFresult %s (code=%s)"%(_messages_.get(code,"???"),code)
-        if code==0:
-            value=self['value']
-            if isinstance(value,list): result += " [value=list with %d elts]"%len(value)
-            elif isinstance(value,dict): result += " [value=dict with keys %s]"%value.keys()
-            else: result += " [value=%s: %s]"%(type(value).__name__,value)
-        else:
-            result += " [output=%s]"%self['output']
-        result += "]"
-        return result
+        return truncate_result(self, 60)
 
 # probably simpler to use a single class and transport the whole result there
 # instead of a clumsy set of derived classes 
@@ -58,4 +77,4 @@ class ManifoldException (Exception):
     def __init__ (self, manifold_result):
         self.manifold_result=manifold_result
     def __repr__ (self):
-        return "Manifold Exception %s"%(self.manifold_result.error())
+        return "<Manifold Exception {}>".format(self.manifold_result.error())