Skip to content

Commit d5ae845

Browse files
committed
Docstring and comments
1 parent f9e39bb commit d5ae845

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

django_mongodb_backend/cache.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,11 @@ def get(self, key, default=None, version=None):
6363
return self.get_many([key], version).get(key, default)
6464

6565
def _filter_expired(self, expired=False):
66+
"""
67+
Create a filter to exclude expired data by default
68+
or include only expired data if `expired` is True.
69+
"""
70+
# The data isn't expired if expires_at > now or is null.
6671
not_expired_filter = [{"expires_at": {"$gte": datetime.utcnow()}}, {"expires_at": None}]
6772
operator = "$nor" if expired else "$or"
6873
return {operator: not_expired_filter}
@@ -120,7 +125,7 @@ def _cull(self, num):
120125
else:
121126
keep_num = num - num // self._cull_frequency
122127
try:
123-
# Delete the first expiration date.
128+
# Delete from the first expiration date.
124129
deleted_from = next(
125130
self.collection_for_write.aggregate(
126131
[
@@ -132,8 +137,10 @@ def _cull(self, num):
132137
)
133138
)
134139
except StopIteration:
140+
# Empty result, nothing to delete.
135141
pass
136142
else:
143+
# Remove from key.
137144
self.collection_for_write.delete_many(
138145
{
139146
"$or": [

0 commit comments

Comments
 (0)