summaryrefslogtreecommitdiff
path: root/docs/narr
diff options
context:
space:
mode:
authorjonathan vanasco <jonathan@2xlp.com>2019-11-04 16:59:41 -0500
committerjonathan vanasco <jonathan@2xlp.com>2019-11-05 16:51:10 -0500
commit1d2b4fd13edc972dd4076500b1ec4cb972bef1c9 (patch)
tree1ab8d633f8916a5190e33af62ca00aafacfef4ed /docs/narr
parentbbc82eac577d2e8a8758df02431cf42df3cae298 (diff)
downloadpyramid-1d2b4fd13edc972dd4076500b1ec4cb972bef1c9.tar.gz
pyramid-1d2b4fd13edc972dd4076500b1ec4cb972bef1c9.tar.bz2
pyramid-1d2b4fd13edc972dd4076500b1ec4cb972bef1c9.zip
deprecate PickleSerializer
Diffstat (limited to 'docs/narr')
-rw-r--r--docs/narr/sessions.rst20
1 files changed, 13 insertions, 7 deletions
diff --git a/docs/narr/sessions.rst b/docs/narr/sessions.rst
index c2cc60de8..413dc5b8e 100644
--- a/docs/narr/sessions.rst
+++ b/docs/narr/sessions.rst
@@ -91,26 +91,32 @@ Remember that sessions should be short-lived and thus the number of clients affe
.. code-block:: python
:linenos:
+ import pickle
from pyramid.session import JSONSerializer
- from pyramid.session import PickleSerializer
from pyramid.session import SignedCookieSessionFactory
+
class JSONSerializerWithPickleFallback(object):
def __init__(self):
self.json = JSONSerializer()
- self.pickle = PickleSerializer()
- def dumps(self, value):
+ def dumps(self, appstruct):
+ """Accept a Python object and return bytes."""
# maybe catch serialization errors here and keep using pickle
# while finding spots in your app that are not storing
# JSON-serializable objects, falling back to pickle
- return self.json.dumps(value)
+ return self.json.dumps(appstruct)
- def loads(self, value):
+ def loads(self, bstruct):
+ """Accept bytes and return a Python object."""
try:
- return self.json.loads(value)
+ return self.json.loads(bstruct)
except ValueError:
- return self.pickle.loads(value)
+ try:
+ return pickle.loads(bstruct)
+ # at least ValueError, AttributeError, ImportError but more to be safe
+ except Exception:
+ raise ValueError
# somewhere in your configuration code
serializer = JSONSerializerWithPickleFallback()