Как правильно написать doc тест для функции?

Question

[Дмитрий Демидов]

Первый раз нужно написать doc-тест для небольшой функции. Исходя из найденного на просторах Интернета, делаю следующее:

1. Пишу код функции и сохраняю в файл с именем func_name.py

def func_name(argument):
    #Some code
    return result

2. Пишу тест в текстовый файл func_name_test.txt:

>>> import ~\func_name.py
>>> func_name(test_argument)
test_result

3. Запускаю командой python -m doctest func_name_test.txt

В терминале выскакивает ошибка name 'func_name' is not defined

Пробовал from file_name import *, from file_name import func_name - тот же результат.

Что не так? Надеюсь, хотя бы на подсказку на верное направление мысли...

Answer 1

[Дмитрий Демидов]

Решил следующим образом:

Тест (кроме import, конечно) пишем в файл модуля сразу после объявления функции. Так:

def func_name(argument):
    """
    >>> func_name(test_argument)
    test_result
    """
    #Some code
    return result

В конце дописываем:

if __name__ == "__main__":
    import doctest
    doctest.testmod()

И запускаем файл с параметром -v

python func_name.py -v

Answer 2

[Дмитрий Демидов]

Здесь подробней - habrahabr.ru/post/121162