feat: add support for MISSING kwargs in UpdateResource

Author: Charles Larivier

metabase/resource.py

@@ -4,6 +4,8 @@
 from metabase import Metabase
 from requests import HTTPError
 
+from missing import MISSING
+
 
 class Resource:
     ENDPOINT: str
@@ -65,7 +67,8 @@ def create(cls, **kwargs):
 class UpdateResource(Resource):
     def update(self, **kwargs) -> None:
         """Update an instance."""
-        response = self.connection().put(self.ENDPOINT + f"/{getattr(self, self.PRIMARY_KEY)}", json=kwargs)
+        params = {k: v for k, v in kwargs.items() if v != MISSING}
+        response = self.connection().put(self.ENDPOINT + f"/{getattr(self, self.PRIMARY_KEY)}", json=params)
 
         if response.status_code != 200:
             raise HTTPError(response.json())

tests/test_resource.py

@@ -1,8 +1,11 @@
 from unittest import TestCase
+from unittest.mock import call, patch
+from requests import HTTPError
 
 from exceptions import NotFoundError
 from metabase.metabase import Metabase
 from metabase.resource import CreateResource, DeleteResource, GetResource, ListResource, Resource, UpdateResource
+from missing import MISSING
 
 from tests.helpers import IntegrationTestCase
 
@@ -92,6 +95,27 @@ class Collection(CreateResource, GetResource, UpdateResource):
         # metabase was updated
         self.assertEqual("My New Collection", Collection.get(collection.id).name)
 
+    def test_update_missing(self):
+        """Ensure UpdateResource.update() ignores arguments equal to MISSING."""
+        class Collection(UpdateResource):
+            ENDPOINT = "/api/collection"
+
+        test_matrix = [
+            ({"a": "A", "b": "B"}, {"a": "A", "b": "B"}),
+            ({"a": "A", "b": MISSING}, {"a": "A"}),
+            ({"a": MISSING, "b": MISSING}, {}),
+        ]
+
+        for kwargs, expected in test_matrix:
+            with patch("metabase.resource.Metabase.put") as mock:
+                try:
+                    Collection(id=1).update(**kwargs)
+                except HTTPError:
+                    pass
+
+                self.assertTrue(mock.called)
+                self.assertIsNone(mock.assert_called_with("/api/collection/1", json=expected))
+
 
 class DeleteResourceTests(IntegrationTestCase):
     def test_delete(self):