.. image:: https://github.com/zopefoundation/Products.StandardCacheManagers/actions/workflows/tests.yml/badge.svg
:target: https://github.com/zopefoundation/Products.StandardCacheManagers/actions/workflows/tests.yml
.. image:: https://coveralls.io/repos/github/zopefoundation/Products.StandardCacheManagers/badge.svg?branch=master
:target: https://coveralls.io/github/zopefoundation/Products.StandardCacheManagers?branch=master
.. image:: https://img.shields.io/pypi/v/Products.StandardCacheManagers.svg
:target: https://pypi.org/project/Products.StandardCacheManagers/
:alt: Current version on PyPI
.. image:: https://img.shields.io/pypi/pyversions/Products.StandardCacheManagers.svg
:target: https://pypi.org/project/Products.StandardCacheManagers/
:alt: Supported Python versions
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
<https://github.com/zopefoundation/Products.StandardCacheManagers/issues/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.
Raw data
{
"_id": null,
"home_page": "https://github.com/zopefoundation/Products.StandardCacheManagers",
"name": "Products.StandardCacheManagers",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Zope Foundation and Contributors",
"author_email": "zope-dev@zope.dev",
"download_url": "https://files.pythonhosted.org/packages/6e/47/4171b0075a5684f68868b020a5ec4696828e8d932a34c1e339e9167e1c7f/Products.StandardCacheManagers-5.0.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/zopefoundation/Products.StandardCacheManagers/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/zopefoundation/Products.StandardCacheManagers/actions/workflows/tests.yml\n\n.. image:: https://coveralls.io/repos/github/zopefoundation/Products.StandardCacheManagers/badge.svg?branch=master\n :target: https://coveralls.io/github/zopefoundation/Products.StandardCacheManagers?branch=master\n\n.. image:: https://img.shields.io/pypi/v/Products.StandardCacheManagers.svg\n :target: https://pypi.org/project/Products.StandardCacheManagers/\n :alt: Current version on PyPI\n\n.. image:: https://img.shields.io/pypi/pyversions/Products.StandardCacheManagers.svg\n :target: https://pypi.org/project/Products.StandardCacheManagers/\n :alt: Supported Python versions\n\nOverview\n========\n\nThis package provides two cache managers for Zope. A RAMCacheManager and an\nAccelerated HTTP cache manager, which adds HTTP cache headers to responses.\n\nThe following is intended for people interested in the internals of\nRAMCacheManager, such as maintainers.\n\nIntroduction\n============\n\nThe caching framework does not interpret the data in any way, it acts\njust as a general storage for data passed to it. It tries to check if\nthe data is pickleable though. IOW, only pickleable data is\ncacheable. \n\nThe idea behind the RAMCacheManager is that it should be shared between\nthreads, so that the same objects are not cached in each thread. This\nis achieved by storing the cache data structure itself as a module\nlevel variable (RAMCacheManager.caches). This, of course, requires\nlocking on modifications of that data structure.\n\nEach RAMCacheManager instance has one cache in RAMCacheManager.caches\ndictionary. A unique __cacheid is generated when creating a cache\nmanager and it's used as a key for caches.\n\nObject Hierarchy\n================\n\nRAMCacheManager\n RAMCache\n ObjectCacheEntries\n CacheEntry\n\nRAMCacheManager is a persistent placeful object. It is assigned a\nunique __cacheid on its creation. It is then used as a key to look up\nthe corresponding RAMCache object in the global caches dictionary.\nSo, each RAMCacheManager has a single RAMCache related to it.\n\nRAMCache is a volatile cache, unique for each RAMCacheManager. It is\nshared among threads and does all the locking. It has a writelock.\nNo locking is done on reading though. RAMCache keeps a dictionary of\nObjectCacheEntries indexed by the physical path of a cached object.\n\nObjectCacheEntries is a container for cached values for a single object. \nThe values in it are indexed by a tuple of a view_name, interesting \nrequest variables, and extra keywords passed to Cache.ZCache_set(). \n\nCacheEntry is a wrapper around a single cached value. It stores the\ndata itself, creation time, view_name and keeps the access count.\n\nChangelog\n=========\n\n5.0 (2023-02-01)\n----------------\n\n- Drop support for Python 2.7, 3.5, 3.6.\n\n\n4.2 (2022-12-16)\n----------------\n\n- Fix insidious buildout configuration bug for tests against Zope 4.\n\n- Add support for Python 3.10 and 3.11.\n\n\n4.1.1 (2021-07-02)\n------------------\n\n- fix DeprecationWarning for rfc1123_date\n (`#8\n <https://github.com/zopefoundation/Products.StandardCacheManagers/issues/8>`_)\n\n\n4.1.0 (2021-03-16)\n------------------\n\n- Add support for Python 3.9.\n\n\n4.0.3 (2019-10-14)\n------------------\n\n- More package cleanups.\n\n- Cleaned up ZMI views for Zope 4.\n\n- Fixed several errors due to changed behavior in Python 3.\n\n- Update `isort` to version 5.\n\n\n4.0.2 (2019-02-17)\n------------------\n\n- Specify supported Python versions using ``python_requires`` in setup.py\n\n- Added support for Python 3.7 and 3.8\n\n- Dropped support for Python 3.4 as Zope does not support it anymore\n\n- More PEP8 compliance.\n\n\n4.0.1 (2017-05-23)\n------------------\n\n- Move version dependency to a released version of Zope\n\n\n4.0.0 (2017-05-13)\n------------------\n\n- Require Zope 4.\n\n- Python 3-compatibility\n\n\n3.0 (2016-07-18)\n----------------\n\n- Remove HelpSys support.\n\n\n2.13.1 (2014-09-14)\n-------------------\n\n- Prevent warnings when RAM caching in a context without a Request.\n\n\n2.13.0 (2010-07-11)\n-------------------\n\n- Released as separate package.\n",
"bugtrack_url": null,
"license": "ZPL 2.1",
"summary": "Cache managers for Zope",
"version": "5.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5e5e0baea7276be3753cbfa38bd005fd1b052dcf6fad20aa9676460b79bc979e",
"md5": "7b2d7dd82ad2b9eec2e8a532e05045dd",
"sha256": "e401119a4ab5290b377726297b5e0739c382aea58fada192b101cd88f09aa921"
},
"downloads": -1,
"filename": "Products.StandardCacheManagers-5.0-py3-none-any.whl",
"has_sig": true,
"md5_digest": "7b2d7dd82ad2b9eec2e8a532e05045dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 24963,
"upload_time": "2023-02-01T08:05:20",
"upload_time_iso_8601": "2023-02-01T08:05:20.623805Z",
"url": "https://files.pythonhosted.org/packages/5e/5e/0baea7276be3753cbfa38bd005fd1b052dcf6fad20aa9676460b79bc979e/Products.StandardCacheManagers-5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e474171b0075a5684f68868b020a5ec4696828e8d932a34c1e339e9167e1c7f",
"md5": "0fff71e325a06a73507708ff7c1046fd",
"sha256": "d4cb2a427d3ec36fe60c872a1dd36d03cf277ebe5ef02beaf7d15ea49f7c2e3c"
},
"downloads": -1,
"filename": "Products.StandardCacheManagers-5.0.tar.gz",
"has_sig": true,
"md5_digest": "0fff71e325a06a73507708ff7c1046fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 20031,
"upload_time": "2023-02-01T08:05:22",
"upload_time_iso_8601": "2023-02-01T08:05:22.447214Z",
"url": "https://files.pythonhosted.org/packages/6e/47/4171b0075a5684f68868b020a5ec4696828e8d932a34c1e339e9167e1c7f/Products.StandardCacheManagers-5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-01 08:05:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "zopefoundation",
"github_project": "Products.StandardCacheManagers",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "products.standardcachemanagers"
}
JSON
