feat(delete_by): implement new delete_by endpoint

Author: LeoErcolanelli

algoliasearch/index.py

@@ -240,6 +240,7 @@ def save_objects(self, objects, request_options=None):
     def deleteByQuery(self, query, params=None):
         return self.delete_by_query(query, params)
 
+    @deprecated
     def delete_by_query(self, query, params=None, request_options=None):
         """
         Delete all objects matching a query.
@@ -260,6 +261,19 @@ def delete_by_query(self, query, params=None, request_options=None):
         ids = (o['objectID'] for o in self.browse_all(params))
         return self.delete_objects(ids, request_options=request_options)
 
+    def delete_by(self, params, request_options=None):
+        """
+        Delete all objects matching an empty query performed with the given
+        parameters
+
+        @param params parameter to restrict the search.
+        """
+        params = {'params': urlencode(urlify(params))}
+        return self._req(
+            False, '/deleteByQuery', 'POST', data=params,
+            request_options=request_options
+        )
+
     @deprecated
     def deleteObject(self, object_id):
         return self.delete_object(object_id)

tests/test_index.py

@@ -487,6 +487,28 @@ def test_delete_by_query(rw_index):
     res = rw_index.search('', {'hitsPerPage': 0})
     assert res['nbHits'] < 5
 
+
+def test_delete_by(index):
+    obj1 = {'objectID': 'A', 'color': 'red'}
+    obj2 = {'objectID': 'B', 'color': 'blue'}
+    index.save_objects([obj1, obj2])
+    task = index.set_settings({
+        'attributesForFaceting': ['color']
+    })
+    index.wait_task(task['taskID'])
+
+    task = index.delete_by({'filters': 'color:red'})
+    print(task)
+    index.wait_task(task['taskID'])
+
+    res = index.search('')
+    assert len(res['hits']) == 1
+    del res['hits'][0]['_highlightResult']
+
+    assert obj1 not in res['hits']
+    assert obj2 in res['hits']
+
+
 def test_batch(rw_index):
     factory = Factory()
     requests = [