Система проверок системы

Система проверок системы — это набор статических проверок для валидации проектов Django. Она обнаруживает распространённые проблемы и предлагает подсказки по их исправлению. Система расширяема, поэтому вы легко можете добавить собственные проверки.

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

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

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

Написание собственных проверок

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

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=None,
                obj=checked_object,
                id='myapp.E001',
            )
        )
    return errors

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

Сообщения

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

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

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

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

• Debug
• Info
• Warning
• Error
• Critical

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

Наконец, ваша функция проверки должна быть зарегистрирована явно в реестре проверок системы. Проверки должны быть зарегистрированы в файле, который загружается при загрузке вашего приложения; например, в методе 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(RangedIntegerField, self).__init__(**kwargs)
        self.min = min
        self.max = max

    def check(self, **kwargs):
        # Call the superclass
        errors = super(RangedIntegerField, self).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(MyModel, cls).check(**kwargs)
        # ... your own checks ...
        return errors

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

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

from django.core.checks import Error
errors = checked_object.check()
expected_errors = [
    Error(
        'an error',
        hint=None,
        obj=checked_object,
        id='myapp.E001',
    )
]
self.assertEqual(errors, expected_errors)