Зарегистрируйтесь для доступа к 15+ бесплатным курсам по программированию с тренажером

Тесты через документацию (Doctest) Python: Автоматическое тестирование

Помимо классических тестов, в Python встроено тестирование через документацию. Довольно необычный способ писать тесты, который иногда применяют для библиотечных функций. Его идея довольно проста, функция вызывается внутри терминала и получившийся вывод (вместе с вызовом) и есть тест, который добавляется в документацию функции:

# Внутри example.py определена функция reverse(), которая переворачивает строку
python -i example.py
reverse('')
# ''
reverse('Hexlet')
# 'telxeH'

Сделав нужные вызовы, мы просто добавляем их в описание функции:

def reverse(string):
    """Reverse string

    reverse('')
    ''

    reverse('Hexlet')
    'telxeH'
    """

    return string[::-1]

# Нужно для запуска тестов
if __name__ == "__main__":
    import doctest
    doctest.testmod()

Теперь, если передать этот файл в интерпретатор, то мы увидим отчёт о выполненных тестах:

# Для полного вывода нужно добавить флаг -v (verbose)
python example.py -v
Trying:
    reverse('')
Expecting:
    ''
ok
Trying:
    reverse('Hexlet')
Expecting:
    'telxeH'
ok
1 items had no tests:
    __main__
1 items passed all tests:
   2 tests in __main__.reverse
2 tests in 2 items.
2 passed and 0 failed.
Test passed.

Вот так документация может одновременно выполнять роль тестов. Достаточно удобно и практично. То же самое можно делать не только на уровне конкретной функции, но и на уровне всего модуля:

"""
This is the "example" module.

The example module supplies one function, reverse().  For example,

reverse('awesome!')
!emosewa
"""

Дополнительные материалы

  1. Doctest

Аватары экспертов Хекслета

Остались вопросы? Задайте их в разделе «Обсуждение»

Вам ответят команда поддержки Хекслета или другие студенты.

Ошибки, сложный материал, вопросы >
Нашли опечатку или неточность?

Выделите текст, нажмите ctrl + enter и отправьте его нам. В течение нескольких дней мы исправим ошибку или улучшим формулировку.

Что-то не получается или материал кажется сложным?

Загляните в раздел «Обсуждение»:

  • задайте вопрос. Вы быстрее справитесь с трудностями и прокачаете навык постановки правильных вопросов, что пригодится и в учёбе, и в работе программистом;
  • расскажите о своих впечатлениях. Если курс слишком сложный, подробный отзыв поможет нам сделать его лучше;
  • изучите вопросы других учеников и ответы на них. Это база знаний, которой можно и нужно пользоваться.

Об обучении на Хекслете

Для полного доступа к курсу нужен базовый план

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

Получить доступ
900
упражнений
2000+
часов теории
3200
тестов

Открыть доступ

Курсы программирования для новичков и опытных разработчиков. Начните обучение бесплатно.

  • 130 курсов, 2000+ часов теории
  • 900 практических заданий в браузере
  • 360 000 студентов
Даю согласие на обработку персональных данных, соглашаюсь с «Политикой конфиденциальности» и «Условиями оказания услуг»

Наши выпускники работают в компаниях:

Логотип компании Альфа Банк
Логотип компании Aviasales
Логотип компании Yandex
Логотип компании Tinkoff
Рекомендуемые программы

С нуля до разработчика. Возвращаем деньги, если не удалось найти работу.

Иконка программы Python-разработчик
Профессия
Разработка веб-приложений на Django
18 мая 10 месяцев

Используйте Хекслет по максимуму!

  • Задавайте вопросы по уроку
  • Проверяйте знания в квизах
  • Проходите практику прямо в браузере
  • Отслеживайте свой прогресс

Зарегистрируйтесь или войдите в свой аккаунт

Даю согласие на обработку персональных данных, соглашаюсь с «Политикой конфиденциальности» и «Условиями оказания услуг»