ADR-018: Caching

Status

Accepted

Context

Efficient caching is important for performance and scalability. Smarter caches function results with from cache_results import cache_results, the decorator of the standalone, Django-only package cache-results (https://pypi.org/project/cache-results/, documented at https://docs.cache-results.smarter.sh/). Smarter configures it through the CACHE_RESULTS setting and the hooks in smarter.lib.cache.hooks. This approach focuses on caching the results of function calls rather than traditional object or instance caching.

Decision

The preferred methodology for caching in this project is to use cache_results for function result caching. Contributors should always attempt to use this approach for caching function outputs. Example:

from cache_results import cache_results

@cache_results(timeout=3600, logging_enabled=True)
def expensive_function(args):
    # hard-to-do computation
    return result

PENDING: - This is not a traditional “object caching” solution; it only covers function results, not class instances. This limitation needs to be addressed.

Alternatives Considered

Implementing traditional object or instance caching.
Using third-party caching libraries for broader caching needs.

Consequences

Positive: - Provides a simple and consistent approach to function result caching. - Improves performance for repeated function calls.
Negative: - Does not cover object or class instance caching. - Requires future work to address broader caching needs.