Adds delete function at a class level.

Author: Simon Prickett

aredis_om/model/model.py

@@ -1335,6 +1335,10 @@ async def get(cls, pk: Any) -> "HashModel":
             result = cls.parse_obj(document)
         return result
 
+    @classmethod
+    async def delete(cls, pk: Any) -> int:
+        return await cls.db().delete(cls.make_primary_key(pk))
+
     @classmethod
     @no_type_check
     def _get_value(cls, *args, **kwargs) -> Any:
@@ -1503,6 +1507,10 @@ async def get(cls, pk: Any) -> "JsonModel":
             raise NotFoundError
         return cls.parse_raw(document)
 
+    @classmethod
+    async def delete(cls, pk: Any) -> int:
+        return await cls.db().delete(cls.make_primary_key(pk))
+
     @classmethod
     def redisearch_schema(cls):
         key_prefix = cls.make_key(cls._meta.primary_key_pattern.format(pk=""))

tests/test_hash_model.py

@@ -374,6 +374,21 @@ async def test_saves_model_and_creates_pk(m):
     member2 = await m.Member.get(member.pk)
     assert member2 == member
 
+@pytest.mark.asyncio
+async def test_delete(m):
+    member = m.Member(
+        first_name="Simon",
+        last_name="Prickett",
+        email="[email protected]",
+        join_date=today,
+        age=97,
+        bio="This is a test use to be deleted.",
+    )
+
+    await member.save()
+    response = await m.Member.delete(member.pk)
+    assert response == 1
+
 
 def test_raises_error_with_embedded_models(m):
     class Address(m.BaseHashModel):

tests/test_json_model.py

@@ -186,6 +186,21 @@ async def test_saves_model_and_creates_pk(address, m, redis):
     assert member2 == member
     assert member2.address == address
 
+@pytest.mark.asyncio
+async def test_delete(address, m, redis):
+    member = m.Member(
+        first_name="Simon",
+        last_name="Prickett",
+        email="[email protected]",
+        join_date=today,
+        age=38,
+        address=address,
+    )
+
+    await member.save()
+    response = await m.Member.delete(member.pk)
+    assert response == 1
+
 
 @pytest.mark.asyncio
 async def test_saves_many_implicit_pipeline(address, m):