redis-tagged-cache
What is it?
redis-tagged-cache is a Python 3.7+ cache library backed with Redis with O(1) tags-based invalidation system.
Low level example
Installation: pip install redis-tagged-cache
Usage:
from rtc import CacheMiss, RedisTaggedCache
cache = RedisTaggedCache(
namespace="foo",
host="localhost",
port=6379,
)
invalidation_tags = ["tag1", "tag2"] # tags are only strings of your choice
# Let's store something in the cache under the key "key1"
# (with a 60s lifetime)
cache.set("key1", "my value", tags=invalidation_tags, lifetime=60)
# it will output "my value" (cache hit!)
print(cache.get("key1", tags=invalidation_tags))
# Let's invalidate a tag (O(1) operation)
cache.invalidate("tag2")
# As the "key1" entry is tagged with "tag1" and "tag2"...
# ...the entry is invalidated (because we just invalidated "tag2")
# It will print "cache miss"
try:
cache.get("key1", tags=invalidation_tags)
except CacheMiss:
print("cache miss")
High level example
from rtc import RedisTaggedCache
cache = RedisTaggedCache(
namespace="foo",
host="localhost",
port=6379,
)
class A:
@cache.decorator(lifetime=60, tags=["tag1", "tag2"])
def slow_method(self, arg1: str, arg2: str = "foo"):
print("called")
return arg1 + arg2
if __name__ == "__main__":
a = A()
# It will output "called" and "foobar" (cache miss)
print(a.slow_method("foo", arg2="bar"))
# It will output "foobar" (cache hit)
print(a.slow_method("foo", arg2="bar"))
# It will output "called" and "foo2bar" (cache miss)
print(a.slow_method("foo2", arg2="bar"))
Full API
You will find the full API in this reference documentation.
Pros & Cons
Pros
All methods have a O(1) complexity regarding the number of keys. The invalidation is synchronous and very fast event if you invalidate millions of keys.
Note: complexity is O(n) regarding the number of tags.
Cons
The invalidation system does not really remove keys from redis. Invalidated entries are inaccessible (from the API) but they are not removed when the invalidation occurred. They are going to expire by themselves.
Be sure to configure your redis instance as a cache with capped memory (see maxmemory configuration parameter) and maxmemory-policy allkeys-lru settings about keys automatic eviction
Dev
As we support Python 3.7+ for the runtime, the dev environment requires Python 3.9+.
make lint: for linting the codemake test: for executing test
(the venv will be automatically created)
Metadata
Release files for redis-tagged-cache 0.12.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| redis_tagged_cache-0.12.1.tar.gz | 16.2 kB | Without provenance | Details for redis_tagged_cache-0.12.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| redis_tagged_cache-0.12.1-py3-none-any.whl | Python 3 | none | any | Details for redis_tagged_cache-0.12.1-py3-none-any.whl |
Total release size: 40.0 kB
Release files / redis_tagged_cache-0.12.1.tar.gz
| Download URL | redis_tagged_cache-0.12.1.tar.gz |
|---|---|
| Size | 16.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8bb799c60bf7857766ffb722403e3b49c8e8429434fa4707cc7145b5710451a0
|
|
BLAKE2b-256 checksum How to use checksums |
d2f5fe119d3828b664a7a6a15f4d5b7c335b40502c20326a08bb2a00a775f52c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.6
|
Release files / redis_tagged_cache-0.12.1-py3-none-any.whl
| Download URL | redis_tagged_cache-0.12.1-py3-none-any.whl |
|---|---|
| Size | 23.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5abd4d925d867ec852e8de1a49889669fb1ee38ca5341fe0cd35213a826a2c21
|
|
BLAKE2b-256 checksum How to use checksums |
137993202d522c62c327fa00f5e5692fb0b6d3eab74463ee5c7bdb9aaef61720
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.6
|
Security for redis-tagged-cache 0.12.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.