Python Glossary English

все Python 3doctestфункция

doctest.run_docstring_examples()

запуск тестов

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

Синтаксис

doctest.run_docstring_examples(f, globs, verbose=False, name='NoName', compileflags=None, optionflags=0)

Ничего не возвращает и при успехе молчит — печатается только отчёт о провалах. Второй аргумент globs — пространство имён примеров, и если не передать туда саму функцию (обычно globals()), каждый пример упадёт с NameError. Аргумент name задаёт имя в отчёте.

Примеры

import doctest
def greet(name):
    """
    >>> greet("Ann")
    'Hi, Ann'
    """
    return "Hi, " + name
print(doctest.run_docstring_examples(greet, globals(), name="greet"))  # → None — успех молчит
doctest.run_docstring_examples(greet, globals(), verbose=True, name="greet")
# → Trying: / greet("Ann") / Expecting: / 'Hi, Ann' / ok

См. также

Открыть в полном глоссарииdocs.python.orgСообщить о неточности