fix: use ResultsCondition in BackendsCall instead of hack in Weboob (refs #372)

weboob/core/bcall.py

@@ -26,7 +26,7 @@ from weboob.tools.misc import get_backtrace
 from weboob.tools.log import getLogger
 
 
-__all__ = ['BackendsCall', 'CallErrors']
+__all__ = ['BackendsCall', 'CallErrors', 'IResultsCondition', 'ResultsConditionError']
 
 
 class CallErrors(Exception):
@@ -37,18 +37,28 @@ class CallErrors(Exception):
     def __iter__(self):
         return self.errors.__iter__()
 
+class IResultsCondition(object):
+    def is_valid(self, obj):
+        raise NotImplementedError()
+
+class ResultsConditionError(Exception):
+    pass
+
 class BackendsCall(object):
-    def __init__(self, backends, function, *args, **kwargs):
+    def __init__(self, backends, condition, function, *args, **kwargs):
         """
-        @param backends  list of backends to call
-        @param function  backends' method name, or callable object
-        @param args, kwargs  arguments given to called functions
+        @param backends  list of backends to call.
+        @param condition  a IResultsCondition object. Can be None.
+        @param function  backends' method name, or callable object.
+        @param args, kwargs  arguments given to called functions.
         """
         self.logger = getLogger('bcall')
         # Store if a backend is finished
         self.backends = {}
         for backend in backends:
             self.backends[backend.name] = False
+        # Condition
+        self.condition = condition
         # Global mutex on object
         self.mutex = RLock()
         # Event set when every backends have give their data
@@ -78,6 +88,8 @@ class BackendsCall(object):
     def _store_result(self, backend, result):
         with self.mutex:
             if isinstance(result, CapBaseObject):
+                if self.condition and not self.condition.is_valid(result):
+                    return
                 result.backend = backend.name
             self.responses.append((backend, result))
             self.response_event.set()

weboob/core/ouiboube.py

@@ -180,7 +180,7 @@ class Weboob(object):
         @param backends  list of backends to iterate on
         @param caps  iterate on backends with this caps
         @param condition  a condition to validate to keep the result
-        @return  an iterator of results
+        @return  the BackendsCall object (iteratable)
         """
         backends = self.backend_instances.values()
         _backends = kwargs.pop('backends', None)
@@ -206,13 +206,12 @@ class Weboob(object):
             caps = kwargs.pop('caps')
             backends = [backend for backend in backends if backend.has_caps(caps)]
         condition = kwargs.pop('condition', None)
-        for backend, result in BackendsCall(backends, function, *args, **kwargs):
-            d = dict(result.iter_fields())
-            if condition:
-                if condition.is_valid(d):
-                    yield backend, result
-            else:
-                yield backend, result
+
+        # The return value MUST BE the BackendsCall instance. Please never iterate
+        # here on this object, because caller might want to use other methods, like
+        # wait() on callback_thread().
+        # Thanks a lot.
+        return BackendsCall(backends, condition, function, *args, **kwargs)
 
     def schedule(self, interval, function, *args):
         return self.scheduler.schedule(interval, function, *args)