Фреймворк проверки системы

Фреймворк system check - это набор статических проверок для проверки проектов Django. Он обнаруживает распространенные проблемы и дает подсказки, как их устранить. Фреймворк является расширяемым, поэтому вы можете легко добавлять свои собственные проверки.

Проверки могут быть вызваны явно с помощью команды check. Проверки запускаются неявно перед большинством команд, включая runserver и migrate. По соображениям производительности, проверки не выполняются как часть стека WSGI, который используется при развертывании. Если вам нужно запустить системные проверки на сервере развертывания, запускайте их явно с помощью команды check.

Серьезные ошибки вообще не позволят выполнить команды Django (например, runserver). О незначительных проблемах сообщается в консоли. Если вы проверили причину предупреждения и готовы проигнорировать его, вы можете скрыть конкретные предупреждения с помощью параметра SILENCED_SYSTEM_CHECKS в файле настроек вашего проекта.

Полный список всех проверок, которые могут быть подняты Django, можно найти в System check reference.

Выписывайте собственные чеки

Фреймворк является гибким и позволяет писать функции, выполняющие любые другие виды проверок, которые вам могут потребоваться. Ниже приведен пример функции проверки заглушки:

from django.core.checks import Error, register

@register()
def example_check(app_configs, **kwargs):
    errors = []
    # ... your check logic here
    if check_failed:
        errors.append(
            Error(
                'an error',
                hint='A hint.',
                obj=checked_object,
                id='myapp.E001',
            )
        )
    return errors

Функция проверки должна принимать аргумент app_configs; этот аргумент - список приложений, которые должны быть проверены. Если None, то проверка должна быть выполнена для всех установленных приложений в проекте. Аргумент **kwargs необходим для будущего расширения.

Сообщения

Функция должна возвращать список сообщений. Если в результате проверки проблем не обнаружено, функция проверки должна вернуть пустой список.

Предупреждения и ошибки, вызванные методом проверки, должны быть экземплярами CheckMessage. Экземпляр CheckMessage заключает в себе одну сообщаемую ошибку или предупреждение. Он также предоставляет контекст и подсказки, применимые к сообщению, и уникальный идентификатор, который используется для целей фильтрации.

Концепция очень похожа на сообщения message framework или logging framework. Сообщения помечаются символом level, указывающим на серьезность сообщения.

Существуют также ярлыки, облегчающие создание сообщений с общими уровнями. При использовании этих классов вы можете опустить аргумент level, поскольку он подразумевается именем класса.

Регистрация и маркировка чеков

Наконец, ваша функция проверки должна быть явно зарегистрирована в системном реестре проверок. Проверки должны быть зарегистрированы в файле, который загружается при загрузке вашего приложения; например, в методе AppConfig.ready().

register(*tags)(function)

Вы можете передать в register столько тегов, сколько хотите, чтобы пометить вашу проверку. Пометка проверок тегами полезна, так как позволяет запускать только определенную группу проверок. Например, чтобы зарегистрировать проверку совместимости, вы должны сделать следующий вызов:

from django.core.checks import register, Tags

@register(Tags.compatibility)
def my_check(app_configs, **kwargs):
    # ... perform compatibility checks and collect errors
    return errors

Вы можете зарегистрировать «проверки развертывания», которые относятся только к производственному файлу настроек, следующим образом:

@register(Tags.security, deploy=True)
def my_check(app_configs, **kwargs):
    ...

Эти проверки будут выполняться только при использовании опции check --deploy.

Вы также можете использовать register как функцию, а не декоратор, передав вызываемый объект (обычно функцию) в качестве первого аргумента в register.

Код ниже эквивалентен коду выше:

def my_check(app_configs, **kwargs):
    ...
register(my_check, Tags.security, deploy=True)

Проверки полей, моделей, менеджеров и баз данных

В некоторых случаях вам не нужно регистрировать свою функцию проверки - вы можете использовать уже существующую регистрацию.

Поля, модели, менеджеры моделей и бэкенды баз данных реализуют метод check(), который уже зарегистрирован в системе проверок. Если вы хотите добавить дополнительные проверки, вы можете расширить реализацию базового класса, выполнить любые дополнительные проверки, которые вам нужны, и добавить любые сообщения к тем, которые генерируются базовым классом. Рекомендуется делегировать каждую проверку отдельным методам.

Рассмотрим пример, в котором вы реализуете пользовательское поле с именем RangedIntegerField. Это поле добавляет аргументы min и max в конструктор IntegerField. Возможно, вы захотите добавить проверку, чтобы убедиться, что пользователи предоставляют минимальное значение, которое меньше или равно максимальному значению. Следующий фрагмент кода показывает, как можно реализовать такую проверку:

from django.core import checks
from django.db import models

class RangedIntegerField(models.IntegerField):
    def __init__(self, min=None, max=None, **kwargs):
        super().__init__(**kwargs)
        self.min = min
        self.max = max

    def check(self, **kwargs):
        # Call the superclass
        errors = super().check(**kwargs)

        # Do some custom checks and add messages to `errors`:
        errors.extend(self._check_min_max_values(**kwargs))

        # Return all errors and warnings
        return errors

    def _check_min_max_values(self, **kwargs):
        if (self.min is not None and
                self.max is not None and
                self.min > self.max):
            return [
                checks.Error(
                    'min greater than max.',
                    hint='Decrease min or increase max.',
                    obj=self,
                    id='myapp.E001',
                )
            ]
        # When no error, return an empty list
        return []

Если бы вы хотели добавить проверки в менеджер моделей, вы бы использовали тот же подход в своем подклассе Manager.

Если вы хотите добавить проверку в класс модели, подход почти такой же: единственное различие в том, что проверка является методом класса, а не методом экземпляра:

class MyModel(models.Model):
    @classmethod
    def check(cls, **kwargs):
        errors = super().check(**kwargs)
        # ... your own checks ...
        return errors

Написание тестов

Сообщения сопоставимы. Это позволяет легко писать тесты:

from django.core.checks import Error
errors = checked_object.check()
expected_errors = [
    Error(
        'an error',
        hint='A hint.',
        obj=checked_object,
        id='myapp.E001',
    )
]
self.assertEqual(errors, expected_errors)
Сигналы
Внешние пакеты
Вернуться на верх