Skip to main content

Flexible caching utilities for Python functions

Project description

twat-cache

(work in progress)

A flexible caching utility package for Python functions that provides a unified interface for caching function results using various backends (memory, disk, SQL).

Features

  • Simple decorator interface for caching function results
  • Multiple caching backends:
    • Memory-based LRU cache (always available)
    • SQL-based disk cache using diskcache (optional)
    • Efficient array caching using joblib (optional)
  • Automatic cache directory management
  • Type hints and modern Python features

Installation

pip install twat-cache

Usage

Basic usage with default memory caching:

from twat_cache import ucache

@ucache()
def expensive_computation(x):
    # Results will be cached automatically
    return x * x

result = expensive_computation(42)  # Computed
result = expensive_computation(42)  # Retrieved from cache

Using SQL-based disk cache:

@ucache(folder_name="my_cache", use_sql=True)
def process_data(data):
    # Results will be cached to disk using SQL backend
    return data.process()

Using joblib for efficient array caching:

import numpy as np
from twat_cache import ucache

@ucache(folder_name="array_cache")
def matrix_operation(arr):
    # Large array operations will be efficiently cached
    return np.dot(arr, arr.T)

Cache Location

The package automatically manages cache directories using the following strategy:

  1. If platformdirs is available, uses the platform-specific user cache directory
  2. Otherwise, falls back to ~/.cache

You can get the cache path programmatically:

from twat_cache import get_cache_path

cache_dir = get_cache_path("my_cache")

Dependencies

  • Required: None (basic memory caching works without dependencies)
  • Optional:
    • platformdirs: For platform-specific cache directories
    • diskcache: For SQL-based disk caching
    • joblib: For efficient array caching

License

MIT License
.

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

twat_cache-1.8.0.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

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

twat_cache-1.8.0-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file twat_cache-1.8.0.tar.gz.

File metadata

  • Download URL: twat_cache-1.8.0.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.0

File hashes

Hashes for twat_cache-1.8.0.tar.gz
Algorithm Hash digest
SHA256 847f4ee2a7bffe6fcdab0530fd63055cd370ded47ec826bc784a9affca198f10
MD5 ca3729c5896739b3ab78e5ae9dce02fc
BLAKE2b-256 2763e0e3c7031ae5975eb3851b0e6b3f5084faa5e76440a9498b5fbe435bbb46

See more details on using hashes here.

File details

Details for the file twat_cache-1.8.0-py3-none-any.whl.

File metadata

  • Download URL: twat_cache-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.0

File hashes

Hashes for twat_cache-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7571e35c1649823b76018ae1dd158b78f45bf40836c58111fafee53237fee4b9
MD5 fd28fda02451bfa0dd2277a211351cb3
BLAKE2b-256 67c03b41e5fd2fbc7210145424e48e97eef77ba2b1b9b0a0748ce741e5e199d7

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