Fake implementation of redis API for testing purposes.
Project description
fakeredis: A fake version of a redis-py
fakeredis is a pure python implementation of the redis-py python client that simulates talking to a redis server. This was created for a single purpose: to write unittests. Setting up redis is not hard, but many times you want to write unittests that do not talk to an external server (such as redis). This module now allows tests to simply use this module as a reasonable substitute for redis.
Note on redis-py 3
redis-py 3 is a recent backwards-compatible update to redis-py. It is not yet supported by fakeredis, which only implements the redis-py 2 API.
If you need to run unit tests against the redis-py 3 API, take a look at birdisle. It embeds the redis server code into your process and supports redis-py 2 and 3. It is also a more accurate emulation of redis, because it is using the actual redis codebase. The downside is that it currently only supports Linux.
How to Use
The intent is for fakeredis to act as though you’re talking to a real redis server. It does this by storing state in the fakeredis module. For example:
>>> import fakeredis
>>> r = fakeredis.FakeStrictRedis()
>>> r.set('foo', 'bar')
True
>>> r.get('foo')
'bar'
>>> r.lpush('bar', 1)
1
>>> r.lpush('bar', 2)
2
>>> r.lrange('bar', 0, -1)
[2, 1]By storing state in the fakeredis module, instances can share data:
>>> import fakeredis
>>> r1 = fakeredis.FakeStrictRedis()
>>> r1.set('foo', 'bar')
True
>>> r2 = fakeredis.FakeStrictRedis()
>>> r2.get('foo')
'bar'
>>> r2.set('bar', 'baz')
True
>>> r1.get('bar')
'baz'
>>> r2.get('bar')
'baz'Because fakeredis stores state at the module level, if you want to ensure that you have a clean slate for every unit test you run, be sure to call r.flushall() in your tearDown method. For example:
def setUp(self):
# Setup fake redis for testing.
self.r = fakeredis.FakeStrictRedis()
def tearDown(self):
# Clear data in fakeredis.
self.r.flushall()
Alternatively, you can create an instance that does not share data with other instances, by passing singleton=False to the constructor.
It is also possible to mock connection errors so you can effectively test your error handling. Simply pass connected=False to the constructor or set the connected attribute to False after initialization.
>>> import fakeredis
>>> r = fakeredis.FakeStrictRedis(connected=False)
>>> r.set('foo', 'bar')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "~/fakeredis/fakeredis.py", line 339, in func_wrapper
raise redis.ConnectionError("FakeRedis is emulating a connection error.")
redis.exceptions.ConnectionError: FakeRedis is emulating a connection error.
>>> r.connected = True
>>> r.set('foo', 'bar')
TrueFakeredis implements the same interface as redis-py, the popular redis client for python, and models the responses of redis 2.6.
Unimplemented Commands
All of the redis commands are implemented in fakeredis with these exceptions:
connection
auth
quit
select
swapdb
server
bgrewriteaof
client kill
client list
client getname
client pause
client reply
client setname
command
command count
command getkeys
command info
config get
config rewrite
config set
config resetstat
dbsize
debug object
debug segfault
info
memory doctor
memory help
memory malloc-stats
memory purge
memory stats
memory usage
monitor
role
shutdown
slaveof
slowlog
sync
time
string
bitfield
bitop
bitpos
cluster
cluster addslots
cluster count-failure-reports
cluster countkeysinslot
cluster delslots
cluster failover
cluster forget
cluster getkeysinslot
cluster info
cluster keyslot
cluster meet
cluster nodes
cluster replicate
cluster reset
cluster saveconfig
cluster set-config-epoch
cluster setslot
cluster slaves
cluster slots
readonly
readwrite
transactions
discard
exec
multi
generic
dump
migrate
move
object
randomkey
restore
touch
unlink
wait
scripting
evalsha
script debug
script exists
script flush
script kill
script load
geo
geoadd
geohash
geopos
geodist
georadius
georadiusbymember
sorted_set
zscan
Contributing
Contributions are welcome. Please see the contributing guide for more details.
If you’d like to help out, you can start with any of the issues labeled with HelpWanted.
Running the Tests
To ensure parity with the real redis, there are a set of integration tests that mirror the unittests. For every unittest that is written, the same test is run against a real redis instance using a real redis-py client instance. In order to run these tests you must have a redis server running on localhost, port 6379 (the default settings). The integration tests use db=10 in order to minimize collisions with an existing redis instance.
To run all the tests, install the requirements file:
pip install -r requirements.txt
If you just want to run the unittests:
nosetests test_fakeredis.py:TestFakeStrictRedis test_fakeredis.py:TestFakeRedis
Because this module is attempting to provide the same interface as redis-py, the python bindings to redis, a reasonable way to test this to to take each unittest and run it against a real redis server. fakeredis and the real redis server should give the same result. This ensures parity between the two. You can run these “integration” tests like this:
nosetests test_fakeredis.py:TestRealStrictRedis test_fakeredis.py:TestRealRedis
In terms of implementation, TestRealRedis is a subclass of TestFakeRedis that overrides a factory method to create an instance of redis.Redis (an actual python client for redis) instead of fakeredis.FakeStrictRedis.
To run both the unittests and the “integration” tests, run:
nosetests
If redis is not running and you try to run tests against a real redis server, these tests will have a result of ‘S’ for skipped.
There are some tests that test redis blocking operations that are somewhat slow. If you want to skip these tests during day to day development, they have all been tagged as ‘slow’ so you can skip them by running:
nosetests -a '!slow'
Revision history
0.16.0
#224 Add __delitem__
Restrict to redis<3
0.15.0
0.14.0
This release greatly improves support for threads: the bulk of commands are now thread-safe, lock has been rewritten to more closely match redis-py, and pubsub now supports run_in_thread:
0.13.1
0.13.0.1
Fix a typo in the Trove classifiers
0.13.0
0.12.0
0.11.0
0.10.3
This is a minor bug-fix release.
#189 Add ‘System’ to the list of libc equivalents
0.10.2
This is a bug-fix release.
#181 Upgrade twine & other packaging dependencies
#106 randomkey method is not implemented, but is not in the list of unimplemented commands
#170 Prefer readthedocs.io instead of readthedocs.org for doc links
#180 zadd with no member-score pairs should fail
#145 expire / _expire: accept ‘long’ also as time
#182 Pattern matching does not match redis behaviour
#135 Scan includes expired keys
#185 flushall() doesn’t clean everything
#186 Fix psubscribe with handlers
Run CI on PyPy
Fix coverage measurement
0.10.1
This release merges the fakenewsredis fork back into fakeredis. The version number is chosen to be larger than any fakenewsredis release, so version numbers between the forks are comparable. All the features listed under fakenewsredis version numbers below are thus included in fakeredis for the first time in this release.
Additionally, the following was added: - #169 Fix set-bit
fakenewsredis 0.10.0
fakenewsredis 0.9.5
This release makes a start on supporting Lua scripting: - #9 Add support for StrictRedis.eval for Lua scripts
fakenewsredis 0.9.4
This is a minor bugfix and optimization release: - #5 Update to match redis-py 2.10.6 - #7 Set with invalid expiry time should not set key - Avoid storing useless expiry times in hashes and sorted sets - Improve the performance of bulk zadd
fakenewsredis 0.9.3
This is a minor bugfix release: - #6 Fix iteration over pubsub list - #3 Preserve expiry time when mutating keys - Fixes to typos and broken links in documentation
fakenewsredis 0.9.2
This is the first release of fakenewsredis, based on fakeredis 0.9.0, with the following features and fixes:
fakeredis #78 Behaviour of transaction() does not match redis-py
fakeredis #79 Implement redis-py’s .lock()
fakeredis #90 HINCRBYFLOAT changes hash value type to float
fakeredis #101 Should raise an error when attempting to get a key holding a list)
fakeredis #146 Pubsub messages and channel names are forced to be ASCII strings on Python 2
fakeredis #163 getset does not to_bytes the value
fakeredis #165 linsert implementation is incomplete
fakeredis #128 Remove _ex_keys mapping
fakeredis #139 Fixed all flake8 errors and added flake8 to Travis CI
fakeredis #166 Add type checking
fakeredis #168 Use repr to encode floats in to_bytes
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fakeredis-0.16.0.tar.gz.
File metadata
- Download URL: fakeredis-0.16.0.tar.gz
- Upload date:
- Size: 56.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ba8a820203ba5a7a7ef62e3619318d513b87f60328c5583634df398ae4b7af00 |
|
| MD5 | 4bcb95ec6c36738339bf334dcb6bf952 |
|
| BLAKE2b-256 | bd9fad782b49ccbd788510961b7e64c8d825376ddfdd2251b2f20393d7c0f8c6 |
File details
Details for the file fakeredis-0.16.0-py2.py3-none-any.whl.
File metadata
- Download URL: fakeredis-0.16.0-py2.py3-none-any.whl
- Upload date:
- Size: 28.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0b03dfdced20169f945bde3cfd505ad5f7b8cf18ad0a124548563cbc587878da |
|
| MD5 | da7b092119b07fa10bfb1dd63a055aee |
|
| BLAKE2b-256 | 87e7c98a93305ddf13cfec664f6a209989438e7f4b21b0eef3bca4adb1e71023 |
