Deprecate APIs to prepare for v4's async checks (#589)

Author: codingjoe

docs/install.md

@@ -55,25 +55,11 @@ urlpatterns = [
                     {"client": Redis.from_url("redis://localhost:6379")},
                 ),
             ],
-            use_threading=True,  # optional, default is True
-            warnings_as_errors=True,  # optional, default is True
         ),
     ),
 ]
 ```
 
-## Threading
-
-Django Health Check runs each check in a separate thread by default to improve performance. If you prefer to run the checks sequentially, you can set the `use_threading` parameter to `False` when instantiating the `HealthCheckView`, as shown in the example above.
-
-This can be useful in environments where threads are not closing IO connections properly, leading to resource leaks.
-However, for Django's database connections, threading is generally safe and recommended for better performance.
-
-## Warnings as Errors
-
-Treats `ServiceWarning` as errors, meaning they will cause the views to respond with a 500 status code. Default is `True`.
-If set to `False` warnings will be displayed in the template or in the JSON response but the status code will remain a 200.
-
 ## Security
 
 You can protect the health check endpoint by adding a secure token to your URL.

docs/usage.md

@@ -70,54 +70,6 @@ class MyHealthCheckBackend(HealthCheck):
 
 ::: health_check.HealthCheck
 
-## Customizing output
-
-You can customize HTML or JSON rendering by inheriting from [HealthCheckView][health_check.views.HealthCheckView]
-and customizing the `template_name`, `get`,
-`render_to_response` and `render_to_response_json` properties:
-
-```python
-# views.py
-from django.http import HttpResponse, JsonResponse
-
-from health_check.views import HealthCheckView
-
-
-class HealthCheckCustomView(HealthCheckView):
-    template_name = "myapp/health_check_dashboard.html"  # customize the used templates
-
-    def get(self, request, *args, **kwargs):
-        plugins = []
-        status = 200  # needs to be filled status you need
-        # …
-        if "application/json" in request.META.get("HTTP_ACCEPT", ""):
-            return self.render_to_response_json(plugins, status)
-        return self.render_to_response(plugins, status)
-
-    def render_to_response(self, plugins, status):  # customize HTML output
-        return HttpResponse("COOL" if status == 200 else "SWEATY", status=status)
-
-    def render_to_response_json(self, plugins, status):  # customize JSON output
-        return JsonResponse({repr(p): "COOL" if status == 200 else "SWEATY" for p in plugins}, status=status)
-
-
-# urls.py
-from django.urls import path
-
-from . import views
-
-urlpatterns = [
-    # …
-    path(
-        "ht/",
-        views.HealthCheckCustomView.as_view(checks=["myapp.health_checks.MyHealthCheckBackend"]),
-        name="health_check_custom",
-    ),
-]
-```
-
-::: health_check.views.HealthCheckView
-
 ## Django command
 
 You can run the Django command `health_check` to perform your health
@@ -134,5 +86,5 @@ Database                 ... OK
 CustomHealthCheck        ... unavailable: Something went wrong!
 ```
 
-Similar to the http version, a critical error will cause the command to
+Similar to the http version, an error will cause the command to
 quit with the exit code `1`.

health_check/views.py

@@ -1,4 +1,5 @@
 import re
+import warnings
 from functools import cached_property
 
 from django.db import transaction
@@ -146,6 +147,21 @@ class HealthCheckView(_MainView):
 
     checks: list[str | tuple[str, dict]] | None = None
 
+    def as_view(self, **initkwargs):
+        if "warnings_as_errors" in initkwargs:
+            warnings.warn(
+                "`warnings_as_errors` argument is deprecated and will be removed the next major version.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        if "use_threading" in initkwargs:
+            warnings.warn(
+                "`use_threading` argument is deprecated and will be removed the next major version.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        super().as_view(**initkwargs)
+
     def get_plugins(self):
         for check in self.checks or [
             "health_check.Cache",