Skip to main content

Set of basic Python collections backed by Redis.

Project description

redis-collections is a Python library that provides a high-level interface to Redis, the excellent key-value store.

As of 2024, this project is retired. This repository will remain available as a public archive.

Quickstart

Import the collections from the top-level redis_collections package.

Standard collections

The standard collections (e.g. Dict, List, Set) behave like their Python counterparts:

>>> from redis_collections import Dict, List, Set

>>> D = Dict()
>>> D['answer'] = 42
>>> D['answer']
42

Collection

Redis type

Description

Dict

Hash

Emulates Python’s dict

List

List

Emulates Python’s list

Set

Set

Emulates Python’s set

Counter

Hash

Emulates Python’s collections.Counter

DefaultDict

Hash

Emulates Python’s collections.defaultdict

Deque

List

Emulates Python’s collections.deque

Syncable collections

The syncable collections in this package provide types whose contents are kept in memory. When their sync method is called those contents are written to Redis:

>>> from redis_collections import SyncableDict

>>> with SyncableDict() as D:
...     D['a'] = 1  # No write to Redis
...     D['a'] += 1  # No read from or write to Redis
>>> D['a']  # D.sync() is called at the end of the with block
2

Collection

Python type

Description

SyncableDict

dict

Syncs to a Redis Hash

SyncableList

list

Syncs to a Redis List

SyncableSet

set

Syncs to a Redis Set

SyncableCounter

collections.Counter

Syncs to a Redis Hash

SyncableDeque

collections.deque

Syncs to a Redis List

SyncableDefaultDict

collections.defaultdict

Syncs to a Redis Hash

Other collections

The LRUDict collection stores recently used items in in memory. It pushes older items to Redis:

>>> from redis_collections import LRUDict

>>> D = LRUDict(maxsize=2)
>>> D['a'] = 1
>>> D['b'] = 2
>>> D['c'] = 2  # 'a' is pushed to Redis and 'c' is stored locally
>>> D['a']  # 'b' is pushed to Redis and 'a' is retrieved for local storage
1
>>> D.sync()  # All items are copied to Redis

The SortedSetCounter provides access to the Redis Sorted Set type:

>>> from redis_collections import SortedSetCounter

>>> ssc = SortedSetCounter([('earth', 300), ('mercury', 100)])
>>> ssc.set_score('venus', 200)
>>> ssc.get_score('venus')
200.0
>>> ssc.items()
[('mercury', 100.0), ('venus', 200.0), ('earth', 300.0)]

Documentation

For more information, see redis-collections.readthedocs.io

License: ISC

© 2016-2024 Bo Bayles <bbayles@gmail.com> and contributors © 2013-2016 Honza Javorek <mail@honzajavorek.cz> and contributors

This work is licensed under ISC license.

This library is not affiliated with Redis Labs, Redis, or redis-py. Govern yourself accordingly!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

redis-collections-0.13.0.tar.gz (41.0 kB view hashes)

Uploaded Source

Built Distribution

redis_collections-0.13.0-py2.py3-none-any.whl (29.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page