doctest.md

1> **Источник:** https://python-all.ru/3.13/library/doctest.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `doctest` – Тестирование интерактивных примеров Python89**Исходный код:** [Lib/doctest.py](https://python-all.ru/src/3.13/Lib/doctest.py)1011---1213Модуль `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` творит своё волшебство:7879```console80$ python example.py81$82```8384Нет вывода! Это нормально и означает, что все примеры сработали. Передайте скрипту `-v`, и `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 test in __main__112   6 tests in __main__.factorial1137 tests in 2 items.1147 passed.115Test passed.116$117```118119Это всё, что нужно знать, чтобы начать продуктивно использовать `doctest`! Погружайтесь. В следующих разделах приводятся полные подробности. Обратите внимание, что в стандартном наборе тестов и библиотеках Python есть много примеров doctest. Особенно полезные примеры можно найти в стандартном тестовом файле `Lib/test/test_doctest/test_doctest.py`.120121## Простое использование: проверка примеров в докстрингах122123Самый простой способ начать использовать doctest (но не обязательно тот, которым вы будете продолжать пользоваться) – это завершить каждый модуль `M` следующим образом:124125```python126if __name__ == "__main__":127    import doctest128    doctest.testmod()129```130131`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.13/library/doctest.html#doctest.testmod), или запретить его, передав `verbose=False`. В любом из этих случаев [`sys.argv`](https://python-all.ru/3.13/library/sys.html#sys.argv) не проверяется `testmod()` (поэтому передача `-v` или её отсутствие не имеет эффекта).150151Также есть сокращение командной строки для запуска [`testmod()`](https://python-all.ru/3.13/library/doctest.html#doctest.testmod); см. раздел [Использование командной строки](https://python-all.ru/3.13/library/doctest.html#doctest-cli).152153Для получения дополнительной информации о [`testmod()`](https://python-all.ru/3.13/library/doctest.html#doctest.testmod) см. раздел [Базовый API](https://python-all.ru/3.13/library/doctest.html#doctest-basic-api).154155## Простое использование: проверка примеров в текстовом файле156157Ещё одно простое применение doctest – тестирование интерактивных примеров в текстовом файле. Это можно сделать с помощью функции [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile):158159```python160import doctest161doctest.testfile("example.txt")162```163164Этот короткий скрипт выполняет и проверяет любые интерактивные примеры Python, содержащиеся в файле `example.txt`. Содержимое файла рассматривается как один гигантский докстринг; файл не обязан содержать программу на Python! Например, предположим, `example.txt` содержит следующее:165166```text167The ``example`` module168======================169170Using ``factorial``171-------------------172173This is an example text file in reStructuredText format.  First import174``factorial`` from the ``example`` module:175176    >>> from example import factorial177178Now use it:179180    >>> factorial(6)181    120182```183184Запуск `doctest.testfile("example.txt")` затем находит ошибку в этой документации:185186```python187File "./example.txt", line 14, in example.txt188Failed example:189    factorial(6)190Expected:191    120192Got:193    720194```195196Как и в случае с [`testmod()`](https://python-all.ru/3.13/library/doctest.html#doctest.testmod), [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile) не будет выводить ничего, пока какой-либо пример не завершится ошибкой. Если пример завершается ошибкой, то ошибочный пример(ы) и причина(ы) ошибки(ок) выводятся в stdout, в том же формате, что и `testmod()`.197198По умолчанию [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile) ищет файлы в каталоге вызывающего модуля. См. раздел [Базовый API](https://python-all.ru/3.13/library/doctest.html#doctest-basic-api) с описанием необязательных аргументов, которые можно использовать, чтобы указать ему искать файлы в других местах.199200Как и у [`testmod()`](https://python-all.ru/3.13/library/doctest.html#doctest.testmod), степень подробности вывода [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile) можно задать с помощью флага командной строки `-v` или необязательного именованного аргумента *verbose*.201202Также есть сокращение командной строки для запуска [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile); см. раздел [Использование командной строки](https://python-all.ru/3.13/library/doctest.html#doctest-cli).203204Для получения дополнительной информации о [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile) см. раздел [Базовый API](https://python-all.ru/3.13/library/doctest.html#doctest-basic-api).205206## Использование командной строки207208Модуль `doctest` можно вызвать как сценарий из командной строки:209210```bash211python -m doctest [-v] [-o OPTION] [-f] file [file ...]212```213214#### `-v, --verbose`215216Подробный отчёт обо всех проверенных примерах выводится в стандартный вывод, вместе с различными сводками в конце:217218```python219python -m doctest -v example.py220```221222Этот импортирует `example.py` как самостоятельный модуль и запустит [`testmod()`](https://python-all.ru/3.13/library/doctest.html#doctest.testmod) для него. Обратите внимание: это может работать некорректно, если файл является частью пакета и импортирует другие подмодули из этого пакета.223224Если имя файла не заканчивается на `.py`, `doctest` считает, что его нужно запускать с [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile):225226```python227python -m doctest -v example.txt228```229230#### `-o, --option <option>`231232Опции управляют различными аспектами поведения doctest; см. раздел [Опции](https://python-all.ru/3.13/library/doctest.html#doctest-options).233234Добавлено в версии 3.4.235236#### `-f, --fail-fast`237238Это сокращение для `-o FAIL_FAST`.239240Добавлено в версии 3.4.241242## Как это работает243244В этом разделе подробно рассматривается, как работает doctest: какие docstrings он просматривает, как находит интерактивные примеры, какой контекст выполнения использует, как обрабатывает исключения и как опции могут управлять его поведением. Это информация, которую нужно знать для написания примеров doctest; сведения о непосредственном запуске doctest на этих примерах приведены в следующих разделах.245246### Какие docstrings проверяются?247248Проверяются docstring модуля, а также docstrings всех функций, классов и методов. Объекты, импортированные в модуль, не проверяются.249250Кроме того, бывают случаи, когда тесты должны быть частью модуля, но не частью текста справки, поэтому тесты не должны включаться в docstring. Doctest ищет переменную уровня модуля с именем `__test__` и использует её для поиска других тестов. Если `M.__test__` существует, это должен быть словарь, где каждая запись сопоставляет имя (строку) с объектом функции, объектом класса или строкой. Docstrings объектов функций и классов, найденные из `M.__test__`, проверяются, а строки обрабатываются так, как если бы они были docstrings. В выводе ключ `K` из `M.__test__` отображается с именем `M.__test__.K`.251252Например, поместите этот блок кода в начало `example.py`:253254```python255__test__ = {256    'numbers': """257>>> factorial(6)258720259260>>> [factorial(n) for n in range(6)]261[1, 1, 2, 6, 24, 120]262"""263}264```265266Значение `example.__test__["numbers"]` будет обрабатываться как docstring, и все тесты внутри него будут запущены. Важно отметить, что значение может быть сопоставлено функции, объекту класса или модулю; если так, `doctest` рекурсивно ищет в них docstrings, которые затем сканируются на наличие тестов.267268Любые найденные классы аналогично рекурсивно проверяются на наличие docstrings в содержащихся в них методах и вложенных классах.269270> **Примечание**271>272> `doctest` может автоматически обнаруживать только классы и функции, которые определены на уровне модуля или внутри других классов.273>274> Поскольку вложенные классы и функции существуют только при вызове внешней функции, их невозможно обнаружить. Определяйте их снаружи, чтобы сделать их видимыми.275276### Как распознаются примеры docstring?277278В большинстве случаев копирование и вставка сессии интерактивной консоли работает нормально, но doctest не пытается точно эмулировать какой-либо конкретный Python shell.279280```python281>>> # комментарии игнорируются282>>> x = 12283>>> x28412285>>> if x == 13:286...     print("yes")287... else:288...     print("no")289...     print("NO")290...     print("NO!!!")291...292no293NO294NO!!!295>>>296```297298Любой ожидаемый вывод должен сразу следовать за последней строкой `'>>> '` или `'... '`, содержащей код, и ожидаемый вывод (если есть) простирается до следующей строки `'>>> '` или строки, состоящей только из пробелов.299300Мелкий шрифт:301302- Ожидаемый вывод не может содержать строку только из пробелов, так как такая строка считается сигналом конца ожидаемого вывода. Если ожидаемый вывод содержит пустую строку, поместите `<BLANKLINE>` в ваш пример doctest в каждом месте, где ожидается пустая строка.303- Все символы жёсткой табуляции заменяются пробелами с использованием 8-колонных позиций табуляции. Табуляции в выводе тестируемого кода не изменяются. Поскольку любые жёсткие табуляции в образцовом выводе *заменяются*, это означает, что если вывод кода содержит жёсткие табуляции, doctest может пройти, только если действует опция [`NORMALIZE_WHITESPACE`](https://python-all.ru/3.13/library/doctest.html#doctest.NORMALIZE_WHITESPACE) или [директива](https://python-all.ru/3.13/library/doctest.html#doctest-directives). В качестве альтернативы тест можно переписать так, чтобы захватывать вывод и сравнивать его с ожидаемым значением как часть теста. Этот способ обработки табуляций в исходном коде был найден методом проб и ошибок и оказался наименее подверженным ошибкам. Можно использовать другой алгоритм для обработки табуляций, написав собственный класс [`DocTestParser`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestParser).304- Вывод в stdout перехватывается, но не вывод в stderr (трассировки исключений перехватываются другим способом).305- Если вы продолжаете строку обратной косой чертой в интерактивной сессии или по любой другой причине используете обратную косую черту, следует использовать сырой docstring, который сохранит обратные косые черты точно в том виде, как вы их ввели:306307  ```python308  >>> def f(x):309  ...     r'''Обратная косая черта в сырой докстринге: m\n'''310  ...311  >>> print(f.__doc__)312  Backslashes in a raw docstring: m\n313  ```314315  В противном случае обратная косая черта будет интерпретироваться как часть строки. Например, `\n` выше будет интерпретироваться как символ новой строки. В качестве альтернативы можно удвоить каждую обратную косую черту в версии для doctest (и не использовать сырую строку):316317  ```python318  >>> def f(x):319  ...     '''Обратная косая черта в сырой докстринге: m\\n'''320  ...321  >>> print(f.__doc__)322  Backslashes in a raw docstring: m\n323  ```324- Начальный столбец не имеет значения:325326  ```python327  >>> assert "Easy!"328        >>> import math329            >>> math.floor(1.9)330            1331  ```332333  а также из ожидаемого вывода удаляется столько начальных пробельных символов, сколько их было в исходной строке `'>>> '`, с которой начинался пример.334335### Что такое контекст выполнения?336337По умолчанию каждый раз, когда `doctest` находит документирующую строку для тестирования, он использует *поверхностную копию* глобальных переменных `M`, чтобы выполнение тестов не изменяло реальные глобальные переменные модуля и чтобы один тест в `M` не мог оставить следов, случайно позволяющих работать другому тесту. Это означает, что примеры могут свободно использовать любые имена, определённые на верхнем уровне в `M`, а также имена, определённые ранее в выполняемой документирующей строке. Примеры не видят имена, определённые в других документирующих строках.338339Можно принудительно использовать собственный словарь в качестве контекста выполнения, передав `globs=your_dict` в [`testmod()`](https://python-all.ru/3.13/library/doctest.html#doctest.testmod) или [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile).340341### Как насчёт исключений?342343Никаких проблем, при условии, что трассировка – единственный вывод, выдаваемый примером: просто вставьте трассировку. [\[1\]](https://python-all.ru/3.13/library/doctest.html#id2) Поскольку трассировки содержат детали, которые могут быстро меняться (например, точные пути к файлам и номера строк), это тот случай, когда doctest старается быть гибким в том, что он принимает.344345Простой пример:346347```python348>>> [1, 2, 3].remove(42)349Traceback (most recent call last):350  File "<stdin>", line 1, in <module>351ValueError: list.remove(x): x not in list352```353354Этот doctest считается успешным, если возбуждается [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError) с деталями `list.remove(x): x not in list`, как показано.355356Ожидаемый вывод для исключения должен начинаться с заголовка трассировки, которым может быть одна из следующих двух строк, с отступом, совпадающим с первой строкой примера:357358```python359Traceback (most recent call last):360Traceback (innermost last):361```362363За заголовком трассировки следует необязательный стек трассировки, содержимое которого игнорируется doctest. Стек трассировки обычно опускается или копируется дословно из интерактивного сеанса.364365За стеком трассировки следует самая интересная часть: строка(и), содержащие тип исключения и его описание. Обычно это последняя строка трассировки, но может занимать несколько строк, если у исключения многострочное описание:366367```python368>>> raise ValueError('multi\n    line\ndetail')369Traceback (most recent call last):370  File "<stdin>", line 1, in <module>371ValueError: multi372    line373detail374```375376Последние три строки (начиная с [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError)) сравниваются с типом и описанием исключения, а остальные игнорируются.377378Лучшая практика – опускать стек трассировки, если он не добавляет существенной документационной ценности примеру. Так что последний пример, вероятно, лучше оформить так:379380```python381>>> raise ValueError('multi\n    line\ndetail')382Traceback (most recent call last):383    ...384ValueError: multi385    line386detail387```388389Обратите внимание, что трассировки обрабатываются особым образом. В частности, в переписанном примере использование `...` не зависит от опции [`ELLIPSIS`](https://python-all.ru/3.13/library/doctest.html#doctest.ELLIPSIS) doctest. Многоточие в этом примере можно было бы опустить или заменить тремя (или тремястами) запятыми, цифрами или отступной стенограммой скетча Монти Пайтона.390391Некоторые детали, которые стоит прочитать один раз, но запоминать не обязательно:392393- Doctest не может угадать, получен ли ваш ожидаемый вывод из трассировки исключения или из обычной печати. Поэтому, например, пример, ожидающий `ValueError: 42 is prime`, будет пройден независимо от того, действительно ли возбуждено [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError) или же пример просто выводит этот текст трассировки. На практике обычный вывод редко начинается со строки заголовка трассировки, так что это не создаёт реальных проблем.394- Каждая строка стека трассировки (если присутствует) должна иметь отступ больше, чем первая строка примера, *или* начинаться с небуквенно-цифрового символа. Первая строка после заголовка трассировки с таким же отступом и начинающаяся с буквенно-цифрового символа считается началом описания исключения. Конечно, это корректно работает для настоящих трассировок.395- Когда указана опция doctest [`IGNORE_EXCEPTION_DETAIL`](https://python-all.ru/3.13/library/doctest.html#doctest.IGNORE_EXCEPTION_DETAIL), всё, что находится после самого левого двоеточия и любой информации о модуле в имени исключения, игнорируется.396- Интерактивная оболочка опускает строку заголовка трассировки для некоторых [`SyntaxError`](https://python-all.ru/3.13/library/exceptions.html#SyntaxError). Но doctest использует строку заголовка трассировки, чтобы отличать исключения от не-исключений. Поэтому в редком случае, когда нужно протестировать `SyntaxError`, который опускает заголовок трассировки, придётся вручную добавить строку заголовка трассировки в тестовый пример.397398- Для некоторых исключений Python отображает положение ошибки с помощью маркеров `^` и тильд:399400  ```python401  >>> 1 + None402    File "<stdin>", line 1403      1 + None404      ~~^~~~~~405  TypeError: unsupported operand type(s) for +: 'int' and 'NoneType'406  ```407408  Поскольку строки, показывающие положение ошибки, идут до типа и описания исключения, они не проверяются doctest. Например, следующий тест будет пройден, даже если `^`-маркер поставлен в неверное место:409410  ```python411  >>> 1 + None412    File "<stdin>", line 1413      1 + None414      ^~~~~~~~415  TypeError: unsupported operand type(s) for +: 'int' and 'NoneType'416  ```417418### Флаги опций419420Ряд опционных флагов управляют различными аспектами поведения doctest. Символические имена флагов предоставляются в виде констант модуля, которые можно [объединять поразрядной операцией ИЛИ](https://python-all.ru/3.13/reference/expressions.html#bitwise) и передавать различным функциям. Имена также можно использовать в [директивах doctest](https://python-all.ru/3.13/library/doctest.html#doctest-directives) и передавать интерфейсу командной строки doctest через опцию `-o`.421422Первая группа опций определяет семантику тестов, управляя аспектами того, как doctest решает, соответствует ли фактический вывод ожидаемому выводу примера:423424#### `doctest.DONT_ACCEPT_TRUE_FOR_1`425426По умолчанию, если блок ожидаемого вывода содержит просто `1`, то фактический вывод, содержащий просто `1` или просто `True`, считается совпадением; аналогично для `0` и `False`. Когда указано [`DONT_ACCEPT_TRUE_FOR_1`](https://python-all.ru/3.13/library/doctest.html#doctest.DONT_ACCEPT_TRUE_FOR_1), ни одна из подстановок не разрешена. Поведение по умолчанию учитывает, что Python изменил тип возвращаемого значения многих функций с целого числа на логическое; тесты из модуля doctest, ожидающие «маленькое целое», всё ещё работают в таких случаях. Эта опция, вероятно, будет удалена, но не в ближайшие годы.427428#### `doctest.DONT_ACCEPT_BLANKLINE`429430По умолчанию, если блок ожидаемого вывода содержит строку, состоящую только из `<BLANKLINE>`, то эта строка будет соответствовать пустой строке в фактическом вызове. Поскольку действительно пустая строка разделяет ожидаемый вывод, это единственный способ указать, что ожидается пустая строка. Когда указано [`DONT_ACCEPT_BLANKLINE`](https://python-all.ru/3.13/library/doctest.html#doctest.DONT_ACCEPT_BLANKLINE), такая подстановка не разрешена.431432#### `doctest.NORMALIZE_WHITESPACE`433434Когда указано, все последовательности пробельных символов (пробелы и переводы строк) считаются равными. Любая последовательность пробелов в ожидаемом выводе будет соответствовать любой последовательности пробелов в фактическом выводе. По умолчанию пробельные символы должны совпадать точно. [`NORMALIZE_WHITESPACE`](https://python-all.ru/3.13/library/doctest.html#doctest.NORMALIZE_WHITESPACE) особенно полезна, когда строка ожидаемого вывода очень длинная, и её хочется перенести на несколько строк в исходном коде.435436#### `doctest.ELLIPSIS`437438Когда указано, маркер многоточия (`...`) в ожидаемом выводе может соответствовать любой подстроке в фактическом выводе. Это включает подстроки, выходящие за границы строк, и пустые подстроки, поэтому лучше использовать эту возможность просто. Сложное использование может привести к тем же сюрпризам «ой, совпало слишком много!», к которым склонен `.*` в регулярных выражениях.439440#### `doctest.IGNORE_EXCEPTION_DETAIL`441442Если этот флаг указан, доктесты, ожидающие исключения, проходят до тех пор,\\nпока возникло исключение ожидаемого типа, даже если детали\\n(сообщение и полное имя исключения) не совпадают.443444Например, пример, в котором ожидается `ValueError: 42`, пройдёт, если на самом деле возникнет исключение `ValueError: 3*14`, но не пройдёт, если, скажем, вместо него возникнет [`TypeError`](https://python-all.ru/3.13/library/exceptions.html#TypeError). Он также игнорирует полное имя, указанное перед классом исключения, которое может различаться в зависимости от реализаций и версий Python и используемых кода или библиотек. Таким образом, все три следующих варианта будут работать при указании этого флага:445446```pycon447>>> raise Exception('message')448Traceback (most recent call last):449Exception: message450451>>> raise Exception('message')452Traceback (most recent call last):453builtins.Exception: message454455>>> raise Exception('message')456Traceback (most recent call last):457__main__.Exception: message458```459460Обратите внимание, что [`ELLIPSIS`](https://python-all.ru/3.13/library/doctest.html#doctest.ELLIPSIS) можно также использовать для игнорирования\\nдеталей сообщения об исключении, но такой тест всё равно может не пройти\\nв зависимости от того, присутствует ли имя модуля и совпадает ли оно в точности.461462Изменено в версии 3.2: [`IGNORE_EXCEPTION_DETAIL`](https://python-all.ru/3.13/library/doctest.html#doctest.IGNORE_EXCEPTION_DETAIL) теперь также игнорирует любую информацию,\\nотносящуюся к модулю, содержащему проверяемое исключение.463464#### `doctest.SKIP`465466Если этот флаг указан, пример не выполняется вообще. Это может быть полезно в ситуациях,\\nкогда доктесты служат одновременно документацией и тестовыми примерами, и пример\\nдолжен быть включён для документации, но не должен проверяться. Например, вывод\\nпримера может быть случайным, или пример может зависеть от ресурсов,\\nнедоступных для тестового драйвера.467468Флаг SKIP также можно использовать для временного «закомментирования» примеров.469470#### `doctest.COMPARISON_FLAGS`471472Битовая маска, объединяющая все перечисленные выше флаги сравнения.473474Вторая группа опций управляет тем, как сообщается о неудачных тестах:475476#### `doctest.REPORT_UDIFF`477478Если указан, ошибки, включающие многострочные ожидаемый и фактический вывод, отображаются в виде unified diff.479480#### `doctest.REPORT_CDIFF`481482Если указан, ошибки, включающие многострочные ожидаемый и фактический вывод, отображаются в виде context diff.483484#### `doctest.REPORT_NDIFF`485486Если указан, различия вычисляются с помощью `difflib.Differ`, используя тот же алгоритм, что и популярная утилита `ndiff.py`. Это единственный метод, который помечает различия как внутри строк, так и между строками. Например, если строка ожидаемого вывода содержит цифру `1`, а фактический вывод – букву `l`, вставляется строка с символом '^', отмечающим позиции несовпадающих столбцов.487488#### `doctest.REPORT_ONLY_FIRST_FAILURE`489490Если указан, отображается первый упавший пример в каждом доктесте, но вывод\\nдля всех остальных примеров подавляется. Это предотвращает сообщение доктестом\\nо корректных примерах, которые «ломаются» из-за предыдущих ошибок; но оно также может\\nскрыть некорректные примеры, которые падают независимо от первой ошибки. Когда\\n[`REPORT_ONLY_FIRST_FAILURE`](https://python-all.ru/3.13/library/doctest.html#doctest.REPORT_ONLY_FIRST_FAILURE) указан, остальные примеры всё равно выполняются\\nи учитываются в общем количестве сообщённых ошибок; только\\nвывод подавляется.491492#### `doctest.FAIL_FAST`493494Если указан, завершить работу после первого упавшего примера и не пытаться\\nвыполнять остальные. Таким образом, количество сообщённых ошибок будет не более\\n1. Этот флаг может быть полезен при отладке, так как примеры после первой\\nошибки даже не будут генерировать отладочный вывод.495496#### `doctest.REPORTING_FLAGS`497498Битовая маска, объединяющая все перечисленные выше флаги отчёта.499500Существует также способ зарегистрировать новые имена флагов опций,\\nхотя это не имеет смысла, если вы не собираетесь расширять внутренности `doctest` через подклассы:501502#### `doctest.register_optionflag(name)`503504Создаёт новый флаг опции с заданным именем и возвращает целочисленное\\nзначение нового флага. `register_optionflag()` можно использовать при создании подклассов\\n[`OutputChecker`](https://python-all.ru/3.13/library/doctest.html#doctest.OutputChecker) или [`DocTestRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner) для создания новых опций, которые\\nподдерживаются вашими подклассами. `register_optionflag()` всегда следует вызывать,\\nиспользуя следующий идиоматический приём:505506```python507MY_FLAG = register_optionflag('MY_FLAG')508```509510### Директивы511512Директивы доктестов могут использоваться для изменения [флагов опций](https://python-all.ru/3.13/library/doctest.html#doctest-options) для отдельного примера. Директивы доктестов – это\\nспециальные комментарии Python, следующие за исходным кодом примера:513514```515516directive             ::= "#" "doctest:" directive_options517directive_options     ::= directive_option ("," directive_option)*518directive_option      ::= on_or_off directive_option_name519on_or_off             ::= "+" | "-"520directive_option_name ::= "DONT_ACCEPT_BLANKLINE" | "NORMALIZE_WHITESPACE" | ...521```522523Пробелы не допускаются между `+` или `-` и именем опции\\nдирективы. Имя опции директивы может быть любым из имён флагов опций,\\nописанных выше.524525Директивы доктестов примера изменяют поведение doctest только для этого\\nодного примера. Используйте `+` для включения указанного поведения или\\n`-` для его отключения.526527Например, этот тест проходит:528529```pycon530>>> print(list(range(20)))  # doctest: +NORMALIZE_WHITESPACE531[0,   1,  2,  3,  4,  5,  6,  7,  8,  9,53210,  11, 12, 13, 14, 15, 16, 17, 18, 19]533```534535Без директивы он бы не прошёл, и потому что в фактическом выводе нет\\nдвух пробелов перед элементами списка из одной цифры, и потому что фактический вывод\\nнаходится на одной строке. Этот тест тоже проходит и тоже требует директивы\\nдля этого:536537```pycon538>>> print(list(range(20)))  # doctest: +ELLIPSIS539[0, 1, ..., 18, 19]540```541542На одной физической строке можно использовать несколько директив, разделённых запятыми:543544```pycon545>>> print(list(range(20)))  # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE546[0,    1, ...,   18,    19]547```548549Если для одного примера используется несколько директив-комментариев, то они объединяются:550551```pycon552>>> print(list(range(20)))  # doctest: +ELLIPSIS553...                         # doctest: +NORMALIZE_WHITESPACE554[0,    1, ...,   18,    19]555```556557Как показано в предыдущем примере, можно добавлять строки `...` в пример, содержащие только директивы. Это может быть полезно, когда пример слишком длинный, чтобы директива удобно поместилась на той же строке:558559```pycon560>>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40)))561... # doctest: +ELLIPSIS562[0, ..., 4, 10, ..., 19, 30, ..., 39]563```564565Обратите внимание: поскольку все опции по умолчанию отключены, а директивы применяются только к тому примеру, в котором они находятся, включение опций (через `+` в директиве) обычно является единственным осмысленным выбором. Однако флаги опций также могут передаваться функциям, запускающим доктесты, устанавливая другие значения по умолчанию. В таких случаях отключение опции через `-` в директиве может быть полезным.566567### Предупреждения568569`doctest` очень требователен к точному совпадению ожидаемого вывода. Если не совпадает хотя бы один символ, тест считается проваленным. Это, скорее всего, несколько раз вас удивит, пока вы будете изучать, что именно Python гарантирует в выводе, а что нет. Например, при печати множества Python не гарантирует, что элементы будут напечатаны в определённом порядке, поэтому тест вида570571```python572>>> foo()573{"spam", "eggs"}574```575576является уязвимым! Один из способов обойти это – сделать577578```python579>>> foo() == {"spam", "eggs"}580True581```582583вместо этого. Другой способ – сделать584585```python586>>> d = sorted(foo())587>>> d588['eggs', 'spam']589```590591Есть и другие, но идея понятна.592593Ещё одна плохая идея – печатать то, что содержит адрес объекта, например594595```pycon596>>> id(1.0)  # обязательно иногда будет ошибаться5977948648598>>> class C: pass599>>> C()  # стандартный repr() для экземпляров содержит адрес600<C object at 0x00AC18F0>601```602603Директива [`ELLIPSIS`](https://python-all.ru/3.13/library/doctest.html#doctest.ELLIPSIS) даёт хороший подход для последнего примера:604605```pycon606>>> C()  # doctest: +ELLIPSIS607<C object at 0x...>608```609610Числа с плавающей точкой также подвержены небольшим вариациям вывода на разных платформах, поскольку Python полагается на системную библиотеку C для некоторых вычислений с плавающей точкой, а библиотеки C сильно различаются по качеству.611612```python613>>> 1000**0.1  # рискованно6141.9952623149688797615>>> round(1000**0.1, 9) # безопаснее6161.995262315617>>> print(f'{1000**0.1:.4f}') # гораздо безопаснее6181.9953619```620621Числа вида `I/2.**J` безопасны на всех платформах, и я часто подбираю примеры для doctest так, чтобы они давали числа такого вида:622623```python624>>> 3./4  # абсолютно безопасно6250.75626```627628Простые дроби также легче понимаются людьми, что улучшает документацию.629630## Базовый API631632Функции [`testmod()`](https://python-all.ru/3.13/library/doctest.html#doctest.testmod) и [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile) предоставляют простой интерфейс к doctest, которого должно быть достаточно для большинства простых случаев использования. Для менее формального введения в эти две функции см. разделы [Простое использование: проверка примеров в строке документации](https://python-all.ru/3.13/library/doctest.html#doctest-simple-testmod) и [Простое использование: проверка примеров в текстовом файле](https://python-all.ru/3.13/library/doctest.html#doctest-simple-testfile).633634#### `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)`635636Все аргументы, кроме *filename*, являются необязательными и должны указываться в форме ключевых слов.637638Проверяет примеры в файле с именем *filename*. Возвращает `(failure_count, test_count)`.639640Необязательный аргумент *module\_relative* определяет, как следует интерпретировать имя файла:641642- Если *module\_relative* равно `True` (значение по умолчанию), то *filename* задаёт независимый от ОС путь относительно модуля. По умолчанию этот путь указывается относительно каталога вызывающего модуля; но если указан аргумент *package*, то путь задаётся относительно этого пакета. Чтобы обеспечить независимость от ОС, *filename* должен использовать символы `/` для разделения сегментов пути и не должен быть абсолютным (т.е. не может начинаться с `/`).643- Если *module\_relative* равно `False`, то *filename* задаёт путь, зависящий от ОС. Путь может быть абсолютным или относительным; относительные пути разрешаются относительно текущего рабочего каталога.644645Необязательный аргумент *name* задаёт имя теста; по умолчанию, или если `None`, используется `os.path.basename(filename)`.646647Необязательный аргумент *package* – это пакет Python или имя пакета Python, каталог которого должен использоваться в качестве базового для имени файла относительно модуля. Если пакет не указан, то в качестве базового каталога для имён файлов относительно модуля используется каталог вызывающего модуля. Указывать *package*, если *module\_relative* равно `False`, является ошибкой.648649Необязательный аргумент *globs* задаёт словарь, который будет использоваться как пространство глобальных имён при выполнении примеров. Для doctest создаётся новая поверхностная копия этого словаря, чтобы примеры начинали с чистого листа. По умолчанию, или если `None`, используется новый пустой словарь.650651Необязательный аргумент *extraglobs* задаёт словарь, который сливается с глобальными переменными, используемыми для выполнения примеров. Это работает как [`dict.update()`](https://python-all.ru/3.13/library/stdtypes.html#dict.update): если *globs* и *extraglobs* имеют общий ключ, то в объединённом словаре отображается значение из *extraglobs*. По умолчанию, или если `None`, дополнительные глобальные переменные не используются. Это расширенная возможность, позволяющая параметризовать доктесты. Например, доктест можно написать для базового класса, используя обобщённое имя класса, а затем повторно использовать для тестирования любого количества подклассов, передавая словарь *extraglobs*, отображающий обобщённое имя на тестируемый подкласс.652653Необязательный аргумент *verbose*: если истина, выводит много информации, если ложь – только ошибки; по умолчанию, или если `None`, он истинен тогда и только тогда, когда `'-v'` присутствует в [`sys.argv`](https://python-all.ru/3.13/library/sys.html#sys.argv).654655Необязательный аргумент *report*: если истина, выводит сводку в конце, иначе ничего не выводит. В подробном режиме сводка подробная, в противном случае – очень краткая (фактически пустая, если все тесты пройдены).656657Необязательный аргумент *optionflags* (значение по умолчанию `0`) принимает [побитовое ИЛИ](https://python-all.ru/3.13/reference/expressions.html#bitwise) флагов опций. См. раздел [Флаги опций](https://python-all.ru/3.13/library/doctest.html#doctest-options).658659Необязательный аргумент *raise\_on\_error* по умолчанию равен false. Если true, при первой ошибке или неожиданном исключении в примере выбрасывается исключение. Это позволяет выполнять посмертную отладку ошибок. Поведение по умолчанию – продолжать выполнение примеров.660661Необязательный аргумент *parser* задаёт объект [`DocTestParser`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestParser) (или его подкласс), который следует использовать для извлечения тестов из файлов. По умолчанию используется обычный анализатор (т.е. `DocTestParser()`).662663Необязательный аргумент *encoding* задаёт кодировку, которая должна использоваться для преобразования файла в Unicode.664665#### `doctest.testmod(m=None, name=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, exclude_empty=False)`666667Все аргументы необязательны, и все, кроме *m*, должны передаваться как именованные.668669Тестирует примеры в строках документации функций и классов, доступных из модуля *m* (или модуля [`__main__`](https://python-all.ru/3.13/library/__main__.html#module-__main__), если *m* не указан или равен `None`), начиная с `m.__doc__`.670671Также тестирует примеры, доступные из словаря `m.__test__`, если он существует. `m.__test__` сопоставляет имена (строки) функциям, классам и строкам; строки документации функций и классов проверяются на наличие примеров; строки проверяются напрямую, как если бы они были строками документации.672673Проверяются только строки документации, прикреплённые к объектам, принадлежащим модулю *m*.674675Вернуть `(failure_count, test_count)`.676677Необязательный аргумент *name* задаёт имя модуля; по умолчанию, или если `None`, используется `m.__name__`.678679Необязательный аргумент *exclude\_empty* по умолчанию равен false. Если true, объекты, для которых не найдено доктестов, исключаются из рассмотрения. Значение по умолчанию – это хак для обратной совместимости, чтобы код, всё ещё использующий [`doctest.master.summarize`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.summarize) вместе с `testmod()`, продолжал получать вывод для объектов без тестов. Аргумент *exclude\_empty* в более новом конструкторе [`DocTestFinder`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestFinder) по умолчанию равен true.680681Необязательные аргументы *extraglobs*, *verbose*, *report*, *optionflags*, *raise\_on\_error* и *globs* такие же, как у функции [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile) выше, за исключением того, что *globs* по умолчанию равен `m.__dict__`.682683#### `doctest.run_docstring_examples(f, globs, verbose=False, name='NoName', compileflags=None, optionflags=0)`684685Тестирует примеры, связанные с объектом *f*; например, *f* может быть строкой, модулем, функцией или объектом класса.686687Для контекста выполнения используется поверхностная копия словаря *globs*.688689Необязательный аргумент *name* используется в сообщениях об ошибках и по умолчанию равен `"NoName"`.690691Если необязательный аргумент *verbose* равен true, вывод создаётся, даже если нет ошибок. По умолчанию вывод создаётся только в случае ошибки в примере.692693Необязательный аргумент *compileflags* задаёт набор флагов, которые должны использоваться компилятором Python при запуске примеров. По умолчанию или если `None`, флаги выводятся из набора будущих возможностей, найденных в *globs*.694695Необязательный аргумент *optionflags* работает так же, как у функции [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile) выше.696697## Unittest API698699По мере роста коллекции модулей с доктестами требуется способ систематически запускать все их доктесты. `doctest` предоставляет две функции, которые можно использовать для создания тестовых наборов [`unittest`](https://python-all.ru/3.13/library/unittest.html#module-unittest) из модулей и текстовых файлов, содержащих доктесты. Для интеграции с обнаружением тестов `unittest` в тестовый модуль следует включить функцию [load\_tests](https://python-all.ru/3.13/library/unittest.html#load-tests-protocol).700701```python702import unittest703import doctest704import my_module_with_doctests705706def load_tests(loader, tests, ignore):707    tests.addTests(doctest.DocTestSuite(my_module_with_doctests))708    return tests709```710711Существует две основные функции для создания экземпляров [`unittest.TestSuite`](https://python-all.ru/3.13/library/unittest.html#unittest.TestSuite) из текстовых файлов и модулей с доктестами:712713#### `doctest.DocFileSuite(*paths, module_relative=True, package=None, setUp=None, tearDown=None, globs=None, optionflags=0, parser=DocTestParser(), encoding=None)`714715Преобразует доктесты из одного или нескольких текстовых файлов в [`unittest.TestSuite`](https://python-all.ru/3.13/library/unittest.html#unittest.TestSuite).716717Возвращаемый [`unittest.TestSuite`](https://python-all.ru/3.13/library/unittest.html#unittest.TestSuite) должен выполняться фреймворком unittest и запускает интерактивные примеры в каждом файле. Если пример в любом файле завершается неудачей, то синтезированный модульный тест также завершается неудачей, и возникает исключение [`failureException`](https://python-all.ru/3.13/library/unittest.html#unittest.TestCase.failureException), показывающее имя файла, содержащего тест, и (иногда приблизительный) номер строки. Если все примеры в файле пропущены, то синтезированный модульный тест также помечается как пропущенный.718719Передаётся один или несколько путей (в виде строк) к текстовым файлам для проверки.720721Параметры могут быть указаны в виде именованных аргументов:722723Необязательный аргумент *module\_relative* определяет, как должны интерпретироваться имена файлов в *paths*:724725- Если *module\_relative* равен `True` (по умолчанию), то каждое имя файла в *paths* задаёт независимый от ОС путь относительно модуля. По умолчанию этот путь относителен каталога вызывающего модуля; но если указан аргумент *package*, то он относителен этого пакета. Для обеспечения независимости от ОС каждое имя файла должно использовать символы `/` для разделения сегментов пути и не может быть абсолютным путём (т.е. не должно начинаться с `/`).726- Если *module\_relative* равен `False`, то каждое имя файла в *paths* задаёт путь, зависящий от ОС. Путь может быть абсолютным или относительным; относительные пути разрешаются относительно текущего рабочего каталога.727728Необязательный аргумент *package* – это пакет Python или имя пакета Python, каталог которого должен использоваться в качестве базового каталога для имён файлов, относительных модуля, в *paths*. Если пакет не указан, то в качестве базового каталога для относительных имён файлов используется каталог вызывающего модуля. Указывать *package*, если *module\_relative* равен `False`, является ошибкой.729730Необязательный аргумент *setUp* задаёт функцию настройки для тестового набора. Она вызывается перед запуском тестов в каждом файле. Функции *setUp* будет передан объект [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest). Функция *setUp* может получить доступ к глобальным переменным теста через атрибут [`globs`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest.globs) переданного теста.731732Необязательный аргумент *tearDown* задаёт функцию завершения для тестового набора. Она вызывается после запуска тестов в каждом файле. Функции *tearDown* будет передан объект [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest). Функция *tearDown* может получить доступ к глобальным переменным теста через атрибут [`globs`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest.globs) переданного теста.733734Необязательный аргумент *globs* – это словарь, содержащий начальные глобальные переменные для тестов. Для каждого теста создаётся новая копия этого словаря. По умолчанию *globs* – новый пустой словарь.735736Необязательный аргумент *optionflags* задаёт параметры доктеста по умолчанию для тестов, создаваемые путём объединения отдельных флагов параметров (OR). См. раздел [Option Flags](https://python-all.ru/3.13/library/doctest.html#doctest-options). Функцию [`set_unittest_reportflags()`](https://python-all.ru/3.13/library/doctest.html#doctest.set_unittest_reportflags) см. ниже для лучшего способа установки параметров отчёта.737738Необязательный аргумент *parser* задаёт [`DocTestParser`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestParser) (или подкласс), который должен использоваться для извлечения тестов из файлов. По умолчанию используется обычный парсер (т.е. `DocTestParser()`).739740Необязательный аргумент *encoding* задаёт кодировку, которая должна использоваться для преобразования файла в Unicode.741742Глобальная переменная `__file__` добавляется к глобальным переменным, предоставляемым доктестам, загруженным из текстового файла с помощью `DocFileSuite()`.743744#### `doctest.DocTestSuite(module=None, globs=None, extraglobs=None, test_finder=None, setUp=None, tearDown=None, optionflags=0, checker=None)`745746Преобразует доктесты для модуля в [`unittest.TestSuite`](https://python-all.ru/3.13/library/unittest.html#unittest.TestSuite).747748Возвращаемое значение [`unittest.TestSuite`](https://python-all.ru/3.13/library/unittest.html#unittest.TestSuite) предназначено для запуска фреймворком unittest и запускает каждый доктест в модуле. Каждая строка документации выполняется как отдельный модульный тест. Если какой-либо доктест завершается неудачей, синтезированный модульный тест также завершается неудачей, и возникает исключение [`unittest.TestCase.failureException`](https://python-all.ru/3.13/library/unittest.html#unittest.TestCase.failureException), показывающее имя файла, содержащего тест, и (иногда приблизительный) номер строки. Если все примеры в строке документации пропущены, то749750Необязательный аргумент *module* задаёт тестируемый модуль. Это может быть объект модуля или (возможно, с точками) имя модуля. Если он не указан, используется модуль, из которого вызывается эта функция.751752Необязательный аргумент *globs* – это словарь, содержащий начальные глобальные переменные для тестов. Для каждого теста создаётся новая копия этого словаря. По умолчанию *globs* – это [`__dict__`](https://python-all.ru/3.13/reference/datamodel.html#module.__dict__) модуля.753754Необязательный аргумент *extraglobs* задаёт дополнительный набор глобальных переменных, который объединяется с *globs*. По умолчанию дополнительные глобальные переменные не используются.755756Необязательный аргумент *test\_finder* – это объект [`DocTestFinder`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestFinder) (или его замена, совместимая по интерфейсу), который используется для извлечения доктестов из модуля.757758Необязательные аргументы *setUp*, *tearDown* и *optionflags* аналогичны одноимённым аргументам функции [`DocFileSuite()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocFileSuite), но вызываются для каждой строки документации.759760Эта функция использует тот же метод поиска, что и [`testmod()`](https://python-all.ru/3.13/library/doctest.html#doctest.testmod).761762Изменено в версии 3.5: `DocTestSuite()` возвращает пустой [`unittest.TestSuite`](https://python-all.ru/3.13/library/unittest.html#unittest.TestSuite), если *module* не содержит строк документации, вместо возбуждения [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError).763764Под капотом [`DocTestSuite()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestSuite) создаёт [`unittest.TestSuite`](https://python-all.ru/3.13/library/unittest.html#unittest.TestSuite) из экземпляров `doctest.DocTestCase`, а `DocTestCase` является подклассом [`unittest.TestCase`](https://python-all.ru/3.13/library/unittest.html#unittest.TestCase). `DocTestCase` здесь не документирован (это внутренняя деталь), но изучение его кода может ответить на вопросы о точных деталях интеграции [`unittest`](https://python-all.ru/3.13/library/unittest.html#module-unittest).765766Аналогично, [`DocFileSuite()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocFileSuite) создаёт [`unittest.TestSuite`](https://python-all.ru/3.13/library/unittest.html#unittest.TestSuite) из экземпляров `doctest.DocFileCase`, а `DocFileCase` является подклассом `DocTestCase`.767768Таким образом, оба способа создания [`unittest.TestSuite`](https://python-all.ru/3.13/library/unittest.html#unittest.TestSuite) запускают экземпляры `DocTestCase`. Это важно по тонкой причине: при непосредственном запуске функций `doctest` можно напрямую управлять используемыми параметрами `doctest`, передавая флаги опций функциям `doctest`. Однако при написании фреймворка [`unittest`](https://python-all.ru/3.13/library/unittest.html#module-unittest) именно `unittest` в конечном счёте управляет тем, когда и как выполняются тесты. Автор фреймворка обычно хочет управлять параметрами отчётности `doctest` (возможно, заданными через параметры командной строки), но нет способа передать параметры через `unittest` в средства запуска тестов `doctest`.769770По этой причине `doctest` также поддерживает понятие флагов отчётности `doctest`, специфичных для поддержки [`unittest`](https://python-all.ru/3.13/library/unittest.html#module-unittest), с помощью этой функции:771772#### `doctest.set_unittest_reportflags(flags)`773774Устанавливает используемые флаги отчётности `doctest`.775776Аргумент *flags* принимает [побитовое ИЛИ](https://python-all.ru/3.13/reference/expressions.html#bitwise) флагов опций. См. раздел [Флаги опций](https://python-all.ru/3.13/library/doctest.html#doctest-options). Можно использовать только «флаги отчётности».777778Это глобальная настройка модуля, которая влияет на все будущие доктесты, запускаемые модулем [`unittest`](https://python-all.ru/3.13/library/unittest.html#module-unittest): метод `runTest()` объекта `DocTestCase` проверяет флаги опций, указанные для тестового случая при создании экземпляра `DocTestCase`. Если флаги отчётности не были указаны (что является типичным и ожидаемым случаем), флаги отчётности `unittest` объекта `doctest` [побитово объединяются с помощью ИЛИ](https://python-all.ru/3.13/reference/expressions.html#bitwise) с флагами опций, и расширенные таким образом флаги опций передаются экземпляру [`DocTestRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner), созданному для запуска доктеста. Если какие-либо флаги отчётности были указаны при создании экземпляра `DocTestCase`, флаги отчётности `unittest` объекта `doctest` игнорируются.779780Функция возвращает значение флагов отчётности [`unittest`](https://python-all.ru/3.13/library/unittest.html#module-unittest), действовавших до её вызова.781782## Расширенный API783784Базовый API – это простая обёртка, предназначенная для упрощения использования doctest. Он достаточно гибок и должен удовлетворять потребности большинства пользователей; однако, если требуется более детальный контроль над тестированием или расширение возможностей doctest, следует использовать расширенный API.785786Расширенный API строится вокруг двух классов-контейнеров, которые используются для хранения интерактивных примеров, извлечённых из тестовых сценариев doctest:787788- [`Example`](https://python-all.ru/3.13/library/doctest.html#doctest.Example): Одна инструкция ([statement](https://python-all.ru/3.13/glossary.html#term-statement)) Python в паре с ожидаемым выводом.789- [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest): Набор объектов [`Example`](https://python-all.ru/3.13/library/doctest.html#doctest.Example), обычно извлечённых из одной строки документации или текстового файла.790791Для поиска, разбора, выполнения и проверки примеров doctest определены дополнительные классы обработки:792793- [`DocTestFinder`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestFinder): Находит все строки документации в заданном модуле и использует [`DocTestParser`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestParser) для создания [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest) из каждой строки документации, содержащей интерактивные примеры.794- [`DocTestParser`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestParser): Создаёт объект [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest) из строки (например, из строки документации объекта).795- [`DocTestRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner): Выполняет примеры в [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest) и использует [`OutputChecker`](https://python-all.ru/3.13/library/doctest.html#doctest.OutputChecker) для проверки их вывода.796- [`OutputChecker`](https://python-all.ru/3.13/library/doctest.html#doctest.OutputChecker): Сравнивает фактический вывод примера doctest с ожидаемым выводом и определяет, совпадают ли они.797798Взаимосвязи между этими классами обработки показаны на следующей диаграмме.799800```python801                            list of:802+------+                   +---------+803|module| --DocTestFinder-> | DocTest | --DocTestRunner-> results804+------+    |        ^     +---------+     |       ^    (printed)805            |        |     | Example |     |       |806            v        |     |   ...   |     v       |807           DocTestParser   | Example |   OutputChecker808                           +---------+809```810811### Объекты DocTest812813#### `class doctest.DocTest(examples, globs, name, filename, lineno, docstring)`814815Набор примеров doctest, которые должны выполняться в одном пространстве имён. Аргументы конструктора инициализируют одноимённые атрибуты.816817`DocTest` определяет следующие атрибуты. Они инициализируются конструктором и не должны изменяться напрямую.818819#### `examples`820821Список объектов [`Example`](https://python-all.ru/3.13/library/doctest.html#doctest.Example), представляющих отдельные интерактивные примеры Python, которые должны быть выполнены этим тестом.822823#### `globs`824825Пространство имён (также известное как globals), в котором должны выполняться примеры. Это словарь, отображающий имена в значения. Любые изменения пространства имён, сделанные примерами (например, связывание новых переменных), будут отражены в [`globs`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest.globs) после выполнения теста.826827#### `name`828829Строковое имя, идентифицирующее `DocTest`. Обычно это имя объекта или файла, из которого был извлечён тест.830831#### `filename`832833Имя файла, из которого был извлечён этот `DocTest`; или `None`, если имя файла неизвестно, или `DocTest` не был извлечён из файла.834835#### `lineno`836837Номер строки внутри [`filename`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest.filename), с которой начинается данный `DocTest`, или `None`, если номер строки недоступен. Этот номер строки отсчитывается от нуля относительно начала файла.838839#### `docstring`840841Строка, из которой был извлечён тест, или `None`, если строка недоступна, или если тест не был извлечён из строки.842843### Объекты Example844845#### `class doctest.Example(source, want, exc_msg=None, lineno=0, indent=0, options=None)`846847Один интерактивный пример, состоящий из оператора Python и ожидаемого вывода. Аргументы конструктора инициализируют одноимённые атрибуты.848849`Example` определяет следующие атрибуты. Они инициализируются конструктором и не должны изменяться напрямую.850851#### `source`852853Строка, содержащая исходный код примера. Этот исходный код состоит из одного оператора Python и всегда заканчивается символом новой строки; конструктор добавляет символ новой строки при необходимости.854855#### `want`856857Ожидаемый результат выполнения исходного кода примера (либо из stdout, либо трассировка в случае исключения). [`want`](https://python-all.ru/3.13/library/doctest.html#doctest.Example.want) заканчивается символом новой строки, если только результат не ожидается; в этом случае это пустая строка. Конструктор добавляет символ новой строки при необходимости.858859#### `exc_msg`860861Сообщение об исключении, сгенерированное примером, если ожидается, что пример вызовет исключение; или `None`, если исключение не ожидается. Это сообщение об исключении сравнивается с возвращаемым значением [`traceback.format_exception_only()`](https://python-all.ru/3.13/library/traceback.html#traceback.format_exception_only). [`exc_msg`](https://python-all.ru/3.13/library/doctest.html#doctest.Example.exc_msg) заканчивается символом новой строки, если только оно не равно `None`. Конструктор добавляет символ новой строки при необходимости.862863#### `lineno`864865Номер строки внутри строки, содержащей этот пример, с которой начинается пример. Этот номер строки отсчитывается от нуля относительно начала содержащей строки.866867#### `indent`868869Отступ примера в содержащей строке, т.е. количество пробелов перед первым приглашением примера.870871#### `options`872873Словарь, отображающий флаги опций в `True` или `False`, который используется для переопределения опций по умолчанию для этого примера. Любые флаги опций, не содержащиеся в этом словаре, остаются со значениями по умолчанию (как указано в [optionflags](https://python-all.ru/3.13/library/doctest.html#doctest-options) объекта [`DocTestRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner)). По умолчанию никакие опции не установлены.874875### Объекты DocTestFinder876877#### `class doctest.DocTestFinder(verbose=False, parser=DocTestParser(), recurse=True, exclude_empty=True)`878879Класс обработки, используемый для извлечения [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest), имеющих отношение к заданному объекту, из его строки документации и строк документации содержащихся в нём объектов. `DocTest` можно извлекать из модулей, классов, функций, методов, статических методов, методов класса и свойств.880881Необязательный аргумент *verbose* используется для отображения объектов, которые ищет поисковик. По умолчанию он равен `False` (вывод отсутствует).882883Необязательный аргумент *parser* задаёт объект [`DocTestParser`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestParser) (или его замену), который используется для извлечения доктестов из строк документации.884885Если необязательный аргумент *recurse* равен false, то [`DocTestFinder.find()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestFinder.find) будет проверять только указанный объект, но не содержащиеся в нём объекты.886887Если необязательный аргумент *exclude\_empty* равен false, то [`DocTestFinder.find()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestFinder.find) будет включать тесты для объектов с пустыми строками документации.888889`DocTestFinder` определяет следующий метод:890891#### `find(obj[, name][, module][, globs][, extraglobs])`892893Возвращает список [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest), определённых строкой документации *obj* или строками документации любых содержащихся в нём объектов.894895Необязательный аргумент *name* задаёт имя объекта; это имя будет использоваться для формирования имён возвращаемых [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest). Если *name* не указан, то используется `obj.__name__`.896897Необязательный параметр *module* – это модуль, содержащий указанный объект. Если модуль не указан или равен `None`, то поисковик тестов попытается автоматически определить правильный модуль. Модуль объекта используется:898899- В качестве пространства имён по умолчанию, если *globs* не указан.900- Чтобы предотвратить извлечение DocTests объектом DocTestFinder из объектов, импортированных из других модулей. (Содержащиеся объекты, чей модуль отличается от *module*, игнорируются.)901- Для поиска имени файла, содержащего объект.902- Для помощи в определении номера строки объекта в его файле.903904Если *module* равен `False`, попытка найти модуль не предпринимается. Это необычная возможность, используемая в основном при тестировании самого doctest: если *module* равен `False` или `None`, но не может быть найден автоматически, то все объекты считаются принадлежащими (несуществующему) модулю, поэтому все содержащиеся объекты будут (рекурсивно) проверяться на наличие доктестов.905906Глобальные переменные для каждого [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest) формируются объединением *globs* и *extraglobs* (связывания из *extraglobs* переопределяют связывания из *globs*). Для каждого `DocTest` создаётся новая мелкая копия словаря глобальных переменных. Если *globs* не указан, то по умолчанию используется [`__dict__`](https://python-all.ru/3.13/reference/datamodel.html#module.__dict__) модуля, если он указан, или `{}` в противном случае. Если *extraglobs* не указан, то по умолчанию он равен `{}`.907908### Объекты DocTestParser909910#### `class doctest.DocTestParser`911912Класс обработки, используемый для извлечения интерактивных примеров из строки и создания из них объекта [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest).913914`DocTestParser` определяет следующие методы:915916#### `get_doctest(string, globs, name, filename, lineno)`917918Извлекает все примеры доктестов из заданной строки и собирает их в объект [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest).919920*globs*, *name*, *filename* и *lineno* – это атрибуты нового объекта `DocTest`. Дополнительную информацию см. в документации [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest).921922#### `get_examples(string, name='<string>')`923924Извлекает все примеры доктестов из заданной строки и возвращает их в виде списка объектов [`Example`](https://python-all.ru/3.13/library/doctest.html#doctest.Example). Номера строк начинаются с 0. Необязательный аргумент *name* – это имя, идентифицирующее данную строку; используется только для сообщений об ошибках.925926#### `parse(string, name='<string>')`927928Разделяет заданную строку на примеры и промежуточный текст и возвращает их в виде списка, чередующего [`Example`](https://python-all.ru/3.13/library/doctest.html#doctest.Example) и строки. Номера строк для `Example` начинаются с 0. Необязательный аргумент *name* – это имя, идентифицирующее данную строку; используется только для сообщений об ошибках.929930### Объекты TestResults931932#### `class doctest.TestResults(failed, attempted)`933934#### `failed`935936Количество проваленных тестов.937938#### `attempted`939940Количество выполненных тестов.941942#### `skipped`943944Количество пропущенных тестов.945946Добавлено в версии 3.13.947948### Объекты DocTestRunner949950#### `class doctest.DocTestRunner(checker=None, verbose=None, optionflags=0)`951952Класс обработки, используемый для выполнения и проверки интерактивных примеров в [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest).953954Сравнение ожидаемых и фактических выходных данных выполняется с помощью [`OutputChecker`](https://python-all.ru/3.13/library/doctest.html#doctest.OutputChecker). Это сравнение можно настроить с помощью ряда флагов опций; подробнее см. раздел [Флаги опций](https://python-all.ru/3.13/library/doctest.html#doctest-options). Если флагов опций недостаточно, сравнение можно также настроить, передав подкласс `OutputChecker` в конструктор.955956Выводом тестового исполнителя можно управлять двумя способами. Во-первых, можно передать функцию вывода в [`run()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.run); эта функция будет вызываться со строками, которые нужно отобразить. По умолчанию используется `sys.stdout.write`. Если захвата вывода недостаточно, то вывод также можно настроить, создав подкласс DocTestRunner и переопределив методы [`report_start()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.report_start), [`report_success()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.report_success), [`report_unexpected_exception()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.report_unexpected_exception) и [`report_failure()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.report_failure).957958Необязательный именованный аргумент *checker* задаёт [`OutputChecker`](https://python-all.ru/3.13/library/doctest.html#doctest.OutputChecker) объект (или замену без изменений), который следует использовать для сравнения ожидаемых выходных данных с фактическими результатами выполнения примеров doctest.959960Необязательный именованный аргумент *verbose* управляет подробностью `DocTestRunner`. Если *verbose* равен `True`, то выводится информация о каждом примере по мере его выполнения. Если *verbose* равен `False`, то выводятся только сбои. Если *verbose* не указан или равен `None`, то подробный вывод используется, только если указан ключ командной строки `-v`.961962Необязательный именованный аргумент *optionflags* позволяет управлять тем, как исполнитель тестов сравнивает ожидаемый вывод с фактическим и как отображает ошибки. Дополнительную информацию см. в разделе [Флаги опций](https://python-all.ru/3.13/library/doctest.html#doctest-options).963964Исполнитель тестов накапливает статистику. Общее количество выполненных, проваленных и пропущенных примеров также доступно через атрибуты [`tries`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.tries), [`failures`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.failures) и [`skips`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.skips). Методы [`run()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.run) и [`summarize()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.summarize) возвращают экземпляр [`TestResults`](https://python-all.ru/3.13/library/doctest.html#doctest.TestResults).965966`DocTestRunner` определяет следующие методы:967968#### `report_start(out, test, example)`969970Сообщает, что исполнитель тестов собирается обработать указанный пример. Этот метод предоставляется, чтобы позволить подклассам `DocTestRunner` настраивать свой вывод; его не следует вызывать напрямую.971972*example* – это пример, который будет обработан. *test* – это тест, содержащий *example*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.run).973974#### `report_success(out, test, example, got)`975976Сообщает, что указанный пример выполнен успешно. Этот метод предоставляется, чтобы позволить подклассам `DocTestRunner` настраивать свой вывод; его не следует вызывать напрямую.977978*example* – это пример, который будет обработан. *got* – это фактический вывод из примера. *test* – это тест, содержащий *example*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.run).979980#### `report_failure(out, test, example, got)`981982Сообщает, что указанный пример провален. Этот метод предоставляется, чтобы позволить подклассам `DocTestRunner` настраивать свой вывод; его не следует вызывать напрямую.983984*example* – это пример, который будет обработан. *got* – это фактический вывод из примера. *test* – это тест, содержащий *example*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.run).985986#### `report_unexpected_exception(out, test, example, exc_info)`987988Сообщает, что указанный пример вызвал неожиданное исключение. Этот метод предоставляется, чтобы позволить подклассам `DocTestRunner` настраивать свой вывод; его не следует вызывать напрямую.989990*example* – это пример, который будет обработан. *exc\_info* – это кортеж, содержащий информацию о неожиданном исключении (возвращаемый функцией [`sys.exc_info()`](https://python-all.ru/3.13/library/sys.html#sys.exc_info)). *test* – это тест, содержащий *example*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner.run).991992#### `run(test, compileflags=None, out=None, clear_globs=True)`993994Выполняет примеры в *test* (объект [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest)) и отображает результаты с помощью функции записи *out*. Возвращает экземпляр [`TestResults`](https://python-all.ru/3.13/library/doctest.html#doctest.TestResults) .995996Примеры выполняются в пространстве имён `test.globs`. Если *clear\_globs* имеет значение true (по умолчанию), то это пространство имён будет очищено после выполнения теста для сборки мусора. Если требуется изучить пространство имён после завершения теста, используйте *clear\_globs=False*.997998*compileflags* задаёт набор флагов, которые должен использовать компилятор Python при выполнении примеров. Если не указан, по умолчанию используется набор флагов future-import, действующих для *globs*.9991000Вывод каждого примера проверяется с помощью средства проверки вывода `DocTestRunner`, а результаты форматируются методами `DocTestRunner.report_*()`.10011002#### `summarize(verbose=None)`10031004Печатает сводку всех тестовых примеров, которые были запущены этим DocTestRunner, и возвращает экземпляр [`TestResults`](https://python-all.ru/3.13/library/doctest.html#doctest.TestResults).10051006Необязательный аргумент *verbose* управляет степенью детализации сводки. Если степень детализации не указана, то используется `DocTestRunner`.10071008[`DocTestParser`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestParser) имеет следующие атрибуты:10091010#### `tries`10111012Количество выполненных примеров.10131014#### `failures`10151016Количество примеров с ошибками.10171018#### `skips`10191020Количество пропущенных примеров.10211022Добавлено в версии 3.13.10231024### Объекты OutputChecker10251026#### `class doctest.OutputChecker`10271028Класс, используемый для проверки, совпадает ли фактический вывод примера doctest с ожидаемым выводом. `OutputChecker` определяет два метода: [`check_output()`](https://python-all.ru/3.13/library/doctest.html#doctest.OutputChecker.check_output), который сравнивает заданную пару выводов и возвращает `True`, если они совпадают; и [`output_difference()`](https://python-all.ru/3.13/library/doctest.html#doctest.OutputChecker.output_difference), который возвращает строку с описанием различий между двумя выводами.10291030`OutputChecker` определяет следующие методы:10311032#### `check_output(want, got, optionflags)`10331034Возвращает `True`, если фактический вывод примера (*got*) совпадает с ожидаемым выводом (*want*). Эти строки всегда считаются совпадающими, если они идентичны; но в зависимости от того, какие флаги опций использует test runner, возможны и несколько нестрогих типов совпадений. См. раздел [Option Flags](https://python-all.ru/3.13/library/doctest.html#doctest-options) для получения дополнительной информации о флагах опций.10351036#### `output_difference(example, got, optionflags)`10371038Возвращает строку с описанием различий между ожидаемым выводом для заданного примера (*example*) и фактическим выводом (*got*). *optionflags* – это набор флагов опций, используемых для сравнения *want* и *got*.10391040## Отладка10411042Doctest предоставляет несколько механизмов для отладки примеров doctest:10431044- Некоторые функции преобразуют doctest в исполняемые программы Python, которые можно запускать под отладчиком Python, [`pdb`](https://python-all.ru/3.13/library/pdb.html#module-pdb).1045- Класс [`DebugRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DebugRunner) является подклассом [`DocTestRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner), который вызывает исключение для первого неудачного примера, содержащее информацию об этом примере. Эту информацию можно использовать для посмертной отладки примера.1046- Случаи [`unittest`](https://python-all.ru/3.13/library/unittest.html#module-unittest), сгенерированные [`DocTestSuite()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestSuite), поддерживают метод [`debug()`](https://python-all.ru/3.13/library/doctest.html#doctest.debug), определённый [`unittest.TestCase`](https://python-all.ru/3.13/library/unittest.html#unittest.TestCase).1047- Можно добавить вызов [`pdb.set_trace()`](https://python-all.ru/3.13/library/pdb.html#pdb.set_trace) в пример doctest, и при выполнении этой строки произойдёт вход в отладчик Python. Затем можно проверять текущие значения переменных и т.д. Например, предположим, что `a.py` содержит только эту строку документации модуля:10481049  ```python1050  """1051  >>> def f(x):1052  ...     g(x*2)1053  >>> def g(x):1054  ...     print(x+3)1055  ...     import pdb; pdb.set_trace()1056  >>> f(3)1057  91058  """1059  ```10601061  Тогда интерактивный сеанс Python может выглядеть так:10621063  ```python1064  >>> import a, doctest1065  >>> doctest.testmod(a)1066  --Return--1067  > <doctest a[1]>(3)g()->None1068  -> import pdb; pdb.set_trace()1069  (Pdb) list1070    1     def g(x):1071    2         print(x+3)1072    3  ->     import pdb; pdb.set_trace()1073  [EOF]1074  (Pdb) p x1075  61076  (Pdb) step1077  --Return--1078  > <doctest a[0]>(2)f()->None1079  -> g(x*2)1080  (Pdb) list1081    1     def f(x):1082    2  ->     g(x*2)1083  [EOF]1084  (Pdb) p x1085  31086  (Pdb) step1087  --Return--1088  > <doctest a[2]>(1)?()->None1089  -> f(3)1090  (Pdb) cont1091  (0, 3)1092  >>>1093  ```10941095Функции, которые преобразуют doctest в код Python и, возможно, запускают полученный код под отладчиком:10961097#### `doctest.script_from_examples(s)`10981099Преобразует текст с примерами в скрипт.11001101Аргумент *s* – это строка, содержащая примеры doctest. Строка преобразуется в скрипт Python, где примеры doctest из *s* преобразуются в обычный код, а всё остальное – в комментарии Python. Сгенерированный скрипт возвращается в виде строки. Например,11021103```python1104import doctest1105print(doctest.script_from_examples(r"""1106    Set x and y to 1 and 2.1107    >>> x, y = 1, 211081109    Print their sum:1110    >>> print(x+y)1111    31112"""))1113```11141115выводит:11161117```python1118# Установите x и y в 1 и 2.1119x, y = 1, 21120#1121# Выведите их сумму:1122print(x+y)1123# Ожидаемый результат:1124## 31125```11261127Эта функция используется внутренне другими функциями (см. ниже), но также может быть полезна, когда требуется преобразовать интерактивный сеанс Python в скрипт Python.11281129#### `doctest.testsource(module, name)`11301131Преобразует доктест объекта в скрипт.11321133Аргумент *module* – это объект модуля или точечное имя модуля, содержащего объект, чьи доктесты интересуют. Аргумент *name* – это имя (внутри модуля) объекта с интересующими доктестами. Результат – строка, содержащая строку документации объекта, преобразованная в скрипт Python, как описано для [`script_from_examples()`](https://python-all.ru/3.13/library/doctest.html#doctest.script_from_examples) выше. Например, если модуль `a.py` содержит функцию верхнего уровня `f()`, то11341135```python1136import a, doctest1137print(doctest.testsource(a, "a.f"))1138```11391140выводит скриптовую версию строки документации функции `f()`, при этом доктесты преобразуются в код, а остальное помещается в комментарии.11411142#### `doctest.debug(module, name, pm=False)`11431144Отладка доктестов для объекта.11451146Аргументы *module* и *name* такие же, как и для функции [`testsource()`](https://python-all.ru/3.13/library/doctest.html#doctest.testsource) выше. Синтезированный скрипт Python из строки документации указанного объекта записывается во временный файл, а затем этот файл выполняется под управлением отладчика Python, [`pdb`](https://python-all.ru/3.13/library/pdb.html#module-pdb).11471148Для локального и глобального контекста выполнения используется поверхностная копия `module.__dict__`.11491150Необязательный аргумент *pm* определяет, используется ли посмертная отладка. Если *pm* имеет истинное значение, файл скрипта выполняется напрямую, и отладчик подключается только в случае завершения скрипта из-за необработанного исключения. Если это происходит, то вызывается посмертная отладка через [`pdb.post_mortem()`](https://python-all.ru/3.13/library/pdb.html#pdb.post_mortem) с передачей объекта traceback из необработанного исключения. Если *pm* не указан или равен false, скрипт выполняется под отладчиком с самого начала, путем передачи соответствующего вызова [`exec()`](https://python-all.ru/3.13/library/functions.html#exec) в [`pdb.run()`](https://python-all.ru/3.13/library/pdb.html#pdb.run).11511152#### `doctest.debug_src(src, pm=False, globs=None)`11531154Отладка доктестов в строке.11551156Эта функция похожа на функцию [`debug()`](https://python-all.ru/3.13/library/doctest.html#doctest.debug) выше, за исключением того, что строка, содержащая примеры доктестов, задается напрямую через аргумент *src*.11571158Необязательный аргумент *pm* имеет тот же смысл, что и в функции [`debug()`](https://python-all.ru/3.13/library/doctest.html#doctest.debug) выше.11591160Необязательный аргумент *globs* задает словарь, используемый как для локального, так и для глобального контекста выполнения. Если он не указан или равен `None`, используется пустой словарь. Если указан, используется поверхностная копия словаря.11611162Класс [`DebugRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DebugRunner) и специальные исключения, которые он может вызывать, представляют наибольший интерес для разработчиков тестовых фреймворков и будут лишь кратко описаны здесь. За подробностями обращайтесь к исходному коду и особенно к строке документации `DebugRunner` (которая сама является доктестом!).11631164#### `class doctest.DebugRunner(checker=None, verbose=None, optionflags=0)`11651166Подкласс [`DocTestRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner), который вызывает исключение сразу при обнаружении сбоя. Если происходит неожиданное исключение, вызывается исключение [`UnexpectedException`](https://python-all.ru/3.13/library/doctest.html#doctest.UnexpectedException), содержащее тест, пример и исходное исключение. Если вывод не совпадает, вызывается исключение [`DocTestFailure`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestFailure), содержащее тест, пример и фактический вывод.11671168Информацию о параметрах конструктора и методах см. в документации для [`DocTestRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner) в разделе [Advanced API](https://python-all.ru/3.13/library/doctest.html#doctest-advanced-api).11691170Экземпляры [`DebugRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DebugRunner) могут вызывать два исключения:11711172#### `exception doctest.DocTestFailure(test, example, got)`11731174Исключение, вызываемое [`DocTestRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner), чтобы указать, что фактический вывод примера доктеста не совпал с ожидаемым. Аргументы конструктора используются для инициализации одноименных атрибутов.11751176[`DocTestFailure`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestFailure) определяет следующие атрибуты:11771178#### `DocTestFailure.test`11791180Объект [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest), который выполнялся, когда пример завершился с ошибкой.11811182#### `DocTestFailure.example`11831184Неудавшийся [`Example`](https://python-all.ru/3.13/library/doctest.html#doctest.Example).11851186#### `DocTestFailure.got`11871188Фактический вывод примера.11891190#### `exception doctest.UnexpectedException(test, example, exc_info)`11911192Исключение, вызываемое [`DocTestRunner`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTestRunner), чтобы указать, что пример доктеста вызвал неожиданное исключение. Аргументы конструктора используются для инициализации одноименных атрибутов.11931194[`UnexpectedException`](https://python-all.ru/3.13/library/doctest.html#doctest.UnexpectedException) определяет следующие атрибуты:11951196#### `UnexpectedException.test`11971198Объект [`DocTest`](https://python-all.ru/3.13/library/doctest.html#doctest.DocTest), который выполнялся, когда пример завершился с ошибкой.11991200#### `UnexpectedException.example`12011202Неудавшийся [`Example`](https://python-all.ru/3.13/library/doctest.html#doctest.Example).12031204#### `UnexpectedException.exc_info`12051206Кортеж, содержащий информацию о неожиданном исключении, возвращаемый вызовом [`sys.exc_info()`](https://python-all.ru/3.13/library/sys.html#sys.exc_info).12071208## Soapbox12091210Как уже упоминалось во введении, у `doctest` появилось три основных назначения:121112121. Проверка примеров в docstrings.12132. Регрессионное тестирование.12143. Исполняемая документация / литературное тестирование.12151216Эти варианты использования предъявляют разные требования, и важно их различать. В частности, наполнение строк документации запутанными тестовыми примерами приводит к плохой документации.12171218При написании docstring'ов выбирайте примеры для них с осторожностью. Это целое искусство, которому нужно учиться, и поначалу оно может даваться нелегко. Примеры должны приносить реальную пользу документации. Хороший пример зачастую дорогого стоит. Если подойти к делу со всей тщательностью, примеры станут бесценными для пользователей и многократно окупят время, потраченное на их сбор, – годы спустя, когда всё меняется. Я до сих пор поражаюсь, как часто мои примеры `doctest` перестают работать после «безобидных» изменений.12191220Doctest также отлично подходит для регрессионного тестирования, особенно если не жалеть пояснительного текста. Чередуя прозу и примеры, гораздо легче отслеживать, что именно тестируется и почему. Когда тест падает, хороший текст помогает быстрее понять, в чём проблема и как её исправить. Конечно, можно писать развёрнутые комментарии в коде тестов, но мало кто это делает. Многие заметили, что использование doctest вместо этого приводит к гораздо более понятным тестам. Возможно, просто потому, что в doctest писать прозу немного легче, чем код, а писать комментарии в коде – немного сложнее. Но я думаю, дело не только в этом: естественный подход при написании теста на основе doctest – это желание объяснить тонкости своего программного обеспечения и проиллюстрировать их примерами. Это, в свою очередь, естественным образом приводит к тестовым файлам, которые начинаются с самых простых функций и логически переходят к осложнениям и крайним случаям. В результате получается связное повествование, а не набор разрозненных функций, тестирующих отдельные фрагменты функциональности, казалось бы, случайным образом. Это другой подход, и он даёт другие результаты, стирая грань между тестированием и объяснением.12211222Регрессионное тестирование лучше всего проводить в отдельных объектах или файлах. Есть несколько вариантов организации тестов:12231224- Создайте текстовые файлы, содержащие тестовые примеры в виде интерактивных примеров, и тестируйте эти файлы с помощью [`testfile()`](https://python-all.ru/3.13/library/doctest.html#doctest.testfile) или [`DocFileSuite()`](https://python-all.ru/3.13/library/doctest.html#doctest.DocFileSuite). Этот подход рекомендуется, хотя его проще всего применить для новых проектов, изначально спроектированных с использованием doctest.1225- Определите функции с именем `_regrtest_topic`, которые состоят из одной строки документации, содержащей тестовые примеры для указанных тем. Эти функции можно включить в тот же файл, что и модуль, или вынести в отдельный тестовый файл.1226- Определите словарь [`__test__`](https://python-all.ru/3.13/library/doctest.html#module.__test__), отображающий темы регрессионных тестов на docstrings, содержащие тестовые примеры.12271228Если вы поместили тесты в модуль, сам модуль может быть тестовым раннером. Когда тест падает, можно настроить раннер на повторный запуск только упавшего doctest'а, пока вы отлаживаете проблему. Вот минимальный пример такого тестового раннера:12291230```python1231if __name__ == '__main__':1232    import doctest1233    flags = doctest.REPORT_NDIFF|doctest.FAIL_FAST1234    if len(sys.argv) > 1:1235        name = sys.argv[1]1236        if name in globals():1237            obj = globals()[name]1238        else:1239            obj = __test__[name]1240        doctest.run_docstring_examples(obj, globals(), name=name,1241                                       optionflags=flags)1242    else:1243        fail, total = doctest.testmod(optionflags=flags)1244        print(f"{fail} failures out of {total} tests")1245```12461247Сноски12481249\[[1](https://python-all.ru/3.13/library/doctest.html#id1)\]12501251Примеры, содержащие как ожидаемый вывод, так и исключение, не поддерживаются. Попытка угадать, где заканчивается одно и начинается другое, слишком чревата ошибками и приводит к запутанным тестам.1252