Merge pull request #322 from ahankinson/fixed-321-xml-json

Fixed: Different JSON and XML behaviour

Author: acdha

pysolr.py

@@ -907,13 +907,17 @@ def suggest_terms(self, fields, prefix, handler="terms", **kwargs):
         )
         return res
 
-    def _build_doc(self, doc, boost=None, fieldUpdates=None):
+    def _build_json_doc(self, doc):
+        cleaned_doc = {k: v for k, v in doc.items() if not self._is_null_value(v)}
+        return cleaned_doc
+
+    def _build_xml_doc(self, doc, boost=None, fieldUpdates=None):
         doc_elem = ElementTree.Element("doc")
 
         for key, value in doc.items():
             if key == NESTED_DOC_KEY:
                 for child in value:
-                    doc_elem.append(self._build_doc(child, boost, fieldUpdates))
+                    doc_elem.append(self._build_xml_doc(child, boost, fieldUpdates))
                 continue
 
             if key == "boost":
@@ -932,7 +936,7 @@ def _build_doc(self, doc, boost=None, fieldUpdates=None):
                     continue
 
                 if key == "_doc":
-                    child = self._build_doc(bit, boost)
+                    child = self._build_xml_doc(bit, boost)
                     doc_elem.append(child)
                     continue
 
@@ -1015,7 +1019,8 @@ def add(
                 # json array of docs
             if isinstance(message, list):
                 # convert to string
-                m = json.dumps(message).encode("utf-8")
+                cleaned_message = [self._build_json_doc(doc) for doc in message]
+                m = json.dumps(cleaned_message).encode("utf-8")
             else:
                 raise ValueError("wrong message type")
         else:
@@ -1025,7 +1030,7 @@ def add(
                 message.set("commitWithin", commitWithin)
 
             for doc in docs:
-                el = self._build_doc(doc, boost=boost, fieldUpdates=fieldUpdates)
+                el = self._build_xml_doc(doc, boost=boost, fieldUpdates=fieldUpdates)
                 message.append(el)
 
             # This returns a bytestring. Ugh.

tests/test_client.py

@@ -663,32 +663,32 @@ def test_suggest_terms(self):
         args, kwargs = self.solr._send_request.call_args
         self.assertTrue(args[1].startswith("fakehandler"))
 
-    def test__build_doc(self):
+    def test__build_xml_doc(self):
         doc = {
             "id": "doc_1",
             "title": "Example doc ☃ 1",
             "price": 12.59,
             "popularity": 10,
         }
         doc_xml = force_unicode(
-            ElementTree.tostring(self.solr._build_doc(doc), encoding="utf-8")
+            ElementTree.tostring(self.solr._build_xml_doc(doc), encoding="utf-8")
         )
         self.assertIn('<field name="title">Example doc ☃ 1</field>', doc_xml)
         self.assertIn('<field name="id">doc_1</field>', doc_xml)
         self.assertEqual(len(doc_xml), 152)
 
-    def test__build_doc_with_sets(self):
+    def test__build_xml_doc_with_sets(self):
         doc = {"id": "doc_1", "title": "Set test doc", "tags": {"alpha", "beta"}}
         doc_xml = force_unicode(
-            ElementTree.tostring(self.solr._build_doc(doc), encoding="utf-8")
+            ElementTree.tostring(self.solr._build_xml_doc(doc), encoding="utf-8")
         )
         self.assertIn('<field name="id">doc_1</field>', doc_xml)
         self.assertIn('<field name="title">Set test doc</field>', doc_xml)
         self.assertIn('<field name="tags">alpha</field>', doc_xml)
         self.assertIn('<field name="tags">beta</field>', doc_xml)
         self.assertEqual(len(doc_xml), 144)
 
-    def test__build_doc_with_sub_docs(self):
+    def test__build_xml_doc_with_sub_docs(self):
         sub_docs = [
             {
                 "id": "sub_doc_1",
@@ -710,7 +710,7 @@ def test__build_doc_with_sub_docs(self):
             "popularity": 10,
             "_doc": sub_docs,
         }
-        doc_xml = self.solr._build_doc(doc)
+        doc_xml = self.solr._build_xml_doc(doc)
         self.assertEqual(doc_xml.find("*[@name='id']").text, doc["id"])
 
         children_docs = doc_xml.findall("doc")
@@ -719,6 +719,19 @@ def test__build_doc_with_sub_docs(self):
         self.assertEqual(children_docs[0].find("*[@name='id']").text, sub_docs[0]["id"])
         self.assertEqual(children_docs[1].find("*[@name='id']").text, sub_docs[1]["id"])
 
+    def test_build_json_doc_matches_xml(self):
+        doc = {
+            "id": "doc_1",
+            "title": "",
+            "price": 12.59,
+            "popularity": 10
+        }
+
+        doc_json = self.solr._build_json_doc(doc)
+        doc_xml = self.solr._build_xml_doc(doc)
+        self.assertNotIn("title", doc_json)
+        self.assertIsNone(doc_xml.find("*[name='title']"))
+
     def test_add(self):
         self.assertEqual(len(self.solr.search("doc")), 3)
         self.assertEqual(len(self.solr.search("example")), 2)