bda.cache 1.3.0__tar.gz → 2.0.0__tar.gz

bda_cache-2.0.0/.gitignore

@@ -0,0 +1,12 @@
+*.egg-info/
+*.pyc
+/.coverage
+/.mxmake
+/.ruff_cache
+/build
+/constraints-mxdev.txt
+/dist/
+/htmlcov/
+/requirements-mxdev.txt
+/venv
+__pycache__

bda_cache-2.0.0/CHANGES.rst

@@ -0,0 +1,85 @@
+Changes
+=======
+
+2.0.0 (2026-10-31)
+------------------
+
+- Fix the client library selection in ``bda.cache.memcached`` if both
+  ``libmc`` and ``pylibmc`` are installed. ``pylibmc.Client`` was initialized
+  with the ``libmc`` arguments. ``libmc`` is preferred now, as intended.
+  [rnix]
+
+- Drop the Python 2 remnants: the ``six`` imports in ``bda.cache.fscache``
+  and ``bda.cache.memcached`` (``six`` never was a declared dependency),
+  ``class X(object)`` and the ``IOError`` alias. Remove the unreachable code
+  in ``FSCache.__delitem__`` and the unused ``ICacheProvider`` import in
+  ``bda.cache.memcached``. Behaviour unchanged.
+  [rnix]
+
+- Convert the doctests to unittest tests and use pytest as test runner. The
+  memcached tests use a fake client and no longer need a running memcached
+  server. Drop the ``interlude`` and ``zope.testing`` test dependencies.
+  [rnix]
+
+- Sort the imports with ruff (one per line, ``from`` imports first, no
+  sections) and format the code with ``ruff format`` (90 characters per line,
+  single quotes).
+  [rnix]
+
+- Add ``Makefile`` (mxmake) with ``qa.ruff``, ``qa.test`` and ``qa.coverage``
+  domains, pin the ruff configuration in ``pyproject.toml`` and add a GitHub
+  Actions test workflow.
+  [rnix]
+
+- Refactor package layout to use ``pyproject.toml`` and implicit namespace
+  packages.
+  [rnix]
+
+- Drop Python 2 support. Python >= 3.10 is required.
+  [rnix]
+
+
+1.3.0 (2019-02-05)
+------------------
+
+- Python 3 comaptibility [reinhardt]
+
+- Code style (black/isort) [jensens]
+
+1.2.0 (2017-10-19)
+------------------
+
+- Change to use libmc or pylibmc when available
+
+- Add option to require with bda.cache[pylibmc] or bda.cache[libmc]
+
+
+1.1.2 (2009-02-10)
+------------------
+
+- remove legacy code
+
+
+1.1.1 (2009-02-10)
+------------------
+
+- bugfix in zcml configuration.
+
+
+1.1 (2009-02-09)
+----------------
+
+- Cache Managers are now adapters.
+
+- Implement memcached server support
+
+- deprecate the default CacheManager
+
+- Fix tests for FSCache
+
+
+1.0
+---
+
+- Initial work
+

bda_cache-2.0.0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.5
+Name: bda.cache
+Version: 2.0.0
+Summary: Simple caching infrastructure.
+Project-URL: Homepage, https://github.com/bluedynamics/bda.cache
+Author-email: Robert Niederreiter <rnix@squarewave.at>
+License: GNU General Public License v2 or later (GPLv2+)
+Keywords: caching,fscache,memcached,zca,zope
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.10
+Requires-Dist: python-memcached
+Requires-Dist: zope-component
+Provides-Extra: libmc
+Requires-Dist: libmc; extra == 'libmc'
+Provides-Extra: pylibmc
+Requires-Dist: pylibmc; extra == 'pylibmc'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/x-rst
+
+.. image:: https://img.shields.io/pypi/v/bda.cache.svg
+    :target: https://pypi.python.org/pypi/bda.cache
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/bda.cache.svg
+    :target: https://pypi.python.org/pypi/bda.cache
+    :alt: Number of PyPI downloads
+
+.. image:: https://github.com/bluedynamics/bda.cache/actions/workflows/test.yml/badge.svg
+    :target: https://github.com/bluedynamics/bda.cache/actions/workflows/test.yml
+    :alt: Test bda.cache
+
+
+General Caching API
+===================
+
+This package is designed to be used by applications which require different
+kinds of caching flavour. This is abstracted due to the interfaces
+``ICacheProvider`` and  ``ICacheManager``. ICacheProvider takes care of the
+concrete cache implementation, ICacheManager is the read/write interface.
+
+The convention is to adapt a concrete ICacheProvider implementation
+
+.. code-block:: python
+
+    from bda.cache import ICacheManager
+    from bda.cache import Memcached
+
+    provider = Memcached(['127.0.0.1:11211'])
+    manager = ICacheManager(provider)
+
+We can ask the manager for data inside the cache
+
+.. code-block:: python
+
+    data = manager.get('somekey', force_reload=False)
+
+If ``force_reload`` is set to True, try to delete data with key from cache and
+return None.
+
+We're also able to manipulate the cache's data (some restrictions my result out
+of backend not providing them)
+
+.. code-block:: python
+
+    manager.set('somekey', object())
+
+There exist a convenience to use some API's and cache it's results all at once.
+
+.. code-block:: python
+
+    data = manager.getData(func, key, force_reload=False, args=[], kwargs={})
+
+First the data for ``key`` is looked up inside the cache provider. If not found
+there or if ``force_reload`` is set to True, call given ``func`` . The return
+value of this function will be stored in the cache provider. ``args`` and
+``kwargs`` are passed as parameters to given function if it's call is required.
+
+You might ask why all this is done due to 2 seperate interfaces...
+
+Some usecase might require different cache providers i.e. for different payload
+size. This way you can implement any other cache provider usage as well due to
+the cache manager interface.
+
+
+Dependencies
+------------
+
+- ``zope.interface``
+
+- ``zope.component``
+
+- ``bda.cache.memcached.Memcached`` requires ``python-memcached``
+
+
+Notes
+-----
+
+If you're interessted to contribute; Feel free but keep in mind that this code
+is planned to be released under a BSD like licence in future.
+
+
+Changes
+=======
+
+2.0.0 (2026-10-31)
+------------------
+
+- Fix the client library selection in ``bda.cache.memcached`` if both
+  ``libmc`` and ``pylibmc`` are installed. ``pylibmc.Client`` was initialized
+  with the ``libmc`` arguments. ``libmc`` is preferred now, as intended.
+  [rnix]
+
+- Drop the Python 2 remnants: the ``six`` imports in ``bda.cache.fscache``
+  and ``bda.cache.memcached`` (``six`` never was a declared dependency),
+  ``class X(object)`` and the ``IOError`` alias. Remove the unreachable code
+  in ``FSCache.__delitem__`` and the unused ``ICacheProvider`` import in
+  ``bda.cache.memcached``. Behaviour unchanged.
+  [rnix]
+
+- Convert the doctests to unittest tests and use pytest as test runner. The
+  memcached tests use a fake client and no longer need a running memcached
+  server. Drop the ``interlude`` and ``zope.testing`` test dependencies.
+  [rnix]
+
+- Sort the imports with ruff (one per line, ``from`` imports first, no
+  sections) and format the code with ``ruff format`` (90 characters per line,
+  single quotes).
+  [rnix]
+
+- Add ``Makefile`` (mxmake) with ``qa.ruff``, ``qa.test`` and ``qa.coverage``
+  domains, pin the ruff configuration in ``pyproject.toml`` and add a GitHub
+  Actions test workflow.
+  [rnix]
+
+- Refactor package layout to use ``pyproject.toml`` and implicit namespace
+  packages.
+  [rnix]
+
+- Drop Python 2 support. Python >= 3.10 is required.
+  [rnix]
+
+
+1.3.0 (2019-02-05)
+------------------
+
+- Python 3 comaptibility [reinhardt]
+
+- Code style (black/isort) [jensens]
+
+1.2.0 (2017-10-19)
+------------------
+
+- Change to use libmc or pylibmc when available
+
+- Add option to require with bda.cache[pylibmc] or bda.cache[libmc]
+
+
+1.1.2 (2009-02-10)
+------------------
+
+- remove legacy code
+
+
+1.1.1 (2009-02-10)
+------------------
+
+- bugfix in zcml configuration.
+
+
+1.1 (2009-02-09)
+----------------
+
+- Cache Managers are now adapters.
+
+- Implement memcached server support
+
+- deprecate the default CacheManager
+
+- Fix tests for FSCache
+
+
+1.0
+---
+
+- Initial work
+

{bda.cache-1.3.0 → bda_cache-2.0.0}/README.rst

@@ -1,3 +1,16 @@
+.. image:: https://img.shields.io/pypi/v/bda.cache.svg
+    :target: https://pypi.python.org/pypi/bda.cache
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/bda.cache.svg
+    :target: https://pypi.python.org/pypi/bda.cache
+    :alt: Number of PyPI downloads
+
+.. image:: https://github.com/bluedynamics/bda.cache/actions/workflows/test.yml/badge.svg
+    :target: https://github.com/bluedynamics/bda.cache/actions/workflows/test.yml
+    :alt: Test bda.cache
+
+
 General Caching API
 ===================
 
@@ -57,8 +70,6 @@ Dependencies
 
 - ``zope.component``
 
-- ``bda.cache.fscache.FSCache`` recommends that availability of ``cpickle``
-
 - ``bda.cache.memcached.Memcached`` requires ``python-memcached``
 
 

bda_cache-2.0.0/pyproject.toml

@@ -0,0 +1,85 @@
+[build-system]
+requires = ["hatchling", "hatch-fancy-pypi-readme"]
+build-backend = "hatchling.build"
+
+[project]
+name = "bda.cache"
+version = "2.0.0"
+description = "Simple caching infrastructure."
+dynamic = ["readme"]
+requires-python = ">=3.10"
+license = {text = "GNU General Public License v2 or later (GPLv2+)"}
+authors = [{name = "Robert Niederreiter", email = "rnix@squarewave.at"}]
+keywords = ["caching", "memcached", "fscache", "zope", "zca"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",
+    "Operating System :: OS Independent",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "python-memcached",
+    "zope.component",
+]
+
+[project.optional-dependencies]
+libmc = ["libmc"]
+pylibmc = ["pylibmc"]
+test = [
+    "pytest",
+]
+
+[project.urls]
+Homepage = "https://github.com/bluedynamics/bda.cache"
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/x-rst"
+fragments = [
+    {path = "README.rst"},
+    {text = "\n\n"},
+    {path = "CHANGES.rst"},
+]
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "/.github/",
+    "/Makefile",
+    "/mx.ini",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/bda"]
+
+[tool.pytest.ini_options]
+consider_namespace_packages = true
+addopts = ["--import-mode=importlib"]
+pythonpath = "src"
+
+[tool.ruff]
+line-length = 90
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "I", "UP"]
+# UP008: zero-argument ``super()`` breaks on ``@plumbing`` decorated classes.
+# UP031: ``%`` formatting is kept.
+ignore = ["UP008", "UP031"]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+from-first = true
+no-sections = true
+lines-after-imports = 2
+order-by-type = false
+
+[tool.ruff.format]
+quote-style = "single"
+
+[tool.zest-releaser]
+create-wheel = true

bda_cache-2.0.0/src/bda/cache/__init__.py

@@ -0,0 +1,14 @@
+# Copyright 2009, Blue Dynamics Alliance, Austria - http://bluedynamics.com
+# GNU General Public Licence Version 2 or later
+
+from bda.cache.fscache import FSCache  # noqa
+from bda.cache.fscache import FSCacheException  # noqa
+from bda.cache.fscache import FSCacheManager  # noqa
+from bda.cache.interfaces import ICacheManager  # noqa
+from bda.cache.interfaces import ICacheProvider  # noqa
+from bda.cache.interfaces import ICacheVary  # noqa
+from bda.cache.memcached import Memcached  # noqa
+from bda.cache.memcached import MemcachedException  # noqa
+from bda.cache.memcached import MemcachedManager  # noqa
+from bda.cache.nullcache import NullCache  # noqa
+from bda.cache.nullcache import NullCacheManager  # noqa

{bda.cache-1.3.0 → bda_cache-2.0.0}/src/bda/cache/fscache.py

@@ -5,39 +5,28 @@ Module fscache.
 
 This module provides fuctionallity for caching objects on the filesystem.
 
-Therefor it uses cPickle if available, otherwise pickle.
+Therefor it uses pickle.
 
 This module was originally designed for very simple caching tasks like caching
 mail headers in a MUA or similar. It is NOT a cache manager.
 
 If you find this module useful and you have some improvements or bugfixes,
 please contact the author.
-
-This module is tested on linux with python 2.4. If you are running in troubles
-when using another operating system or python version, please contact the
-author.
 """
 
-try:
-    import six.moves.cPickle as pickle
-except:
-    import pickle
-
-
 from bda.cache.interfaces import CacheException
 from bda.cache.interfaces import ICacheManager
 from bda.cache.interfaces import IFSCacheProvider
-from six.moves import range
 from zope.component import adapter
 from zope.component import provideAdapter
 from zope.interface import implementer
-
 import logging
 import os
+import pickle
 import time
 
 
-logger = logging.getLogger("bda.cache.cachemanager")
+logger = logging.getLogger('bda.cache.cachemanager')
 
 
 class FSCacheException(CacheException):
@@ -45,7 +34,7 @@ class FSCacheException(CacheException):
 
 
 @implementer(IFSCacheProvider)
-class FSCache(object):
+class FSCache:
     """Class FsCache.
 
     Simple object caching.
@@ -124,9 +113,8 @@ class FSCache(object):
         return self._getitem(key)
 
     def __setitem__(self, key, object):
-        """Read the class documentation how keys must look like.
-        """
-        objpath = key.split(".")
+        """Read the class documentation how keys must look like."""
+        objpath = key.split('.')
         objlen = len(objpath)
         pt = 1
         path = self.cachedir
@@ -136,14 +124,14 @@ class FSCache(object):
             if not exists:
                 os.mkdir(path)
             pt += 1
-        path = os.path.join(path, "%s." % objpath[-1])
-        file = open(path, "wb")
+        path = os.path.join(path, '%s.' % objpath[-1])
+        file = open(path, 'wb')
         pickle.dump(object, file, self.protocol)
         file.close()
 
     def __delitem__(self, key):
-        path = key.split(".")
-        path[-1] = "%s." % path[-1]
+        path = key.split('.')
+        path[-1] = '%s.' % path[-1]
         try:
             os.remove(os.path.join(self.cachedir, *path))
         except OSError:
@@ -151,8 +139,6 @@ class FSCache(object):
         pt = len(path) - 1
         while pt > 0:
             previous = path[:pt]
-            if not previous:
-                return None
             curpath = os.path.join(self.cachedir, *previous)
             contents = os.listdir(curpath)
             if not contents:
@@ -163,10 +149,10 @@ class FSCache(object):
         return None
 
     def _getitem(self, key, default=None):
-        path = "%s." % os.path.join(self.cachedir, *key.split("."))
+        path = '%s.' % os.path.join(self.cachedir, *key.split('.'))
         try:
-            file = open(path, "rb")
-        except IOError:
+            file = open(path, 'rb')
+        except OSError:
             return default
         obj = pickle.load(file)
         file.close()
@@ -175,11 +161,11 @@ class FSCache(object):
     def _readkeys(self, keys, path=[]):
         entries = os.listdir(os.path.join(self.cachedir, *path))
         for entry in entries:
-            if entry[-1] == ".":
-                key = ""
+            if entry[-1] == '.':
+                key = ''
                 for part in path:
-                    key = "%s%s." % (key, part)
-                keys.append("%s%s" % (key, entry[: len(entry) - 1]))
+                    key = '%s%s.' % (key, part)
+                keys.append('%s%s' % (key, entry[: len(entry) - 1]))
             else:
                 self._readkeys(keys, path + [entry])
         return keys
@@ -195,7 +181,7 @@ class FSCache(object):
 
 @implementer(ICacheManager)
 @adapter(IFSCacheProvider)
-class FSCacheManager(object):
+class FSCacheManager:
     def __init__(self, context):
         self.timeout = 300  # defaults to 300 seconds
         self.cache = context
@@ -215,10 +201,10 @@ class FSCacheManager(object):
     def get(self, key, force_reload=False):
         if force_reload or self._isTimedOut(key):
             del self.cache[key]
-            creationmap = self.cache.get("creationmap", None)
+            creationmap = self.cache.get('creationmap', None)
             if creationmap is not None and key in creationmap:
                 del creationmap[key]
-                self.cache["creationmap"] = creationmap
+                self.cache['creationmap'] = creationmap
             return None
         return self.cache.get(key, None)
 
@@ -226,27 +212,26 @@ class FSCacheManager(object):
         self.cache[key] = item
         if not set_creationtime:
             return
-        creationmap = self.cache.get("creationmap", None)
+        creationmap = self.cache.get('creationmap', None)
         if not creationmap:
             creationmap = dict()
         creationmap[key] = time.time()
-        self.cache["creationmap"] = creationmap
+        self.cache['creationmap'] = creationmap
 
     def rem(self, key):
         del self.cache[key]
-        creationmap = self.cache.get("creationmap", None)
+        creationmap = self.cache.get('creationmap', None)
         if creationmap is not None and key in creationmap:
             del creationmap[key]
-            self.cache["creationmap"] = creationmap
+            self.cache['creationmap'] = creationmap
 
     def __delitem__(self, key):
         self.rem(key)
 
     def _isTimedOut(self, key):
-        """Return wether the item with key is timed out or not.
-        """
+        """Return wether the item with key is timed out or not."""
         cur = time.time()
-        creationmap = self.cache.get("creationmap", None)
+        creationmap = self.cache.get('creationmap', None)
         if not creationmap:
             return True
         creationtime = creationmap.get(key, None)

{bda.cache-1.3.0 → bda_cache-2.0.0}/src/bda/cache/interfaces.py

@@ -9,12 +9,10 @@ class CacheException(Exception):
 
 
 class ICacheVary(Interface):
-    """This interface describes an API for manipulating objects inside a cache.
-    """
+    """This interface describes an API for manipulating objects inside a cache."""
 
     def vary(*args, **kwargs):
-        """Manipulate objects inside the cache.
-        """
+        """Manipulate objects inside the cache."""
 
 
 class ICacheManager(Interface):
@@ -23,8 +21,7 @@ class ICacheManager(Interface):
     """
 
     def setTimeout(timeout):
-        """Set cache timeout in seconds.
-        """
+        """Set cache timeout in seconds."""
 
     def getData(func, key, force_reload=False, args=[], kwargs={}):
         """Convenience to read and cache results at once.
@@ -55,13 +52,11 @@ class ICacheManager(Interface):
         """
 
     def __delitem__(key):
-        """Remove item with key from cache if exists.
-        """
+        """Remove item with key from cache if exists."""
 
 
 class ICacheProvider(Interface):
-    """This interface describes an API for caching objects.
-    """
+    """This interface describes an API for caching objects."""
 
     def reset():
         """Reset the cache object.
@@ -70,28 +65,22 @@ class ICacheProvider(Interface):
         """
 
     def size():
-        """Return the current size of the cache in byte.
-        """
+        """Return the current size of the cache in byte."""
 
     def keys():
-        """Return the keys of the objects contained in this cache as list.
-        """
+        """Return the keys of the objects contained in this cache as list."""
 
     def values():
-        """Return objects contained in this cache as list.
-        """
+        """Return objects contained in this cache as list."""
 
     def get(key, default=None):
-        """Return object by key or default value if not exist.
-        """
+        """Return object by key or default value if not exist."""
 
     def __getitem__(key):
-        """Return object by key or None if not exists.
-        """
+        """Return object by key or None if not exists."""
 
     def __setitem__(key, object):
-        """Store object to cache by given key.
-        """
+        """Store object to cache by given key."""
 
     def __delitem__(key):
         """Delete object by key from cache.
@@ -101,15 +90,12 @@ class ICacheProvider(Interface):
 
 
 class INullCacheProvider(ICacheProvider):
-    """Marker
-    """
+    """Marker"""
 
 
 class IFSCacheProvider(ICacheProvider):
-    """Marker
-    """
+    """Marker"""
 
 
 class IMemcachedProvider(ICacheProvider):
-    """Marker
-    """
+    """Marker"""