A nice way to use Redis in your Flask app
A nice way to use Redis in your Flask app.
Start by installing the extension with
pip install flask-redis.
Once that's done, configure it within your Flask config.
Set the URL of your Redis instance like this:
REDIS_URL = "redis://:password@localhost:6379/0"
If you wanna connect to a Unix socket,
you can specify it like
To add a Redis client to your application:
from flask import Flask from flask_redis import FlaskRedis app = Flask(__name__) redis_client = FlaskRedis(app)
or if you prefer, you can do it the other way around:
redis_client = FlaskRedis(app) def create_app(): app = Flask(__name__) redis_client.init_app(app) return app
The redis client you created above from
FlaskRedis acts just like a regular
Redis instance from the
from my_app import redis_client @app.route('/') def index(): return redis_client.get('potato')
For detailed instructions on what methods you can use on the client, as well as how you can use advanced features such as Lua scripting, pipelines, and callbacks, please check the redis-py documentation.
Pro-tip: The redis-py
package uses the
redis namespace, so it's nicer to name your Redis object something like
redis_client instead of just
Extra features in flask-redis
Instead of the default
Redis client from
you can provide your own.
This can be useful to replace it with mockredis for testing:
from flask import Flask from flask_redis import FlaskRedis from mockredis import MockRedis def create_app(): app = Flask(__name__) if app.testing: redis_store = FlaskRedis.from_custom_provider(MockRedis) else: redis_store = FlaskRedis() redis_store.init_app(app) return app
- Check for open issues or open a fresh issue to start a discussion
- Fork the repository on GitHub.
- Send a pull request with your code!
Merging will require a test which shows that the bug was fixed, or that the feature works as expected. Feel free to open a draft pull request though without such a test and ask for help with writing it if you're not sure how to.
As Bence (the only maintainer) works full-time, please allow some time before your issue or pull request is handled.
All notable changes to this project will be documented in this file.
- Reorganized the module and rewrote everything other than the library code, mainly packaging and CI. There are no user-facing changes in behavior.
- Backwards incompatible: The
FlaskRedis.init_appmethod no longer takes a
strictparameter. Pass this flag when creating your
- Backwards incompatible: The extension will now be registered
under the (lowercased) config prefix of the instance. The default
config prefix is
'REDIS', so unless you change that, you can still access the extension via
- Backwards incompatible: The default class has been changed to
redis.StrictRedis. You can switch back to the old
redis.Redisclass by specifying
- You can now pass all supported
Rediskeyword arguments (such as
FlaskRedisand they will be correctly passed over to the
redis-pyinstance. Thanks, @giyyapan!
- Usage like
redis_store['key'] = value,
del redis_store['key']is now supported. Thanks, @ariscn!
- Made 0.1.0's deprecation warned changes final
- Deprecation: Renamed
flask_redis.FlaskRedis. Using the old name still works, but emits a deprecation warning, as it will be removed from the next version
- Deprecation: Setting a
REDIS_DATABASE(or equivalent) now emits a deprecation warning as it will be removed in the version in favor of including the database number in
- Added a
FlaskRedis.from_custom_provider(provider)class method for using any redis provider class that supports instantiation with a
- Added a
FlaskRediswhich expects a boolean value and allows choosing between using
redis.Redisas the defualt provider.
FlaskRedisregister as a Flask extension through Flask's extension API
- Rewrote test suite in py.test
- Got rid of the hacky attribute copying mechanism in favor of using
__getattr__magic method to pass calls to the underlying client
- Improved Python 3 Support (Thanks underyx!).
- Improved test cases.
- Improved configuration.
- Fixed up documentation.
- Removed un-used imports (Thanks underyx and lyschoening!).
- Improved suppot for the config prefix.
- Added support for config_prefix, allowing multiple DBs.
- Added TravisCI Testing for Flask 0.9/0.10.
- Added Badges to README.
- Implemented a very simple test.
- Fixed some documentation issues.
- Included requirements.txt for testing.
- Included task file including some basic methods for tests.
- Initial Commit of Package to GitHub.
flask-redis project is written and maintained
by Bence Nagy (underyx).
The project was originally created by Rhys Elsmore, who maintained it until the 0.0.6 release in 2014. His work was licensed under the Apache 2 license. The project has gone through a full rewrite since, but his work was essential as inspiration. Thanks, Rhys!
A full list of contributors can be found on GitHub's Contributors page
or you can obtain it on your own by running
git shortlog -sn.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for flask_redis-0.4.0-py2.py3-none-any.whl