Перейти к основному содержимому

Django и Django REST Framework

IDE знает поля ваших моделей и подставляет их везде, где Django ждёт имя поля строкой: в запросах ORM, админке, формах, сериализаторах и шаблонах. Опечатка в таком имени подчёркивается до запуска.

Файл admin.py в редакторе: строка 4 — API_TOKEN со строковым значением «sk_live_9f2b7c41d8e6a05b3417», подчёркнутым волной; строка 15 — list_display с подчёркнутым значением «prise» вместо «price»; строка 20 — Product.objects.filter с подчёркнутым аргументом prise__lt. В правом верхнем углу счётчик двух и одного предупреждения

Опечатка prise в list_display и в запросе ORM подчёркнута, как и секрет, вписанный строкой. Слева от ProductAdmin — значок перехода к модели.

Модели и запросы ORM​

  • Поля в запросах. filter, exclude, order_by и values дополняются полями модели, путь через __ проходит по внешним ключам. Несуществующее поле или лукап подчёркивается.
  • Типы. get возвращает модель, filter и all — набор её объектов, у значения поля свой тип. Конструктор модели дополняется по полям, а после models. классы полей подписаны типом: CharField → str, IntegerField → int.
  • Связи. Значок на ForeignKey, OneToOne и ManyToMany ведёт к целевой модели, в том числе по строковой ссылке "app.Model".
  • Переименование и поиск. Переименование поля правит и строки в запросах. Поиск использований находит поле в Meta, админке, ModelForm, запросах и шаблонах ({{ obj.field }}).
  • Объявление полей. Типичные ошибки подсвечиваются — например, null у текстового поля.

Админка и формы​

  • ModelAdmin. list_display, list_filter, search_fields и fieldsets дополняются полями модели, опечатка подчёркивается. Методы и property в list_display ошибкой не считаются.
  • ModelForm. Дополняется полями своей модели, в том числе у форм от базового класса проекта. Поле, которого нет в модели, подчёркивается.
  • Переход к модели. Значок на ModelAdmin и ModelForm открывает модель.
  • Генерация. ModelForm, менеджер, атрибуты и действия ModelAdmin создаются из контекстного меню модели в окне Python Frameworks.

Настройки​

  • settings.py. Имена настроек и ключи конфигурации логирования дополняются, неизвестная настройка подчёркивается.
  • INSTALLED_APPS и MIDDLEWARE. Помечаются повторно добавленное приложение и нарушенный порядок промежуточных слоёв.
  • Настройки в дереве. В окне Python Frameworks они разложены по разделам: Installed Apps, Middleware, Databases, Caches, Auth, Templates, Logging, Static/Media.
  • Подключение к базе. Из раздела Data Sources подключение заводится в DB-клиенте (плагин OpenIDE DB Client) по координатам из настроек проекта.

Сигналы​

Раздел Events (Signals) в окне Python Frameworks показывает, какие получатели подписаны на каждый сигнал, и открывает обработчик. Получатель собственного сигнала, который в проекте ни разу не отправляется, помечается.

Миграции​

Окно миграций показывает дерево «приложение → миграции» и отмечает применённые, когда это удаётся определить. Из окна запускаются makemigrations, migrate и просмотр SQL. Две головы в графе миграций видны отметкой на приложении.

Остальные команды manage.py — в разделе Запуск и отладка.

Шаблоны​

Поддерживаются Django Templates и Jinja. Набор тегов и фильтров выбирается по расширению файла, поэтому в проекте с обоими движками подсказки не смешиваются.

  • Теги внутри {% %} и фильтры после | — свои для каждого движка.
  • Переменные контекста внутри {{ }} — ключи словаря, переданного в render, и именованные аргументы во Flask.
  • Точки останова ставятся прямо в шаблоне — см. Отладка шаблонов.

Django REST Framework​

Сериализаторы и представления DRF разбираются вместе с моделями Django.

  • Сериализаторы. Meta.fields дополняется полями модели, опечатка подчёркивается, значение __all__ проверку снимает. Поля, объявленные в самом классе, и наследование от базового класса проекта учитываются.
  • Представления. ViewSet без serializer_class помечается, значок ведёт от представления к сериализатору, get_serializer и self.get_object знают свой тип.
  • Маршруты роутера попадают в список эндпоинтов, а при генерации запроса тело POST, PUT и PATCH собирается по сериализатору.
  • Сериализатор для модели создаётся одним действием.

Заготовки​

Из меню Новый (New) создаются Django-приложение целиком, а также модель и представление по диалогу.