Skip to main content

Lightweight in-memory cache with TTL, LRU eviction, and tag-based invalidation

Project description

philiprehberger-cache-kit

Lightweight in-memory cache with TTL, LRU eviction, and tag-based invalidation.

Installation

pip install philiprehberger-cache-kit

Usage

Basic Cache

from philiprehberger_cache_kit import Cache

cache: Cache[str] = Cache(max_size=1000)

cache.set("key", "value")
print(cache.get("key"))  # "value"

TTL (Time-to-Live)

cache = Cache(default_ttl=60.0)  # 60 seconds default

cache.set("session", "abc123")           # uses default TTL
cache.set("temp", "data", ttl=5.0)       # expires in 5 seconds
cache.set("permanent", "data", ttl=None) # no expiry when default is set

LRU Eviction

cache = Cache(max_size=100)

# When full, least recently used entries are evicted first
# Expired entries are evicted before non-expired ones
for i in range(200):
    cache.set(f"key-{i}", f"value-{i}")

print(cache.size)  # 100

Tag-Based Invalidation

cache.set("user:1", user_data, tags={"users", "team-a"})
cache.set("user:2", user_data, tags={"users", "team-b"})
cache.set("post:1", post_data, tags={"posts", "team-a"})

# Invalidate all entries tagged "team-a"
removed = cache.invalidate_by_tag("team-a")
print(removed)  # 2

Other Operations

cache.has("key")        # check existence
"key" in cache          # same as has()
cache.delete("key")     # delete single entry
cache.keys()            # list all non-expired keys
len(cache)              # count of non-expired entries
cache.get_entry("key")  # get CacheEntry with tags, expires_at
cache.clear()           # remove everything

API Reference

Method Description
Cache(max_size=1000, default_ttl=None) Create a new cache
.set(key, value, ttl=None, tags=None) Store a value
.get(key, default=None) Retrieve a value
.has(key) Check if key exists and is not expired
.delete(key) Remove a key
.invalidate_by_tag(tag) Remove all entries with a tag
.clear() Remove all entries
.keys() List non-expired keys
.get_entry(key) Get CacheEntry object (value, expires_at, tags)
.size Number of stored entries
len(cache) Number of non-expired entries
key in cache Check key existence

License

MIT

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

philiprehberger_cache_kit-0.2.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_cache_kit-0.2.0-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_cache_kit-0.2.0.tar.gz
Algorithm Hash digest
SHA256 477afaa5b77796588e08285c142f1f2775099a957c093498d6f90eec54f1f8fe
MD5 4b28e3264adfe1fbb681c3a1f6476b9c
BLAKE2b-256 e68283f4cffae35de995a024a33516b76aebc3175db5ba0cc8dfdd942a7d44c9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_cache_kit-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1de09dad3ace1c2a6eb6c442a301cc619582f7d9255924a399ead955a5a1ad03
MD5 941f94200967766a6f51b06935470ea9
BLAKE2b-256 18e1876feaee0ca113e01c55f4f2c0f913f67834794901dfa65bef7472d10252

See more details on using hashes here.

Supported by

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