orbit-oss/flask
4
4
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Removed outdated section in the docs

Browse source
This commit is contained in:
Armin Ronacher 2012-08-11 03:13:16 +01:00
parent c3d38a21c6
commit a4977cfe2b
2 changed files with 2 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/api.rst
View file

@ -215,13 +215,9 @@ implementation that Flask is using.
.. autoclass:: SecureCookieSessionInterface .. autoclass:: SecureCookieSessionInterface
:members: :members:
.. autoclass:: UpgradeSecureCookieSessionInterface
.. autoclass:: SecureCookieSession .. autoclass:: SecureCookieSession
:members: :members:
.. autoclass:: UpgradeSecureCookieSession
.. autoclass:: NullSession .. autoclass:: NullSession
:members: :members:

41
docs/upgrading.rst
View file

@ -29,46 +29,9 @@ format changed from pickle to a specialized JSON format. This change has
been done in order to avoid the damage an attacker can do if the secret been done in order to avoid the damage an attacker can do if the secret
key is leaked. When you upgrade you will notice two major changes: all key is leaked. When you upgrade you will notice two major changes: all
sessions that were issued before the upgrade are invalidated and you can sessions that were issued before the upgrade are invalidated and you can
only store a limited amount of types in the session. There are two ways only store a limited amount of types in the session.
to avoid these problems on upgrading:
Automatically Upgrade Sessions
``````````````````````````````
The first method is to allow pickle based sessions for a limited amount of
time. This can be done by using the
:class:`~flask.sessions.UpgradeSecureCookieSession` session
implementation::
from flask import Flask
from flask.sessions import UpgradeSecureCookieSessionInterface
app = Flask(__name__)
app.session_interface = UpgradeSecureCookieSessionInterface
For as long as this class is being used both pickle and json sessions are
supported but changes are written in JSON format only.
Revert to Pickle Sessions
`````````````````````````
You can also revert to pickle based sessions if you want::
import pickle
from flask import Flask
from flask.sessions import SecureCookieSession, \
SecureCookieSessionInterface
class PickleSessionInterface(SecureCookieSessionInterface):
class session_class(SecureCookieSession):
serialization_method = pickle
app = Flask(__name__)
app.session_interface = PickleSessionInterface
If you want to continue to use pickle based data we strongly recommend
switching to a server side session store however.
TODO: add external module for session upgrading
Version 0.9 Version 0.9
----------- -----------