django-health-check 3.23.3__py3-none-any.whl → 4.0rc2__py3-none-any.whl

health_check/contrib/s3boto_storage/backends.py

@@ -1,27 +0,0 @@
-import logging
-
-from health_check.deprecation import deprecated
-from health_check.storage.backends import StorageHealthCheck
-
-
-@deprecated(
-    "`S3BotoStorageHealthCheck` is deprecated: use `health_check.Storage` instead. Action: remove legacy storage checks and add `health_check.Storage` to your `HealthCheckView.checks`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md)."
-)
-class S3BotoStorageHealthCheck(StorageHealthCheck):
-    """
-    Tests the status of a `S3BotoStorage` file storage backend.
-
-    S3BotoStorage is included in the `django-storages` package
-    and recommended by for example Amazon and Heroku for Django
-    static and media file storage on cloud platforms.
-
-    ``django-storages`` can be found at https://git.io/v1lGx
-    ``S3BotoStorage`` can be found at https://git.io/v1lGF
-    """
-
-    logger = logging.getLogger(__name__)
-    storage = "storages.backends.s3boto.S3BotoStorage"
-
-    def check_delete(self, file_name):
-        storage = self.get_storage()
-        storage.delete(file_name)

health_check/db/apps.py

@@ -1,20 +0,0 @@
-import warnings
-
-from django.apps import AppConfig
-
-from health_check.plugins import plugin_dir
-
-
-class HealthCheckConfig(AppConfig):
-    default_auto_field = "django.db.models.AutoField"
-    name = "health_check.db"
-
-    def ready(self):
-        from .backends import DatabaseBackend
-
-        warnings.warn(
-            "The `health_check.db` app is deprecated: it is superseded by view-based checks. Action: remove `health_check.db` from `INSTALLED_APPS` and use `HealthCheckView` with an explicit `checks` list. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
-            DeprecationWarning,
-        )
-
-        plugin_dir.register(DatabaseBackend)

health_check/db/backends.py

@@ -1,23 +0,0 @@
-from django.db import DatabaseError, IntegrityError
-
-from health_check.backends import HealthCheck
-from health_check.deprecation import deprecated
-from health_check.exceptions import ServiceReturnedUnexpectedResult, ServiceUnavailable
-
-from .models import TestModel
-
-
-@deprecated(
-    "`DatabaseBackend` is deprecated: use `health_check.Database` (new view-based Database check) instead. Action: remove legacy DatabaseBackend subclasses and configure `HealthCheckView` with `health_check.Database` in your `checks` list. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md)."
-)
-class DatabaseBackend(HealthCheck):
-    def check_status(self):
-        try:
-            obj = TestModel.objects.create(title="test")
-            obj.title = "newtest"
-            obj.save()
-            obj.delete()
-        except IntegrityError:
-            raise ServiceReturnedUnexpectedResult("Integrity Error")
-        except DatabaseError:
-            raise ServiceUnavailable("Database error")

health_check/db/migrations/0001_initial.py

@@ -1,34 +0,0 @@
-# Generated by Django 1.10.1 on 2016-09-26 18:46
-
-from django.db import migrations, models
-
-
-class Migration(migrations.Migration):
-    initial = True
-
-    replaces = [
-        ("health_check_db", "0001_initial"),
-    ]
-
-    dependencies = []
-
-    operations = [
-        migrations.CreateModel(
-            name="TestModel",
-            fields=[
-                (
-                    "id",
-                    models.AutoField(
-                        auto_created=True,
-                        primary_key=True,
-                        serialize=False,
-                        verbose_name="ID",
-                    ),
-                ),
-                ("title", models.CharField(max_length=128)),
-            ],
-            options={
-                "db_table": "health_check_db_testmodel",
-            },
-        ),
-    ]

health_check/db/migrations/0002_alter_testmodel_options.py

@@ -1,32 +0,0 @@
-# Generated by Django 4.2.20 on 2025-03-20 11:10
-
-from django.db import migrations
-
-
-def remove_test_model_default_permissions(apps, schema_editor):
-    ContentType = apps.get_model("contenttypes", "ContentType")
-    Permission = apps.get_model("auth", "Permission")
-    db_alias = schema_editor.connection.alias
-
-    try:
-        test_model_content_type = ContentType.objects.using(db_alias).get(app_label="db", model="testmodel")
-        Permission.objects.using(db_alias).filter(content_type=test_model_content_type).delete()
-    except ContentType.DoesNotExist:
-        return
-
-
-class Migration(migrations.Migration):
-    dependencies = [
-        ("db", "0001_initial"),
-    ]
-
-    operations = [
-        migrations.AlterModelOptions(
-            name="testmodel",
-            options={"default_permissions": ()},
-        ),
-        migrations.RunPython(
-            code=remove_test_model_default_permissions,
-            reverse_code=migrations.RunPython.noop,
-        ),
-    ]

health_check/db/models.py

@@ -1,9 +0,0 @@
-from django.db import models
-
-
-class TestModel(models.Model):
-    title = models.CharField(max_length=128)
-
-    class Meta:
-        db_table = "health_check_db_testmodel"
-        default_permissions = ()

health_check/deprecation.py

@@ -1,35 +0,0 @@
-from __future__ import annotations
-
-try:
-    from warnings import deprecated
-except ImportError:
-    import functools
-    import warnings
-
-    def deprecated(message: str, *, category: type[Warning] | None = DeprecationWarning, stacklevel: int = 1):
-        def _decorator(obj):
-            obj.__deprecated__ = message
-
-            # For classes, wrap __init__ to warn on instantiation
-            if isinstance(obj, type):
-                original_init = obj.__init__
-
-                @functools.wraps(original_init)
-                def new_init(self, *args, **kwargs):
-                    warnings.warn(message, category, stacklevel=stacklevel + 1)
-                    original_init(self, *args, **kwargs)
-
-                obj.__init__ = new_init
-            # For functions, wrap the function to warn on call
-            else:
-
-                @functools.wraps(obj)
-                def wrapper(*args, **kwargs):
-                    warnings.warn(message, category, stacklevel=stacklevel + 1)
-                    return obj(*args, **kwargs)
-
-                return wrapper
-
-            return obj
-
-        return _decorator

health_check/mixins.py

@@ -1,86 +0,0 @@
-import copy
-from collections import OrderedDict
-from concurrent.futures import ThreadPoolExecutor
-
-from django.db import connections
-from django.http import Http404
-
-from health_check.conf import HEALTH_CHECK
-from health_check.exceptions import HealthCheckException, ServiceWarning
-from health_check.plugins import plugin_dir
-
-
-class CheckMixin:
-    _errors: list[HealthCheckException] | None = None
-    _plugins = None
-    use_threading: bool = not HEALTH_CHECK["DISABLE_THREADING"]
-    warnings_as_errors: bool = HEALTH_CHECK["WARNINGS_AS_ERRORS"]
-
-    @property
-    def errors(self):
-        if not self._errors:
-            self._errors = self.run_check()
-        return self._errors
-
-    def check(self, subset=None):
-        return self.run_check(subset=subset)
-
-    @property
-    def plugins(self):
-        if not plugin_dir._registry:
-            return OrderedDict({})
-
-        if not self._plugins:
-            registering_plugins = (
-                plugin_class(**copy.deepcopy(options)) for plugin_class, options in plugin_dir._registry
-            )
-            registering_plugins = sorted(registering_plugins, key=repr)
-            self._plugins = OrderedDict({repr(plugin): plugin for plugin in registering_plugins})
-        return self._plugins
-
-    def filter_plugins(self, subset=None):
-        if subset is None:
-            return self.plugins
-
-        health_check_subsets = HEALTH_CHECK["SUBSETS"]
-        if subset not in health_check_subsets or not self.plugins:
-            raise Http404(f"Subset: '{subset}' does not exist.")
-
-        selected_subset = set(health_check_subsets[subset])
-        return {
-            plugin_identifier: v
-            for plugin_identifier, v in self.plugins.items()
-            if plugin_identifier in selected_subset
-        }
-
-    def run_check(self, subset=None):
-        errors = []
-
-        def _run(plugin):
-            plugin.run_check()
-            try:
-                return plugin
-            finally:
-                if self.use_threading:
-                    # DB connections are thread-local so we need to close them here
-                    connections.close_all()
-
-        def _collect_errors(plugin):
-            if plugin.critical_service:
-                if not self.warnings_as_errors:
-                    errors.extend(e for e in plugin.errors if not isinstance(e, ServiceWarning))
-                else:
-                    errors.extend(plugin.errors)
-
-        plugins = dict(self.filter_plugins(subset=subset))
-        plugin_instances = plugins.values()
-
-        if not self.use_threading:
-            for plugin in plugin_instances:
-                _run(plugin)
-                _collect_errors(plugin)
-        else:
-            with ThreadPoolExecutor(max_workers=len(plugin_instances) or 1) as executor:
-                for plugin in executor.map(_run, plugin_instances):
-                    _collect_errors(plugin)
-        return errors

health_check/plugins.py

@@ -1,25 +0,0 @@
-class AlreadyRegistered(Exception):
-    pass
-
-
-class NotRegistered(Exception):
-    pass
-
-
-class HealthCheckPluginDirectory:
-    """Django health check registry."""
-
-    def __init__(self):
-        self._registry = []  # plugin_class class -> plugin options
-
-    def reset(self):
-        """Reset registry state, e.g. for testing purposes."""
-        self._registry = []
-
-    def register(self, plugin, **options):
-        """Add the given plugin from the registry."""
-        # Instantiate the admin class to save in the registry
-        self._registry.append((plugin, options))
-
-
-plugin_dir = HealthCheckPluginDirectory()

health_check/storage/apps.py

@@ -1,12 +0,0 @@
-from django.apps import AppConfig
-
-from health_check.plugins import plugin_dir
-
-
-class HealthCheckConfig(AppConfig):
-    name = "health_check.storage"
-
-    def ready(self):
-        from .backends import DefaultFileStorageHealthCheck
-
-        plugin_dir.register(DefaultFileStorageHealthCheck)

health_check/storage/backends.py

@@ -1,73 +0,0 @@
-from __future__ import annotations
-
-import dataclasses
-import datetime
-import uuid
-
-from django.core.files.base import ContentFile
-from django.core.files.storage import storages
-
-from health_check.backends import HealthCheck
-from health_check.deprecation import deprecated
-from health_check.exceptions import ServiceUnavailable
-
-
-@dataclasses.dataclass
-class StorageHealthCheck(HealthCheck):
-    """
-    Check file storage backends by saving, reading, and deleting a test file.
-
-    Args:
-        alias (str): The alias of the storage backend to check. Defaults to "default".
-
-    """
-
-    alias: str = "default"
-
-    def get_storage(self):
-        return storages[self.storage_alias if hasattr(self, "storage_alias") else self.alias]
-
-    def get_file_name(self):
-        return f"health_check_storage_test/test-{uuid.uuid4()}.txt"
-
-    def get_file_content(self):
-        return f"# generated by health_check.Storage at {datetime.datetime.now().timestamp()}".encode()
-
-    def check_save(self, file_name, file_content):
-        storage = self.get_storage()
-        # save the file
-        file_name = storage.save(file_name, ContentFile(content=file_content))
-        # read the file and compare
-        if not storage.exists(file_name):
-            raise ServiceUnavailable("File does not exist")
-        with storage.open(file_name) as f:
-            if not f.read() == file_content:
-                raise ServiceUnavailable("File content does not match")
-        return file_name
-
-    def check_delete(self, file_name):
-        storage = self.get_storage()
-        # delete the file and make sure it is gone
-        storage.delete(file_name)
-        if storage.exists(file_name):
-            raise ServiceUnavailable("File was not deleted")
-
-    def check_status(self):
-        try:
-            # write the file to the storage backend
-            file_name = self.get_file_name()
-            file_content = self.get_file_content()
-            file_name = self.check_save(file_name, file_content)
-            self.check_delete(file_name)
-            return True
-        except ServiceUnavailable as e:
-            raise e
-        except Exception as e:
-            raise ServiceUnavailable("Unknown exception") from e
-
-
-@deprecated(
-    "`DefaultFileStorageHealthCheck` is deprecated: use `health_check.Storage` instead. Action: remove legacy storage sub-apps from `INSTALLED_APPS` and add `health_check.Storage` to your `HealthCheckView.checks`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md)."
-)
-class DefaultFileStorageHealthCheck(StorageHealthCheck):
-    alias = "default"

health_check/urls.py

@@ -1,18 +0,0 @@
-import warnings
-
-from django.urls import path
-
-from health_check.views import MainView
-
-warnings.warn(
-    "The `health_check.urls` module is deprecated: it has been replaced by view-based checks. Action: use `health_check.views.MainView` or `HealthCheckView.as_view(checks=...)` in your URLconf. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
-    DeprecationWarning,
-    stacklevel=2,
-)
-
-app_name = "health_check"
-
-urlpatterns = [
-    path("", MainView.as_view(), name="health_check_home"),
-    path("<str:subset>/", MainView.as_view(), name="health_check_subset"),
-]