redgrease 0.1.5.dev5

RedisGears helper package

RedGrease

RedGrease is a Python package and set of tools to facilitate development against Redis in general and Redis Gears in particular.

RedGrease consists of the followinig, components:

1. A Redis / Redis Gears client (redgrease.client.RedisGears), which is an extended version of the redis client, but with additional pythonic functions, mapping closely (1-to-1) to the Redis Gears command set (e.g. RG.PYEXECUTE, RG.GETRESULT, RG.TRIGGER, RG.DUMPREGISTRATIONS etc), outlined here

from redgrease.client import RedisGears

gear_script = ... # Some Gear script

rg = RedisGears()
rg.gears.pyexecute(gear_script)  # <--

2. Some helper runtime functions defined in redgrease.runtime, but also exposed at 'top-level' (redgrease), exposing placeholders for the built-in Redis Gears functions (e.g. GearsBuilder, GB, atomic, execute, log etc) that are automatically loaded into the server runtime environment. These placeholder versions provide auto completion and type hints during development, and does not clash with the actual runtime, i.e does not require redgrease to be installed on the server.

3. Syntactic sugar for various things like 'magic' values and strings, like the different reader names (e.g redgrease.Reader.CommandReader), trigger modes (e.g. redgrease.TriggerMode.AsyncLocal) and log levels (e.g. redgrease.LogLevel.Notice).

from redgrease import GB, execute, hashtag, Reader, TriggerMode, cmd


cap = GB(Reader.StreamReader)  # <--
cap.foreach(lambda x:
            cmd.xadd(f'expired:{hashtag()}', '*', 'key', x['key']))
cap.register(prefix='*',
             mode=TriggerMode.Async,  # <-- 
             eventTypes=['expired'],
             readValue=False)

4. Servers-side Redis commands, allowing for all Redis (v.6) commands to be executed on serverside as if using a Redis 'client' class, instead of 'manually' invoking the execute(). It is basically the redis client, but with execute_command() rewired to use the Gears-native execute() instead under the hood.

import redgrease


def double(record):
    try:
        key = record["key"]
        val = redgrease.cmd.get(key)  # <--
        newval = float(val)
    except Exception as ex:
        err_msg = f"The value of the key {key} did not float very well"
        redgrease.log(err_msg + f": {ex}. Blubb, blubb!")
        raise TypeError(err_msg) from ex
    else:
        val *= 2
        redgrease.cmd.set(key, val)  # <--


redgrease.GB(redgrease.Reader.KeysReader).foreach(double).run()

4. Loader CLI and Docker image, for automatic loading of Gears scripts, mainly "trigger-based" CommandReader Gears, into a Redis Gears cluster. It also provides a simple form of 'hot-reloading' of Redis Gears scripts, by continously monitoring directories containing Redis Gears scripts and automatically 'pyexecute' them on a Redis Gear instance if it detects modifications. The purpose is mainly to streamline development of 'trigger-style' Gear scripts by providing a form of hot-reloading functionality.

redgrease --server 10.0.2.21 --watch scripts/

This will 'pyexecute' the gears scripts in the 'scripts' directory against the server. It will also watch the directors for changes and re-execute the scripts if they have been modified.

5. [Work-in-Progress] A remote GearsBuilder, inspired by the official redisgears-py client, but with some differences.

from redgrease.client import RedisGears
from redgrease.reader import CommandReader
from redgrease import log

def process(x):
    log(f"Processing '{x}'")
    return x

my_command = CommandReader().flatmap(lambda x: x)
my_command.register(trigger="bang")

rg = RedisGears()
my_command.on(rg)

rg.gears.trigger("bang")

6. [In Backlog] Other boilerplate or otherwise functions, that may commonly be used in gears. e.g:
   • A simple records() function that can be used to transform the default KeysReader dict to an Records object with the appropriate attributes. Maybe even sertter for the value (?)

   KeysReader().map(redgrease.record).foreach(lambda r: log(f"The key '{r[.key]}' is of type '{r.type}' with value '{r.value}'")
   

   • Helpers to aid debugging and/ or testing of gears.
   • ...

Suggestions appriciated.

Installation

Redgrease may be installed either as a developmet tool only, a client library and/or as a runtime library on the Redis Gears server. It can be installed with different 'extras' dependencies depending on preferred usage.

Development / Client Environment Install

In the environment where you develop your Gears scripts, simply install 'redgrease' with pip3, as usual:

python3 -m pip install redgrease[all]

This installs all the dependencies, allowing for the full features set.

reagrease[cli] : Installs dependencies for the CLI

Runtime / Server Environment Install

It is recomendede to use the redgreese[runtime] package as a serverside dependency. This installs dependencies for the all the serverside features such as serverside Redis commands and the runtime for gears constructed with the 'Remote Gears Builder'

from redgrease.client import RedisGears

rg = RedisGears()
rg.gears.pyexecute("", requirements=["redgrease[runtime]"])

The current 3rd party packages in the runtime extras are:

• attrs - For parsing composite Gears response structures into attrs objects
• redis - Needed for server-side redis commands
• cludpickle - Needed for the "Remote" gears (similarly to the official redisgears-py client)

Note on the runtime environment

If the only thing you need is the redgrease client and/or docstings, typhints and the loader CLI for development of conventional Gears scripts (i.e that only use the standard commands and loaded as strings), then the RedGrease package is not strictly required to be installed in the Redis Gears Python Runtime environment (i.e. on the server)

You can in this case simply remove the redgrease import clause from your script, after development but before pyexecuting them as per the Redis Gears documentation. Such scripts will still run perfectly fine without redgrease in Redis Gears Environment.

A minimal install, without any 3-rd party dependencies, which is pretty much only the syntactic sugar and runtime placeholders, can be installed usig the bare 'redgrease' package.

This migth be useful if you really don't want the 3rd party packages in the server runtime but still want to use the redgrese sugar.

You can also use the RedGrease watcher or loader CLI to automate loading your scripts as well as requirements from a normal 'requirements.txt' files, as outlined here

Usage / Documentation

The Documenttion is work-in-progress, but the latest and greatest version is available here:

https://redgrease.readthedocs.io

Go read the docs!

Testing

Tests are separate from the package, but are available in the GitHub repo.

git clone https://github.com/lyngon/redgrease

In order to run the tests, Docker is required to be installed in order to spin up fresh Redis instances, on demand for the tests.

PyTest and quite a number of its add-ons, as well as Tox, is also needed to run the tests properly. All test (and dev) requirements is best installed through:

cd redgrease/
python3 -m venv .venv
source .venv/bin/activate
pip install -r src/requirements-dev.txt

Then the tess can be run with PyTest as per usual:

pytest 

Note: Running the tests takes excruciatingly long, sas a new fresh Redis instance is spun up for each test, just to ensure no risk of cross-contamination. This may be optimized, as many tests are actually independent, but it's left like this for now.

Why This?

The need for this arose from wanting to prototype the concepts for a new Redis module, using Gears CommandReaders and triggers instead of having to write full fledged module in C.

Intitially RedGrease was just a very simple module, with placeholders for the default Redis gears runtime functions, with type hints and docstrings, just to make it more convenient and less error prone to write Gears functions.

Then the loader cli was created, in order to furthure speed up the rapid development cycle.

Then the server-side Redis 'client' commands function was addes to minimize errors (E.g. mispelled command strings).

Then the client was added ... and before long it started to get a life of its own.

Note that this means RedGrease package is primarily intended to be an aid for development of Gears scripts, and was not originally intended to be used in any "production" software.

This intent has now changed, and the new goal is now to make Redgrease a production grade package for Redis Gears. Granted, there is stilll quite some way to go to get there, so your support and feedback is greatly appriciated.

If you like this project, or want professional support, please consider sponsoring.