redis_models 0.0.4

This package provides a simple model structure for redis based storage.

Redis Models

This package provides a simple model structure for redis based storage. It acts like an ORM and allows you to create models with validation.

Installation

pip install redis_models

Usage

First, you need to create your model. It's similar to Pydantic models, or built-in dataclass.

from redis_models.models import RedisModelMeta


class User(metaclass=RedisModelMeta):
    name: str
    age: int

    class Meta:
        redis_url = "redis://localhost:6379/0"

Let's create a User object

user = User(name="John Doe", age=30)

Let's try creating an object that does not fit to the definition

try:
    bad_user = User(name="John", eye_color="blue")
except ValidationError:
    pass

Let's write it to Redis

user.save()

Let's see its id. ids are UUID4 hex strings

print(user.id)

Fetch the record from Redis

user_again = User.get(id=user.id)

See the object as dictionary

print(user.asd)

Let's delete the record

user_again.delete()

Trying to find a non-existing record throws NotFound exception

from redis_models.errors import NotFound

try:
    user_not_found = User.get(id=user_again.id)
except NotFound:
    print("User not found!")