django-health-check 3.21.1__tar.gz → 3.22.0__tar.gz

{django_health_check-3.21.1 → django_health_check-3.22.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-health-check
-Version: 3.21.1
+Version: 3.22.0
 Summary: Monitor the health of your Django app and its connected services.
 Keywords: django,postgresql
 Author-email: Kristian Ollegaard <kristian@oellegaard.com>, Johannes Maron <johannes@maron.family>

{django_health_check-3.21.1 → django_health_check-3.22.0}/health_check/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.21.1'
-__version_tuple__ = version_tuple = (3, 21, 1)
+__version__ = version = '3.22.0'
+__version_tuple__ = version_tuple = (3, 22, 0)
 
-__commit_id__ = commit_id = 'g8948ab942'
+__commit_id__ = commit_id = 'g12f02362c'

django_health_check-3.22.0/health_check/contrib/redis/backends.py

@@ -0,0 +1,75 @@
+import dataclasses
+import logging
+import typing
+import warnings
+
+from django.conf import settings
+from redis import Redis as RedisClient
+from redis import RedisCluster, exceptions
+
+from health_check.backends import HealthCheck
+from health_check.exceptions import ServiceUnavailable
+
+logger = logging.getLogger(__name__)
+
+
+@dataclasses.dataclass
+class RedisHealthCheck(HealthCheck):
+    """
+    Check Redis service by pinging a Redis client.
+
+    This check works with any Redis client that implements the ping() method,
+    including standard Redis, Sentinel, and Cluster clients.
+
+    Args:
+        client: A Redis client instance (Redis, Sentinel master, or Cluster).
+                If provided, this takes precedence over redis_url.
+
+    Examples:
+        Using a standard Redis client:
+        >>> from redis import Redis as RedisClient
+        >>> Redis(client=RedisClient(host='localhost', port=6379))
+
+        Using a Cluster client:
+        >>> from redis.cluster import RedisCluster
+        >>> Redis(client=RedisCluster(host='localhost', port=7000))
+
+        Using a Sentinel client:
+        >>> from redis.sentinel import Sentinel
+        >>> sentinel = Sentinel([('localhost', 26379)])
+        >>> Redis(client=sentinel.master_for('mymaster'))
+
+    """
+
+    client: RedisClient | RedisCluster = dataclasses.field(default=None, repr=False)
+    redis_url: str = dataclasses.field(default=getattr(settings, "REDIS_URL", "redis://localhost/1"), repr=False)
+    redis_url_options: dict[str, typing.Any] = dataclasses.field(
+        default_factory=lambda: getattr(settings, "HEALTHCHECK_REDIS_URL_OPTIONS", {}), repr=False
+    )
+
+    def __post_init__(self):
+        if not self.client:
+            print(self.client)
+            warnings.warn(
+                "The 'redis_url' parameter is deprecated. Please use the 'client' parameter instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.client = RedisClient.from_url(self.redis_url, **self.redis_url_options)
+
+    def check_status(self):
+        logger.debug("Pinging Redis client...")
+        try:
+            self.client.ping()
+        except ConnectionRefusedError as e:
+            raise ServiceUnavailable("Unable to connect to Redis: Connection was refused.") from e
+        except exceptions.TimeoutError as e:
+            raise ServiceUnavailable("Unable to connect to Redis: Timeout.") from e
+        except exceptions.ConnectionError as e:
+            raise ServiceUnavailable("Unable to connect to Redis: Connection Error") from e
+        except BaseException as e:
+            raise ServiceUnavailable("Unknown error.") from e
+        else:
+            logger.debug("Connection established. Redis is healthy.")
+        finally:
+            self.client.close()

django_health_check-3.21.1/health_check/contrib/redis/backends.py

@@ -1,50 +0,0 @@
-import dataclasses
-import logging
-import typing
-
-from django.conf import settings
-from redis import exceptions, from_url
-
-from health_check.backends import HealthCheck
-from health_check.exceptions import ServiceUnavailable
-
-logger = logging.getLogger(__name__)
-
-
-@dataclasses.dataclass
-class RedisHealthCheck(HealthCheck):
-    """
-    Check Redis service by pinging the redis instance with a redis connection.
-
-    Args:
-        redis_url: The Redis connection URL.
-        redis_url_options: Additional options for the Redis connection.
-
-    """
-
-    redis_url: str = dataclasses.field(default=getattr(settings, "REDIS_URL", "redis://localhost/1"), repr=False)
-    redis_url_options: dict[str, typing.Any] = dataclasses.field(
-        default=getattr(settings, "HEALTHCHECK_REDIS_URL_OPTIONS", None), repr=False
-    )
-
-    def check_status(self):
-        logger.debug("Got %s as the redis_url. Connecting to redis...", self.redis_url)
-
-        logger.debug("Attempting to connect to redis...")
-        try:
-            # conn is used as a context to release opened resources later
-            with from_url(self.redis_url, **(self.redis_url_options or {})) as conn:
-                conn.ping()  # exceptions may be raised upon ping
-        except ConnectionRefusedError as e:
-            self.add_error(
-                ServiceUnavailable("Unable to connect to Redis: Connection was refused."),
-                e,
-            )
-        except exceptions.TimeoutError as e:
-            self.add_error(ServiceUnavailable("Unable to connect to Redis: Timeout."), e)
-        except exceptions.ConnectionError as e:
-            self.add_error(ServiceUnavailable("Unable to connect to Redis: Connection Error"), e)
-        except BaseException as e:
-            self.add_error(ServiceUnavailable("Unknown error"), e)
-        else:
-            logger.debug("Connection established. Redis is healthy.")