Логотип МИЭМ НИУ ВШЭ
Завершен
Логотип типа проекта Программный
Программный
2021 / 2022
Логотип проекта NumPy Doctest

829 NumPy Doctest

Старт
01.09.2021
Представление
08.11.2021
Постерная сессия
18.04.2022
Защита
06.06.2022

Паспорт проекта

Аннотация

Содержащиеся в документации библиотечного программного кода примеры использования должны автоматически проверяться на корректность. В стандартной библиотеке языка Python для этого присутствует модуль doctest. Возможности данного модуля ограничены: в частности, отсутствует возможность задать "допуск" для проверки близости действительных чисел. В настоящее время библиотеки NumPy и SciPy используют модификацию модуля doctest, `https://github.com/scipy/scipy/blob/master/tools/refguide_check.py`,...

Отрасль

Информатика

Теги

Информатика

Цель

Разработать плагин к системе pytest для программной проверки примеров исполняемого программного кода.

Ожидаемые результаты

  • Результатом проекта будет являться программный модуль плагина pytest, удовлетворяющий следующим требованиям:
    • - модуль размещен в системе GitHub
      • - модуль позволяет проводить проверку документации NumPy и SciPy и позволяет отказаться от использования refguide-check
        • - модуль используется для проверки документации SciPy (pull request в статусе не ниже "рецензирование")
          • - модуль опубликован на PyPI

            Форма и способы промежуточного контроля

            Еженедельные обсуждения хода работ.

            Форма представления результатов

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

            Ресурсное обеспечение

            Средства разработки на Python

            Имеющийся задел

            Заполнено автоматически

            Заказчик