NvdaDevTestToolbox (Набор инструментов для разработки и тестирования NVDA)

• Автор: Cyrille Bougot
• Совместимость с NVDA: 2019.2 и новее
• Скачать стабильную версию

Этот аддон предоставляет различные функции для отладки и тестирования NVDA.

Возможности

• Улучшенный диалог перезагрузки для указания дополнительных параметров при перезапуске NVDA.
• Различные функции, связанные с залогированными ошибками.
• Исследователь свойств объектов.
• Инструменты для работы со скриптами: расширенный режим описания скриптов и открыватель скриптов.
• Команды для удобного чтения и анализа логов.
• Резервные копии старых логов.
• В рабочей области Python-консоли - функция для открытия исходного кода объекта.
• Пользовательский стартовый скрипт для Python-консоли.
• Команда для логирования трассировки стека функции speech.speak.
• Команда для обратного перевода элементов интерфейса.

Команды

Этот аддон использует многоуровневые команды для всех новых команд, которые он добавляет. Точка входа для этих команд - NVDA+X; таким образом, все команды должны выполняться через NVDA+X, за которым следует другая клавиша или жест. Вы можете просмотреть все доступные многоуровневые команды, нажав NVDA+X, H.

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

Улучшенный диалог перезагрузки

Команда NVDA+X, Q открывает диалог для указания дополнительных параметров перед перезапуском NVDA. Указываемые параметры соответствуют параметрам командной строки, которые можно использовать с nvda.exe, например -c для пути к конфигурации, --disable-addons для отключения аддонов и т.д.

Функции, связанные с залогированными ошибками

Сообщить о последней залогированной ошибке

Нажатие NVDA+X, E позволяет сообщить о последней ошибке без необходимости открывать лог. Повторное нажатие очищает запомненную последнюю ошибку.

Воспроизведение звука при ошибках

Настройка "Воспроизводить звук при ошибках" была добавлена в NVDA 2021.3 и позволяет указать, будет ли NVDA воспроизводить звук ошибки в случае записи ошибки в лог.

Этот аддон предоставляет дополнительную команду (NVDA+X, shift+E) для переключения этой настройки. Вы можете выбрать:

• "Только в тестовых версиях" (по умолчанию) - NVDA будет воспроизводить звуки ошибок только если текущая версия NVDA является тестовой (альфа, бета или запущенная из исходников).
• "Да" - включить звуки ошибок независимо от версии NVDA.

Для NVDA версий ниже 2021.3 этот аддон предоставляет обратную совместимость этой функции и возможность управления ей с клавиатуры. Однако флажок в панели дополнительных настроек не поддерживается в старых версиях.

Исследователь свойств объектов

Эта функция позволяет сообщать некоторые свойства текущего навигационного объекта без открытия просмотрщика логов.

Чтобы просмотреть свойства объекта, переместите навигационный объект на нужный элемент и используйте следующие команды:

• NVDA+X, стрелкаВверх: Выбирает предыдущее свойство и сообщает его для навигационного объекта.
• NVDA+X, стрелкаВниз: Выбирает следующее свойство и сообщает его для навигационного объекта.
• NVDA+X, N: Сообщает текущее выбранное свойство для навигационного объекта.
• NVDA+X, shift+N: Отображает текущее выбранное свойство для навигационного объекта в просматриваемом сообщении.

Список поддерживаемых свойств: name, role, state, value, windowClassName, windowControlID, windowHandle, location, Python class, Python class mro.

При использовании команд навигации по объектам вы также можете выбрать отчет о текущем выбранном свойстве вместо стандартного отчета NVDA. Команда-переключатель NVDA+X, control+N позволяет переключаться между этим пользовательским отчетом объектов и стандартным отчетом NVDA.

Например, вы можете выбрать свойство "windowClassName" и включить пользовательский отчет объектов. Тогда при перемещении навигационного объекта к следующему или предыдущему объекту вы будете слышать windowClassName объекта вместо стандартного отчета.

Инструменты для работы со скриптами

Открыватель скриптов

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

Чтобы использовать ее, нажмите NVDA+x, C, а затем жест скрипта, код которого вы хотите увидеть. Например, чтобы увидеть код скрипта, который сообщает заголовок активного окна, нажмите NVDA+X, C, а затем NVDA+T.

Для работы этой функции необходимо настроить команду вашего любимого редактора в настройках аддона. Если вы не запускаете NVDA из исходников и хотите открыть код NVDA, также должно быть настроено расположение исходного кода NVDA.

Расширенный режим описания скриптов

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

Когда расширенный режим описания скриптов активен, режим справки по вводу (NVDA+1) изменяется следующим образом. Если у скрипта нет описания, сообщаются имя и класс скрипта. Если у скрипта есть описание, оно сообщается как обычно. Жест для активации или деактивации этой функции - NVDA+X, D.

Выполнение жеста, связанного со скриптом без описания в режиме справки по вводу, также создает запись для этого скрипта в диалоге управления жестами. Эта запись находится в специальной категории под названием "Скрипты без описания (изменяйте на свой риск!)". Это позволяет легко добавлять, удалять или изменять жесты NVDA для этих скриптов. Однако имейте в виду, что часто отсутствие описания у скрипта преднамеренно, чтобы пользователь не изменял связанный жест. Действительно, жест может быть определен для соответствия сочетанию клавиш приложения. Например, скрипт script_toggleItalic в NVDAObjects.window.winword.WordDocument связан с control+I, и это не следует изменять, поскольку жест передается приложению для фактического выполнения сочетания клавиш.

Пример использования

Control+shift+I также переключает курсив в Word, даже если это не сообщается NVDA по умолчанию. Чтобы NVDA сообщала результат control+shift+I как control+I, выполните следующие шаги:

• Откройте документ Word.
• Включите расширенный режим описания скриптов с помощью NVDA+X, D.
• Войдите в режим справки по вводу с помощью NVDA+1.
• Нажмите control+I, чтобы сообщить о скрипте курсива и добавить его в диалог жестов.
• Выйдите из режима справки по вводу с помощью NVDA+1.
• Откройте диалог управления жестами.
• В категории "Скрипты без описания (изменяйте на свой риск!)" выберите команду "toggleItalic on NVDAObjects.window.winword.WordDocument".
• Добавьте сочетание control+shift+I и подтвердите.
• При желании выйдите из расширенного режима описания скриптов с помощью NVDA+X, D.

Известная ошибка: Скрипт, добавленный для конкретного класса, виден даже если диалог управления жестами открыт в другом контексте.

Функции для чтения и анализа логов

Разметка логов маркерами

Во время тестирования или работы вы можете пометить определенный момент в логе, чтобы легко вернуться к нему позже при чтении лога. Чтобы добавить маркер в лог, нажмите NVDA+X, K. На уровне INFO будет записано сообщение следующего вида:
-- NDTT marker 0 --
Вы можете добавить сколько угодно маркеров в лог. Номер маркера будет увеличиваться каждый раз, когда вы добавляете маркер в лог; он сбрасывается только при перезапуске NVDA.

Режим чтения логов

Режим чтения логов предоставляет команды для удобного чтения и анализа логов. В окне просмотрщика логов режим чтения включен по умолчанию, поэтому команды чтения логов доступны сразу. В другой области чтения текста, например в редакторе (например, Notepad++) или на веб-странице (например, issue на GitHub), вам нужно нажать NVDA+X, L, чтобы включить режим чтения логов и использовать его команды. Когда вы закончите задачи по чтению и анализу логов, вы можете снова отключить режим чтения с помощью NVDA+X, L.

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

Команды быстрой навигации

Односимвольные команды, аналогичные клавишам быстрой навигации в режиме просмотра, позволяют переходить к различным типам сообщений лога:

• m: любое сообщение
• e: сообщения об ошибках (ERROR и CRITICAL)
• w: предупреждения (WARNING)
• f: информационные сообщения (INFO)
• k: маркеры, ранее размещенные в логе
• g: отладочные предупреждения (DEBUGWARNING)
• i: сообщения ввода/вывода (IO)
• n: сообщения ввода
• s: речевые сообщения
• d: отладочные сообщения (DEBUG)

Нажатие одной буквы перемещает к следующему вхождению этого сообщения. Комбинация буквы с клавишей shift перемещает к предыдущему вхождению этого сообщения.

Перевод речевых сообщений

Иногда вам может потребоваться просмотреть лог, сделанный на системе на иностранном языке, который вы не понимаете. Например, лог был сделан на китайской системе/NVDA, а вы понимаете только французский. Если у вас установлен аддон Instant Translate, вы можете использовать его вместе с командами быстрой навигации по логу для перевода речевых сообщений.

• Сначала настройте языки в Instant Translate. Исходный язык должен быть языком системы, на которой был сделан лог (например, китайский). Целевой язык должен быть вашим языком (например, французский).
• Откройте лог
• Нажмите T, чтобы включить автоматический перевод речевых сообщений в логе
• Используйте команды быстрой навигации по логу, например S, I и т.д. При обнаружении речевого сообщения оно будет произнесено на вашем языке (французском в нашем примере)

Если вы хотите отключить перевод речевых сообщений, снова нажмите T.

Открытие файла с исходным кодом в вашем редакторе

В логе некоторые строки могут ссылаться на исходный код:

• Строка, относящаяся к трассировке (traceback), содержит путь и номер строки в файле, например:
  File "virtualBuffers\__init__.pyc", line 226, in _getStoryLength
• Заголовочная строка залогированного сообщения содержит функцию, которая записала это сообщение, например:
  INFO - config.ConfigManager._loadConfig (22:45:26.145) - MainThread (16580):
• Содержимое сообщения, записанного в режиме ввода помощи (логируется на уровне info):
  Input help: gesture kb(desktop):NVDA+t, bound to script title on globalCommands.GlobalCommands

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

Для работы этой функции необходимо предварительно настроить команду вашего любимого редактора в настройках аддона.
Если вы не запускаете NVDA из исходного кода и хотите открыть код NVDA, также должна быть настроена локация исходного кода NVDA.

Резервное копирование старых логов

NVDA уже предоставляет резервную копию лога предыдущей сессии; файл называется nvda-old.log.
Однако иногда может понадобиться доступ к более старым логам, например, если пришлось перезапустить NVDA до просмотра nvda-old.log.
Этот аддон позволяет настроить, нужно ли создавать резервные копии старых логов и сколько их хранить; это делается в настройках аддона.

Диалог менеджера логов позволяет просматривать резервные копии.
Его можно открыть через меню NVDA -> Инструменты -> Менеджер логов.
В этом диалоге вы можете увидеть список всех резервных копий логов и выполнить различные действия с выбранным логом:

• открыть его (нажмите Enter),
• удалить (нажмите Delete),
• скопировать файл лога (нажмите control+C).

Также можно выбрать несколько логов для выполнения действий над всеми сразу.

Чтобы открыть лог, предварительно необходимо настроить Команду для открытия файла в вашем редакторе.

Расширение Python-консоли

Функция openCodeFile

В консоли можно вызвать следующую функцию для просмотра исходного кода, определяющего переменную myVar:
openCodeFile(myVar)

Для работы этой функции необходимо предварительно настроить команду вашего любимого редактора в настройках аддона.
Если вы не запускаете NVDA из исходного кода и хотите открыть код NVDA, также должна быть настроена локация исходного кода NVDA.

Функция openCodeFile может быть вызвана для объектов, определённых в коде NVDA или в аддонах.
Она не может быть вызвана для объектов, исходный код которых недоступен (например, встроенных объектов Python).

Если объект ещё не импортирован в консоль, его имя можно передать как параметр в openCodeFile.

Примеры вызовов для кода NVDA:

• Просмотр определения функции speech.speech.speak:
  openCodeFile(speech.speech.speak)
  или с передачей имени:
  openCodeFile("speech.speech.speak")
• Просмотр определения класса TextInfo:
  openCodeFile(textInfos.TextInfo)
• Просмотр определения метода copyToClipboard класса TextInfo:
  openCodeFile(textInfos.TextInfo.copyToClipboard)
• Просмотр определения класса объекта в фокусе:
  openCodeFile(focus)
• Открытие файла api.py, определяющего модуль api:
  openCodeFile(api)

Стартовый скрипт Python-консоли

Можно определить пользовательский скрипт, который будет выполняться в пространстве имён Python-консоли при её первом открытии или после перезагрузки аддона (NVDA+F3), если консоль уже была открыта.

Например, скрипт позволяет выполнить новые импорты и определить алиасы, которые можно будет использовать прямо в консоли:

# Различные импорты для консоли.
import globalVars as gv
import core
import ui
# Алиасы
ocf = openCodeFile

Скрипт должен быть размещён по следующему пути: pathToNVDAConfig\ndtt\consoleStartup.py
Например: C:\Users\myUserName\AppData\Roaming\nvda\ndtt\consoleStartup.py

Логирование трассировки стека функции речи

Иногда может понадобиться узнать, какая часть кода ответственна за произнесение чего-либо.
Для этого можно включить логирование трассировки стека функции речи, нажав NVDA+X, S.
Каждый раз, когда NVDA что-то произносит, соответствующая трассировка стека будет записана в лог.

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

Команда обратного перевода

Многие тестировщики используют NVDA не на английском языке.
Но при отчёте о результатах тестирования на GitHub описания изменённых опций или сообщения NVDA должны быть на английском.
Это может быть утомительно и отнимать время, если приходится перезапускать NVDA на английском, чтобы проверить точные формулировки.

Чтобы избежать этого, аддон предоставляет команду обратного перевода NVDA+X, R, которая позволяет перевести интерфейс NVDA (сообщения, метки элементов GUI и т. д.) обратно на английский.
Эта команда использует систему перевода gettext NVDA для попытки обратного перевода последнего произнесённого текста.
А именно, переводится первая строка из последней последовательности речи.

Например, во французской NVDA при переходе к меню "Outils" NVDA произнесёт "Outils sous-Menu o" (что соответствует "Tools subMenu o" на английском).
Если сразу после этого нажать команду обратного перевода, NVDA переведёт "Outils" обратно в "Tools".

В логе можно увидеть следующие строки:

IO - speech.speech.speak (23:38:24.450) - MainThread (2044):
Speaking ['Outils', 'sous-Menu', CharacterModeCommand(True), 'o', CharacterModeCommand(False), CancellableSpeech (still valid)]

Это подтверждает, что "Outils" была первой строкой в последовательности речи.

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

Результат обратного перевода также копируется в буфер обмена, если включена соответствующая опция (по умолчанию включена).

Настройки

Некоторые функции аддона требуют дополнительной настройки.
Панель настроек позволяет включать их и управлять их работой.
Чтобы просмотреть или изменить настройки, перейдите в меню NVDA -> Параметры и выберите категорию "NVDA Dev & Test Toolbox".
Этот диалог настроек также доступен прямо из диалога Менеджера логов.

Эти настройки глобальны и могут быть изменены только при активном профиле по умолчанию.

Команда для открытия файла в вашем редакторе

Некоторые функции позволяют просматривать содержимое в вашем редакторе.
К ним относятся команды для просмотра исходного файла из лога или из объекта в консоли, а также кнопка "Открыть" в менеджере логов.

Для их использования необходимо настроить команду, которая будет вызываться для открытия файла в вашем редакторе.
Команда должна быть в формате:
"C:\path\to\my\editor\editor.exe" "{path}":{line}
Естественно, нужно изменить эту строку в соответствии с реальным именем и расположением вашего редактора и его синтаксисом для открытия файлов.
{path} будет заменён на полный путь к файлу, а {line} — на номер строки, куда нужно поместить курсор.
Например, для Notepad++ команда будет выглядеть так:
"C:\Program Files\Notepad++\notepad++.exe" "{path}" -n{line}

Путь к исходному коду NVDA

При использовании команд для просмотра исходного файла из лога или из объекта в консоли файл может принадлежать самой NVDA.
Если вы не запускаете NVDA из исходного кода, ваша NVDA содержит только скомпилированные файлы.
Поэтому здесь можно указать альтернативное расположение, где будет найден соответствующий исходный файл (например, место, куда вы склонировали исходный код NVDA).
Путь должен быть указан в формате:
C:\pathExample\GIT\nvda\source
Естественно, замените путь на корректный.

Убедитесь, что версия вашего исходного кода (например, коммит в GIT) совпадает с версией запущенной NVDA.

Резервное копирование старых логов

Выпадающий список "Резервное копирование старых логов" позволяет включить или отключить функцию.
Если она включена, ниже в поле "Лимит резервных копий" можно указать максимальное количество хранимых копий.
Эти настройки вступают в силу при следующем запуске NVDA, когда происходит резервное копирование.

Копировать результат обратного перевода в буфер обмена

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

Перевод

• Валентин Куприянов: Русский язык
• Поддержка перевода с версии 4.2.

Журнал изменений

Версия 7.0

• Добавлены многослойные команды; точка входа — комбинация клавиш NVDA+X.
  Соответственно были изменены существующие команды.
• Новая команда (NVDA+X, R), предназначенная для обратного перевода последнего произнесённого сообщения.
• Новая команда (NVDA+X, C), открывающая исходный код скрипта, привязанного к следующему нажатому жесту.
• Реализована поддержка озвучивания по требованию.
• Менеджер журналов теперь поддерживает больше действий либо с помощью кнопок в диалоговых окнах, либо используя сочетания клавиш в списке: клавиша Enter, чтобы открыть журнал, сочетание Ctrl+C, чтобы скопировать файл журнала, и клавиша Delete, чтобы удалить файл журнала.
• Порядок сортировки в менеджере журналов изменён на обратный (самый свежий журнал сверху).
• Исправлена проблема, возникающая при попытке открытия модуля Python функцией openCodeFile.

Версия 6.3

• Совместимость с NVDA 2024.1.

Версия 6.2

• Восстановлено открытие консоли для NVDA < 2021.1.
• Устранены потенциальные проблемы безопасности, связанные с GHSA-xg6w-23rw-39r8 при использовании дополнения со старыми версиями NVDA. Тем не менее, рекомендуется использовать NVDA 2023.3.3 или выше.

Версия 6.1

• Открытие исходного файла объекта, находящегося в подмодуле пакета, теперь работает.
• Исправление: расширенный диалог выхода теперь может быть снова открыт и использован, как ожидалось, после закрытия. (вклад Лукаша Голонки)

Версия 6.0

• При использовании команд навигации по объектам можно сообщать о конкретном свойстве объекта вместо обычного сообщения NVDA об объекте.
• В режиме чтения журнала клавиша «C» для открытия файла кода из журнала теперь работает и при вводе справочного сообщения.
• Исправление: дополнение теперь может успешно запускаться, когда количество журналов для сохранения установлено на максимальное значение.
• Исправление: вывод скрипта запуска консоли Python больше не мешает переходу к первому результату в консоли при использовании команд навигации по результатам.
• Примечание: С этого момента обновления локализации больше не будут отображаться в журнале изменений.

Версия 5.0

• Если установлено дополнение Instant Translate, теперь можно переводить речевые сообщения на лету при использовании команд чтения журнала.
• В режиме чтения журнала при нажатии клавиш E или shift+E теперь можно перейти как к сообщениям CRITICAL erorr, так и к обычным сообщениям ERROR.
• Добавлены новые команды быстрой навигации по журналу для перехода к сообщениям ввода и речи.
• Новая команда позволяет поместить маркер в журнал; а специальные команды быстрой навигации в режиме чтения журнала позволяют переходить к ним.
  Заслуга: первоначальная идея этой функции принадлежит дополнению Debug Helper Люка Дэвиса.
• Bubfix: Запоминание последней ошибки больше не происходит в некоторых случаях.
• Исправление: дополнение может снова инициализироваться с NVDA 2019.2.1.
• Исправление: функция сохранения журнала больше не будет работать с журналами, не относящимися к стандарту ASCII.

Версия 4.2.

• Исправлена ошибка с NVDA версии ниже 2021.3.
• Исправлено форматирование журнала трассировки стека.
• Первые локализации.

Версия 4.1

• Исправлена ошибка, возникавшая в некоторых ситуациях при записи в журнал ошибок.
• Настройки дополнения теперь могут быть изменены только при активном профиле по умолчанию, чтобы избежать проблем с конфигурацией.

Версия 4.0

• Возможность резервного копирования старых логов и введение менеджера логов.
• Добавлен скрипт, сообщающий о последней ошибке в журнале.
• Исправлена ошибка, не позволяющая прочитать последнее сообщение журнала в старых версиях NVDA.

Версия 3.2

• Совместимость с NVDA 2023.1.

Версия 3.1

• Исправлена ошибка, возникающая при запросе недоступной информации об объекте.

Версия 3.0

• В журнале теперь можно нажать C в строке заголовка сообщения, чтобы открыть функцию/модуль, которая его выдала.
• В консоли функция openCodeFile теперь может принимать в качестве параметра объект или строку, содержащую его имя.
• Новая функция: Файл запуска консоли NVDA: Если он существует, то файл YourNVDAConfigFolder\ndtt\consoleStartup.py будет выполняться при первом открытии консоли NVDA или при перезагрузке дополнений.
• Различные мелкие исправления для функции Python-консоли openCodeFile и команды для открытия исходного файла, соответствующего строке в журнале.
• Исправлена проблема при попытке создания отчета о ролях/состояниях для проводника объектов в старой версии NVDA.
• Дополнение больше не вызывает проблем с перехватчиком деревьев при использовании UIA в Edge.

Версия 2.1

• Различные исправления ошибок и рефакторинг/чистка кода для всех случаев использования: все поддерживаемые версии, установка против запуска из исходников и т.д. (вклад от Лукаша Голонки)
• Переписывание модуля compa (вклад от Łukasz Golonka)
• Диалог перезапуска теперь может быть открыт только один раз.
• Ярлыки проводника объектов теперь не назначаются по умолчанию и должны быть назначены пользователем.
• В проводнике объектов двойное нажатие для вызова скрипта, сообщающего о свойстве текущего объекта, теперь отображает сообщаемую информацию в виде сообщения, которое можно просмотреть.

Версия 2.0

• Новая функция: Улучшенный диалог перезапуска для указания некоторых дополнительных опций при перезапуске NVDA.
• Новая функция: расширенный режим описания.
• Функция воспроизведения звука ошибки согласована между версиями NVDA до и после 2021.3.
• Новая функция: Команды чтения журнала теперь доступны в окне просмотра журнала, а также в полях редактирования или на веб-страницах.
• Новая возможность: В консоли Python доступна функция openCodeFile для просмотра исходного кода объекта.
• Некоторые функции теперь отключены в безопасном режиме по соображениям безопасности.
• Расширен диапазон совместимости дополнения (с 2019.2 до 2021.1).
• Релизы теперь выполняются с помощью действия GitHub вместо appVeyor.

Версия 1.0

• Первоначальный релиз.

• NvdaDevTestToolbox-V.7.0.nvda-addon
• NvdaDevTestToolbox-V.6.3.nvda-addon
• NvdaDevTestToolbox-V.6.2.nvda-addon
• NvdaDevTestToolbox-V.6.1.nvda-addon
• NvdaDevTestToolbox-V.6.0.nvda-addon
• NvdaDevTestToolbox-V.5.0.nvda-addon
• NvdaDevTestToolbox-V.4.1.nvda-addon
• NvdaDevTestToolbox-V.3.2.nvda-addon