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

FastAPI и Flask

Для FastAPI и Flask плагин собирает маршруты с полными путями, сверяет параметры пути с обработчиком и разбирает модели Pydantic и SQLAlchemy, на которых обычно держится слой данных.

FastAPI​

Окно Python Frameworks: проект rw-fastapi с пометками FastAPI, Pydantic и Alembic в шапке; раскрыт раздел Endpoints — маршруты сгруппированы по модулям items, login, private, router, users, у каждого свой метод GET, POST, PUT, PATCH или DELETE и путь с префиксом /api/v1

Префикс /api/v1 собран из include_router, у каждого маршрута свой метод. В шапке дерева — найденные библиотеки проекта: Pydantic и Alembic.

  • Маршруты. Декораторы get, post, put, delete и остальные дополняются вместе с аргументами, для status_code, response_model и tags есть подсказки значений. Путь собирается с учётом include_router и вложенных префиксов.
  • Параметры пути. Переменная пути, которой нет в аргументах обработчика, подчёркивается. Недостающие параметры дописываются в сигнатуру одним действием.
  • Depends и фоновые задачи. Значок ведёт от Depends к объявлению зависимости, от вызова add_task — к фоновой функции.
  • Проверки. Помечаются синхронный блокирующий вызов внутри async-обработчика и операция без response_model.
  • Заготовки. Модуль FastAPI с роутером и обработчиками создаётся из меню Новый (New), отдельный обработчик маршрута добавляется вместе с регистрацией.

Flask​

Окно Python Frameworks: проект rw-flask с пометками Flask, SQLAlchemy, Alembic и Celery в шапке; разделы Models, Endpoints с группами auth, forum, management, user, Migrations и CLI Commands с раскрытой группой Click — команды branches, celery, check, cleanup, compile, current с указанием области вроде «in db»

В шапке дерева — найденные расширения проекта. Маршруты сгруппированы по blueprint, ниже — миграции и команды Click с их областью.

  • Маршруты. Пути от app.route и от blueprint собираются вместе с префиксом.
  • Конфигурация. Имена конфигурационных ключей Flask дополняются, запуск с debug=True подчёркивается.
  • Окно Flask CLI. Команды приложения деревом, рядом с именем — область команды, запуск прямо из окна. Отсюда же выполняются migrate, upgrade и downgrade, а ревизии Alembic из versions/ видны цепочкой со статусом.
  • Шаблоны Jinja. Теги, фильтры и переменные из render_template дополняются — см. Шаблоны.
  • Заготовки. Blueprint создаётся из меню Новый (New).

Pydantic​

Модели Pydantic видны в окне Python Frameworks вместе с моделями ORM.

  • Поля и конфигурация. Аргументы Field и ключи ConfigDict дополняются с подсказками.
  • Переход на v2. Вызовы API первой версии подчёркиваются в проекте на второй.
  • Модель по списку полей. DTO создаётся из диалога с набором полей.
  • Тело запроса. По модели, объявленной телом запроса, собирается JSON при генерации запроса к маршруту.

SQLAlchemy​

  • Колонки. Имена колонок дополняются в запросах и фильтрах, у колонки — подсказки для nullable, index, default и других аргументов.
  • Конструктор модели. Именованные аргументы подставляются по колонкам.
  • Связи. Значок на relationship ведёт к связанной модели, в том числе заданной строкой.
  • Модели в дереве. Модели SQLAlchemy показаны вместе с остальными в разделе Models.