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

Система проверки системы — это набор статических проверок для проверки проектов 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='A hint.',
                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().__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)