django-health-check 3.21.1__py3-none-any.whl → 3.22.0__py3-none-any.whl

{django_health_check-3.21.1.dist-info → django_health_check-3.22.0.dist-info}/METADATA

@@ -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.dist-info → django_health_check-3.22.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 health_check/__init__.py,sha256=vLH1k9cjhuLe_swu-qMxrz1_7fFJA179-UWNcsdA8QA,868
-health_check/_version.py,sha256=lnu-yfgOzv6DG7Vjh0cOUPFmVZ0swqx_iu6PWn47660,714
+health_check/_version.py,sha256=fYOTYhtJ3EebEFBMa41v24xwRC5E0azzRRvSxT74Jtg,714
 health_check/backends.py,sha256=Q4B8yRusBZz8mOz8jNZmqJWQ1Fu6YawYiLNFkw5sUmA,3414
 health_check/conf.py,sha256=l3Utl8zLLT42TKUnBFNLnD_i-wYNKmxPXVVyIucGUXc,319
 health_check/deprecation.py,sha256=uYGwPFW8lX1xQ33x0VRkoPFoyoLcrMt6DmpX3RHLxj4,1127
@@ -36,7 +36,7 @@ health_check/contrib/rabbitmq/apps.py,sha256=i-1Uo3W6Ofc0_StFABfrxysh_anWVP-mcNK
 health_check/contrib/rabbitmq/backends.py,sha256=22zNDsX-Ie-a5Rwk4naIpGB3184SV2OaGTXzwBzWbU0,1836
 health_check/contrib/redis/__init__.py,sha256=TzSbuXNst7itI8mbrtsCNJXJP40ZpX-r2x6mxMNTgYE,69
 health_check/contrib/redis/apps.py,sha256=1bhVAy5iKZer8IwG4WXZYeYUSl7AMTtNPRRhR5ugrLs,700
-health_check/contrib/redis/backends.py,sha256=UuKWmSD4CzM48f6Ora-IuqoqV8jeX3u9UVZG4-ckrgg,1896
+health_check/contrib/redis/backends.py,sha256=xQ73bnGlOGtvnaNiEOz4bhqxXsD-Qn2y6aVwoiQkWCg,2788
 health_check/contrib/s3boto3_storage/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 health_check/contrib/s3boto3_storage/apps.py,sha256=1-7X_v7d6HeKD5MBxyDvrh5vdopsvmnJNjToiFjeDx4,732
 health_check/contrib/s3boto3_storage/backends.py,sha256=0WrNNNJiqDVn5_GHQZm6hlEBvSxhWTqWSWUtmVHkzzo,1331
@@ -57,7 +57,7 @@ health_check/storage/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hS
 health_check/storage/apps.py,sha256=f6958Deq62DXoe8myL57rnKSkKkPQf2FLM9iJkUdx-U,293
 health_check/storage/backends.py,sha256=pkj64HcVnvm9pvgWFhL81IDejTOH8-pLSFwJQ_90jbs,2636
 health_check/templates/health_check/index.html,sha256=pOC7GW_r0gDQ5Qz5aJacNFI22N52kbiOzh4aZb9_V-Q,4045
-django_health_check-3.21.1.dist-info/licenses/LICENSE,sha256=19Rs8FInCokFQuq03cab_KHwpeyF5pt-lTp7pfJX1iE,1101
-django_health_check-3.21.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-django_health_check-3.21.1.dist-info/METADATA,sha256=SH__WORk7gW7EFGzHjS-6rLuUMMIqVUhqiS8Vs53ibk,3554
-django_health_check-3.21.1.dist-info/RECORD,,
+django_health_check-3.22.0.dist-info/licenses/LICENSE,sha256=19Rs8FInCokFQuq03cab_KHwpeyF5pt-lTp7pfJX1iE,1101
+django_health_check-3.22.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+django_health_check-3.22.0.dist-info/METADATA,sha256=blyMILwBcnvuFzsfU8l_4HfDiQzuNRpZMr23vS4Y3Ig,3554
+django_health_check-3.22.0.dist-info/RECORD,,

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'

health_check/contrib/redis/backends.py

@@ -1,9 +1,11 @@
 import dataclasses
 import logging
 import typing
+import warnings
 
 from django.conf import settings
-from redis import exceptions, from_url
+from redis import Redis as RedisClient
+from redis import RedisCluster, exceptions
 
 from health_check.backends import HealthCheck
 from health_check.exceptions import ServiceUnavailable
@@ -14,37 +16,60 @@ logger = logging.getLogger(__name__)
 @dataclasses.dataclass
 class RedisHealthCheck(HealthCheck):
     """
-    Check Redis service by pinging the redis instance with a redis connection.
+    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:
-        redis_url: The Redis connection URL.
-        redis_url_options: Additional options for the Redis connection.
+        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=getattr(settings, "HEALTHCHECK_REDIS_URL_OPTIONS", None), repr=False
+        default_factory=lambda: getattr(settings, "HEALTHCHECK_REDIS_URL_OPTIONS", {}), repr=False
     )
 
-    def check_status(self):
-        logger.debug("Got %s as the redis_url. Connecting to redis...", self.redis_url)
+    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)
 
-        logger.debug("Attempting to connect to redis...")
+    def check_status(self):
+        logger.debug("Pinging Redis client...")
         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
+            self.client.ping()
         except ConnectionRefusedError as e:
-            self.add_error(
-                ServiceUnavailable("Unable to connect to Redis: Connection was refused."),
-                e,
-            )
+            raise ServiceUnavailable("Unable to connect to Redis: Connection was refused.") from e
         except exceptions.TimeoutError as e:
-            self.add_error(ServiceUnavailable("Unable to connect to Redis: Timeout."), e)
+            raise ServiceUnavailable("Unable to connect to Redis: Timeout.") from e
         except exceptions.ConnectionError as e:
-            self.add_error(ServiceUnavailable("Unable to connect to Redis: Connection Error"), e)
+            raise ServiceUnavailable("Unable to connect to Redis: Connection Error") from e
         except BaseException as e:
-            self.add_error(ServiceUnavailable("Unknown error"), e)
+            raise ServiceUnavailable("Unknown error.") from e
         else:
             logger.debug("Connection established. Redis is healthy.")
+        finally:
+            self.client.close()