Skip to main content

Redis native types for Python

Project description

https://travis-ci.org/vladimirshkoda/redis-bindings.svg?branch=master https://img.shields.io/badge/style-wemake-000000.svg

Redis bindings is an attempt to bring Redis types into Python as native ones. It is based on redis-py and has the following types implemented so far:

Moreover, it provides some Redis descriptor interfaces:

  • IRedisField

  • IRedisListField

It is exactly interfaces, because it requires user to override get_key_name method to define key name for Redis. Here is an example of how it can be implemented (can be found in example.py).

from redis import Redis
from redistypes.descriptors import IRedisField, IRedisListField


r_connection = Redis()


class RedisField(IRedisField):
    def __init__(self, pickling=True):
        super(RedisField, self).__init__(
            redis_connection=r_connection,
            pickling=pickling
        )

    def get_key_name(self, instance):
        return ':'.join([
            instance.__class__.__name__, str(instance.pk), self.name
        ])


class RedisListField(IRedisListField, RedisField):
    pass


class Student:
    name = RedisField()
    subjects = RedisListField()

    def __init__(self, pk):
        self.pk = pk

The Student class defined above can do the following things:

>>> from example import Student
>>> s = Student(pk=1)
>>> s.name = 'John Galt'
>>> s.subjects = ['math', 'physics']
>>> s.name
John Galt
>>> s.subjects
RedisList: ['math', 'physics']
>>> s.subjects.append('p.e.')
>>> s.subjects
RedisList: ['math', 'physics', 'p.e.']
>>> # Values stored inside the Redis types are immutable!
>>> s.subjects.append({'name': 'art', 'avg_score': 4.5})
>>> s.subjects[3]
{'avg_score': 4.5, 'name': 'art'}
>>> s.subjects[3]['avg_score'] = 3
>>> s.subjects[3]
{'avg_score': 4.5, 'name': 'art'}

Warning!

All values stored inside the Redis types are immutable! As the example above shows, an attempt to change the value stored in the dictionary inside the RedisList leads to nothing.

Roadmap

  • Querying over the pipe

  • RedisDict

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

redistypes-0.2.0.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

redistypes-0.2.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file redistypes-0.2.0.tar.gz.

File metadata

  • Download URL: redistypes-0.2.0.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.6

File hashes

Hashes for redistypes-0.2.0.tar.gz
Algorithm Hash digest
SHA256 2c87966b5c0b27ffbc75e0d3acf97ee949929643ffae06d54d2fe69b4e18ea0d
MD5 b94b9e87cd0dd5811b451e608f90b57a
BLAKE2b-256 e532e2137ab35ffea24fb74fc90b0b9d1d6b4d95e092c6ce1d0983057856971f

See more details on using hashes here.

File details

Details for the file redistypes-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: redistypes-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.6

File hashes

Hashes for redistypes-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 38ecc3796e12192c31b2fa7d4ebe3f66788412306137b03bd0beaed107f8d2a3
MD5 f5ae38dccceaddd3a5e9f78c76564f35
BLAKE2b-256 556388531c600bcc875400758983bf30bf1e77c96ddf6fc895abf82b3dc8ebbb

See more details on using hashes here.

Supported by

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