Skip to main content

Simple, distributed sorted sets with redis

Project description

PyPI version build status Coverage Status

You may not need heavyweights like Celery or RQ. Maintaing an AMQP server might be overkill. There’s a simpler, easier way to distribute work.

Redset provides simple, generic sorted sets backed by Redis that can be used to coordinate distributed systems and parcel out work. Unlike more common distribution libraries like Celery or RQ, redset avoids duplicate work for certain use-cases by maintaining a set of tasks instead of a list or queue. And it does so with a dead-simple interface that feels natural for Python.

Redset is currently used in the wild to do things like

  • maintain a high-throughput work queue of streaming updates to be processed

  • power a multi-producer, multi-consumer scraping architecture that won’t do the same work twice

  • maintain a simple, cross-process set of “seen” items that each have a TTL

  • schedule non-duplicate, periodic polling of analytics on social services

Features

  • No worker daemons to run, no heavy AMQP service to monitor

  • Safe for multiple producers and consumers

  • Seamless, simple use with Python objects using serializers

  • Zero dependencies: you provide an object that implements the redis.client.Redis interface, we don’t ask any questions.

  • Simple, easy-to-read implementation

  • Mimics Python’s native set interface

  • Battle-tested

  • Python 3 compatible

Simple example

import json
import redis

from redset import TimeSortedSet

r = redis.Redis()
ss = TimeSortedSet(r, 'important_json_biz', serializer=json)

ss.add({'foo': 'bar1'})
ss.add({'foo': 'bar2'})

ss.add({'foo': 'bar3'})
ss.add({'foo': 'bar3'})

len(ss)
# 3


# ...some other process A

ss.peek()
# {'foo': 'bar1'}

ss.pop()
# {'foo': 'bar1'}


# ...meanwhile in process B (at exactly same time as A's pop)

ss.take(2)
# [{'foo': 'bar2'}, {'foo': 'bar3'}]

Docs

Here

About

This software was developed at Percolate, where we use it for all sorts of things that involve maintaining synchronized sets of things across process boundaries. A common use-case is to use redset for coordinating time-sensitive tasks where duplicate requests may be generated.

Redset is unopinionated about how consumers look or behave. Want to have a plain ‘ol Python consumer managed by supervisor? Fine. Want to be able to pop off items from within a celery job? Great. Redset has no say in where or how it is used: mechanism, not policy.

Usage concepts

redset.SortedSet and its subclasses can be instantiated with a few paramters that are notable.

Specifying a serializer

Since Redis only stores primitive numbers and strings, handling serialization and deserialization is a key part of making redset set usage simple in Python.

A serializer instance can be passed (which adheres to the redset.interfaces.Serializer interface, though it need not subclass it) to automatically handle packing and unpacking items managed with redset.

Specifying a scorer

A callable that specifies how to generate a score for items being added can also be passed to SortedSet’s constructor as scorer. This callable takes one argument, which is the item object (i.e. the item before serialization) to be “scored.”

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

redset-0.5.1.tar.gz (8.6 kB view details)

Uploaded Source

Built Distributions

redset-0.5.1-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

redset-0.5.1-py2-none-any.whl (11.7 kB view details)

Uploaded Python 2

File details

Details for the file redset-0.5.1.tar.gz.

File metadata

  • Download URL: redset-0.5.1.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for redset-0.5.1.tar.gz
Algorithm Hash digest
SHA256 a1eeab91f95acc586e5886f3fffdc2bcfbdd00dc00d0da881c5d1482b70a92af
MD5 bac9043b24f830cafd3826d6e4bafd65
BLAKE2b-256 f5cfaabbe231b78a8b50a3e7779d03b5a2493e040e470f26f99b7e10644fa49f

See more details on using hashes here.

File details

Details for the file redset-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for redset-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f841ff13156725ab5facbf287cac9c97152dcdd74885880b268b06cff6fbb436
MD5 4790fb68a3a58aabddd5955ffd9b4ca0
BLAKE2b-256 c56e359b7165782e7b517a54b7aed1c9c4b2665fd6ca06256f8acec5b786cd09

See more details on using hashes here.

File details

Details for the file redset-0.5.1-py2-none-any.whl.

File metadata

File hashes

Hashes for redset-0.5.1-py2-none-any.whl
Algorithm Hash digest
SHA256 d7436d638531bfa3baa93ba4a365afd2262cae8538ec1f49ff8cfe4c6263abbf
MD5 5cf1398edde9e7125b563bdbb153adab
BLAKE2b-256 70a63823eae1a6c60e17068145e35387163e7e6f657558d674fffb68e74ce136

See more details on using hashes here.

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