Merge remote-tracking branch 'origin/pr/151'

Author: acdha

README.rst

@@ -106,9 +106,12 @@ Basic usage looks like:
     # correctly.
     similar = solr.more_like_this(q='id:doc_2', mltfl='text')
 
-    # Finally, you can delete either individual documents...
+    # Finally, you can delete either individual documents,
     solr.delete(id='doc_1')
 
+    # also in batches...
+    solr.delete(id=['doc_1', 'doc_2'])
+
     # ...or all documents.
     solr.delete(q='*:*')
 

pysolr.py

@@ -907,7 +907,8 @@ def delete(self, id=None, q=None, commit=True, softCommit=False, waitFlush=None,
         Deletes documents.
 
         Requires *either* ``id`` or ``query``. ``id`` is if you know the
-        specific document id to remove. ``query`` is a Lucene-style query
+        specific document id to remove. Note that ``id`` can also be a list of
+        document ids to be deleted. ``query`` is a Lucene-style query
         indicating a collection of documents to delete.
 
         Optionally accepts ``commit``. Default is ``True``.
@@ -921,6 +922,7 @@ def delete(self, id=None, q=None, commit=True, softCommit=False, waitFlush=None,
         Usage::
 
             solr.delete(id='doc_12')
+            solr.delete(id=['doc_1', 'doc_3'])
             solr.delete(q='*:*')
 
         """
@@ -929,7 +931,14 @@ def delete(self, id=None, q=None, commit=True, softCommit=False, waitFlush=None,
         elif id is not None and q is not None:
             raise ValueError('You many only specify "id" OR "q", not both.')
         elif id is not None:
-            m = '<delete><id>%s</id></delete>' % id
+            if not isinstance(id, (list, set, tuple)):
+                id = [id]
+            else:
+                id = list(filter(None, id))
+            if id:
+                m = '<delete>%s</delete>' % ''.join('<id>%s</id>' % i for i in id)
+            else:
+                raise ValueError('The list of documents to delete was empty.')
         elif q is not None:
             m = '<delete><query>%s</query></delete>' % q
 

tests/test_client.py

@@ -2,6 +2,7 @@
 from __future__ import absolute_import, unicode_literals
 
 import datetime
+import random
 import unittest
 from io import StringIO
 from xml.etree import ElementTree
@@ -704,7 +705,35 @@ def test_delete(self):
         self.solr.delete(q='*:*')
         self.assertEqual(len(self.solr.search('*:*')), 0)
 
-        # Need at least one.
+        # Test delete() with `id' being a list.
+        # Solr's ability to delete parent/children docs by id is simply assumed
+        # and not what's under test here.
+        def leaf_doc(doc):
+            return 'price' in doc and NESTED_DOC_KEY not in doc
+
+        to_delete_docs = list(filter(leaf_doc, self.docs))
+        to_delete_ids = [doc['id'] for doc in to_delete_docs]
+
+        self.solr.add(to_delete_docs)
+        self.solr.commit()
+
+        leaf_q = 'price:[* TO *]'
+        self.assertEqual(len(self.solr.search(leaf_q)), len(to_delete_docs))
+        # Extract a random doc from the list, to later check it wasn't deleted.
+        graced_doc_id = to_delete_ids.pop(random.randint(0, len(to_delete_ids) - 1))
+        self.solr.delete(id=to_delete_ids)
+        # There should be only one left, our graced id
+        self.assertEqual(len(self.solr.search(leaf_q)), 1)
+        self.assertEqual(len(self.solr.search('id:%s' % graced_doc_id)), 1)
+        # Now we can wipe the graced document too. None should be left.
+        self.solr.delete(id=graced_doc_id)
+        self.assertEqual(len(self.solr.search(leaf_q)), 0)
+
+        # Can't delete when the list of documents is empty
+        self.assertRaises(ValueError, self.solr.delete, id=[None, None, None])
+        self.assertRaises(ValueError, self.solr.delete, id=[None])
+
+        # Need at least one of either `id' or `q'
         self.assertRaises(ValueError, self.solr.delete)
         # Can't have both.
         self.assertRaises(ValueError, self.solr.delete, id='foo', q='bar')