Merge pull request #297 from algolia/feat/syno-rule-iterators

feat: Iterators on synonyms and rules of an index

algoliasearch/index.py

@@ -69,6 +69,69 @@ def _load_next_page(self):
         self.pos = 0
         self.cursor = self.answer.get('cursor', None)
 
+class SynonymIterator:
+    """Iterator on the synonyms of an index"""
+
+    def __init__(self, index, hits_per_page=1000):
+        self.index = index
+        self.hits_per_page = hits_per_page
+        self.page = 0
+
+    def __iter__(self):
+        self._load_next_page()
+        return self
+
+    def __next__(self):
+        return self.next()
+
+    def next(self):
+        if self.pos >= len(self.response['hits']):
+            self._load_next_page()
+        if self.pos < len(self.response['hits']):
+            result = self.response['hits'][self.pos]
+            self.pos += 1
+            # Remove highlighting.
+            if '_highlightResult' in result: del result['_highlightResult']
+            return result
+        else:
+            raise StopIteration
+
+    def _load_next_page(self):
+        self.response = self.index.search_synonyms('', page=self.page, hits_per_page=self.hits_per_page)
+        self.page += 1
+        self.pos = 0
+
+class RuleIterator:
+    """Iterator on the rules of an index"""
+
+    def __init__(self, index, hits_per_page=1000):
+        self.index = index
+        self.hits_per_page = hits_per_page
+        self.page = 0
+
+    def __iter__(self):
+        self._load_next_page()
+        return self
+
+    def __next__(self):
+        return self.next()
+
+    def next(self):
+        if self.pos >= len(self.response['hits']):
+            self._load_next_page()
+        if self.pos < len(self.response['hits']):
+            result = self.response['hits'][self.pos]
+            self.pos += 1
+            # Remove highlighting.
+            if '_highlightResult' in result: del result['_highlightResult']
+            return result
+        else:
+            raise StopIteration
+
+    def _load_next_page(self):
+        self.response = self.index.search_rules('', page=self.page, hitsPerPage=self.hits_per_page)
+        self.page += 1
+        self.pos = 0
 
 class Index(object):
     """