Описание тега doctest
Модуль doctest ищет фрагменты текста, которые выглядят как интерактивные сеансы Python, а затем выполняет эти сеансы, чтобы убедиться, что они работают точно так, как показано. Тестовые примеры и ожидаемый результат можно скопировать из сеанса интерактивного интерпретатора Python. Во время регрессионного тестирования doctest предупреждает о неудачных случаях.
Следующий обзор взят со страницы документации стандартной библиотеки Python. Примеры в официальной документации также предоставляют хорошее руководство по использованию doctest.
Есть несколько распространенных способов использования doctest:
- Проверить, что строки документации модуля актуальны, убедившись, что все интерактивные примеры по-прежнему работают, как задокументировано.
- Выполнить регрессионное тестирование, убедившись, что интерактивные примеры из тестового файла или тестового объекта работают должным образом.
- Написать учебную документацию для пакета, обильно иллюстрированную примерами ввода-вывода. В зависимости от того, выделены ли примеры или поясняющий текст, это имеет оттенок "грамотного тестирования" или "исполняемой документации".