Overview

This package provides two cache managers for Zope. A RAMCacheManager and an Accelerated HTTP cache manager, which adds HTTP cache headers to responses.

The following is intended for people interested in the internals of RAMCacheManager, such as maintainers.

Introduction

The caching framework does not interpret the data in any way, it acts just as a general storage for data passed to it. It tries to check if the data is pickleable though. IOW, only pickleable data is cacheable.

The idea behind the RAMCacheManager is that it should be shared between threads, so that the same objects are not cached in each thread. This is achieved by storing the cache data structure itself as a module level variable (RAMCacheManager.caches). This, of course, requires locking on modifications of that data structure.

Each RAMCacheManager instance has one cache in RAMCacheManager.caches dictionary. A unique __cacheid is generated when creating a cache manager and it's used as a key for caches.

Object Hierarchy

RAMCacheManager
RAMCache
ObjectCacheEntries
CacheEntry

RAMCacheManager is a persistent placeful object. It is assigned a unique __cacheid on its creation. It is then used as a key to look up the corresponding RAMCache object in the global caches dictionary. So, each RAMCacheManager has a single RAMCache related to it.

RAMCache is a volatile cache, unique for each RAMCacheManager. It is shared among threads and does all the locking. It has a writelock. No locking is done on reading though. RAMCache keeps a dictionary of ObjectCacheEntries indexed by the physical path of a cached object.

ObjectCacheEntries is a container for cached values for a single object. The values in it are indexed by a tuple of a view_name, interesting request variables, and extra keywords passed to Cache.ZCache_set().

CacheEntry is a wrapper around a single cached value. It stores the data itself, creation time, view_name and keeps the access count.

Changelog

5.0 (2023-02-01)

• Drop support for Python 2.7, 3.5, 3.6.

4.2 (2022-12-16)

• Fix insidious buildout configuration bug for tests against Zope 4.
• Add support for Python 3.10 and 3.11.

4.1.1 (2021-07-02)

• fix DeprecationWarning for rfc1123_date (#8)

4.1.0 (2021-03-16)

• Add support for Python 3.9.

4.0.3 (2019-10-14)

• More package cleanups.
• Cleaned up ZMI views for Zope 4.
• Fixed several errors due to changed behavior in Python 3.
• Update isort to version 5.

4.0.2 (2019-02-17)

• Specify supported Python versions using python_requires in setup.py
• Added support for Python 3.7 and 3.8
• Dropped support for Python 3.4 as Zope does not support it anymore
• More PEP8 compliance.

4.0.1 (2017-05-23)

• Move version dependency to a released version of Zope

4.0.0 (2017-05-13)

• Require Zope 4.
• Python 3-compatibility

3.0 (2016-07-18)

• Remove HelpSys support.

2.13.1 (2014-09-14)

• Prevent warnings when RAM caching in a context without a Request.

2.13.0 (2010-07-11)

• Released as separate package.