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.7.14.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.7.14-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: twat_cache-1.7.14.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.7.14.tar.gz
Algorithm Hash digest
SHA256 d3b4f072605c63ec854753b9e3b5716dc829fdd9fc81bc5f8babb28345b34ff9
MD5 ad436e8b10bf65f29dd0e8110f4667cf
BLAKE2b-256 a9798a85720daf2f3e006e651a62aad2919d38856a7a2280309244cb2a4542fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for twat_cache-1.7.14-py3-none-any.whl
Algorithm Hash digest
SHA256 f31280e0b63e3a972d982a7443d8306fe930ac46685109454e4adfb4a122e983
MD5 d6bf9bf0872b384e060141597b10928c
BLAKE2b-256 69f78f8e21c4198d10708c0fcbdef6be1f9b77911870f7d82891ab654c04cc1d

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