Adds support for Server-side Session to your Flask application.

Installation

Install the extension with the following command::

pip install Flask-Session2

Quickstart

Flask-Session is really easy to use.

Basically for the common use of having one Flask application all you have to do is to create your Flask application, load the configuration of choice and then create the Session object by passing it the application.

The Session instance is not used for direct access, you should always use flask.session:

from flask import Flask, session
from flask_session import Session

app = Flask(__name__)
# Check Configuration section for more details
SESSION_TYPE = 'redis'
app.config.from_object(__name__)
Session(app)

@app.route('/set/')
def set():
    session['key'] = 'value'
    return 'ok'

@app.route('/get/')
def get():
    return session.get('key', 'not set')

You may also set up your application later using Session.init_app method:

sess = Session()
sess.init_app(app)

Configuration

The following configuration values exist for Flask-Session. Flask-Session loads these values from your Flask application config, so you should configure your app first before you pass it to Flask-Session. Note that these values cannot be modified after the init_app was applied so make sure to not modify them at runtime.

We are not supplying something like SESSION_REDIS_HOST and SESSION_REDIS_PORT, if you want to use the RedisSessionInterface, you should configure SESSION_REDIS to your own redis.Redis instance. This gives you more flexibility, like maybe you want to use the same redis.Redis instance for cache purpose too, then you do not need to keep two redis.Redis instance in the same process.

The following configuration values are builtin configuration values within Flask itself that are related to session. They are all understood by Flask-Session, for example, you should use PERMANENT_SESSION_LIFETIME to control your session lifetime.

A list of configuration keys also understood by the extension:

Basically you only need to configure SESSION_TYPE.

By default, all non-null sessions in Flask-Session are permanent.

Built-in Session Interfaces

NullSessionInterface

If you do not configure a different SESSION_TYPE, this will be used to generate nicer error messages. Will allow read-only access to the empty session but fail on setting.

RedisSessionInterface

Uses the Redis key-value store as a session backend. (redis-py required)

MemcachedSessionInterface

Uses the Memcached as a session backend. (pymemecache required)

FileSystemSessionInterface

Uses the cachelib.file.FileSystemCache as a session backend.

MongoDBSessionInterface

Uses the MongoDB as a session backend. (pymongo required)

SqlAlchemySessionInterface

Uses SQLAlchemy as a session backend. (Flask-SQLAlchemy required)

ElasticsearchSessionInterface

Uses elasticsearch as a session backend. (elasticsearch required)

• SESSION_ELASTICSEARCH
• SESSION_ELASTICSEARCH_HOST
• SESSION_ELASTICSEARCH_INDEX

GoogleCloudDatastoreSessionInterface

Uses Google Cloud Datastore as a session backend. (google-cloud-datastore required)

• GCLOUD_APP_PROJECT_ID

GoogleFireStoreSessionInterface

Uses Google Firebase as a session backend. (google-cloud-firestore required)

• SESSION_FIRESTORE
• SESSION_FIRESTORE_COLLECT

PeeweeSessionInterface

Uses Peewee as a session backend. (peewee required)

• SESSION_PEEWEE_TABLE
• SESSION_PEEWEE_CONFIG

DynamoDBSessionInterface

Uses DynamoDB as a session backend. (boto3 required)

Credits

This project is a fork of flask-session, created by Shipeng Feng.

Contributors

Thanks for many who have contributed to this project. Submit a PR if you have contributed and your name is missing.

• sulantha2006 | Google Cloud Firestore session backend
• bsmar, Nilkree, km445, PavelTsaritsynKS, PetruninAleksey | Peewee session backend
• JimBroad | DynamoDB session backend
• bieli | Custom session backend
• jesserobles | Elasticsearch session backend
• ghost | Google Datastore session backend
• PjrCodes
• treycucco
• tassaron
• rsyring
• Junzki
• gdoumenc
• twolfson
• splbio
• moskitos80
• h4ck3rm1k3
• grutz
• zebpalmer
• knivre
• funoverip
• isopropanol
• ronsmith
• marcuspen
• lucassus
• loukash
• najamansari
• brunokim
• Ricky-Hao
• slastrina
• Kolarovski
• wangsha
• christopherpickering