Support all cache backends of Django >=3.2

django_prometheus/cache/backends/memcached.py

@@ -1,3 +1,4 @@
+from django import VERSION as DJANGO_VERSION
 from django.core.cache.backends import memcached
 
 from django_prometheus.cache.metrics import (
@@ -7,9 +8,7 @@
 )
 
 
-class MemcachedCache(memcached.PyLibMCCache):
-    """Inherit memcached to add metrics about hit/miss ratio"""
-
+class MemcachedPrometheusCacheMixin:
     def get(self, key, default=None, version=None):
         django_cache_get_total.labels(backend="memcached").inc()
         cached = super().get(key, default=None, version=version)
@@ -18,3 +17,22 @@ def get(self, key, default=None, version=None):
         else:
             django_cache_misses_total.labels(backend="memcached").inc()
         return cached or default
+
+
+class MemcachedCache(MemcachedPrometheusCacheMixin, memcached.MemcachedCache):
+    """Inherit memcached to add metrics about hit/miss ratio"""
+
+    pass
+
+
+if DJANGO_VERSION >= (3, 2):
+
+    class PyLibMCCache(MemcachedPrometheusCacheMixin, memcached.PyLibMCCache):
+        """Inherit memcached to add metrics about hit/miss ratio"""
+
+        pass
+
+    class PyMemcacheCache(MemcachedPrometheusCacheMixin, memcached.PyMemcacheCache):
+        """Inherit memcached to add metrics about hit/miss ratio"""
+
+        pass

django_prometheus/tests/end2end/testapp/settings.py

@@ -1,6 +1,7 @@
 import os
 import tempfile
 
+from django import VERSION as DJANGO_VERSION
 from testapp.helpers import get_middleware
 
 # SECURITY WARNING: keep the secret key used in production secret!
@@ -99,7 +100,7 @@
         "BACKEND": "django_prometheus.cache.backends.memcached.MemcachedCache",
         "LOCATION": "localhost:11211",
     },
-    "memcached": {
+    "memcached.MemcachedCache": {
         "BACKEND": "django_prometheus.cache.backends.memcached.MemcachedCache",
         "LOCATION": "localhost:11211",
     },
@@ -127,6 +128,17 @@
     },
 }
 
+
+if DJANGO_VERSION >= (3, 2):
+    CACHES["memcached.PyLibMCCache"] = {
+        "BACKEND": "django_prometheus.cache.backends.memcached.PyLibMCCache",
+        "LOCATION": "localhost:11211",
+    }
+    CACHES["memcached.PyMemcacheCache"] = {
+        "BACKEND": "django_prometheus.cache.backends.memcached.PyMemcacheCache",
+        "LOCATION": "localhost:11211",
+    }
+
 # Internationalization
 LANGUAGE_CODE = "en-us"
 TIME_ZONE = "UTC"

django_prometheus/tests/end2end/testapp/test_caches.py

@@ -1,3 +1,4 @@
+from django import VERSION as DJANGO_VERSION
 from django.core.cache import caches
 from django.test import TestCase
 from redis import RedisError
@@ -9,22 +10,34 @@ class TestCachesMetrics(PrometheusTestCaseMixin, TestCase):
     """Test django_prometheus.caches metrics."""
 
     def testCounters(self):
-        supported_caches = ["memcached", "filebased", "locmem", "redis"]
+        supported_caches = [
+            "memcached.MemcachedCache",
+            "filebased",
+            "locmem",
+            "redis",
+        ]
+
+        if DJANGO_VERSION >= (3, 2):
+            supported_caches.extend(
+                [
+                    "memcached.PyLibMCCache",
+                    "memcached.PyMemcacheCache",
+                ]
+            )
 
         # Note: those tests require a memcached server running
         for supported_cache in supported_caches:
             tested_cache = caches[supported_cache]
+            backend = supported_cache.split(".")[0]
 
             total_before = (
-                self.getMetric("django_cache_get_total", backend=supported_cache) or 0
+                self.getMetric("django_cache_get_total", backend=backend) or 0
             )
             hit_before = (
-                self.getMetric("django_cache_get_hits_total", backend=supported_cache)
-                or 0
+                self.getMetric("django_cache_get_hits_total", backend=backend) or 0
             )
             miss_before = (
-                self.getMetric("django_cache_get_misses_total", backend=supported_cache)
-                or 0
+                self.getMetric("django_cache_get_misses_total", backend=backend) or 0
             )
 
             tested_cache.set("foo1", "bar")
@@ -37,15 +50,15 @@ def testCounters(self):
             assert result == "default"
 
             self.assertMetricEquals(
-                total_before + 4, "django_cache_get_total", backend=supported_cache
+                total_before + 4, "django_cache_get_total", backend=backend
             )
             self.assertMetricEquals(
-                hit_before + 2, "django_cache_get_hits_total", backend=supported_cache
+                hit_before + 2, "django_cache_get_hits_total", backend=backend
             )
             self.assertMetricEquals(
                 miss_before + 2,
                 "django_cache_get_misses_total",
-                backend=supported_cache,
+                backend=backend,
             )
 
     def test_redis_cache_fail(self):
@@ -101,7 +114,20 @@ def test_redis_cache_fail(self):
         )
 
     def test_cache_version_support(self):
-        supported_caches = ["memcached", "filebased", "locmem", "redis"]
+        supported_caches = [
+            "memcached.MemcachedCache",
+            "filebased",
+            "locmem",
+            "redis",
+        ]
+
+        if DJANGO_VERSION >= (3, 2):
+            supported_caches.extend(
+                [
+                    "memcached.PyLibMCCache",
+                    "memcached.PyMemcacheCache",
+                ]
+            )
 
         # Note: those tests require a memcached server running
         for supported_cache in supported_caches:

django_prometheus/tests/test_testutils.py

@@ -61,18 +61,15 @@ def testGetMetricVector(self):
         vector = self.test_case.getMetricVector(
             "some_labelled_gauge", registry=self.registry
         )
-        assert (
-            sorted(
-                [
-                    ({"labelred": "pink", "labelblue": "indigo"}, 1),
-                    ({"labelred": "pink", "labelblue": "royal"}, 2),
-                    ({"labelred": "carmin", "labelblue": "indigo"}, 3),
-                    ({"labelred": "carmin", "labelblue": "royal"}, 4),
-                ],
-                key=itemgetter(1),
-            )
-            == sorted(vector, key=itemgetter(1))
-        )
+        assert sorted(
+            [
+                ({"labelred": "pink", "labelblue": "indigo"}, 1),
+                ({"labelred": "pink", "labelblue": "royal"}, 2),
+                ({"labelred": "carmin", "labelblue": "indigo"}, 3),
+                ({"labelred": "carmin", "labelblue": "royal"}, 4),
+            ],
+            key=itemgetter(1),
+        ) == sorted(vector, key=itemgetter(1))
 
     def testAssertMetricEquals(self):
         """Tests assertMetricEquals."""

django_prometheus/utils.py

@@ -24,6 +24,6 @@ def TimeSince(t):
 def PowersOf(logbase, count, lower=0, include_zero=True):
     """Returns a list of count powers of logbase (from logbase**lower)."""
     if not include_zero:
-        return [logbase ** i for i in range(lower, count + lower)]
+        return [logbase**i for i in range(lower, count + lower)]
     else:
-        return [0] + [logbase ** i for i in range(lower, count + lower)]
+        return [0] + [logbase**i for i in range(lower, count + lower)]

requirements.txt

@@ -9,3 +9,5 @@ psycopg2
 pytest==6.2.5
 pytest-django
 pylibmc
+pymemcache
+python-memcached

setup.py

@@ -26,19 +26,25 @@ def get_version():
     keywords="django monitoring prometheus",
     url="http://github.com/korfuri/django-prometheus",
     project_urls={
-            "Changelog": "https://github.com/korfuri/django-prometheus/blob/master/CHANGELOG.md",
-            "Documentation": "https://github.com/korfuri/django-prometheus/blob/master/README.md",
-            "Source": "https://github.com/korfuri/django-prometheus",
-            "Tracker": "https://github.com/korfuri/django-prometheus/issues",
+        "Changelog": "https://github.com/korfuri/django-prometheus/blob/master/CHANGELOG.md",
+        "Documentation": "https://github.com/korfuri/django-prometheus/blob/master/README.md",
+        "Source": "https://github.com/korfuri/django-prometheus",
+        "Tracker": "https://github.com/korfuri/django-prometheus/issues",
     },
-    packages=find_packages(exclude=["tests",]),
+    packages=find_packages(
+        exclude=[
+            "tests",
+        ]
+    ),
     test_suite="django_prometheus.tests",
     long_description=LONG_DESCRIPTION,
     long_description_content_type="text/markdown",
     tests_require=["pytest", "pytest-django"],
     setup_requires=["pytest-runner"],
     options={"bdist_wheel": {"universal": "1"}},
-    install_requires=["prometheus-client>=0.7",],
+    install_requires=[
+        "prometheus-client>=0.7",
+    ],
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",

update_version_from_git.py

@@ -78,7 +78,7 @@ def get_git_version_info():
 
 
 def prerelease_version():
-    """ return what the prerelease version should be.
+    """return what the prerelease version should be.
     https://packaging.python.org/tutorials/distributing-packages/#pre-release-versioning
     0.0.2.dev22
     """