Dictionary with Redis as storage backend
Project description
Redis Dict
Dictionary with Redis as storage back-end. Redis is a great database for all kinds of environments; from simple to complex. redis-dict tries to make using Redis as simple as using a dictionary. redis-dict stores data in Redis with key values, this is according to Redis best practices. This also allows other non-python programs to access the data stored in Redis.
redis-dict was build out of the necessity of working with incredible large data sets. It had to be possible to only send or receive data the required data over the wire and into memory. And with redis-dict it's as simple as a dictionary.
Example
Redis is a really fast database if used right. redis-dict uses Redis as key value storage.
>>> from redis_dict import RedisDict
>>> dic = RedisDict(namespace='bar')
>>> 'foo' in dic
False
>>> dic['foo'] = 42
>>> dic['foo']
42
>>> 'foo' in dic
True
>>> dic["baz"] = "a string"
>>> print(dic)
{'foo': 42, 'baz': 'a string'}
In Redis our example looks like this.
127.0.0.1:6379> KEYS "*"
1) "bar:foo"
2) "bar:baz"
Features
Dictionary
redis-dict can be used in drop in replacement of a normal dictionary as long no referenced datascructed are used. i.e no nested layout e.g values such list, instance and other dictionaries. When used with supported types in can be used a drop in for a normal dictionary.
redis-dict has all the methods and behavior of a normal dictionary.
Types
Several python types can be saved and retrieved as the same type. As of writing, redis-dict supports the following types.
- String
- Integer
- Float
- Boolean
- None
Expire
Redis has the great feature of expiring keys, this feature is supported.
- you can set default expiration when creating redis-dict instance.
r_dic = RedisDict(namespace='app_name', expire=10)
- With context manager you can temporary set the default expiration time you have set. Defaults to None (do not expire)
seconds = 60
with r_dic.expire_at(seconds):
r_dic['gone_in_sixty_seconds'] = 'foo'
Batching
Batch your requests by using Pipeline, as easy as using context manager
Example storing the first ten items of Fibonacci, with one round trip to Redis.
def fib(n):
a, b = 0, 1
for _ in range(n):
yield a
a, b = (a+b), a
with r_dic.pipeline():
for index, item in enumerate(fib(10)):
r_dic[str(index)] = item
Namescape
Redis-dict uses name spaces by default. This allows you to have an instance of Redis-dict per project. When looking directly at the data in Redis, this gives you the advantage of directly seeing which data belongs to which app. This also has the advantage that it is less likely for apps to collide with keys, which is a difficult problem to debug.
More Examples
More complex examples of Redis-dict can be found in the tests. All functionality is tested in either assert_test.py
(here) or in the unit tests (here).
Installation
pip install redis-dict
Note
This project is used by different companies in production.
Project details
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
Hashes for redis_dict-1.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20e490deafe319c4a75d934e702ee094661ff7b242046a035c81aa9f8978bb0b |
|
MD5 | c339766b895b45f58f87f8a2477b043d |
|
BLAKE2b-256 | 072dd99fb9d3ea8e461a2e37325e7831cacf94117a133ecb594cacebe2ba9df5 |