From a0555d4cdce5981721a0151a42a01b24d99d14ec Mon Sep 17 00:00:00 2001 From: Calen Pennington Date: Tue, 21 Apr 2015 12:47:08 -0400 Subject: [PATCH] Add more documentation to DjangoOrmFieldCache --- lms/djangoapps/courseware/model_data.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/lms/djangoapps/courseware/model_data.py b/lms/djangoapps/courseware/model_data.py index a2659d6f10..638d8d7474 100644 --- a/lms/djangoapps/courseware/model_data.py +++ b/lms/djangoapps/courseware/model_data.py @@ -197,10 +197,26 @@ class DjangoOrmFieldCache(object): @contract(kvs_key=DjangoKeyValueStore.Key) def get(self, kvs_key): + """ + Return the django model object specified by `kvs_key` from + the cache. + + Arguments: + kvs_key (`DjangoKeyValueStore.Key`): The field value to delete + + Returns: A django orm object from the cache + """ return self._cache.get(self._cache_key_for_kvs_key(kvs_key)) @contract(kvs_key=DjangoKeyValueStore.Key) def set(self, kvs_key, value): + """ + Set the specified `kvs_key` to the django model object `value`. + + Arguments: + kvs_key (`DjangoKeyValueStore.Key`): The field value to delete + value: The django orm object to be stored in the cache + """ self._cache[self._cache_key_for_kvs_key(kvs_key)] = value @contract(kvs_key=DjangoKeyValueStore.Key)