project_read — Документация Кванты

project_read

R · чтениебесплатноне изменяет проект

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

Когда использовать

В начале сессии — узнать идентификаторы проектов (УТ2020, УТ2020.<Расширение>) для параметра project других инструментов.
Проверить, что проект открыт, и понять его тип: конфигурация, расширение (с указанием базового проекта) или внешний объект.
Перед запуском тестов — посмотреть доступные конфигурации запуска и базы для project_action с операцией run_tests.
При сбоях — операция selftest показывает, какие службы EDT, на которые опирается Кванта, отвечают прямо сейчас.

Соседние инструменты домена «Проекты»

project_writeWсоздать новый проект: расширение, внешнюю обработку или отчёт project_actionAимпортировать, закрыть, обновить, пересобрать проект, запустить тесты test_readRпрочитать результаты прогона тестов

Операции

Операции project_read
operation	Что делает	Нужно передать
`list`по умолчанию	Все проекты рабочей области: идентификатор, статус (открыт или закрыт), путь, тип — конфигурация, расширение и его базовый проект, внешний объект. Плюс конфигурации запуска и базы, доступные для тестов.	ничего
`selftest`	Живая проверка служб EDT, на которые опираются инструменты Кванты: какие отвечают сейчас. Помогает отличить холодный старт от поломки.	ничего

Параметры

Параметры project_read
Параметр и тип	Обязательный	Описание	По умолчанию
`operation`строка	нет	Операция инструмента — значения и их смысл в таблице «Операции».значения: list · selftest	`list`
`limit`целое	нет	Окно чтения: сколько строк готового ответа вернуть. По умолчанию 200, максимум 1000.	`200`
`offset`целое	нет	Окно чтения: номер строки ответа, с которой начать (0 — первая страница). Значение для следующей страницы подсказывает строка `lines: …` в конце ответа.	`0`
`filter`строка	нет	Регулярное выражение без учёта регистра. Сужает вывод: оставляет строки ответа, в которых есть совпадение (заголовки секций с совпадениями сохраняются). Применяется до окна чтения.	—

Таблица собрана из схемы инструмента, которую получает агент при подключении.

Адреса

Адрес fqn не используется: инструмент читает всю рабочую область.

Пример вызова и ответа

Бесплатный инструмент: работает без ключа.

аргументы project_read

{ "operation": "list" }

Пример ответа в подготовке Устройство ответа — на странице Формат ответов.

Отказы и ошибки

Пустой список проектов

В рабочей области нет открытых проектов или EDT ещё загружает их. Откройте проект в EDT или импортируйте его: project_action с операцией attach и путём к папке проекта.

failed · Unknown operation

Неизвестное значение operation. В ответе — fix_hint: supported: … со списком допустимых операций и секция Did you mean. Допустимо: list, selftest.

Ограничения

Только чтение: состояние рабочей области не меняется.
Строка compat в ответе — сводка проверок совместимости с установленной версией EDT; при обновлении EDT смотрите её первой.