Cleaned up some __getstate__() docstrings.

This commit is contained in:
Tim Graham 2016-11-23 09:45:21 -05:00
parent b63d0c54b0
commit 2e5fbe889f
3 changed files with 8 additions and 12 deletions

View File

@ -197,9 +197,6 @@ class QuerySet(object):
return obj return obj
def __getstate__(self): def __getstate__(self):
"""
Allows the QuerySet to be pickled.
"""
# Force the cache to be fully populated. # Force the cache to be fully populated.
self._fetch_all() self._fetch_all()
obj_dict = self.__dict__.copy() obj_dict = self.__dict__.copy()

View File

@ -44,11 +44,9 @@ class SimpleTemplateResponse(HttpResponse):
self._is_rendered = False self._is_rendered = False
def __getstate__(self): def __getstate__(self):
"""Pickling support function. """
Raise an exception if trying to pickle an unrendered response. Pickle
Ensures that the object can't be pickled before it has been only rendered data, not the data used to construct the response.
rendered, and that the pickled state only includes rendered
data, not the data used to construct the response.
""" """
obj_dict = self.__dict__.copy() obj_dict = self.__dict__.copy()
if not self._is_rendered: if not self._is_rendered:

View File

@ -300,11 +300,12 @@ class LazyObject(object):
self._setup() self._setup()
return (unpickle_lazyobject, (self._wrapped,)) return (unpickle_lazyobject, (self._wrapped,))
# We have to explicitly override __getstate__ so that older versions of
# pickle don't try to pickle the __dict__ (which in the case of a
# SimpleLazyObject may contain a lambda). The value will end up being
# ignored by our __reduce__ and custom unpickler.
def __getstate__(self): def __getstate__(self):
"""
Prevent older versions of pickle from trying to pickle the __dict__
(which in the case of a SimpleLazyObject may contain a lambda). The
value will be ignored by __reduce__() and the custom unpickler.
"""
return {} return {}
def __copy__(self): def __copy__(self):