doctest.md

1> **Источник:** https://python-all.ru/3.8/library/doctest.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) – Тестирование интерактивных примеров Python89**Исходный код:** [Lib/doctest.py](https://python-all.ru/src/3.8/Lib/doctest.py)1011---1213Модуль [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) ищет фрагменты текста, которые выглядят как интерактивные сеансы Python, а затем выполняет эти сеансы, чтобы убедиться, что они работают в точности как показано. Есть несколько распространённых способов использования doctest:1415- Чтобы проверить, что докстринги модуля актуальны, убедившись, что все интерактивные примеры по-прежнему работают как описано.16- Чтобы выполнить регрессионное тестирование, проверяя, что интерактивные примеры из тестового файла или тестового объекта работают как ожидается.17- Чтобы написать учебную документацию для пакета, обильно иллюстрированную примерами ввода-вывода. В зависимости от того, на чём делается акцент – на примерах или на пояснительном тексте, это напоминает «грамотное тестирование» (literate testing) или «исполняемую документацию» (executable documentation).1819Вот полный, но небольшой пример модуля:2021```python22"""23Это модуль "example".2425Модуль example предоставляет одну функцию, factorial(). Например,2627>>> factorial(5)2812029"""3031def factorial(n):32    """Возвращает факториал n – целое число >= 0.3334    >>> [factorial(n) for n in range(6)]35    [1, 1, 2, 6, 24, 120]36    >>> factorial(30)37    26525285981219105863630848000000038    >>> factorial(-1)39    Traceback (самый последний вызов последним):40        ...41    ValueError: n должно быть >= 04243    Факториалы чисел с плавающей точкой допустимы, но число должно быть точным целым:44    >>> factorial(30.1)45    Traceback (самый последний вызов последним):46        ...47    ValueError: n должно быть целым числом48    >>> factorial(30.0)49    2652528598121910586363084800000005051    Оно также не должно быть нелепо большим:52    >>> factorial(1e100)53    Traceback (самый последний вызов последним):54        ...55    OverflowError: n слишком велико56    """5758    import math59    if not n >= 0:60        raise ValueError("n must be >= 0")61    if math.floor(n) != n:62        raise ValueError("n must be exact integer")63    if n+1 == n:  # перехватить значение, например 1e30064        raise OverflowError("n too large")65    result = 166    factor = 267    while factor <= n:68        result *= factor69        factor += 170    return result7172if __name__ == "__main__":73    import doctest74    doctest.testmod()75```7677Если запустить `example.py` напрямую из командной строки, [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) творит своё волшебство:7879```console80$ python example.py81$82```8384Нет вывода! Это нормально и означает, что все примеры сработали. Передайте скрипту `-v`, и [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) выведет подробный журнал того, что он пытается сделать, а в конце – сводку:8586```console87$ python example.py -v88Trying:89    factorial(5)90Expecting:91    12092ok93Trying:94    [factorial(n) for n in range(6)]95Expecting:96    [1, 1, 2, 6, 24, 120]97ok98```99100И так далее, в конечном итоге завершаясь:101102```text103Trying:104    factorial(1e100)105Expecting:106    Traceback (most recent call last):107        ...108    OverflowError: n too large109ok1102 items passed all tests:111   1 tests in __main__112   8 tests in __main__.factorial1139 tests in 2 items.1149 passed and 0 failed.115Test passed.116$117```118119Это всё, что нужно знать, чтобы начать продуктивно использовать [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest)! Погружайтесь. В следующих разделах приводятся полные подробности. Обратите внимание, что в стандартном наборе тестов и библиотеках Python есть много примеров doctest. Особенно полезные примеры можно найти в стандартном тестовом файле `Lib/test/test_doctest.py`.120121## Простое использование: проверка примеров в докстрингах122123Самый простой способ начать использовать doctest (но не обязательно тот, которым вы будете продолжать пользоваться) – это завершить каждый модуль `M` следующим образом:124125```python126if __name__ == "__main__":127    import doctest128    doctest.testmod()129```130131[`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) затем проверяет докстринги в модуле `M`.132133Запуск модуля как скрипта приводит к тому, что примеры в докстрингах выполняются и проверяются:134135```python136python M.py137```138139Это не отобразит ничего, если только какой-либо пример не завершится ошибкой – в этом случае ошибочный пример(ы) и причина(ы) ошибки(ок) выводятся в stdout, и последняя строка вывода будет `***Test Failed*** N failures.`, где *N* – это количество примеров, которые не прошли проверку.140141Запустите его с флагом `-v` вместо этого:142143```python144python M.py -v145```146147и подробный отчёт обо всех проверенных примерах выводится в стандартный вывод, а в конце – различные сводки.148149Можно принудительно включить подробный режим, передав `verbose=True` в [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod), или запретить его, передав `verbose=False`. В любом из этих случаев `sys.argv` не проверяется [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod) (поэтому передача `-v` или её отсутствие не имеет эффекта).150151Существует также сокращение командной строки для запуска [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod). Можно указать интерпретатору Python запустить модуль doctest напрямую из стандартной библиотеки и передать имя(ена) модуля в командной строке:152153```python154python -m doctest -v example.py155```156157Это импортирует `example.py` как отдельный модуль и запустит для него [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod). Обратите внимание, что это может работать некорректно, если файл является частью пакета и импортирует другие подмодули из этого пакета.158159Для получения дополнительной информации о [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod) см. раздел [Базовый API](https://python-all.ru/3.8/library/doctest.html#doctest-basic-api).160161## Простое использование: проверка примеров в текстовом файле162163Ещё одно простое применение doctest – тестирование интерактивных примеров в текстовом файле. Это можно сделать с помощью функции [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile):164165```python166import doctest167doctest.testfile("example.txt")168```169170Этот короткий скрипт выполняет и проверяет любые интерактивные примеры Python, содержащиеся в файле `example.txt`. Содержимое файла рассматривается как один гигантский докстринг; файл не обязан содержать программу на Python! Например, предположим, `example.txt` содержит следующее:171172```text173The ``example`` module174======================175176Using ``factorial``177-------------------178179This is an example text file in reStructuredText format.  First import180``factorial`` from the ``example`` module:181182    >>> from example import factorial183184Now use it:185186    >>> factorial(6)187    120188```189190Запуск `doctest.testfile("example.txt")` затем находит ошибку в этой документации:191192```python193File "./example.txt", line 14, in example.txt194Failed example:195    factorial(6)196Expected:197    120198Got:199    720200```201202Как и в случае с [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod), [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile) не будет выводить ничего, пока какой-либо пример не завершится ошибкой. Если пример завершается ошибкой, то ошибочный пример(ы) и причина(ы) ошибки(ок) выводятся в stdout, в том же формате, что и [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod).203204По умолчанию [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile) ищет файлы в каталоге вызывающего модуля. См. раздел [Базовый API](https://python-all.ru/3.8/library/doctest.html#doctest-basic-api) с описанием необязательных аргументов, которые можно использовать, чтобы указать ему искать файлы в других местах.205206Как и у [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod), степень подробности вывода [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile) можно задать с помощью флага командной строки `-v` или необязательного именованного аргумента *verbose*.207208Существует также сокращение командной строки для запуска [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile). Можно указать интерпретатору Python запустить модуль doctest напрямую из стандартной библиотеки и передать имя(ена) файла в командной строке:209210```python211python -m doctest -v example.txt212```213214Поскольку имя файла не заканчивается на `.py`, [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) делает вывод, что его нужно запускать с [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile), а не с [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod).215216Для получения дополнительной информации о [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile) см. раздел [Базовый API](https://python-all.ru/3.8/library/doctest.html#doctest-basic-api).217218## Как это работает219220В этом разделе подробно рассматривается, как работает doctest: какие docstrings он просматривает, как находит интерактивные примеры, какой контекст выполнения использует, как обрабатывает исключения и как опции могут управлять его поведением. Это информация, которую нужно знать для написания примеров doctest; сведения о непосредственном запуске doctest на этих примерах приведены в следующих разделах.221222### Какие docstrings проверяются?223224Проверяются docstring модуля, а также docstrings всех функций, классов и методов. Объекты, импортированные в модуль, не проверяются.225226Кроме того, если `M.__test__` существует и имеет значение «истина», это должен быть словарь, и каждая запись сопоставляет строковое имя с объектом функции, объектом класса или строкой. Докстринги объектов функций и классов, найденные из `M.__test__`, ищутся, а строки обрабатываются так, как если бы они были докстрингами. В выводе ключ `K` в `M.__test__` отображается с именем227228```python229<name of M>.__test__.K230```231232Любые найденные классы аналогично рекурсивно проверяются на наличие docstrings в содержащихся в них методах и вложенных классах.233234**Особенность реализации CPython:** До версии 3.4 модули расширения, написанные на C, не полностью просматривались doctest.235236### Как распознаются примеры docstring?237238В большинстве случаев копирование и вставка сессии интерактивной консоли работает нормально, но doctest не пытается точно эмулировать какой-либо конкретный Python shell.239240```python241>>> # комментарии игнорируются242>>> x = 12243>>> x24412245>>> if x == 13:246...     print("yes")247... else:248...     print("no")249...     print("NO")250...     print("NO!!!")251...252no253NO254NO!!!255>>>256```257258Любой ожидаемый вывод должен сразу следовать за последней строкой `'>>> '` или `'... '`, содержащей код, и ожидаемый вывод (если есть) простирается до следующей строки `'>>> '` или строки, состоящей только из пробелов.259260Мелкий шрифт:261262- Ожидаемый вывод не может содержать строку только из пробелов, так как такая строка считается сигналом конца ожидаемого вывода. Если ожидаемый вывод содержит пустую строку, поместите `<BLANKLINE>` в ваш пример doctest в каждом месте, где ожидается пустая строка.263- Все символы жёсткой табуляции заменяются пробелами с использованием 8-колонных позиций табуляции. Табуляции в выводе тестируемого кода не изменяются. Поскольку любые жёсткие табуляции в образцовом выводе *заменяются*, это означает, что если вывод кода содержит жёсткие табуляции, doctest может пройти, только если действует опция [`NORMALIZE_WHITESPACE`](https://python-all.ru/3.8/library/doctest.html#doctest.NORMALIZE_WHITESPACE) или [директива](https://python-all.ru/3.8/library/doctest.html#doctest-directives). В качестве альтернативы тест можно переписать так, чтобы захватывать вывод и сравнивать его с ожидаемым значением как часть теста. Этот способ обработки табуляций в исходном коде был найден методом проб и ошибок и оказался наименее подверженным ошибкам. Можно использовать другой алгоритм для обработки табуляций, написав собственный класс [`DocTestParser`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestParser).264- Вывод в stdout перехватывается, но не вывод в stderr (трассировки исключений перехватываются другим способом).265- Если вы продолжаете строку обратной косой чертой в интерактивной сессии или по любой другой причине используете обратную косую черту, следует использовать сырой docstring, который сохранит обратные косые черты точно в том виде, как вы их ввели:266267  ```python268  >>> def f(x):269  ...     r'''Обратная косая черта в сырой докстринге: m\n'''270  >>> print(f.__doc__)271  Backslashes in a raw docstring: m\n272  ```273274  В противном случае обратная косая черта будет интерпретироваться как часть строки. Например, `\n` выше будет интерпретироваться как символ новой строки. В качестве альтернативы можно удвоить каждую обратную косую черту в версии для doctest (и не использовать сырую строку):275276  ```python277  >>> def f(x):278  ...     '''Обратная косая черта в сырой докстринге: m\\n'''279  >>> print(f.__doc__)280  Backslashes in a raw docstring: m\n281  ```282- Начальный столбец не имеет значения:283284  ```python285  >>> assert "Easy!"286        >>> import math287            >>> math.floor(1.9)288            1289  ```290291  а также из ожидаемого вывода удаляется столько начальных пробельных символов, сколько их было в исходной строке `'>>> '`, с которой начинался пример.292293### Что такое контекст выполнения?294295По умолчанию каждый раз, когда [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) находит документирующую строку для тестирования, он использует *поверхностную копию* глобальных переменных `M`, чтобы выполнение тестов не изменяло реальные глобальные переменные модуля и чтобы один тест в `M` не мог оставить следов, случайно позволяющих работать другому тесту. Это означает, что примеры могут свободно использовать любые имена, определённые на верхнем уровне в `M`, а также имена, определённые ранее в выполняемой документирующей строке. Примеры не видят имена, определённые в других документирующих строках.296297Можно принудительно использовать собственный словарь в качестве контекста выполнения, передав `globs=your_dict` в [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod) или [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile).298299### Как насчёт исключений?300301Никаких проблем, при условии, что трассировка – единственный вывод, выдаваемый примером: просто вставьте трассировку. [1](https://python-all.ru/3.8/library/doctest.html#id2) Поскольку трассировки содержат детали, которые могут быстро меняться (например, точные пути к файлам и номера строк), это тот случай, когда doctest старается быть гибким в том, что он принимает.302303Простой пример:304305```python306>>> [1, 2, 3].remove(42)307Traceback (most recent call last):308  File "<stdin>", line 1, in <module>309ValueError: list.remove(x): x not in list310```311312Этот doctest считается успешным, если возбуждается [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError) с деталями `list.remove(x): x not in list`, как показано.313314Ожидаемый вывод для исключения должен начинаться с заголовка трассировки, которым может быть одна из следующих двух строк, с отступом, совпадающим с первой строкой примера:315316```python317Traceback (most recent call last):318Traceback (innermost last):319```320321За заголовком трассировки следует необязательный стек трассировки, содержимое которого игнорируется doctest. Стек трассировки обычно опускается или копируется дословно из интерактивного сеанса.322323За стеком трассировки следует самая интересная часть: строка(и), содержащие тип исключения и его описание. Обычно это последняя строка трассировки, но может занимать несколько строк, если у исключения многострочное описание:324325```python326>>> raise ValueError('multi\n    line\ndetail')327Traceback (most recent call last):328  File "<stdin>", line 1, in <module>329ValueError: multi330    line331detail332```333334Последние три строки (начиная с [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError)) сравниваются с типом и описанием исключения, а остальные игнорируются.335336Лучшая практика – опускать стек трассировки, если он не добавляет существенной документационной ценности примеру. Так что последний пример, вероятно, лучше оформить так:337338```python339>>> raise ValueError('multi\n    line\ndetail')340Traceback (most recent call last):341    ...342ValueError: multi343    line344detail345```346347Обратите внимание, что трассировки обрабатываются особым образом. В частности, в переписанном примере использование `...` не зависит от опции [`ELLIPSIS`](https://python-all.ru/3.8/library/doctest.html#doctest.ELLIPSIS) doctest. Многоточие в этом примере можно было бы опустить или заменить тремя (или тремястами) запятыми, цифрами или отступной стенограммой скетча Монти Пайтона.348349Некоторые детали, которые стоит прочитать один раз, но запоминать не обязательно:350351- Doctest не может угадать, получен ли ваш ожидаемый вывод из трассировки исключения или из обычной печати. Поэтому, например, пример, ожидающий `ValueError: 42 is prime`, будет пройден независимо от того, действительно ли возбуждено [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError) или же пример просто выводит этот текст трассировки. На практике обычный вывод редко начинается со строки заголовка трассировки, так что это не создаёт реальных проблем.352- Каждая строка стека трассировки (если присутствует) должна иметь отступ больше, чем первая строка примера, *или* начинаться с небуквенно-цифрового символа. Первая строка после заголовка трассировки с таким же отступом и начинающаяся с буквенно-цифрового символа считается началом описания исключения. Конечно, это корректно работает для настоящих трассировок.353- Когда указана опция doctest [`IGNORE_EXCEPTION_DETAIL`](https://python-all.ru/3.8/library/doctest.html#doctest.IGNORE_EXCEPTION_DETAIL), всё, что находится после самого левого двоеточия и любой информации о модуле в имени исключения, игнорируется.354- Интерактивная оболочка опускает строку заголовка трассировки для некоторых [`SyntaxError`](https://python-all.ru/3.8/library/exceptions.html#SyntaxError). Но doctest использует строку заголовка трассировки, чтобы отличать исключения от не-исключений. Поэтому в редком случае, когда нужно протестировать [`SyntaxError`](https://python-all.ru/3.8/library/exceptions.html#SyntaxError), который опускает заголовок трассировки, придётся вручную добавить строку заголовка трассировки в тестовый пример.355356- Для некоторых [`SyntaxError`](https://python-all.ru/3.8/library/exceptions.html#SyntaxError) Python отображает позицию символа синтаксической ошибки с помощью маркера `^`:357358  ```python359  >>> 1 1360    File "<stdin>", line 1361      1 1362        ^363  SyntaxError: invalid syntax364  ```365366  Поскольку строки, показывающие положение ошибки, идут до типа и описания исключения, они не проверяются doctest. Например, следующий тест будет пройден, даже если `^`-маркер поставлен в неверное место:367368  ```python369  >>> 1 1370  Traceback (most recent call last):371    File "<stdin>", line 1372      1 1373      ^374  SyntaxError: invalid syntax375  ```376377### Флаги опций378379Ряд опционных флагов управляют различными аспектами поведения doctest. Символические имена флагов предоставляются в виде констант модуля, которые можно [объединять поразрядной операцией ИЛИ](https://python-all.ru/3.8/reference/expressions.html#bitwise) и передавать различным функциям. Имена также можно использовать в [директивах doctest](https://python-all.ru/3.8/library/doctest.html#doctest-directives) и передавать интерфейсу командной строки doctest через опцию `-o`.380381Новое в версии 3.4: Опция командной строки `-o`.382383Первая группа опций определяет семантику тестов, управляя аспектами того, как doctest решает, соответствует ли фактический вывод ожидаемому выводу примера:384385#### `doctest.DONT_ACCEPT_TRUE_FOR_1`386387По умолчанию, если блок ожидаемого вывода содержит просто `1`, то фактический вывод, содержащий просто `1` или просто `True`, считается совпадением; аналогично для `0` и `False`. Когда указано [`DONT_ACCEPT_TRUE_FOR_1`](https://python-all.ru/3.8/library/doctest.html#doctest.DONT_ACCEPT_TRUE_FOR_1), ни одна из подстановок не разрешена. Поведение по умолчанию учитывает, что Python изменил тип возвращаемого значения многих функций с целого числа на логическое; тесты из модуля doctest, ожидающие «маленькое целое», всё ещё работают в таких случаях. Эта опция, вероятно, будет удалена, но не в ближайшие годы.388389#### `doctest.DONT_ACCEPT_BLANKLINE`390391По умолчанию, если блок ожидаемого вывода содержит строку, состоящую только из `<BLANKLINE>`, то эта строка будет соответствовать пустой строке в фактическом вызове. Поскольку действительно пустая строка разделяет ожидаемый вывод, это единственный способ указать, что ожидается пустая строка. Когда указано [`DONT_ACCEPT_BLANKLINE`](https://python-all.ru/3.8/library/doctest.html#doctest.DONT_ACCEPT_BLANKLINE), такая подстановка не разрешена.392393#### `doctest.NORMALIZE_WHITESPACE`394395Когда указано, все последовательности пробельных символов (пробелы и переводы строк) считаются равными. Любая последовательность пробелов в ожидаемом выводе будет соответствовать любой последовательности пробелов в фактическом выводе. По умолчанию пробельные символы должны совпадать точно. [`NORMALIZE_WHITESPACE`](https://python-all.ru/3.8/library/doctest.html#doctest.NORMALIZE_WHITESPACE) особенно полезна, когда строка ожидаемого вывода очень длинная, и её хочется перенести на несколько строк в исходном коде.396397#### `doctest.ELLIPSIS`398399Когда указано, маркер многоточия (`...`) в ожидаемом выводе может соответствовать любой подстроке в фактическом выводе. Это включает подстроки, выходящие за границы строк, и пустые подстроки, поэтому лучше использовать эту возможность просто. Сложное использование может привести к тем же сюрпризам «ой, совпало слишком много!», к которым склонен `.*` в регулярных выражениях.400401#### `doctest.IGNORE_EXCEPTION_DETAIL`402403Если этот флаг указан, пример, ожидающий исключение, считается успешным, если возбуждено исключение ожидаемого типа, даже если описание исключения не совпадает. Например, пример, ожидающий `ValueError: 42`, будет пройден, если фактически возбуждено исключение `ValueError: 3*14`, но не пройден, если возбуждено, скажем, [`TypeError`](https://python-all.ru/3.8/library/exceptions.html#TypeError).404405Этот флаг также игнорирует имя модуля, которое используется в отчётах doctest в Python 3. Поэтому оба следующих варианта будут работать с указанным флагом независимо от того, выполняется ли тест под Python 2.7 или Python 3.2 (или более поздними версиями):406407```python408>>> raise CustomError('message')409Traceback (most recent call last):410CustomError: message411412>>> raise CustomError('message')413Traceback (most recent call last):414my_module.CustomError: message415```416417Обратите внимание, что [`ELLIPSIS`](https://python-all.ru/3.8/library/doctest.html#doctest.ELLIPSIS) можно также использовать для игнорирования деталей сообщения об исключении, но такой тест всё равно может не пройти из-за того, выводятся ли сведения о модуле как часть имени исключения. Использование [`IGNORE_EXCEPTION_DETAIL`](https://python-all.ru/3.8/library/doctest.html#doctest.IGNORE_EXCEPTION_DETAIL) и деталей из Python 2.3 – единственный понятный способ написать доктест, которому безразличны детали исключения и который продолжает работать в Python 2.3 и более ранних версиях (эти версии не поддерживают [директивы doctest](https://python-all.ru/3.8/library/doctest.html#doctest-directives) и игнорируют их как незначащие комментарии). Например:418419```python420>>> (1, 2)[3] = 'moo'421Traceback (most recent call last):422  File "<stdin>", line 1, in <module>423TypeError: object doesn't support item assignment424```425426проходит в Python 2.3 и более поздних версиях Python с указанным флагом, хотя в Python 2.4 описание изменилось c «doesn’t» на «does not».427428Изменено в версии 3.2: [`IGNORE_EXCEPTION_DETAIL`](https://python-all.ru/3.8/library/doctest.html#doctest.IGNORE_EXCEPTION_DETAIL) теперь также игнорирует любую информацию,\\nотносящуюся к модулю, содержащему проверяемое исключение.429430#### `doctest.SKIP`431432Если этот флаг указан, пример не выполняется вообще. Это может быть полезно в ситуациях,\\nкогда доктесты служат одновременно документацией и тестовыми примерами, и пример\\nдолжен быть включён для документации, но не должен проверяться. Например, вывод\\nпримера может быть случайным, или пример может зависеть от ресурсов,\\nнедоступных для тестового драйвера.433434Флаг SKIP также можно использовать для временного «закомментирования» примеров.435436#### `doctest.COMPARISON_FLAGS`437438Битовая маска, объединяющая все перечисленные выше флаги сравнения.439440Вторая группа опций управляет тем, как сообщается о неудачных тестах:441442#### `doctest.REPORT_UDIFF`443444Если указан, ошибки, включающие многострочные ожидаемый и фактический вывод, отображаются в виде unified diff.445446#### `doctest.REPORT_CDIFF`447448Если указан, ошибки, включающие многострочные ожидаемый и фактический вывод, отображаются в виде context diff.449450#### `doctest.REPORT_NDIFF`451452Если указан, различия вычисляются с помощью `difflib.Differ`, используя тот же алгоритм, что и популярная утилита `ndiff.py`. Это единственный метод, который помечает различия как внутри строк, так и между строками. Например, если строка ожидаемого вывода содержит цифру `1`, а фактический вывод – букву `l`, вставляется строка с символом '^', отмечающим позиции несовпадающих столбцов.453454#### `doctest.REPORT_ONLY_FIRST_FAILURE`455456Если указан, отображается первый упавший пример в каждом доктесте, но вывод\\nдля всех остальных примеров подавляется. Это предотвращает сообщение доктестом\\nо корректных примерах, которые «ломаются» из-за предыдущих ошибок; но оно также может\\nскрыть некорректные примеры, которые падают независимо от первой ошибки. Когда\\n[`REPORT_ONLY_FIRST_FAILURE`](https://python-all.ru/3.8/library/doctest.html#doctest.REPORT_ONLY_FIRST_FAILURE) указан, остальные примеры всё равно выполняются\\nи учитываются в общем количестве сообщённых ошибок; только\\nвывод подавляется.457458#### `doctest.FAIL_FAST`459460Если указан, завершить работу после первого упавшего примера и не пытаться\\nвыполнять остальные. Таким образом, количество сообщённых ошибок будет не более\\n1. Этот флаг может быть полезен при отладке, так как примеры после первой\\nошибки даже не будут генерировать отладочный вывод.461462Командная строка doctest принимает опцию `-f` как сокращение для `-o FAIL_FAST`.463464Новое в версии 3.4.465466#### `doctest.REPORTING_FLAGS`467468Битовая маска, объединяющая все перечисленные выше флаги отчёта.469470Существует также способ зарегистрировать новые имена флагов опций,\\nхотя это не имеет смысла, если вы не собираетесь расширять внутренности [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) через подклассы:471472#### `doctest.register_optionflag(name)`473474Создаёт новый флаг опции с заданным именем и возвращает целочисленное\\nзначение нового флага. [`register_optionflag()`](https://python-all.ru/3.8/library/doctest.html#doctest.register_optionflag) можно использовать при создании подклассов\\n[`OutputChecker`](https://python-all.ru/3.8/library/doctest.html#doctest.OutputChecker) или [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner) для создания новых опций, которые\\nподдерживаются вашими подклассами. [`register_optionflag()`](https://python-all.ru/3.8/library/doctest.html#doctest.register_optionflag) всегда следует вызывать,\\nиспользуя следующий идиоматический приём:475476```python477MY_FLAG = register_optionflag('MY_FLAG')478```479480### Директивы481482Директивы доктестов могут использоваться для изменения [флагов опций](https://python-all.ru/3.8/library/doctest.html#doctest-options) для отдельного примера. Директивы доктестов – это\\nспециальные комментарии Python, следующие за исходным кодом примера:483484```485486directive             ::=  "#" "doctest:" directive_options487directive_options     ::=  directive_option ("," directive_option)\*488directive_option      ::=  on_or_off directive_option_name489on_or_off             ::=  "+" \| "-"490directive_option_name ::=  "DONT_ACCEPT_BLANKLINE" \| "NORMALIZE_WHITESPACE" \| ...491```492493Пробелы не допускаются между `+` или `-` и именем опции\\nдирективы. Имя опции директивы может быть любым из имён флагов опций,\\nописанных выше.494495Директивы доктестов примера изменяют поведение doctest только для этого\\nодного примера. Используйте `+` для включения указанного поведения или\\n`-` для его отключения.496497Например, этот тест проходит:498499```python500>>> print(list(range(20))) 501[0,   1,  2,  3,  4,  5,  6,  7,  8,  9,50210,  11, 12, 13, 14, 15, 16, 17, 18, 19]503```504505Без директивы он бы не прошёл, и потому что в фактическом выводе нет\\nдвух пробелов перед элементами списка из одной цифры, и потому что фактический вывод\\nнаходится на одной строке. Этот тест тоже проходит и тоже требует директивы\\nдля этого:506507```python508>>> print(list(range(20))) 509[0, 1, ..., 18, 19]510```511512На одной физической строке можно использовать несколько директив, разделённых запятыми:513514```python515>>> print(list(range(20))) 516[0,    1, ...,   18,    19]517```518519Если для одного примера используется несколько директив-комментариев, то они объединяются:520521```python522>>> print(list(range(20))) 523...                        524[0,    1, ...,   18,    19]525```526527Как показано в предыдущем примере, можно добавлять строки `...` в пример, содержащие только директивы. Это может быть полезно, когда пример слишком длинный, чтобы директива удобно поместилась на той же строке:528529```python530>>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40)))531... 532[0, ..., 4, 10, ..., 19, 30, ..., 39]533```534535Обратите внимание: поскольку все опции по умолчанию отключены, а директивы применяются только к тому примеру, в котором они находятся, включение опций (через `+` в директиве) обычно является единственным осмысленным выбором. Однако флаги опций также могут передаваться функциям, запускающим доктесты, устанавливая другие значения по умолчанию. В таких случаях отключение опции через `-` в директиве может быть полезным.536537### Предупреждения538539[`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) очень требователен к точному совпадению ожидаемого вывода. Если не совпадает хотя бы один символ, тест считается проваленным. Это, скорее всего, несколько раз вас удивит, пока вы будете изучать, что именно Python гарантирует в выводе, а что нет. Например, при печати множества Python не гарантирует, что элементы будут напечатаны в определённом порядке, поэтому тест вида540541```python542>>> foo()543{"Hermione", "Harry"}544```545546является уязвимым! Один из способов обойти это – сделать547548```python549>>> foo() == {"Hermione", "Harry"}550True551```552553вместо этого. Другой способ – сделать554555```python556>>> d = sorted(foo())557>>> d558['Harry', 'Hermione']559```560561> **Примечание**562>563> До Python 3.6 при выводе словаря Python не гарантировал, что пары ключ-значение будут напечатаны в каком-либо определённом порядке.564565Есть и другие, но идея понятна.566567Ещё одна плохая идея – печатать то, что содержит адрес объекта, например568569```python570>>> id(1.0) # обязательно иногда будет ошибаться5717948648572>>> class C: pass573>>> C()   # стандартный repr() для экземпляров содержит адрес574<__main__.C instance at 0x00AC18F0>575```576577Директива [`ELLIPSIS`](https://python-all.ru/3.8/library/doctest.html#doctest.ELLIPSIS) даёт хороший подход для последнего примера:578579```python580>>> C() 581<__main__.C instance at 0x...>582```583584Числа с плавающей запятой также подвержены небольшим различиям в выводе на разных платформах, поскольку Python полагается на системную библиотеку C для форматирования чисел с плавающей запятой, а качество библиотек C сильно различается.585586```python587>>> 1./7  # рискованно5880.14285714285714285589>>> print(1./7) # безопаснее5900.142857142857591>>> print(round(1./7, 6)) # гораздо безопаснее5920.142857593```594595Числа вида `I/2.**J` безопасны на всех платформах, и я часто подбираю примеры для doctest так, чтобы они давали числа такого вида:596597```python598>>> 3./4  # абсолютно безопасно5990.75600```601602Простые дроби также легче понимаются людьми, что улучшает документацию.603604## Базовый API605606Функции [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod) и [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile) предоставляют простой интерфейс к doctest, которого должно быть достаточно для большинства простых случаев использования. Для менее формального введения в эти две функции см. разделы [Простое использование: проверка примеров в строке документации](https://python-all.ru/3.8/library/doctest.html#doctest-simple-testmod) и [Простое использование: проверка примеров в текстовом файле](https://python-all.ru/3.8/library/doctest.html#doctest-simple-testfile).607608#### `doctest.testfile(filename, module_relative=True, name=None, package=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, parser=DocTestParser(), encoding=None)`609610Все аргументы, кроме *filename*, являются необязательными и должны указываться в форме ключевых слов.611612Проверяет примеры в файле с именем *filename*. Возвращает `(failure_count, test_count)`.613614Необязательный аргумент *module\_relative* определяет, как следует интерпретировать имя файла:615616- Если *module\_relative* равно `True` (значение по умолчанию), то *filename* задаёт независимый от ОС путь относительно модуля. По умолчанию этот путь указывается относительно каталога вызывающего модуля; но если указан аргумент *package*, то путь задаётся относительно этого пакета. Чтобы обеспечить независимость от ОС, *filename* должен использовать символы `/` для разделения сегментов пути и не должен быть абсолютным (т.е. не может начинаться с `/`).617- Если *module\_relative* равно `False`, то *filename* задаёт путь, зависящий от ОС. Путь может быть абсолютным или относительным; относительные пути разрешаются относительно текущего рабочего каталога.618619Необязательный аргумент *name* задаёт имя теста; по умолчанию, или если `None`, используется `os.path.basename(filename)`.620621Необязательный аргумент *package* – это пакет Python или имя пакета Python, каталог которого должен использоваться в качестве базового для имени файла относительно модуля. Если пакет не указан, то в качестве базового каталога для имён файлов относительно модуля используется каталог вызывающего модуля. Указывать *package*, если *module\_relative* равно `False`, является ошибкой.622623Необязательный аргумент *globs* задаёт словарь, который будет использоваться как пространство глобальных имён при выполнении примеров. Для doctest создаётся новая поверхностная копия этого словаря, чтобы примеры начинали с чистого листа. По умолчанию, или если `None`, используется новый пустой словарь.624625Необязательный аргумент *extraglobs* задаёт словарь, который сливается с глобальными переменными, используемыми для выполнения примеров. Это работает как [`dict.update()`](https://python-all.ru/3.8/library/stdtypes.html#dict.update): если *globs* и *extraglobs* имеют общий ключ, то в объединённом словаре отображается значение из *extraglobs*. По умолчанию, или если `None`, дополнительные глобальные переменные не используются. Это расширенная возможность, позволяющая параметризовать доктесты. Например, доктест можно написать для базового класса, используя обобщённое имя класса, а затем повторно использовать для тестирования любого количества подклассов, передавая словарь *extraglobs*, отображающий обобщённое имя на тестируемый подкласс.626627Необязательный аргумент *verbose*: если истина, выводит много информации, если ложь – только ошибки; по умолчанию, или если `None`, он истинен тогда и только тогда, когда `'-v'` присутствует в `sys.argv`.628629Необязательный аргумент *report*: если истина, выводит сводку в конце, иначе ничего не выводит. В подробном режиме сводка подробная, в противном случае – очень краткая (фактически пустая, если все тесты пройдены).630631Необязательный аргумент *optionflags* (значение по умолчанию 0) принимает [побитовое ИЛИ](https://python-all.ru/3.8/reference/expressions.html#bitwise) флагов опций. См. раздел [Флаги опций](https://python-all.ru/3.8/library/doctest.html#doctest-options).632633Необязательный аргумент *raise\_on\_error* по умолчанию равен false. Если true, при первой ошибке или неожиданном исключении в примере выбрасывается исключение. Это позволяет выполнять посмертную отладку ошибок. Поведение по умолчанию – продолжать выполнение примеров.634635Необязательный аргумент *parser* задаёт объект [`DocTestParser`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestParser) (или его подкласс), который следует использовать для извлечения тестов из файлов. По умолчанию используется обычный анализатор (т.е. `DocTestParser()`).636637Необязательный аргумент *encoding* задаёт кодировку, которая должна использоваться для преобразования файла в Unicode.638639#### `doctest.testmod(m=None, name=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, exclude_empty=False)`640641Все аргументы необязательны, и все, кроме *m*, должны передаваться как именованные.642643Тестирует примеры в строках документации функций и классов, доступных из модуля *m* (или модуля [`__main__`](https://python-all.ru/3.8/library/__main__.html#module-__main__), если *m* не указан или равен `None`), начиная с `m.__doc__`.644645Также проверяет примеры, доступные из словаря `m.__test__`, если он существует и не равен `None`. `m.__test__` сопоставляет имена (строки) с функциями, классами и строками; докстринги функций и классов ищутся на наличие примеров; строки ищутся напрямую, как если бы они были докстрингами.646647Проверяются только строки документации, прикреплённые к объектам, принадлежащим модулю *m*.648649Вернуть `(failure_count, test_count)`.650651Необязательный аргумент *name* задаёт имя модуля; по умолчанию, или если `None`, используется `m.__name__`.652653Необязательный аргумент *exclude\_empty* по умолчанию равен false. Если true, объекты, для которых не найдено ни одного доктеста, исключаются из рассмотрения. Значение по умолчанию – это хак для обратной совместимости, чтобы код, всё ещё использующий `doctest.master.summarize()` в сочетании с [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod), продолжал получать вывод для объектов без тестов. Аргумент *exclude\_empty* у более нового конструктора [`DocTestFinder`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestFinder) по умолчанию равен true.654655Необязательные аргументы *extraglobs*, *verbose*, *report*, *optionflags*, *raise\_on\_error* и *globs* такие же, как у функции [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile) выше, за исключением того, что *globs* по умолчанию равен `m.__dict__`.656657#### `doctest.run_docstring_examples(f, globs, verbose=False, name=\"NoName\", compileflags=None, optionflags=0)`658659Тестирует примеры, связанные с объектом *f*; например, *f* может быть строкой, модулем, функцией или объектом класса.660661Для контекста выполнения используется поверхностная копия словаря *globs*.662663Необязательный аргумент *name* используется в сообщениях об ошибках и по умолчанию равен `"NoName"`.664665Если необязательный аргумент *verbose* равен true, вывод создаётся, даже если нет ошибок. По умолчанию вывод создаётся только в случае ошибки в примере.666667Необязательный аргумент *compileflags* задаёт набор флагов, которые должны использоваться компилятором Python при запуске примеров. По умолчанию или если `None`, флаги выводятся из набора будущих возможностей, найденных в *globs*.668669Необязательный аргумент *optionflags* работает так же, как у функции [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile) выше.670671## API модуля unittest672673По мере роста вашей коллекции модулей с доктестами вам понадобится способ систематически запускать все их доктесты. [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) предоставляет две функции, которые можно использовать для создания [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest) наборов тестов из модулей и текстовых файлов, содержащих доктесты. Для интеграции с [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest) обнаружением тестов включите функцию `load_tests()` в свой тестовый модуль:674675```python676import unittest677import doctest678import my_module_with_doctests679680def load_tests(loader, tests, ignore):681    tests.addTests(doctest.DocTestSuite(my_module_with_doctests))682    return tests683```684685Существует две основные функции для создания экземпляров [`unittest.TestSuite`](https://python-all.ru/3.8/library/unittest.html#unittest.TestSuite) из текстовых файлов и модулей с доктестами:686687#### `doctest.DocFileSuite(*paths, module_relative=True, package=None, setUp=None, tearDown=None, globs=None, optionflags=0, parser=DocTestParser(), encoding=None)`688689Преобразует доктесты из одного или нескольких текстовых файлов в [`unittest.TestSuite`](https://python-all.ru/3.8/library/unittest.html#unittest.TestSuite).690691Возвращаемый [`unittest.TestSuite`](https://python-all.ru/3.8/library/unittest.html#unittest.TestSuite) предназначен для запуска через unittest framework и выполняет интерактивные примеры из каждого файла. Если пример в любом файле завершается неудачей, то созданный модульный тест также завершается неудачей, и вызывается исключение `failureException`, которое показывает имя файла с тестом и (иногда приблизительный) номер строки.692693Передаётся один или несколько путей (в виде строк) к текстовым файлам для проверки.694695Параметры могут быть указаны в виде именованных аргументов:696697Необязательный аргумент *module\_relative* определяет, как должны интерпретироваться имена файлов в *paths*:698699- Если *module\_relative* равен `True` (по умолчанию), то каждое имя файла в *paths* задаёт независимый от ОС путь относительно модуля. По умолчанию этот путь относителен каталога вызывающего модуля; но если указан аргумент *package*, то он относителен этого пакета. Для обеспечения независимости от ОС каждое имя файла должно использовать символы `/` для разделения сегментов пути и не может быть абсолютным путём (т.е. не должно начинаться с `/`).700- Если *module\_relative* равен `False`, то каждое имя файла в *paths* задаёт путь, зависящий от ОС. Путь может быть абсолютным или относительным; относительные пути разрешаются относительно текущего рабочего каталога.701702Необязательный аргумент *package* – это пакет Python или имя пакета Python, каталог которого должен использоваться в качестве базового каталога для имён файлов, относительных модуля, в *paths*. Если пакет не указан, то в качестве базового каталога для относительных имён файлов используется каталог вызывающего модуля. Указывать *package*, если *module\_relative* равен `False`, является ошибкой.703704Необязательный аргумент *setUp* задаёт функцию настройки для набора тестов. Она вызывается перед выполнением тестов в каждом файле. Функция *setUp* получает объект [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest). Функция setUp может обращаться к глобальным переменным теста через атрибут *globs* переданного теста.705706Необязательный аргумент *tearDown* задаёт функцию завершения для набора тестов. Она вызывается после выполнения тестов в каждом файле. Функция *tearDown* получает объект [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest). Функция setUp может обращаться к глобальным переменным теста через атрибут *globs* переданного теста.707708Необязательный аргумент *globs* – это словарь, содержащий начальные глобальные переменные для тестов. Для каждого теста создаётся новая копия этого словаря. По умолчанию *globs* – новый пустой словарь.709710Необязательный аргумент *optionflags* задаёт параметры доктеста по умолчанию для тестов, создаваемые путём объединения отдельных флагов параметров (OR). См. раздел [Option Flags](https://python-all.ru/3.8/library/doctest.html#doctest-options). Функцию [`set_unittest_reportflags()`](https://python-all.ru/3.8/library/doctest.html#doctest.set_unittest_reportflags) см. ниже для лучшего способа установки параметров отчёта.711712Необязательный аргумент *parser* задаёт [`DocTestParser`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestParser) (или подкласс), который должен использоваться для извлечения тестов из файлов. По умолчанию используется обычный парсер (т.е. `DocTestParser()`).713714Необязательный аргумент *encoding* задаёт кодировку, которая должна использоваться для преобразования файла в Unicode.715716Глобальная переменная `__file__` добавляется к глобальным переменным, предоставляемым доктестам, загруженным из текстового файла с помощью [`DocFileSuite()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocFileSuite).717718#### `doctest.DocTestSuite(module=None, globs=None, extraglobs=None, test_finder=None, setUp=None, tearDown=None, checker=None)`719720Преобразует доктесты для модуля в [`unittest.TestSuite`](https://python-all.ru/3.8/library/unittest.html#unittest.TestSuite).721722Возвращаемый [`unittest.TestSuite`](https://python-all.ru/3.8/library/unittest.html#unittest.TestSuite) предназначен для запуска через unittest framework и выполняет каждый doctest в модуле. Если какой-либо из doctest'ов завершается неудачей, то созданный модульный тест завершается неудачей, и вызывается исключение `failureException`, которое показывает имя файла с тестом и (иногда приблизительный) номер строки.723724Необязательный аргумент *module* задаёт тестируемый модуль. Это может быть объект модуля или (возможно, с точками) имя модуля. Если он не указан, используется модуль, из которого вызывается эта функция.725726Необязательный аргумент *globs* – это словарь, содержащий начальные глобальные переменные для тестов. Для каждого теста создаётся новая копия этого словаря. По умолчанию *globs* – новый пустой словарь.727728Необязательный аргумент *extraglobs* задаёт дополнительный набор глобальных переменных, который объединяется с *globs*. По умолчанию дополнительные глобальные переменные не используются.729730Необязательный аргумент *test\_finder* – это объект [`DocTestFinder`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestFinder) (или его замена, совместимая по интерфейсу), который используется для извлечения доктестов из модуля.731732Необязательные аргументы *setUp*, *tearDown* и *optionflags* такие же, как для функции [`DocFileSuite()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocFileSuite) выше.733734Эта функция использует тот же метод поиска, что и [`testmod()`](https://python-all.ru/3.8/library/doctest.html#doctest.testmod).735736Изменено в версии 3.5: [`DocTestSuite()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestSuite) возвращает пустой [`unittest.TestSuite`](https://python-all.ru/3.8/library/unittest.html#unittest.TestSuite), если *module* не содержит строк документации, вместо возбуждения [`ValueError`](https://python-all.ru/3.8/library/exceptions.html#ValueError).737738Под капотом [`DocTestSuite()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestSuite) создаёт [`unittest.TestSuite`](https://python-all.ru/3.8/library/unittest.html#unittest.TestSuite) из экземпляров `doctest.DocTestCase`, а `DocTestCase` является подклассом [`unittest.TestCase`](https://python-all.ru/3.8/library/unittest.html#unittest.TestCase). `DocTestCase` здесь не документирован (это внутренняя деталь), но изучение его кода может ответить на вопросы о точных деталях интеграции [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest).739740Аналогично, [`DocFileSuite()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocFileSuite) создаёт [`unittest.TestSuite`](https://python-all.ru/3.8/library/unittest.html#unittest.TestSuite) из экземпляров `doctest.DocFileCase`, а `DocFileCase` является подклассом `DocTestCase`.741742Таким образом, оба способа создания [`unittest.TestSuite`](https://python-all.ru/3.8/library/unittest.html#unittest.TestSuite) запускают экземпляры `DocTestCase`. Это важно по тонкой причине: при непосредственном запуске функций [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) можно напрямую управлять используемыми параметрами [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest), передавая флаги опций функциям [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest). Однако при написании фреймворка [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest) именно [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest) в конечном счёте управляет тем, когда и как выполняются тесты. Автор фреймворка обычно хочет управлять параметрами отчётности [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) (возможно, заданными через параметры командной строки), но нет способа передать параметры через [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest) в средства запуска тестов [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest).743744По этой причине [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) также поддерживает понятие флагов отчётности [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest), специфичных для поддержки [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest), с помощью этой функции:745746#### `doctest.set_unittest_reportflags(flags)`747748Устанавливает используемые флаги отчётности [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest).749750Аргумент *flags* принимает [побитовое ИЛИ](https://python-all.ru/3.8/reference/expressions.html#bitwise) флагов опций. См. раздел [Флаги опций](https://python-all.ru/3.8/library/doctest.html#doctest-options). Можно использовать только «флаги отчётности».751752Это глобальная настройка модуля, которая влияет на все будущие доктесты, запускаемые модулем [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest): метод `runTest()` объекта `DocTestCase` проверяет флаги опций, указанные для тестового случая при создании экземпляра `DocTestCase`. Если флаги отчётности не были указаны (что является типичным и ожидаемым случаем), флаги отчётности [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest) объекта [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) [побитово объединяются с помощью ИЛИ](https://python-all.ru/3.8/reference/expressions.html#bitwise) с флагами опций, и расширенные таким образом флаги опций передаются экземпляру [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner), созданному для запуска доктеста. Если какие-либо флаги отчётности были указаны при создании экземпляра `DocTestCase`, флаги отчётности [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest) объекта [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) игнорируются.753754Функция возвращает значение флагов отчётности [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest), действовавших до её вызова.755756## Расширенный API757758Базовый API – это простая обёртка, предназначенная для упрощения использования doctest. Он достаточно гибок и должен удовлетворять потребности большинства пользователей; однако, если требуется более детальный контроль над тестированием или расширение возможностей doctest, следует использовать расширенный API.759760Расширенный API строится вокруг двух классов-контейнеров, которые используются для хранения интерактивных примеров, извлечённых из тестовых сценариев doctest:761762- [`Example`](https://python-all.ru/3.8/library/doctest.html#doctest.Example): Одна инструкция ([statement](https://python-all.ru/3.8/glossary.html#term-statement)) Python в паре с ожидаемым выводом.763- [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest): Набор объектов [`Example`](https://python-all.ru/3.8/library/doctest.html#doctest.Example), обычно извлечённых из одной строки документации или текстового файла.764765Для поиска, разбора, выполнения и проверки примеров doctest определены дополнительные классы обработки:766767- [`DocTestFinder`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestFinder): Находит все строки документации в заданном модуле и использует [`DocTestParser`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestParser) для создания [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest) из каждой строки документации, содержащей интерактивные примеры.768- [`DocTestParser`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestParser): Создаёт объект [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest) из строки (например, из строки документации объекта).769- [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner): Выполняет примеры в [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest) и использует [`OutputChecker`](https://python-all.ru/3.8/library/doctest.html#doctest.OutputChecker) для проверки их вывода.770- [`OutputChecker`](https://python-all.ru/3.8/library/doctest.html#doctest.OutputChecker): Сравнивает фактический вывод примера doctest с ожидаемым выводом и определяет, совпадают ли они.771772Взаимосвязи между этими классами обработки показаны на следующей диаграмме.773774```python775                            list of:776+------+                   +---------+777|module| --DocTestFinder-> | DocTest | --DocTestRunner-> results778+------+    |        ^     +---------+     |       ^    (printed)779            |        |     | Example |     |       |780            v        |     |   ...   |     v       |781           DocTestParser   | Example |   OutputChecker782                           +---------+783```784785### Объекты DocTest786787#### `class doctest.DocTest(examples, globs, name, filename, lineno, docstring)`788789Набор примеров doctest, которые должны выполняться в одном пространстве имён. Аргументы конструктора инициализируют одноимённые атрибуты.790791[`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest) определяет следующие атрибуты. Они инициализируются конструктором и не должны изменяться напрямую.792793#### `examples`794795Список объектов [`Example`](https://python-all.ru/3.8/library/doctest.html#doctest.Example), представляющих отдельные интерактивные примеры Python, которые должны быть выполнены этим тестом.796797#### `globs`798799Пространство имён (также известное как globals), в котором должны выполняться примеры. Это словарь, отображающий имена в значения. Любые изменения пространства имён, сделанные примерами (например, связывание новых переменных), будут отражены в [`globs`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest.globs) после выполнения теста.800801#### `name`802803Строковое имя, идентифицирующее [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest). Обычно это имя объекта или файла, из которого был извлечён тест.804805#### `filename`806807Имя файла, из которого был извлечён этот [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest); или `None`, если имя файла неизвестно, или [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest) не был извлечён из файла.808809#### `lineno`810811Номер строки внутри [`filename`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest.filename), с которой начинается данный [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest), или `None`, если номер строки недоступен. Этот номер строки отсчитывается от нуля относительно начала файла.812813#### `docstring`814815Строка, из которой был извлечён тест, или `None`, если строка недоступна, или если тест не был извлечён из строки.816817### Объекты Example818819#### `class doctest.Example(source, want, exc_msg=None, lineno=0, indent=0, options=None)`820821Один интерактивный пример, состоящий из оператора Python и ожидаемого вывода. Аргументы конструктора инициализируют одноимённые атрибуты.822823[`Example`](https://python-all.ru/3.8/library/doctest.html#doctest.Example) определяет следующие атрибуты. Они инициализируются конструктором и не должны изменяться напрямую.824825#### `source`826827Строка, содержащая исходный код примера. Этот исходный код состоит из одного оператора Python и всегда заканчивается символом новой строки; конструктор добавляет символ новой строки при необходимости.828829#### `want`830831Ожидаемый результат выполнения исходного кода примера (либо из stdout, либо трассировка в случае исключения). [`want`](https://python-all.ru/3.8/library/doctest.html#doctest.Example.want) заканчивается символом новой строки, если только результат не ожидается; в этом случае это пустая строка. Конструктор добавляет символ новой строки при необходимости.832833#### `exc_msg`834835Сообщение об исключении, сгенерированное примером, если ожидается, что пример вызовет исключение; или `None`, если исключение не ожидается. Это сообщение об исключении сравнивается с возвращаемым значением [`traceback.format_exception_only()`](https://python-all.ru/3.8/library/traceback.html#traceback.format_exception_only). [`exc_msg`](https://python-all.ru/3.8/library/doctest.html#doctest.Example.exc_msg) заканчивается символом новой строки, если только оно не равно `None`. Конструктор добавляет символ новой строки при необходимости.836837#### `lineno`838839Номер строки внутри строки, содержащей этот пример, с которой начинается пример. Этот номер строки отсчитывается от нуля относительно начала содержащей строки.840841#### `indent`842843Отступ примера в содержащей строке, т.е. количество пробелов перед первым приглашением примера.844845#### `options`846847Словарь, отображающий флаги опций в `True` или `False`, который используется для переопределения опций по умолчанию для этого примера. Любые флаги опций, не содержащиеся в этом словаре, остаются в своем значении по умолчанию (как указано в [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner).`optionflags`). По умолчанию никакие опции не установлены.848849### Объекты DocTestFinder850851#### `class doctest.DocTestFinder(verbose=False, parser=DocTestParser(), recurse=True, exclude_empty=True)`852853Класс обработки, используемый для извлечения [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest), имеющих отношение к заданному объекту, из его строки документации и строк документации содержащихся в нём объектов. [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest) можно извлекать из модулей, классов, функций, методов, статических методов, методов класса и свойств.854855Необязательный аргумент *verbose* используется для отображения объектов, которые ищет поисковик. По умолчанию он равен `False` (вывод отсутствует).856857Необязательный аргумент *parser* задаёт объект [`DocTestParser`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestParser) (или его замену), который используется для извлечения доктестов из строк документации.858859Если необязательный аргумент *recurse* равен false, то [`DocTestFinder.find()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestFinder.find) будет проверять только указанный объект, но не содержащиеся в нём объекты.860861Если необязательный аргумент *exclude\_empty* равен false, то [`DocTestFinder.find()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestFinder.find) будет включать тесты для объектов с пустыми строками документации.862863[`DocTestFinder`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestFinder) определяет следующий метод:864865#### `find(obj[, name][, module][, globs][, extraglobs])`866867Возвращает список [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest), определённых строкой документации *obj* или строками документации любых содержащихся в нём объектов.868869Необязательный аргумент *name* задаёт имя объекта; это имя будет использоваться для формирования имён возвращаемых [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest). Если *name* не указан, то используется `obj.__name__`.870871Необязательный параметр *module* – это модуль, содержащий указанный объект. Если модуль не указан или равен `None`, то поисковик тестов попытается автоматически определить правильный модуль. Модуль объекта используется:872873- В качестве пространства имён по умолчанию, если *globs* не указан.874- Чтобы предотвратить извлечение DocTests объектом DocTestFinder из объектов, импортированных из других модулей. (Содержащиеся объекты, чей модуль отличается от *module*, игнорируются.)875- Для поиска имени файла, содержащего объект.876- Для помощи в определении номера строки объекта в его файле.877878Если *module* равен `False`, попытка найти модуль не предпринимается. Это необычная возможность, используемая в основном при тестировании самого doctest: если *module* равен `False` или `None`, но не может быть найден автоматически, то все объекты считаются принадлежащими (несуществующему) модулю, поэтому все содержащиеся объекты будут (рекурсивно) проверяться на наличие доктестов.879880Глобальные переменные для каждого [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest) формируются объединением *globs* и *extraglobs* (привязки в *extraglobs* переопределяют привязки в *globs*). Создаётся новая поверхностная копия словаря глобальных переменных для каждого [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest). Если *globs* не указано, то по умолчанию используется *\_\_dict\_\_* модуля, если он указан, или `{}` в противном случае. Если *extraglobs* не указано, то по умолчанию используется `{}`.881882### Объекты DocTestParser883884#### `class doctest.DocTestParser`885886Класс обработки, используемый для извлечения интерактивных примеров из строки и создания из них объекта [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest).887888[`DocTestParser`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestParser) определяет следующие методы:889890#### `get_doctest(string, globs, name, filename, lineno)`891892Извлекает все примеры доктестов из заданной строки и собирает их в объект [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest).893894*globs*, *name*, *filename* и *lineno* – это атрибуты нового объекта [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest). Дополнительную информацию см. в документации [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest).895896#### `get_examples(string, name='<string>')`897898Извлекает все примеры доктестов из заданной строки и возвращает их в виде списка объектов [`Example`](https://python-all.ru/3.8/library/doctest.html#doctest.Example). Номера строк начинаются с 0. Необязательный аргумент *name* – это имя, идентифицирующее данную строку; используется только для сообщений об ошибках.899900#### `parse(string, name='<string>')`901902Разделяет заданную строку на примеры и промежуточный текст и возвращает их в виде списка, чередующего [`Example`](https://python-all.ru/3.8/library/doctest.html#doctest.Example) и строки. Номера строк для [`Example`](https://python-all.ru/3.8/library/doctest.html#doctest.Example) начинаются с 0. Необязательный аргумент *name* – это имя, идентифицирующее данную строку; используется только для сообщений об ошибках.903904### Объекты DocTestRunner905906#### `class doctest.DocTestRunner(checker=None, verbose=None, optionflags=0)`907908Класс обработки, используемый для выполнения и проверки интерактивных примеров в [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest).909910Сравнение ожидаемых и фактических выходных данных выполняется с помощью [`OutputChecker`](https://python-all.ru/3.8/library/doctest.html#doctest.OutputChecker). Это сравнение можно настроить с помощью ряда флагов опций; подробнее см. раздел [Флаги опций](https://python-all.ru/3.8/library/doctest.html#doctest-options). Если флагов опций недостаточно, сравнение можно также настроить, передав подкласс [`OutputChecker`](https://python-all.ru/3.8/library/doctest.html#doctest.OutputChecker) в конструктор.911912Выводом тестового исполнителя можно управлять двумя способами. Во-первых, можно передать функцию вывода в `TestRunner.run()`; эта функция будет вызываться со строками, которые нужно отобразить. По умолчанию используется `sys.stdout.write`. Если захвата вывода недостаточно, то вывод также можно настроить, создав подкласс DocTestRunner и переопределив методы [`report_start()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner.report_start), [`report_success()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner.report_success), [`report_unexpected_exception()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner.report_unexpected_exception) и [`report_failure()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner.report_failure).913914Необязательный именованный аргумент *checker* задаёт [`OutputChecker`](https://python-all.ru/3.8/library/doctest.html#doctest.OutputChecker) объект (или замену без изменений), который следует использовать для сравнения ожидаемых выходных данных с фактическими результатами выполнения примеров doctest.915916Необязательный именованный аргумент *verbose* управляет подробностью [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner). Если *verbose* равен `True`, то выводится информация о каждом примере по мере его выполнения. Если *verbose* равен `False`, то выводятся только сбои. Если *verbose* не указан или равен `None`, то подробный вывод используется, только если указан ключ командной строки `-v`.917918Необязательный именованный аргумент *optionflags* позволяет управлять тем, как исполнитель тестов сравнивает ожидаемый вывод с фактическим и как отображает ошибки. Дополнительную информацию см. в разделе [Флаги опций](https://python-all.ru/3.8/library/doctest.html#doctest-options).919920[`DocTestParser`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestParser) определяет следующие методы:921922#### `report_start(out, test, example)`923924Сообщает, что исполнитель тестов собирается обработать указанный пример. Этот метод предоставляется, чтобы позволить подклассам [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner) настраивать свой вывод; его не следует вызывать напрямую.925926*example* – это пример, который будет обработан. *test* – это тест, *содержащий пример*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner.run).927928#### `report_success(out, test, example, got)`929930Сообщает, что указанный пример выполнен успешно. Этот метод предоставляется, чтобы позволить подклассам [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner) настраивать свой вывод; его не следует вызывать напрямую.931932*example* – это пример, который будет обработан. *got* – это фактический вывод из примера. *test* – это тест, содержащий *example*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner.run).933934#### `report_failure(out, test, example, got)`935936Сообщает, что указанный пример провален. Этот метод предоставляется, чтобы позволить подклассам [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner) настраивать свой вывод; его не следует вызывать напрямую.937938*example* – это пример, который будет обработан. *got* – это фактический вывод из примера. *test* – это тест, содержащий *example*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner.run).939940#### `report_unexpected_exception(out, test, example, exc_info)`941942Сообщает, что указанный пример вызвал неожиданное исключение. Этот метод предоставляется, чтобы позволить подклассам [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner) настраивать свой вывод; его не следует вызывать напрямую.943944*example* – это пример, который будет обработан. *exc\_info* – это кортеж, содержащий информацию о неожиданном исключении (возвращаемый функцией [`sys.exc_info()`](https://python-all.ru/3.8/library/sys.html#sys.exc_info)). *test* – это тест, содержащий *example*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner.run).945946#### `run(test, compileflags=None, out=None, clear_globs=True)`947948Выполняет примеры в *test* (объект [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest)) и отображает результаты с помощью функции вывода *out*.949950Примеры выполняются в пространстве имён `test.globs`. Если *clear\_globs* имеет значение true (по умолчанию), то это пространство имён будет очищено после выполнения теста для сборки мусора. Если требуется изучить пространство имён после завершения теста, используйте *clear\_globs=False*.951952*compileflags* задаёт набор флагов, которые должен использовать компилятор Python при выполнении примеров. Если не указан, по умолчанию используется набор флагов future-import, действующих для *globs*.953954Вывод каждого примера проверяется с помощью средства проверки вывода [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner), а результаты форматируются методами `DocTestRunner.report_*()`.955956#### `summarize(verbose=None)`957958Выводит сводку всех тестовых случаев, выполненных этим DocTestRunner, и возвращает [именованный кортеж](https://python-all.ru/3.8/glossary.html#term-named-tuple) `TestResults(failed, attempted)`.959960Необязательный аргумент *verbose* управляет степенью детализации сводки. Если степень детализации не указана, то используется [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner).961962### Объекты OutputChecker963964#### `class doctest.OutputChecker`965966Класс, используемый для проверки, совпадает ли фактический вывод примера doctest с ожидаемым выводом. [`OutputChecker`](https://python-all.ru/3.8/library/doctest.html#doctest.OutputChecker) определяет два метода: [`check_output()`](https://python-all.ru/3.8/library/doctest.html#doctest.OutputChecker.check_output), который сравнивает заданную пару выводов и возвращает `True`, если они совпадают; и [`output_difference()`](https://python-all.ru/3.8/library/doctest.html#doctest.OutputChecker.output_difference), который возвращает строку с описанием различий между двумя выводами.967968[`OutputChecker`](https://python-all.ru/3.8/library/doctest.html#doctest.OutputChecker) определяет следующие методы:969970#### `check_output(want, got, optionflags)`971972Возвращает `True`, если фактический вывод примера (*got*) совпадает с ожидаемым выводом (*want*). Эти строки всегда считаются совпадающими, если они идентичны; но в зависимости от того, какие флаги опций использует test runner, возможны и несколько нестрогих типов совпадений. См. раздел [Option Flags](https://python-all.ru/3.8/library/doctest.html#doctest-options) для получения дополнительной информации о флагах опций.973974#### `output_difference(example, got, optionflags)`975976Возвращает строку с описанием различий между ожидаемым выводом для заданного примера (*example*) и фактическим выводом (*got*). *optionflags* – это набор флагов опций, используемых для сравнения *want* и *got*.977978## Отладка979980Doctest предоставляет несколько механизмов для отладки примеров doctest:981982- Некоторые функции преобразуют doctest в исполняемые программы Python, которые можно запускать под отладчиком Python, [`pdb`](https://python-all.ru/3.8/library/pdb.html#module-pdb).983- Класс [`DebugRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DebugRunner) является подклассом [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner), который вызывает исключение для первого неудачного примера, содержащее информацию об этом примере. Эту информацию можно использовать для посмертной отладки примера.984- Случаи [`unittest`](https://python-all.ru/3.8/library/unittest.html#module-unittest), сгенерированные [`DocTestSuite()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestSuite), поддерживают метод [`debug()`](https://python-all.ru/3.8/library/doctest.html#doctest.debug), определённый [`unittest.TestCase`](https://python-all.ru/3.8/library/unittest.html#unittest.TestCase).985- Можно добавить вызов [`pdb.set_trace()`](https://python-all.ru/3.8/library/pdb.html#pdb.set_trace) в пример doctest, и при выполнении этой строки произойдёт вход в отладчик Python. Затем можно проверять текущие значения переменных и т.д. Например, предположим, что `a.py` содержит только эту строку документации модуля:986987  ```python988  """989  >>> def f(x):990  ...     g(x*2)991  >>> def g(x):992  ...     print(x+3)993  ...     import pdb; pdb.set_trace()994  >>> f(3)995  9996  """997  ```998999  Тогда интерактивный сеанс Python может выглядеть так:10001001  ```python1002  >>> import a, doctest1003  >>> doctest.testmod(a)1004  --Return--1005  > <doctest a[1]>(3)g()->None1006  -> import pdb; pdb.set_trace()1007  (Pdb) list1008    1     def g(x):1009    2         print(x+3)1010    3  ->     import pdb; pdb.set_trace()1011  [EOF]1012  (Pdb) p x1013  61014  (Pdb) step1015  --Return--1016  > <doctest a[0]>(2)f()->None1017  -> g(x*2)1018  (Pdb) list1019    1     def f(x):1020    2  ->     g(x*2)1021  [EOF]1022  (Pdb) p x1023  31024  (Pdb) step1025  --Return--1026  > <doctest a[2]>(1)?()->None1027  -> f(3)1028  (Pdb) cont1029  (0, 3)1030  >>>1031  ```10321033Функции, которые преобразуют doctest в код Python и, возможно, запускают полученный код под отладчиком:10341035#### `doctest.script_from_examples(s)`10361037Преобразует текст с примерами в скрипт.10381039Аргумент *s* – это строка, содержащая примеры doctest. Строка преобразуется в скрипт Python, где примеры doctest из *s* преобразуются в обычный код, а всё остальное – в комментарии Python. Сгенерированный скрипт возвращается в виде строки. Например,10401041```python1042import doctest1043print(doctest.script_from_examples(r"""1044    Set x and y to 1 and 2.1045    >>> x, y = 1, 210461047    Print their sum:1048    >>> print(x+y)1049    31050"""))1051```10521053выводит:10541055```python1056# Установите x и y в 1 и 2.1057x, y = 1, 21058#1059# Выведите их сумму:1060print(x+y)1061# Ожидаемый результат:1062## 31063```10641065Эта функция используется внутренне другими функциями (см. ниже), но также может быть полезна, когда требуется преобразовать интерактивный сеанс Python в скрипт Python.10661067#### `doctest.testsource(module, name)`10681069Преобразует доктест объекта в скрипт.10701071Аргумент *module* – это объект модуля или точечное имя модуля, содержащего объект, чьи доктесты интересуют. Аргумент *name* – это имя (внутри модуля) объекта с интересующими доктестами. Результат – строка, содержащая строку документации объекта, преобразованная в скрипт Python, как описано для [`script_from_examples()`](https://python-all.ru/3.8/library/doctest.html#doctest.script_from_examples) выше. Например, если модуль `a.py` содержит функцию верхнего уровня `f()`, то10721073```python1074import a, doctest1075print(doctest.testsource(a, "a.f"))1076```10771078выводит скриптовую версию строки документации функции `f()`, при этом доктесты преобразуются в код, а остальное помещается в комментарии.10791080#### `doctest.debug(module, name, pm=False)`10811082Отладка доктестов для объекта.10831084Аргументы *module* и *name* такие же, как и для функции [`testsource()`](https://python-all.ru/3.8/library/doctest.html#doctest.testsource) выше. Синтезированный скрипт Python из строки документации указанного объекта записывается во временный файл, а затем этот файл выполняется под управлением отладчика Python, [`pdb`](https://python-all.ru/3.8/library/pdb.html#module-pdb).10851086Для локального и глобального контекста выполнения используется поверхностная копия `module.__dict__`.10871088Необязательный аргумент *pm* определяет, используется ли посмертная отладка. Если *pm* имеет истинное значение, файл скрипта выполняется напрямую, и отладчик подключается только в случае завершения скрипта из-за необработанного исключения. Если это происходит, то вызывается посмертная отладка через [`pdb.post_mortem()`](https://python-all.ru/3.8/library/pdb.html#pdb.post_mortem) с передачей объекта traceback из необработанного исключения. Если *pm* не указан или равен false, скрипт выполняется под отладчиком с самого начала, путем передачи соответствующего вызова [`exec()`](https://python-all.ru/3.8/library/functions.html#exec) в [`pdb.run()`](https://python-all.ru/3.8/library/pdb.html#pdb.run).10891090#### `doctest.debug_src(src, pm=False, globs=None)`10911092Отладка доктестов в строке.10931094Эта функция похожа на функцию [`debug()`](https://python-all.ru/3.8/library/doctest.html#doctest.debug) выше, за исключением того, что строка, содержащая примеры доктестов, задается напрямую через аргумент *src*.10951096Необязательный аргумент *pm* имеет тот же смысл, что и в функции [`debug()`](https://python-all.ru/3.8/library/doctest.html#doctest.debug) выше.10971098Необязательный аргумент *globs* задает словарь, используемый как для локального, так и для глобального контекста выполнения. Если он не указан или равен `None`, используется пустой словарь. Если указан, используется поверхностная копия словаря.10991100Класс [`DebugRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DebugRunner) и специальные исключения, которые он может вызывать, представляют наибольший интерес для разработчиков тестовых фреймворков и будут лишь кратко описаны здесь. За подробностями обращайтесь к исходному коду и особенно к строке документации [`DebugRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DebugRunner) (которая сама является доктестом!).11011102#### `class doctest.DebugRunner(checker=None, verbose=None, optionflags=0)`11031104Подкласс [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner), который вызывает исключение сразу при обнаружении сбоя. Если происходит неожиданное исключение, вызывается исключение [`UnexpectedException`](https://python-all.ru/3.8/library/doctest.html#doctest.UnexpectedException), содержащее тест, пример и исходное исключение. Если вывод не совпадает, вызывается исключение [`DocTestFailure`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestFailure), содержащее тест, пример и фактический вывод.11051106Информацию о параметрах конструктора и методах см. в документации для [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner) в разделе [Advanced API](https://python-all.ru/3.8/library/doctest.html#doctest-advanced-api).11071108Экземпляры [`DebugRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DebugRunner) могут вызывать два исключения:11091110#### `exception doctest.DocTestFailure(test, example, got)`11111112Исключение, вызываемое [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner), чтобы указать, что фактический вывод примера доктеста не совпал с ожидаемым. Аргументы конструктора используются для инициализации одноименных атрибутов.11131114[`DocTestFailure`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestFailure) определяет следующие атрибуты:11151116#### `DocTestFailure.test`11171118Объект [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest), который выполнялся, когда пример завершился с ошибкой.11191120#### `DocTestFailure.example`11211122Неудавшийся [`Example`](https://python-all.ru/3.8/library/doctest.html#doctest.Example).11231124#### `DocTestFailure.got`11251126Фактический вывод примера.11271128#### `exception doctest.UnexpectedException(test, example, exc_info)`11291130Исключение, вызываемое [`DocTestRunner`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTestRunner), чтобы указать, что пример доктеста вызвал неожиданное исключение. Аргументы конструктора используются для инициализации одноименных атрибутов.11311132[`UnexpectedException`](https://python-all.ru/3.8/library/doctest.html#doctest.UnexpectedException) определяет следующие атрибуты:11331134#### `UnexpectedException.test`11351136Объект [`DocTest`](https://python-all.ru/3.8/library/doctest.html#doctest.DocTest), который выполнялся, когда пример завершился с ошибкой.11371138#### `UnexpectedException.example`11391140Неудавшийся [`Example`](https://python-all.ru/3.8/library/doctest.html#doctest.Example).11411142#### `UnexpectedException.exc_info`11431144Кортеж, содержащий информацию о неожиданном исключении, возвращаемый вызовом [`sys.exc_info()`](https://python-all.ru/3.8/library/sys.html#sys.exc_info).11451146## Трибуна11471148Как уже упоминалось во введении, у [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) появилось три основных назначения:114911501. Проверка примеров в docstrings.11512. Регрессионное тестирование.11523. Исполняемая документация / литературное тестирование.11531154Эти варианты использования предъявляют разные требования, и важно их различать. В частности, наполнение строк документации запутанными тестовыми примерами приводит к плохой документации.11551156При написании docstring'ов выбирайте примеры для них с осторожностью. Это целое искусство, которому нужно учиться, и поначалу оно может даваться нелегко. Примеры должны приносить реальную пользу документации. Хороший пример зачастую дорогого стоит. Если подойти к делу со всей тщательностью, примеры станут бесценными для пользователей и многократно окупят время, потраченное на их сбор, – годы спустя, когда всё меняется. Я до сих пор поражаюсь, как часто мои примеры [`doctest`](https://python-all.ru/3.8/library/doctest.html#module-doctest) перестают работать после «безобидных» изменений.11571158Doctest также отлично подходит для регрессионного тестирования, особенно если не жалеть пояснительного текста. Чередуя прозу и примеры, гораздо легче отслеживать, что именно тестируется и почему. Когда тест падает, хороший текст помогает быстрее понять, в чём проблема и как её исправить. Конечно, можно писать развёрнутые комментарии в коде тестов, но мало кто это делает. Многие заметили, что использование doctest вместо этого приводит к гораздо более понятным тестам. Возможно, просто потому, что в doctest писать прозу немного легче, чем код, а писать комментарии в коде – немного сложнее. Но я думаю, дело не только в этом: естественный подход при написании теста на основе doctest – это желание объяснить тонкости своего программного обеспечения и проиллюстрировать их примерами. Это, в свою очередь, естественным образом приводит к тестовым файлам, которые начинаются с самых простых функций и логически переходят к осложнениям и крайним случаям. В результате получается связное повествование, а не набор разрозненных функций, тестирующих отдельные фрагменты функциональности, казалось бы, случайным образом. Это другой подход, и он даёт другие результаты, стирая грань между тестированием и объяснением.11591160Регрессионное тестирование лучше всего проводить в отдельных объектах или файлах. Есть несколько вариантов организации тестов:11611162- Создайте текстовые файлы, содержащие тестовые примеры в виде интерактивных примеров, и тестируйте эти файлы с помощью [`testfile()`](https://python-all.ru/3.8/library/doctest.html#doctest.testfile) или [`DocFileSuite()`](https://python-all.ru/3.8/library/doctest.html#doctest.DocFileSuite). Этот подход рекомендуется, хотя его проще всего применить для новых проектов, изначально спроектированных с использованием doctest.1163- Определите функции с именем `_regrtest_topic`, которые состоят из одной строки документации, содержащей тестовые примеры для указанных тем. Эти функции можно включить в тот же файл, что и модуль, или вынести в отдельный тестовый файл.1164- Определите словарь `__test__`, отображающий темы регрессионных тестов на docstrings, содержащие тестовые примеры.11651166Если вы поместили тесты в модуль, сам модуль может быть тестовым раннером. Когда тест падает, можно настроить раннер на повторный запуск только упавшего doctest'а, пока вы отлаживаете проблему. Вот минимальный пример такого тестового раннера:11671168```python1169if __name__ == '__main__':1170    import doctest1171    flags = doctest.REPORT_NDIFF|doctest.FAIL_FAST1172    if len(sys.argv) > 1:1173        name = sys.argv[1]1174        if name in globals():1175            obj = globals()[name]1176        else:1177            obj = __test__[name]1178        doctest.run_docstring_examples(obj, globals(), name=name,1179                                       optionflags=flags)1180    else:1181        fail, total = doctest.testmod(optionflags=flags)1182        print("{} failures out of {} tests".format(fail, total))1183```11841185Сноски11861187**[1](https://python-all.ru/3.8/library/doctest.html#id1)**11881189Примеры, содержащие как ожидаемый вывод, так и исключение, не поддерживаются. Попытка угадать, где заканчивается одно и начинается другое, слишком чревата ошибками и приводит к запутанным тестам.1190