From b42e63606ac6de38883db91dd36cd95ed682a186 Mon Sep 17 00:00:00 2001 From: Simon Prickett Date: Tue, 29 Mar 2022 22:15:05 +0100 Subject: [PATCH 1/2] Adds expire and test. --- aredis_om/model/model.py | 9 +++++++++ tests/test_hash_model.py | 18 ++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/aredis_om/model/model.py b/aredis_om/model/model.py index 0c2ef60..dafd41a 100644 --- a/aredis_om/model/model.py +++ b/aredis_om/model/model.py @@ -1130,6 +1130,15 @@ class RedisModel(BaseModel, abc.ABC, metaclass=ModelMeta): async def save(self, pipeline: Optional[Pipeline] = None) -> "RedisModel": raise NotImplementedError + async def expire(self, num_seconds: int, pipeline: Optional[Pipeline] = None): + if pipeline is None: + db = self.db() + else: + db = pipeline + + # TODO: Wrap any Redis response errors in a custom exception? + await db.expire(self.make_primary_key(self.pk), num_seconds) + @validator("pk", always=True, allow_reuse=True) def validate_pk(cls, v): if not v: diff --git a/tests/test_hash_model.py b/tests/test_hash_model.py index 133e43a..ddcf905 100644 --- a/tests/test_hash_model.py +++ b/tests/test_hash_model.py @@ -391,6 +391,24 @@ async def test_delete(m): assert response == 1 +@pytest.mark.asyncio +async def test_expire(m): + member = m.Member( + first_name="Expire", + last_name="Test", + email="e@example.com", + join_date=today, + age=93, + bio="This is a test user for expiry", + ) + + await member.save() + await member.expire(60) + + ttl = await m.Member.db().ttl(member.key()) + assert ttl > 0 + + def test_raises_error_with_embedded_models(m): class Address(m.BaseHashModel): address_line_1: str From 93aa9f75076e029273e2b3624f2c5eea5a171215 Mon Sep 17 00:00:00 2001 From: Simon Prickett Date: Tue, 29 Mar 2022 22:19:08 +0100 Subject: [PATCH 2/2] Updated docs with expire. --- README.md | 3 +++ docs/getting_started.md | 9 +++++++++ 2 files changed, 12 insertions(+) diff --git a/README.md b/README.md index 9e7607a..32ca32c 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,9 @@ print(andrew.pk) # We can save the model to Redis by calling `save()`: andrew.save() +# Expire the model after 2 mins (120 seconds) +andrew.expire(120) + # To retrieve this customer with its primary key, we use `Customer.get()`: assert Customer.get(andrew.pk) == andrew ``` diff --git a/docs/getting_started.md b/docs/getting_started.md index f80d8dd..5f43086 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -553,6 +553,15 @@ andrew = Customer( andrew.save() ``` +## Expiring Models + +We can expire an instance of a model using `expire`, and passing it the number of seconds after which we want the instance to expire in Redis: + +```python +# Expire Andrew in 2 minutes (120 seconds) +andrew.expire(120) +``` + ## Examining Your Data In Redis You can view the data stored in Redis for any Redis OM model.