Как создать пользовательские команды django-admin

Приложения могут регистрировать свои собственные действия с помощью manage.py. Например, вы можете добавить действие manage.py для приложения Django, которое вы распространяете. В этом документе мы создадим пользовательскую команду closepoll для приложения polls из урока.

Для этого добавьте директорию management/commands в приложение. Django зарегистрирует команду manage.py для каждого Python модуля в этой директории, имя которого не начинается с нижнего подчеркивания. Например:

polls/
    __init__.py
    models.py
    management/
        __init__.py
        commands/
            __init__.py
            _private.py
            closepoll.py
    tests.py
    views.py

В этом примере команда closepoll будет доступна для любого проекта, который включает приложение polls в INSTALLED_APPS.

Модуль _private.py не будет доступен как команда управления.

Модуль closepoll.py имеет только одно требование — он должен определить класс Command , который расширяет BaseCommand или один из его подклассов.

Для реализации команды измените polls/management/commands/closepoll.py следующим образом:

from django.core.management.base import BaseCommand, CommandError
from polls.models import Question as Poll

class Command(BaseCommand):
    help = 'Closes the specified poll for voting'

    def add_arguments(self, parser):
        parser.add_argument('poll_ids', nargs='+', type=int)

    def handle(self, *args, **options):
        for poll_id in options['poll_ids']:
            try:
                poll = Poll.objects.get(pk=poll_id)
            except Poll.DoesNotExist:
                raise CommandError('Poll "%s" does not exist' % poll_id)

            poll.opened = False
            poll.save()

            self.stdout.write(self.style.SUCCESS('Successfully closed poll "%s"' % poll_id))

self.stdout.write("Unterminated line", ending='')

Новую пользовательскую команду можно вызвать с помощью python manage.py closepoll <poll_ids>.

Метод handle() принимает один или несколько poll_ids и устанавливает poll.opened на False для каждого из них. Если пользователь указал несуществующие опросы, будет поднята ошибка CommandError. Атрибут poll.opened отсутствует в уроке и был добавлен в polls.models.Question для этого примера.

Принятие необязательных аргументов

То же closepoll можно легко изменить, чтобы удалить заданный опрос вместо его закрытия, приняв дополнительные параметры командной строки. Эти пользовательские параметры можно добавить в методе add_arguments() следующим образом:

class Command(BaseCommand):
    def add_arguments(self, parser):
        # Positional arguments
        parser.add_argument('poll_ids', nargs='+', type=int)

        # Named (optional) arguments
        parser.add_argument(
            '--delete',
            action='store_true',
            help='Delete poll instead of closing it',
        )

    def handle(self, *args, **options):
        # ...
        if options['delete']:
            poll.delete()
        # ...

Параметр (delete в нашем примере) доступен в словаре параметров options в методе handle. Подробнее об использовании add_argument см. в документации Python argparse.

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

Команды управления и локали

По умолчанию, команды управления выполняются с текущей активной локалью.

Если по какой-то причине ваша пользовательская команда управления должна выполняться без активной локали (например, чтобы предотвратить вставку переведенного содержимого в базу данных), отключите переводы с помощью декоратора @no_translations на методе handle():

from django.core.management.base import BaseCommand, no_translations

class Command(BaseCommand):
    ...

    @no_translations
    def handle(self, *args, **options):
        ...

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

Тестирование

Информацию о том, как тестировать пользовательские команды управления, можно найти в документации по тестированию.

Переопределение команд

Django регистрирует встроенные команды, а затем ищет команды в INSTALLED_APPS в обратном порядке. Во время поиска, если имя команды дублирует уже зарегистрированную команду, вновь обнаруженная команда переопределяет первую.

Другими словами, чтобы переопределить команду, новая команда должна иметь то же имя, и её приложение должно располагаться перед приложением переопределяемой команды в INSTALLED_APPS.

Команды управления из сторонних приложений, которые были непреднамеренно переопределены, могут быть доступны под новым именем, создав новую команду в одном из приложений вашего проекта (упорядоченного перед сторонним приложением в INSTALLED_APPS), которая импортирует Command переопределённой команды.

Объекты команд

class BaseCommand

Базовый класс, от которого в конечном счёте происходят все команды управления.

Используйте этот класс, если вам нужен доступ ко всем механизмам, которые анализируют аргументы командной строки и определяют, какой код вызвать в ответ; если вам не нужно изменять это поведение, рассмотрите использование одного из его подклассов.

Для наследования от класса BaseCommand требуется реализовать метод handle().

Атрибуты

Все атрибуты можно установить в вашем производном классе и использовать в BaseCommand’s подклассах.

BaseCommand.help

Краткое описание команды, которое будет выведено в сообщении справки, когда пользователь выполнит команду python manage.py help <command>.

BaseCommand.missing_args_message

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

BaseCommand.output_transaction

Булево значение, указывающее, выводит ли команда SQL-запросы; если True, вывод будет автоматически обернут в BEGIN; и COMMIT;. Значение по умолчанию False.

BaseCommand.requires_migrations_checks

Булево значение; если True, команда выводит предупреждение, если набор миграций на диске не соответствует миграциям в базе данных. Предупреждение не предотвращает выполнение команды. Значение по умолчанию False.

BaseCommand.requires_system_checks

Список или кортеж тегов, например [Tags.staticfiles, Tags.models]. Проверки системы зарегистрированные в выбранных тегах будут проверяться на наличие ошибок перед выполнением команды. Значение '__all__' можно использовать для указания выполнения всех проверок системы. Значение по умолчанию '__all__'.

BaseCommand.style

Атрибут экземпляра, который помогает создавать цветной вывод при записи в stdout или stderr. Например:

self.stdout.write(self.style.SUCCESS('...'))

См. Цветовое форматирование синтаксиса, чтобы узнать, как изменить цветовую палитру и увидеть доступные стили (используйте заглавные версии «ролей», описанных в этом разделе).

Если при выполнении вашей команды вы передадите параметр --no-color, все вызовы self.style() вернут исходную строку без форматирования.

BaseCommand.suppressed_base_arguments

Новое в Django 4.0.

Параметры команды по умолчанию, которые следует подавить в выводе справки. Это должен быть набор имён параметров (например, '--verbosity'). Значения по умолчанию для подавленных параметров всё ещё передаются.

Методы

BaseCommand имеет несколько методов, которые можно переопределить, но метод handle() обязательно должен быть реализован.

class Command(BaseCommand):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # ...

BaseCommand.create_parser(prog_name, subcommand, **kwargs)

Возвращает экземпляр CommandParser, который является подклассом ArgumentParser с несколькими настройками для Django.

Вы можете настроить экземпляр, переопределив этот метод и вызвав super() с kwargs параметрами ArgumentParser.

BaseCommand.add_arguments(parser)

Точка входа для добавления аргументов парсера для обработки аргументов командной строки, переданных команде. Пользовательские команды должны переопределить этот метод, чтобы добавить позиционные и необязательные аргументы, принимаемые командой. Вызов super() не требуется при непосредственном наследовании от BaseCommand.

BaseCommand.get_version()

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

BaseCommand.execute(*args, **options)

Попытка выполнить эту команду, выполняя проверки системы, если это необходимо (как контролируется атрибутом requires_system_checks). Если команда вызывает исключение CommandError, оно перехватывается и выводится в stderr.

BaseCommand.handle(*args, **options)

Фактическая логика команды. Подклассы должны реализовать этот метод.

Он может вернуть строку, которая будет выведена в stdout (оборачивается BEGIN; и COMMIT; , если output_transaction равно True).

BaseCommand.check(app_configs=None, tags=None, display_num_errors=False)

Использует систему проверок для проверки всего проекта Django на наличие потенциальных проблем. Серьёзные проблемы генерируются как CommandError; предупреждения выводятся в stderr; незначительные уведомления выводятся в stdout.

Если app_configs и tags оба равны None, выполняются все проверки системы. tags может быть списком тегов проверки, например, compatibility или models.

BaseCommand подклассы

class AppCommand

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

Вместо реализации handle(), подклассы должны реализовать handle_app_config(), который будет вызываться один раз для каждого приложения.

AppCommand.handle_app_config(app_config, **options)

Выполнение действий команды для app_config, которая будет экземпляром AppConfig, соответствующим метке приложения, указанной в командной строке.

class LabelCommand

Команда управления, которая принимает один или несколько произвольных аргументов (меток) в командной строке и выполняет действия с каждым из них.

Вместо реализации handle(), подклассы должны реализовать handle_label(), который будет вызываться один раз для каждой метки.

LabelCommand.label

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

LabelCommand.handle_label(label, **options)

Выполнение действий команды для label, которая будет строкой, указанной в командной строке.

Исключения команд

exception CommandError(returncode=1)

Класс исключений, указывающий на проблему при выполнении команды управления.

Если это исключение возникает во время выполнения команды управления из консоли командной строки, оно будет перехвачено и преобразовано в красиво отформатированное сообщение об ошибке в соответствующий поток вывода (т. е., stderr); в результате, поднятие этого исключения (с осмысленным описанием ошибки) является предпочтительным способом указать, что что-то пошло не так при выполнении команды. Оно принимает необязательный аргумент returncode для настройки кода выхода для выхода команды управления с использованием sys.exit().

Если команда управления вызывается из кода через call_command(), вам нужно перехватить исключение, когда это необходимо.