Issue42489: Bug With experiment.save_batch (#43)

Author: RosalineP

CHANGE.txt

@@ -2,6 +2,13 @@
 LabKey Python Client API News
 +++++++++++
 
+What's New in the LabKey 2.0.1 package
+==============================
+
+*Release date: 02/01/2021*
+- Updated Run.to_json() to drop unset values, since keys are given default values server-side, and null values on the
+form result in exceptions
+
 What's New in the LabKey 2.0.0 package
 ==============================
 

labkey/__init__.py

@@ -16,6 +16,6 @@
 from labkey import domain, query, experiment, security, utils
 
 __title__ = "labkey"
-__version__ = "2.0.0"
+__version__ = "2.0.1"
 __author__ = "LabKey"
 __license__ = "Apache License 2.0"

labkey/experiment.py

@@ -103,6 +103,9 @@ def to_json(self):
         data["materialOutputs"] = self.material_outputs
         data["plateMetadata"] = self.plate_metadata
 
+        # Issue 2489: Drop empty values. Server supplies default values for missing keys, 
+        # and will throw exception if a null value is supplied
+        data = {k: v for k, v in data.items() if v}
         return data
 
 

test/unit/test_experiment_api.py

@@ -290,7 +290,7 @@ def setUp(self):
         self.service = MockSaveBatch()
         self.expected_kwargs = {
             "expected_args": [self.service.get_server_url()],
-            "data": '{"assayId": 12345, "batches": [{"batchProtocolId": null, "comment": null, "created": null, "createdBy": null, "modified": null, "modifiedBy": null, "name": null, "properties": {"PropertyName": "Property Value"}, "runs": [{"comment": null, "created": null, "createdBy": null, "dataInputs": [], "dataRows": [], "experiments": [], "filePathRoot": null, "materialInputs": [], "materialOutputs": [], "modified": null, "modifiedBy": null, "name": "python upload", "plateMetadata": null, "properties": {"RunFieldName": "Run Field Value"}}]}]}',
+            "data": '{"assayId": 12345, "batches": [{"batchProtocolId": null, "comment": null, "created": null, "createdBy": null, "modified": null, "modifiedBy": null, "name": null, "properties": {"PropertyName": "Property Value"}, "runs": [{"name": "python upload", "properties": {"RunFieldName": "Run Field Value"}}]}]}',
             "headers": {"Content-type": "application/json", "Accept": "text/plain"},
             "timeout": 300,
         }