add Object.get_or_create

models.py

@@ -473,6 +473,24 @@ class Object(StringIdModel):
         """
         return super().get_by_id(id.replace('^^', '#'))
 
+    @classmethod
+    @ndb.transactional()
+    def get_or_create(cls, id, **props):
+        """Returns an Object with the given property values.
+
+        If a matching Object doesn't exist in the datastore, creates it first.
+
+        Only populates non-False/empty property values.
+
+        Returns:
+          :class:`Object`
+        """
+        obj = cls.get_by_id(id) or Object(id=id)
+        obj.clear()
+        obj.populate(**{k: v for k, v in props.items() if v})
+        obj.put()
+        return obj
+
     def clear(self):
         """Clears all data properties."""
         for prop in 'as2', 'bsky', 'mf2':

tests/test_models.py

@@ -162,6 +162,39 @@ class ObjectTest(TestCase):
         # print(id(got))
         self.assertEqual('asdf', got.a)
 
+    def test_get_or_create(self):
+        def check(obj1, obj2):
+            self.assert_entities_equal(obj1, obj2, ignore=['expire', 'updated'])
+
+        self.assertEqual(0, Object.query().count())
+
+        obj = Object.get_or_create('foo', status='failed', source_protocol='ui',
+                                   labels=['notification'])
+        check([obj], Object.query().fetch())
+        self.assertEqual('foo', obj.key.id())
+        self.assertEqual('failed', obj.status)
+        self.assertEqual('ui', obj.source_protocol)
+        self.assertEqual(['notification'], obj.labels)
+
+        obj2 = Object.get_or_create('foo')
+        check(obj, obj2)
+        check([obj2], Object.query().fetch())
+
+        # non-null **props should be populated
+        obj3 = Object.get_or_create('foo', status='complete', source_protocol=None,
+                                    labels=[])
+        self.assertEqual('foo', obj3.key.id())
+        self.assertEqual('complete', obj3.status)
+        self.assertEqual('ui', obj.source_protocol)
+        self.assertEqual(['notification'], obj.labels)
+        check([obj3], Object.query().fetch())
+
+        check(obj3, Object.get_by_id('foo'))
+
+        Object.get_or_create('bar')
+        Object.get_or_create('baz', labels=['feed'])
+        self.assertEqual(3, Object.query().count())
+
     def test_proxy_url(self):
         obj = Object(id='abc', source_protocol='bluesky')
         self.assertEqual('http://localhost/convert/bluesky/web/abc',