doctest.md

1> **Источник:** https://python-all.ru/3.4/library/doctest.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 26.2. [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) – Тестирование интерактивных примеров Python89Модуль [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) ищет фрагменты текста, похожие на интерактивные сеансы Python, а затем выполняет эти сеансы, чтобы проверить, что они работают в точности так, как показано. Существует несколько распространённых способов использования doctest:1011- Чтобы проверить, что докстринги модуля актуальны, убедившись, что все интерактивные примеры по-прежнему работают как описано.12- Чтобы выполнить регрессионное тестирование, проверяя, что интерактивные примеры из тестового файла или тестового объекта работают как ожидается.13- Чтобы написать учебную документацию для пакета, обильно иллюстрированную примерами ввода-вывода. В зависимости от того, на чём делается акцент – на примерах или на пояснительном тексте, это напоминает «грамотное тестирование» (literate testing) или «исполняемую документацию» (executable documentation).1415Вот полный, но небольшой пример модуля:1617```python18"""19Это модуль "example".2021Модуль example предоставляет одну функцию, factorial(). Например,2223>>> factorial(5)2412025"""2627def factorial(n):28    """Возвращает факториал n – целое число >= 0.2930    >>> [factorial(n) for n in range(6)]31    [1, 1, 2, 6, 24, 120]32    >>> factorial(30)33    26525285981219105863630848000000034    >>> factorial(-1)35    Traceback (самый последний вызов последним):36        ...37    ValueError: n должно быть >= 03839    Факториалы чисел с плавающей точкой допустимы, но число должно быть точным целым:40    >>> factorial(30.1)41    Traceback (самый последний вызов последним):42        ...43    ValueError: n должно быть целым числом44    >>> factorial(30.0)45    2652528598121910586363084800000004647    Оно также не должно быть нелепо большим:48    >>> factorial(1e100)49    Traceback (самый последний вызов последним):50        ...51    OverflowError: n слишком велико52    """5354    import math55    if not n >= 0:56        raise ValueError("n must be >= 0")57    if math.floor(n) != n:58        raise ValueError("n must be exact integer")59    if n+1 == n:  # перехватить значение, например 1e30060        raise OverflowError("n too large")61    result = 162    factor = 263    while factor <= n:64        result *= factor65        factor += 166    return result6768if __name__ == "__main__":69    import doctest70    doctest.testmod()71```7273Если запустить `example.py` напрямую из командной строки, [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) делает своё дело:7475```python76$ python example.py77$78```7980Вывода нет! Это нормально, это означает, что все примеры сработали. Передайте `-v` скрипту, и [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) выведет подробный журнал того, что он пытается сделать, и в конце напечатает сводку:8182```python83$ python example.py -v84Trying:85    factorial(5)86Expecting:87    12088ok89Trying:90    [factorial(n) for n in range(6)]91Expecting:92    [1, 1, 2, 6, 24, 120]93ok94```9596И так далее, в конечном итоге завершаясь:9798```python99Trying:100    factorial(1e100)101Expecting:102    Traceback (most recent call last):103        ...104    OverflowError: n too large105ok1062 items passed all tests:107   1 tests in __main__108   8 tests in __main__.factorial1099 tests in 2 items.1109 passed and 0 failed.111Test passed.112$113```114115Это всё, что нужно знать, чтобы начать продуктивно использовать [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest)! Приступайте. В следующих разделах приведены полные подробности. Обратите внимание, что в стандартном наборе тестов и библиотеках Python много примеров doctest. Особенно полезные примеры можно найти в стандартном тестовом файле `Lib/test/test_doctest.py`.116117## 26.2.1. Простое использование: проверка примеров в строках документации118119Самый простой способ начать использовать doctest (но не обязательно тот, которым вы будете продолжать пользоваться) – это завершить каждый модуль `M` следующим образом:120121```python122if __name__ == "__main__":123    import doctest124    doctest.testmod()125```126127Затем [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) проверяет строки документации в модуле `M`.128129Запуск модуля как скрипта приводит к тому, что примеры в докстрингах выполняются и проверяются:130131```python132python M.py133```134135Это не выведет ничего, если только какой-нибудь пример не завершится ошибкой. В этом случае неудачные примеры и причины сбоев выводятся в stdout, а последняя строка вывода выглядит как `***Test Failed*** N failures.`, где *N* – количество примеров, завершившихся ошибкой.136137Вместо этого запустите его с флагом `-v`:138139```python140python M.py -v141```142143и подробный отчёт обо всех проверенных примерах выводится в стандартный вывод, а в конце – различные сводки.144145Можно принудительно включить подробный режим, передав `verbose=True` в [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod), или запретить его, передав `verbose=False`. В любом из этих случаев `sys.argv` не проверяется [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod) (поэтому передача `-v` или её отсутствие не имеет эффекта).146147Существует также сокращение в командной строке для запуска [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod). Можно указать интерпретатору Python запустить модуль doctest непосредственно из стандартной библиотеки и передать имена модулей в командной строке:148149```python150python -m doctest -v example.py151```152153Это импортирует `example.py` как самостоятельный модуль и запустит на нём [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod). Обратите внимание, что это может работать неправильно, если файл является частью пакета и импортирует другие подмодули из этого пакета.154155Дополнительную информацию о [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod) см. в разделе [*Basic API*](https://python-all.ru/3.4/library/doctest.html#doctest-basic-api).156157## 26.2.2. Простое использование: проверка примеров в текстовом файле158159Ещё одно простое применение doctest – тестирование интерактивных примеров в текстовом файле. Это можно сделать с помощью функции [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile):160161```python162import doctest163doctest.testfile("example.txt")164```165166Этот короткий скрипт выполняет и проверяет любые интерактивные примеры Python, содержащиеся в файле `example.txt`. Содержимое файла обрабатывается так, как если бы это была одна гигантская строка документации; файлу не нужно содержать программу на Python! Например, возможно, `example.txt` содержит следующее:167168```python169The ``example`` module170======================171172Using ``factorial``173-------------------174175This is an example text file in reStructuredText format.  First import176``factorial`` from the ``example`` module:177178    >>> from example import factorial179180Now use it:181182    >>> factorial(6)183    120184```185186Запуск `doctest.testfile("example.txt")` затем находит ошибку в этой документации:187188```python189File "./example.txt", line 14, in example.txt190Failed example:191    factorial(6)192Expected:193    120194Got:195    720196```197198Как и [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod), [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile) не будет ничего выводить, если пример не завершится сбоем. Если же пример завершается сбоем, то неудачные примеры и причины сбоев выводятся в stdout в том же формате, что и в [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod).199200По умолчанию [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile) ищет файлы в каталоге вызывающего модуля. Описание необязательных аргументов, которые можно использовать, чтобы указать ему искать файлы в других местах, см. в разделе [*Basic API*](https://python-all.ru/3.4/library/doctest.html#doctest-basic-api).201202Как и у [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod), степень подробности [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile) можно задать с помощью флага командной строки `-v` или необязательного ключевого аргумента *verbose*.203204Существует также сокращение в командной строке для запуска [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile). Можно указать интерпретатору Python запустить модуль doctest непосредственно из стандартной библиотеки и передать имена файлов в командной строке:205206```python207python -m doctest -v example.txt208```209210Поскольку имя файла не заканчивается на `.py`, [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) делает вывод, что его нужно запустить с помощью [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile), а не [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod).211212Дополнительную информацию о [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile) см. в разделе [*Basic API*](https://python-all.ru/3.4/library/doctest.html#doctest-basic-api).213214## 26.2.3. Как это работает215216В этом разделе подробно рассматривается, как работает doctest: какие docstrings он просматривает, как находит интерактивные примеры, какой контекст выполнения использует, как обрабатывает исключения и как опции могут управлять его поведением. Это информация, которую нужно знать для написания примеров doctest; сведения о непосредственном запуске doctest на этих примерах приведены в следующих разделах.217218### 26.2.3.1. Какие строки документации проверяются?219220Проверяются docstring модуля, а также docstrings всех функций, классов и методов. Объекты, импортированные в модуль, не проверяются.221222Кроме того, если `M.__test__` существует и "истинно", это должен быть словарь, и каждая запись сопоставляет (строковое) имя с объектом функции, объектом класса или строкой. Строки документации объектов функций и классов, найденные через `M.__test__`, ищутся, а строки обрабатываются так, как если бы они были строками документации. В выводе ключ `K` в `M.__test__` появляется с именем223224```python225<name of M>.__test__.K226```227228Любые найденные классы аналогично рекурсивно проверяются на наличие docstrings в содержащихся в них методах и вложенных классах.229230**Особенность реализации CPython:** До версии 3.4 модули расширения, написанные на C, не полностью просматривались doctest.231232### 26.2.3.2. Как распознаются примеры в строках документации?233234В большинстве случаев копирование и вставка сессии интерактивной консоли работает нормально, но doctest не пытается точно эмулировать какой-либо конкретный Python shell.235236```python237>>> # комментарии игнорируются238>>> x = 12239>>> x24012241>>> if x == 13:242...     print("yes")243... else:244...     print("no")245...     print("NO")246...     print("NO!!!")247...248no249NO250NO!!!251>>>252```253254Любой ожидаемый вывод должен сразу следовать за последней строкой `'>>> '` или `'... '`, содержащей код, и ожидаемый вывод (если есть) простирается до следующей строки `'>>> '` или строки, состоящей только из пробелов.255256Мелкий шрифт:257258- Ожидаемый вывод не может содержать строку, состоящую только из пробелов, поскольку такая строка воспринимается как сигнал конца ожидаемого вывода. Если ожидаемый вывод содержит пустую строку, поместите `<BLANKLINE>` в пример doctest в каждом месте, где ожидается пустая строка.259- Все символы табуляции заменяются пробелами с шагом табуляции в 8 столбцов. Табуляции в выводе, создаваемом тестируемым кодом, не изменяются. Поскольку любые символы табуляции в образцовом выводе *заменяются*, это означает, что если вывод кода содержит символы табуляции, единственный способ пройти doctest – это если активна опция [`NORMALIZE_WHITESPACE`](https://python-all.ru/3.4/library/doctest.html#doctest.NORMALIZE_WHITESPACE) или [*директива*](https://python-all.ru/3.4/library/doctest.html#doctest-directives). В качестве альтернативы тест можно переписать так, чтобы захватывать вывод и сравнивать его с ожидаемым значением в рамках теста. Эта обработка табуляции в исходном тексте была выработана методом проб и ошибок и оказалась наименее подверженным ошибкам способом их обработки. Можно использовать другой алгоритм обработки табуляции, написав пользовательский класс [`DocTestParser`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestParser).260- Вывод в stdout перехватывается, но не вывод в stderr (трассировки исключений перехватываются другим способом).261- Если вы продолжаете строку обратной косой чертой в интерактивной сессии или по любой другой причине используете обратную косую черту, следует использовать сырой docstring, который сохранит обратные косые черты точно в том виде, как вы их ввели:262263  ```python264  >>> def f(x):265  ...     r'''Обратная косая черта в сырой докстринге: m\n'''266  >>> print(f.__doc__)267  Backslashes in a raw docstring: m\n268  ```269270  В противном случае обратная косая черта будет интерпретироваться как часть строки. Например, `\n` выше будет интерпретироваться как символ новой строки. В качестве альтернативы можно удвоить каждую обратную косую черту в версии для doctest (и не использовать сырую строку):271272  ```python273  >>> def f(x):274  ...     '''Обратная косая черта в сырой докстринге: m\\n'''275  >>> print(f.__doc__)276  Backslashes in a raw docstring: m\n277  ```278- Начальный столбец не имеет значения:279280  ```python281  >>> assert "Easy!"282        >>> import math283            >>> math.floor(1.9)284            1285  ```286287  а также из ожидаемого вывода удаляется столько начальных пробельных символов, сколько их было в исходной строке `'>>> '`, с которой начинался пример.288289### 26.2.3.3. Что такое контекст выполнения?290291По умолчанию каждый раз, когда [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) находит докстринг для тестирования, он использует *поверхностную копию* глобальных переменных `M`, чтобы запуск тестов не изменял реальные глобальные переменные модуля, и чтобы один тест в `M` не мог оставить следы, которые случайно позволили бы другому тесту сработать. Это означает, что примеры могут свободно использовать любые имена, определённые на верхнем уровне в `M`, и имена, определённые ранее в выполняемом докстринге. Примеры не могут видеть имена, определённые в других докстрингах.292293Можно принудительно использовать собственный словарь в качестве контекста выполнения, передав `globs=your_dict` в [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod) или [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile).294295### 26.2.3.4. А что насчёт исключений?296297Никаких проблем, при условии, что трассировка – единственный вывод, выдаваемый примером: просто вставьте трассировку. [\[1\]](https://python-all.ru/3.4/library/doctest.html#id2) Поскольку трассировки содержат детали, которые могут быстро меняться (например, точные пути к файлам и номера строк), это тот случай, когда doctest старается быть гибким в том, что он принимает.298299Простой пример:300301```python302>>> [1, 2, 3].remove(42)303Traceback (most recent call last):304  File "<stdin>", line 1, in ?305ValueError: list.remove(x): x not in list306```307308Этот doctest завершается успешно, если возбуждается [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError), с сообщением `list.remove(x): x not in list`, как показано.309310Ожидаемый вывод для исключения должен начинаться с заголовка трассировки, которым может быть одна из следующих двух строк, с отступом, совпадающим с первой строкой примера:311312```python313Traceback (most recent call last):314Traceback (innermost last):315```316317За заголовком трассировки следует необязательный стек трассировки, содержимое которого игнорируется doctest. Стек трассировки обычно опускается или копируется дословно из интерактивного сеанса.318319За стеком трассировки следует самая интересная часть: строка(и), содержащие тип исключения и его описание. Обычно это последняя строка трассировки, но может занимать несколько строк, если у исключения многострочное описание:320321```python322>>> raise ValueError('multi\n    line\ndetail')323Traceback (most recent call last):324  File "<stdin>", line 1, in ?325ValueError: multi326    line327detail328```329330Последние три строки (начиная с [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError)) сравниваются с типом и сообщением исключения, а остальные игнорируются.331332Лучшая практика – опускать стек трассировки, если он не добавляет существенной документационной ценности примеру. Так что последний пример, вероятно, лучше оформить так:333334```python335>>> raise ValueError('multi\n    line\ndetail')336Traceback (most recent call last):337    ...338ValueError: multi339    line340detail341```342343Обратите внимание, что трассировки обрабатываются особым образом. В частности, в переписанном примере использование `...` не зависит от опции [`ELLIPSIS`](https://python-all.ru/3.4/library/doctest.html#doctest.ELLIPSIS) модуля doctest. Многоточие в этом примере можно опустить или заменить тремя (или тремястами) запятыми, цифрами или даже отформатированной стенограммой скетча Монти Пайтона.344345Некоторые детали, которые стоит прочитать один раз, но запоминать не обязательно:346347- Doctest не может угадать, взялся ли ожидаемый вывод из трассировки исключения или из обычной печати. Так, например, пример, ожидающий `ValueError: 42 является простым числом` будет пройден, независимо от того, действительно ли возбуждено [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError) или пример просто печатает этот текст трассировки. На практике обычный вывод редко начинается со строки заголовка трассировки, так что это не создаёт реальных проблем.348- Каждая строка стека трассировки (если присутствует) должна иметь отступ больше, чем первая строка примера, *или* начинаться с небуквенно-цифрового символа. Первая строка после заголовка трассировки с таким же отступом и начинающаяся с буквенно-цифрового символа считается началом описания исключения. Конечно, это корректно работает для настоящих трассировок.349- Если указана опция doctest [`IGNORE_EXCEPTION_DETAIL`](https://python-all.ru/3.4/library/doctest.html#doctest.IGNORE_EXCEPTION_DETAIL), то игнорируется всё, что следует за самой левой двоеточием, а также любая информация о модуле в имени исключения.350- Интерактивная оболочка опускает строку заголовка трассировки для некоторых [`SyntaxError`](https://python-all.ru/3.4/library/exceptions.html#SyntaxError). Но doctest использует строку заголовка трассировки, чтобы отличать исключения от не-исключений. Поэтому в редком случае, когда нужно протестировать [`SyntaxError`](https://python-all.ru/3.4/library/exceptions.html#SyntaxError), в котором отсутствует заголовок трассировки, потребуется вручную добавить строку заголовка трассировки в тестовый пример.351- Для некоторых [`SyntaxError`](https://python-all.ru/3.4/library/exceptions.html#SyntaxError) Python отображает позицию символа синтаксической ошибки, используя маркер `^`:352353  ```python354  >>> 1 1355    File "<stdin>", line 1356      1 1357        ^358  SyntaxError: invalid syntax359  ```360361  Поскольку строки, показывающие положение ошибки, идут до типа и описания исключения, они не проверяются doctest. Например, следующий тест будет пройден, даже если `^`-маркер поставлен в неверное место:362363  ```python364  >>> 1 1365    File "<stdin>", line 1366      1 1367      ^368  SyntaxError: invalid syntax369  ```370371### 26.2.3.5. Флаги опций372373Ряд флагов опций управляют различными аспектами поведения doctest. Символические имена флагов предоставляются как константы модуля, которые можно объединять побитовым ИЛИ и передавать различным функциям. Эти имена также можно использовать в [*директивах doctest*](https://python-all.ru/3.4/library/doctest.html#doctest-directives), и их можно передавать интерфейсу командной строки doctest через опцию `-o`.374375Новое в версии 3.4: Опция командной строки `-o`.376377Первая группа опций определяет семантику тестов, управляя аспектами того, как doctest решает, соответствует ли фактический вывод ожидаемому выводу примера:378379#### `doctest.DONT_ACCEPT_TRUE_FOR_1`380381По умолчанию, если блок ожидаемого вывода содержит просто `1`, блок фактического вывода, содержащий просто `1` или просто `True`, считается совпадением, и аналогично для `0` по сравнению с `False`. Когда указан [`DONT_ACCEPT_TRUE_FOR_1`](https://python-all.ru/3.4/library/doctest.html#doctest.DONT_ACCEPT_TRUE_FOR_1), ни одна из замен не допускается. Поведение по умолчанию учитывает, что Python изменил тип возвращаемого значения многих функций с целого числа на булев; doctests, ожидающие вывод «маленького целого», всё ещё работают в этих случаях. Эта опция, вероятно, исчезнет, но не в ближайшие годы.382383#### `doctest.DONT_ACCEPT_BLANKLINE`384385По умолчанию, если блок ожидаемого вывода содержит строку, содержащую только строку `<BLANKLINE>`, то эта строка будет соответствовать пустой строке в фактическом выводе. Поскольку настоящая пустая строка разделяет ожидаемый вывод, это единственный способ указать, что ожидается пустая строка. Когда указан [`DONT_ACCEPT_BLANKLINE`](https://python-all.ru/3.4/library/doctest.html#doctest.DONT_ACCEPT_BLANKLINE), эта замена не допускается.386387#### `doctest.NORMALIZE_WHITESPACE`388389Если указано, все последовательности пробельных символов (пробелы и новые строки) считаются равными. Любая последовательность пробельных символов в ожидаемом выводе будет соответствовать любой последовательности пробельных символов в фактическом выводе. По умолчанию пробельные символы должны совпадать в точности. [`NORMALIZE_WHITESPACE`](https://python-all.ru/3.4/library/doctest.html#doctest.NORMALIZE_WHITESPACE) особенно полезен, когда строка ожидаемого вывода очень длинная, и вы хотите перенести её на несколько строк в исходном коде.390391#### `doctest.ELLIPSIS`392393Когда указано, маркер многоточия (`...`) в ожидаемом выводе может соответствовать любой подстроке в фактическом выводе. Это включает подстроки, выходящие за границы строк, и пустые подстроки, поэтому лучше использовать эту возможность просто. Сложное использование может привести к тем же сюрпризам «ой, совпало слишком много!», к которым склонен `.*` в регулярных выражениях.394395#### `doctest.IGNORE_EXCEPTION_DETAIL`396397Если указано, пример, который ожидает исключение, проходит, если возбуждается исключение ожидаемого типа, даже если сообщение исключения не совпадает. Например, пример, ожидающий `ValueError: 42`, будет пройден, если фактически возбуждённое исключение – `ValueError: 3*14`, но не пройдёт, если, например, возбуждён [`TypeError`](https://python-all.ru/3.4/library/exceptions.html#TypeError).398399Этот флаг также игнорирует имя модуля, которое используется в отчётах doctest в Python 3. Поэтому оба следующих варианта будут работать с указанным флагом независимо от того, выполняется ли тест под Python 2.7 или Python 3.2 (или более поздними версиями):400401```python402>>> raise CustomError('message')403Traceback (most recent call last):404CustomError: message405406>>> raise CustomError('message')407Traceback (most recent call last):408my_module.CustomError: message409```410411Обратите внимание, что [`ELLIPSIS`](https://python-all.ru/3.4/library/doctest.html#doctest.ELLIPSIS) также можно использовать для игнорирования деталей сообщения об исключении, но такой тест может всё равно не пройти из-за того, печатаются ли сведения о модуле как часть имени исключения. Использование [`IGNORE_EXCEPTION_DETAIL`](https://python-all.ru/3.4/library/doctest.html#doctest.IGNORE_EXCEPTION_DETAIL) вместе со сведениями из Python 2.3 является также единственным понятным способом написать doctest, которому не важно сообщение исключения, но который продолжает проходить под Python 2.3 или более ранними версиями (эти выпуски не поддерживают [*директивы doctest*](https://python-all.ru/3.4/library/doctest.html#doctest-directives) и игнорируют их как нерелевантные комментарии). Например:412413```python414>>> (1, 2)[3] = 'moo'415Traceback (most recent call last):416  File "<stdin>", line 1, in ?417TypeError: object doesn't support item assignment418```419420проходит в Python 2.3 и более поздних версиях Python с указанным флагом, хотя в Python 2.4 описание изменилось c «doesn’t» на «does not».421422Изменено в версии 3.2: [`IGNORE_EXCEPTION_DETAIL`](https://python-all.ru/3.4/library/doctest.html#doctest.IGNORE_EXCEPTION_DETAIL) теперь также игнорирует любую информацию, относящуюся к модулю, содержащему тестируемое исключение.423424#### `doctest.SKIP`425426Если этот флаг указан, пример не выполняется вообще. Это может быть полезно в ситуациях,\\nкогда доктесты служат одновременно документацией и тестовыми примерами, и пример\\nдолжен быть включён для документации, но не должен проверяться. Например, вывод\\nпримера может быть случайным, или пример может зависеть от ресурсов,\\nнедоступных для тестового драйвера.427428Флаг SKIP также можно использовать для временного «закомментирования» примеров.429430#### `doctest.COMPARISON_FLAGS`431432Битовая маска, объединяющая все перечисленные выше флаги сравнения.433434Вторая группа опций управляет тем, как сообщается о неудачных тестах:435436#### `doctest.REPORT_UDIFF`437438Если указан, ошибки, включающие многострочные ожидаемый и фактический вывод, отображаются в виде unified diff.439440#### `doctest.REPORT_CDIFF`441442Если указан, ошибки, включающие многострочные ожидаемый и фактический вывод, отображаются в виде context diff.443444#### `doctest.REPORT_NDIFF`445446Если указано, различия вычисляются с помощью `difflib.Differ`, используя тот же алгоритм, что и популярная утилита `ndiff.py`. Это единственный метод, который отмечает различия как внутри строк, так и между строками. Например, если строка ожидаемого вывода содержит цифру `1`, а фактический вывод содержит букву `l`, вставляется строка с символом «^», отмечающим несовпадающие позиции столбцов.447448#### `doctest.REPORT_ONLY_FIRST_FAILURE`449450Если указано, отображается первый завершившийся с ошибкой пример в каждом doctest, но вывод для всех остальных примеров подавляется. Это предотвращает сообщение doctest о корректных примерах, которые стали неверными из-за предыдущих ошибок; однако это может также скрыть некорректные примеры, которые падают независимо от первой ошибки. Когда указано [`REPORT_ONLY_FIRST_FAILURE`](https://python-all.ru/3.4/library/doctest.html#doctest.REPORT_ONLY_FIRST_FAILURE), остальные примеры по-прежнему выполняются и учитываются в общем числе сообщенных ошибок; подавляется только вывод.451452#### `doctest.FAIL_FAST`453454Если указан, завершить работу после первого упавшего примера и не пытаться\\nвыполнять остальные. Таким образом, количество сообщённых ошибок будет не более\\n1. Этот флаг может быть полезен при отладке, так как примеры после первой\\nошибки даже не будут генерировать отладочный вывод.455456Командная строка doctest принимает опцию `-f` как сокращение для `-o FAIL_FAST`.457458Новое в версии 3.4.459460#### `doctest.REPORTING_FLAGS`461462Битовая маска, объединяющая все перечисленные выше флаги отчёта.463464Существует также способ регистрации новых имен опциональных флагов, хотя это имеет смысл только при расширении внутренней реализации [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) с помощью подклассов:465466#### `doctest.register_optionflag(name)`467468Создает новый опциональный флаг с заданным именем и возвращает целочисленное значение нового флага. [`register_optionflag()`](https://python-all.ru/3.4/library/doctest.html#doctest.register_optionflag) можно использовать при создании подклассов [`OutputChecker`](https://python-all.ru/3.4/library/doctest.html#doctest.OutputChecker) или [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner) для создания новых опций, поддерживаемых своими подклассами. [`register_optionflag()`](https://python-all.ru/3.4/library/doctest.html#doctest.register_optionflag) всегда следует вызывать, используя следующую идиому:469470```python471MY_FLAG = register_optionflag('MY_FLAG')472```473474### 26.2.3.6. Директивы475476Директивы доктестов могут использоваться для изменения [*флагов опций*](https://python-all.ru/3.4/library/doctest.html#doctest-options) для отдельного примера. Директивы доктестов – это\\nспециальные комментарии Python, следующие за исходным кодом примера:477478```479480directive             ::=  "#" "doctest:" directive_options481directive_options     ::=  directive_option ("," directive_option)\*482directive_option      ::=  on_or_off directive_option_name483on_or_off             ::=  "+" \| "-"484directive_option_name ::=  "DONT_ACCEPT_BLANKLINE" \| "NORMALIZE_WHITESPACE" \| ...485```486487Пробелы не допускаются между `+` или `-` и именем опции\\nдирективы. Имя опции директивы может быть любым из имён флагов опций,\\nописанных выше.488489Директивы доктестов примера изменяют поведение doctest только для этого\\nодного примера. Используйте `+` для включения указанного поведения или\\n`-` для его отключения.490491Например, этот тест проходит:492493```python494>>> print(list(range(20))) # doctest: +NORMALIZE_WHITESPACE495[0,   1,  2,  3,  4,  5,  6,  7,  8,  9,49610,  11, 12, 13, 14, 15, 16, 17, 18, 19]497```498499Без директивы он бы не прошёл, и потому что в фактическом выводе нет\\nдвух пробелов перед элементами списка из одной цифры, и потому что фактический вывод\\nнаходится на одной строке. Этот тест тоже проходит и тоже требует директивы\\nдля этого:500501```python502>>> print(list(range(20))) # doctest: +ELLIPSIS503[0, 1, ..., 18, 19]504```505506На одной физической строке можно использовать несколько директив, разделённых запятыми:507508```python509>>> print(list(range(20))) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE510[0,    1, ...,   18,    19]511```512513Если для одного примера используется несколько директив-комментариев, то они объединяются:514515```python516>>> print(list(range(20))) # doctest: +ELLIPSIS517...                        # doctest: +NORMALIZE_WHITESPACE518[0,    1, ...,   18,    19]519```520521Как показано в предыдущем примере, можно добавлять строки `...` в пример, содержащие только директивы. Это может быть полезно, когда пример слишком длинный, чтобы директива удобно поместилась на той же строке:522523```python524>>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40)))525... # doctest: +ELLIPSIS526[0, ..., 4, 10, ..., 19, 30, ..., 39]527```528529Обратите внимание: поскольку все опции по умолчанию отключены, а директивы применяются только к тому примеру, в котором они находятся, включение опций (через `+` в директиве) обычно является единственным осмысленным выбором. Однако флаги опций также могут передаваться функциям, запускающим доктесты, устанавливая другие значения по умолчанию. В таких случаях отключение опции через `-` в директиве может быть полезным.530531### 26.2.3.7. Предупреждения532533[`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) очень строг в отношении точного совпадения ожидаемого вывода. Если не совпадает хотя бы один символ, тест считается проваленным. В процессе изучения того, что именно Python гарантирует, а что нет в отношении вывода, это может несколько раз удивить. Например, при выводе словаря Python не гарантирует, что пары ключ-значение будут выведены в каком-то определенном порядке, поэтому такой тест534535```python536>>> foo()537{"Hermione": "hippogryph", "Harry": "broomstick"}538```539540является уязвимым! Один из способов обойти это – сделать541542```python543>>> foo() == {"Hermione": "hippogryph", "Harry": "broomstick"}544True545```546547вместо этого. Другой способ – сделать548549```python550>>> d = sorted(foo().items())551>>> d552[('Harry', 'broomstick'), ('Hermione', 'hippogryph')]553```554555Есть и другие, но идея понятна.556557Ещё одна плохая идея – печатать то, что содержит адрес объекта, например558559```python560>>> id(1.0) # обязательно иногда будет ошибаться5617948648562>>> class C: pass563>>> C()   # стандартный repr() для экземпляров содержит адрес564<__main__.C instance at 0x00AC18F0>565```566567Директива [`ELLIPSIS`](https://python-all.ru/3.4/library/doctest.html#doctest.ELLIPSIS) дает хороший подход для последнего примера:568569```python570>>> C() #doctest: +ELLIPSIS571<__main__.C instance at 0x...>572```573574Числа с плавающей запятой также подвержены небольшим различиям в выводе на разных платформах, поскольку Python полагается на системную библиотеку C для форматирования чисел с плавающей запятой, а качество библиотек C сильно различается.575576```python577>>> 1./7  # рискованно5780.14285714285714285579>>> print(1./7) # безопаснее5800.142857142857581>>> print(round(1./7, 6)) # гораздо безопаснее5820.142857583```584585Числа вида `I/2.**J` безопасны на всех платформах, и примеры для doctest часто намеренно составляются так, чтобы получались числа такой формы:586587```python588>>> 3./4  # абсолютно безопасно5890.75590```591592Простые дроби также легче понимаются людьми, что улучшает документацию.593594## 26.2.4. Базовый API595596Функции [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod) и [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile) предоставляют простой интерфейс к doctest, которого должно быть достаточно для большинства базовых применений. Для менее формального введения в эти две функции см. разделы [*Простое использование: проверка примеров в docstrings*](https://python-all.ru/3.4/library/doctest.html#doctest-simple-testmod) и [*Простое использование: проверка примеров в текстовом файле*](https://python-all.ru/3.4/library/doctest.html#doctest-simple-testfile).597598#### `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)`599600Все аргументы, кроме *filename*, являются необязательными и должны указываться в форме ключевых слов.601602Тестирует примеры в файле с именем *filename*. Возвращает `(failure_count, test_count)`.603604Необязательный аргумент *module\_relative* определяет, как следует интерпретировать имя файла:605606- Если *module\_relative* равен `True` (по умолчанию), то *filename* задает независимый от ОС путь, относительный модуля. По умолчанию этот путь относителен каталога вызывающего модуля; но если указан аргумент *package*, то путь относителен этого пакета. Для обеспечения независимости от ОС в *filename* следует использовать символ `/` для разделения сегментов пути, и он не может быть абсолютным путем (т.е. не должен начинаться с `/`).607- Если *module\_relative* равен `False`, то *filename* задает путь, зависящий от ОС. Путь может быть абсолютным или относительным; относительные пути разрешаются относительно текущего рабочего каталога.608609Необязательный аргумент *name* задает имя теста; по умолчанию или если `None`, используется `os.path.basename(filename)`.610611Необязательный аргумент *package* – это пакет Python или имя пакета Python, чей каталог должен использоваться как базовый каталог для имени файла, относительного модуля. Если пакет не указан, то в качестве базового каталога для имен файлов, относительных модуля, используется каталог вызывающего модуля. Указывать *package*, если *module\_relative* равно `False`, является ошибкой.612613Необязательный аргумент *globs* задает словарь, используемый в качестве глобальных переменных при выполнении примеров. Для doctest создается новая поверхностная копия этого словаря, так что примеры начинают с чистого листа. По умолчанию или если `None`, используется новый пустой словарь.614615Необязательный аргумент *extraglobs* задает словарь, объединяемый с глобальными переменными, используемыми для выполнения примеров. Это работает как [`dict.update()`](https://python-all.ru/3.4/library/stdtypes.html#dict.update): если *globs* и *extraglobs* имеют общий ключ, соответствующее значение из *extraglobs* появляется в объединенном словаре. По умолчанию или если `None`, дополнительные глобальные переменные не используются. Это расширенная возможность, позволяющая параметризацию doctest. Например, doctest может быть написан для базового класса с использованием обобщенного имени класса, а затем повторно использован для тестирования любого количества подклассов путем передачи словаря *extraglobs*, отображающего обобщенное имя на тестируемый подкласс.616617Необязательный аргумент *verbose* выводит много информации, если равен true, и только ошибки, если false; по умолчанию или если `None`, он равен true тогда и только тогда, когда `'-v'` присутствует в `sys.argv`.618619Необязательный аргумент *report*: если истина, выводит сводку в конце, иначе ничего не выводит. В подробном режиме сводка подробная, в противном случае – очень краткая (фактически пустая, если все тесты пройдены).620621Необязательный аргумент *optionflags* (значение по умолчанию 0) принимает побитовое ИЛИ опциональных флагов. См. раздел [*Опциональные флаги*](https://python-all.ru/3.4/library/doctest.html#doctest-options).622623Необязательный аргумент *raise\_on\_error* по умолчанию равен false. Если true, при первой ошибке или неожиданном исключении в примере выбрасывается исключение. Это позволяет выполнять посмертную отладку ошибок. Поведение по умолчанию – продолжать выполнение примеров.624625Необязательный аргумент *parser* задает [`DocTestParser`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestParser) (или подкласс), который следует использовать для извлечения тестов из файлов. По умолчанию используется обычный парсер (т.е. `DocTestParser()`).626627Необязательный аргумент *encoding* задаёт кодировку, которая должна использоваться для преобразования файла в Unicode.628629#### `doctest.testmod(m=None, name=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, exclude_empty=False)`630631Все аргументы необязательны, и все, кроме *m*, должны передаваться как именованные.632633Тестирует примеры в docstrings функций и классов, доступных из модуля *m* (или модуля [`__main__`](https://python-all.ru/3.4/library/__main__.html#module-__main__), если *m* не указан или равен `None`), начиная с `m.__doc__`.634635Также тестирует примеры, доступные из словаря `m.__test__`, если он существует и не равен `None`. `m.__test__` отображает имена (строки) на функции, классы и строки; docstrings функций и классов проверяются на наличие примеров; строки проверяются напрямую, как если бы они были docstrings.636637Проверяются только строки документации, прикреплённые к объектам, принадлежащим модулю *m*.638639Возвращает `(failure_count, test_count)`.640641Необязательный аргумент *name* задает имя модуля; по умолчанию или если `None`, используется `m.__name__`.642643Необязательный аргумент *exclude\_empty* по умолчанию равен false. Если true, объекты, для которых не найдено ни одного doctest, исключаются из рассмотрения. Значение по умолчанию – это хак для обратной совместимости, чтобы код, все еще использующий `doctest.master.summarize()` вместе с [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod), продолжал получать вывод для объектов без тестов. Аргумент *exclude\_empty* конструктора более нового [`DocTestFinder`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestFinder) по умолчанию равен true.644645Необязательные аргументы *extraglobs*, *verbose*, *report*, *optionflags*, *raise\_on\_error* и *globs* аналогичны таковым для функции [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile) выше, за исключением того, что *globs* по умолчанию равен `m.__dict__`.646647#### `doctest.run_docstring_examples(f, globs, verbose=False, name="NoName", compileflags=None, optionflags=0)`648649Тестирует примеры, связанные с объектом *f*; например, *f* может быть строкой, модулем, функцией или объектом класса.650651Для контекста выполнения используется поверхностная копия словаря *globs*.652653Необязательный аргумент *name* используется в сообщениях об ошибках и по умолчанию равен `"NoName"`.654655Если необязательный аргумент *verbose* равен true, вывод создаётся, даже если нет ошибок. По умолчанию вывод создаётся только в случае ошибки в примере.656657Необязательный аргумент *compileflags* задаёт набор флагов, которые должен использовать компилятор Python при выполнении примеров. По умолчанию или если `None`, флаги выводятся на основе набора будущих возможностей, обнаруженных в *globs*.658659Необязательный аргумент *optionflags* работает так же, как для функции [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile) выше.660661## 26.2.5. API для unittest662663По мере роста вашей коллекции модулей с doctest, вам понадобится способ систематически запускать все их doctest. [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) предоставляет две функции, которые можно использовать для создания тестовых наборов [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest) из модулей и текстовых файлов, содержащих doctest. Чтобы интегрироваться с обнаружением тестов [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest), включите функцию `load_tests()` в ваш тестовый модуль:664665```python666import unittest667import doctest668import my_module_with_doctests669670def load_tests(loader, tests, ignore):671    tests.addTests(doctest.DocTestSuite(my_module_with_doctests))672    return tests673```674675Существует две основные функции для создания экземпляров [`unittest.TestSuite`](https://python-all.ru/3.4/library/unittest.html#unittest.TestSuite) на основе текстовых файлов и модулей с doctest:676677#### `doctest.DocFileSuite(*paths, module_relative=True, package=None, setUp=None, tearDown=None, globs=None, optionflags=0, parser=DocTestParser(), encoding=None)`678679Преобразует тесты doctest из одного или нескольких текстовых файлов в [`unittest.TestSuite`](https://python-all.ru/3.4/library/unittest.html#unittest.TestSuite).680681Возвращаемый [`unittest.TestSuite`](https://python-all.ru/3.4/library/unittest.html#unittest.TestSuite) должен выполняться фреймворком unittest и запускает интерактивные примеры в каждом файле. Если пример в каком-либо файле не срабатывает, то созданный тест модуля завершается неудачей, и возникает исключение `failureException` с указанием имени файла, содержащего тест, и (иногда приблизительным) номером строки.682683Передаётся один или несколько путей (в виде строк) к текстовым файлам для проверки.684685Параметры могут быть указаны в виде именованных аргументов:686687Необязательный аргумент *module\_relative* определяет, как должны интерпретироваться имена файлов в *paths*:688689- Если *module\_relative* равно `True` (по умолчанию), то каждое имя файла в *paths* задаёт независимый от ОС путь относительно модуля. По умолчанию этот путь относителен к каталогу вызывающего модуля; но если указан аргумент *package*, то он относителен к этому пакету. Чтобы гарантировать независимость от ОС, каждое имя файла должно использовать символы `/` для разделения сегментов пути и не должно быть абсолютным путём (т.е. не должно начинаться с `/`).690- Если *module\_relative* равно `False`, то каждое имя файла в *paths* задаёт путь, зависящий от ОС. Путь может быть абсолютным или относительным; относительные пути разрешаются относительно текущего рабочего каталога.691692Необязательный аргумент *package* – это пакет Python или имя пакета Python, каталог которого должен использоваться как базовый каталог для имён файлов, относительных модуля, в *paths*. Если пакет не указан, то в качестве базового каталога для имён файлов, относительных модуля, используется каталог вызывающего модуля. Указывать *package*, если *module\_relative* равно `False`, является ошибкой.693694Необязательный аргумент *setUp* задаёт функцию настройки для тестового набора. Она вызывается перед запуском тестов в каждом файле. Функции *setUp* будет передан объект [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest). Функция setUp может получить доступ к глобальным переменным теста через атрибут *globs* переданного теста.695696Необязательный аргумент *tearDown* задаёт функцию завершения для тестового набора. Она вызывается после запуска тестов в каждом файле. Функции *tearDown* будет передан объект [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest). Функция setUp может получить доступ к глобальным переменным теста через атрибут *globs* переданного теста.697698Необязательный аргумент *globs* – это словарь, содержащий начальные глобальные переменные для тестов. Для каждого теста создаётся новая копия этого словаря. По умолчанию *globs* – новый пустой словарь.699700Необязательный аргумент *optionflags* задаёт стандартные параметры doctest для тестов, создаваемые путём объединения отдельных флагов опций (логическим ИЛИ). См. раздел [*Option Flags*](https://python-all.ru/3.4/library/doctest.html#doctest-options). См. функцию [`set_unittest_reportflags()`](https://python-all.ru/3.4/library/doctest.html#doctest.set_unittest_reportflags) ниже для лучшего способа задания параметров отчёта.701702Необязательный аргумент *parser* задаёт объект [`DocTestParser`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestParser) (или подкласс), который следует использовать для извлечения тестов из файлов. По умолчанию используется обычный анализатор (т.е. `DocTestParser()`).703704Необязательный аргумент *encoding* задаёт кодировку, которая должна использоваться для преобразования файла в Unicode.705706Глобальная переменная `__file__` добавляется в область глобальных переменных, передаваемых doctest, загруженному из текстового файла с помощью [`DocFileSuite()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocFileSuite).707708#### `doctest.DocTestSuite(module=None, globs=None, extraglobs=None, test_finder=None, setUp=None, tearDown=None, checker=None)`709710Преобразует тесты doctest для модуля в [`unittest.TestSuite`](https://python-all.ru/3.4/library/unittest.html#unittest.TestSuite).711712Возвращаемый [`unittest.TestSuite`](https://python-all.ru/3.4/library/unittest.html#unittest.TestSuite) должен выполняться фреймворком unittest и запускает каждый doctest в модуле. Если какой-либо из doctest завершится неудачей, то созданный модульный тест завершается неудачей, и возникает исключение `failureException` с указанием имени файла, содержащего тест, и (иногда приблизительным) номером строки.713714Необязательный аргумент *module* задаёт тестируемый модуль. Это может быть объект модуля или (возможно, с точками) имя модуля. Если он не указан, используется модуль, из которого вызывается эта функция.715716Необязательный аргумент *globs* – это словарь, содержащий начальные глобальные переменные для тестов. Для каждого теста создаётся новая копия этого словаря. По умолчанию *globs* – новый пустой словарь.717718Необязательный аргумент *extraglobs* задаёт дополнительный набор глобальных переменных, который объединяется с *globs*. По умолчанию дополнительные глобальные переменные не используются.719720Необязательный аргумент *test\_finder* – это объект [`DocTestFinder`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestFinder) (или его полноценная замена), который извлекает doctest из модуля.721722Необязательные аргументы *setUp*, *tearDown* и *optionflags* аналогичны одноимённым аргументам функции [`DocFileSuite()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocFileSuite) выше.723724Эта функция использует тот же метод поиска, что и [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod).725726> **Примечание**727>728> В отличие от [`testmod()`](https://python-all.ru/3.4/library/doctest.html#doctest.testmod) и [`DocTestFinder`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestFinder), эта функция вызывает [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError), если *module* не содержит строк документации. Эту ошибку можно предотвратить, передав экземпляр [`DocTestFinder`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestFinder) в качестве аргумента *test\_finder* с его именованным аргументом *exclude\_empty*, установленным в `False`:729>730> ```python731> >>> finder = doctest.DocTestFinder(exclude_empty=False)732> >>> suite = doctest.DocTestSuite(test_finder=finder)733> ```734735Внутренне [`DocTestSuite()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestSuite) создаёт [`unittest.TestSuite`](https://python-all.ru/3.4/library/unittest.html#unittest.TestSuite) из экземпляров `doctest.DocTestCase`, а `DocTestCase` является подклассом [`unittest.TestCase`](https://python-all.ru/3.4/library/unittest.html#unittest.TestCase). `DocTestCase` не документирован здесь (это внутренняя деталь), но изучение его кода может ответить на вопросы о точных деталях интеграции с [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest).736737Аналогично, [`DocFileSuite()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocFileSuite) создаёт [`unittest.TestSuite`](https://python-all.ru/3.4/library/unittest.html#unittest.TestSuite) из экземпляров `doctest.DocFileCase`, а `DocFileCase` является подклассом `DocTestCase`.738739Таким образом, оба способа создания [`unittest.TestSuite`](https://python-all.ru/3.4/library/unittest.html#unittest.TestSuite) запускают экземпляры `DocTestCase`. Это важно по тонкой причине: когда вы запускаете функции [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) самостоятельно, вы можете напрямую управлять используемыми опциями [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest), передавая флаги опций функциям [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest). Однако, если вы пишете фреймворк [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest), [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest) в конечном счёте управляет тем, когда и как запускаются тесты. Автор фреймворка обычно хочет управлять параметрами отчёта [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) (возможно, например, указанными через параметры командной строки), но нет способа передать параметры через [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest) программам запуска тестов [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest).740741По этой причине [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) также поддерживает понятие флагов отчёта [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest), специфичных для поддержки [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest), с помощью этой функции:742743#### `doctest.set_unittest_reportflags(flags)`744745Устанавливает используемые флаги отчёта [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest).746747Аргумент *flags* принимает побитовое ИЛИ флагов опций. См. раздел [*Option Flags*](https://python-all.ru/3.4/library/doctest.html#doctest-options). Можно использовать только «флаги отчёта».748749Это глобальная настройка модуля, которая влияет на все будущие doctest, запускаемые модулем [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest): метод `runTest()` класса `DocTestCase` смотрит на флаги опций, указанные для тестового случая при создании экземпляра `DocTestCase`. Если флаги отчётности не были указаны (что является типичным и ожидаемым случаем), флаги отчётности [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest) объединяются по ИЛИ с флагами опций, и дополненные таким образом флаги опций передаются экземпляру [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner), созданному для выполнения doctest. Если при создании экземпляра `DocTestCase` были указаны какие-либо флаги отчётности, флаги отчётности [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest) игнорируются.750751Функция возвращает значение флагов отчётности [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest), действовавших до её вызова.752753## 26.2.6. Расширенный API754755Базовый API – это простая обёртка, предназначенная для упрощения использования doctest. Он достаточно гибок и должен удовлетворять потребности большинства пользователей; однако, если требуется более детальный контроль над тестированием или расширение возможностей doctest, следует использовать расширенный API.756757Расширенный API строится вокруг двух классов-контейнеров, которые используются для хранения интерактивных примеров, извлечённых из тестовых сценариев doctest:758759- [`Example`](https://python-all.ru/3.4/library/doctest.html#doctest.Example): одна инструкция [*statement*](https://python-all.ru/3.4/glossary.html#term-statement) на языке Python в паре с ожидаемым выводом.760- [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest): набор объектов [`Example`](https://python-all.ru/3.4/library/doctest.html#doctest.Example), обычно извлекаемый из одной строки документации или текстового файла.761762Для поиска, разбора, выполнения и проверки примеров doctest определены дополнительные классы обработки:763764- [`DocTestFinder`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestFinder): находит все строки документации в заданном модуле и использует [`DocTestParser`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestParser) для создания [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest) из каждой строки документации, содержащей интерактивные примеры.765- [`DocTestParser`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestParser): создаёт объект [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest) из строки (например, docstring объекта).766- [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner): выполняет примеры в [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest) и использует [`OutputChecker`](https://python-all.ru/3.4/library/doctest.html#doctest.OutputChecker) для проверки их вывода.767- [`OutputChecker`](https://python-all.ru/3.4/library/doctest.html#doctest.OutputChecker): сравнивает фактический вывод из примера doctest с ожидаемым выводом и определяет, совпадают ли они.768769Взаимосвязи между этими классами обработки показаны на следующей диаграмме.770771```python772                            list of:773+------+                   +---------+774|module| --DocTestFinder-> | DocTest | --DocTestRunner-> results775+------+    |        ^     +---------+     |       ^    (printed)776            |        |     | Example |     |       |777            v        |     |   ...   |     v       |778           DocTestParser   | Example |   OutputChecker779                           +---------+780```781782### 26.2.6.1. Объекты DocTest783784#### `class doctest.DocTest(examples, globs, name, filename, lineno, docstring)`785786Набор примеров doctest, которые должны выполняться в одном пространстве имён. Аргументы конструктора инициализируют одноимённые атрибуты.787788[`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest) определяет следующие атрибуты. Они инициализируются конструктором и не должны изменяться напрямую.789790#### `examples`791792Список объектов [`Example`](https://python-all.ru/3.4/library/doctest.html#doctest.Example), описывающих отдельные интерактивные примеры на Python, которые должны быть выполнены этим тестом.793794#### `globs`795796Пространство имён (глобальные переменные), в котором должны выполняться примеры. Это словарь, отображающий имена в значения. Все изменения пространства имён, сделанные примерами (например, привязка новых переменных), будут отражены в [`globs`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest.globs) после выполнения теста.797798#### `name`799800Строковое имя, идентифицирующее [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest). Обычно это имя объекта или файла, из которого был извлечён тест.801802#### `filename`803804Имя файла, из которого был извлечён этот [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest); или `None`, если имя файла неизвестно или если [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest) не был извлечён из файла.805806#### `lineno`807808Номер строки в [`filename`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest.filename), с которой начинается этот [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest); или `None`, если номер строки недоступен. Номер строки отсчитывается от нуля относительно начала файла.809810#### `docstring`811812Строка, из которой был извлечён тест, или «None», если строка недоступна, или если тест не был извлечён из строки.813814### 26.2.6.2. Объекты Example815816#### `class doctest.Example(source, want, exc_msg=None, lineno=0, indent=0, options=None)`817818Один интерактивный пример, состоящий из оператора Python и ожидаемого вывода. Аргументы конструктора инициализируют одноимённые атрибуты.819820[`Example`](https://python-all.ru/3.4/library/doctest.html#doctest.Example) определяет следующие атрибуты. Они инициализируются конструктором и не должны изменяться напрямую.821822#### `source`823824Строка, содержащая исходный код примера. Этот исходный код состоит из одного оператора Python и всегда заканчивается символом новой строки; конструктор добавляет символ новой строки при необходимости.825826#### `want`827828Ожидаемый вывод после выполнения исходного кода примера (либо из stdout, либо трассировка в случае исключения). [`want`](https://python-all.ru/3.4/library/doctest.html#doctest.Example.want) завершается символом новой строки, если не ожидается, что вывод отсутствует; в этом случае он представляет собой пустую строку. Конструктор добавляет символ новой строки при необходимости.829830#### `exc_msg`831832Сообщение об исключении, сгенерированное примером, если ожидается, что пример вызовет исключение; или `None`, если исключение не ожидается. Это сообщение об исключении сравнивается с возвращаемым значением [`traceback.format_exception_only()`](https://python-all.ru/3.4/library/traceback.html#traceback.format_exception_only). [`exc_msg`](https://python-all.ru/3.4/library/doctest.html#doctest.Example.exc_msg) завершается символом новой строки, если только не равно `None`. Конструктор добавляет символ новой строки при необходимости.833834#### `lineno`835836Номер строки внутри строки, содержащей этот пример, с которой начинается пример. Этот номер строки отсчитывается от нуля относительно начала содержащей строки.837838#### `indent`839840Отступ примера в содержащей строке, т.е. количество пробелов перед первым приглашением примера.841842#### `options`843844Словарь, сопоставляющий флаги опций со значениями `True` или `False`, используется для переопределения стандартных опций для этого примера. Любые флаги опций, не вошедшие в этот словарь, сохраняют своё значение по умолчанию (как указано в [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner)‘s `optionflags`). По умолчанию опции не заданы.845846### 26.2.6.3. Объекты DocTestFinder847848#### `class doctest.DocTestFinder(verbose=False, parser=DocTestParser(), recurse=True, exclude_empty=True)`849850Класс обработки, используемый для извлечения [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest), имеющих отношение к заданному объекту, из его строки документации и строк документации содержащихся в нём объектов. [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest) могут быть извлечены из модулей, классов, функций, методов, статических методов, методов класса и свойств.851852Необязательный аргумент *verbose* можно использовать для вывода объектов, которые ищет поисковик. По умолчанию `False` (вывод отсутствует).853854Необязательный аргумент *parser* задаёт объект [`DocTestParser`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestParser) (или его полноценную замену), который используется для извлечения доктестов из строк документации.855856Если необязательный аргумент *recurse* равен false, то [`DocTestFinder.find()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestFinder.find) будет проверять только переданный объект, но не содержащиеся в нём объекты.857858Если необязательный аргумент *exclude\_empty* равен false, то [`DocTestFinder.find()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestFinder.find) включит тесты для объектов с пустыми строками документации.859860[`DocTestFinder`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestFinder) определяет следующий метод:861862#### `find(obj[, name][, module][, globs][, extraglobs])`863864Возвращает список объектов [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest), определённых строкой документации *obj* или строками документации любых содержащихся в нём объектов.865866Необязательный аргумент *name* задаёт имя объекта; это имя будет использоваться для формирования имён возвращаемых [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest). Если *name* не указан, то используется `obj.__name__`.867868Необязательный параметр *module* – это модуль, содержащий переданный объект. Если модуль не указан или равен None, то поисковик тестов попытается автоматически определить правильный модуль. Модуль объекта используется:869870- В качестве пространства имён по умолчанию, если *globs* не указан.871- Чтобы предотвратить извлечение DocTests объектом DocTestFinder из объектов, импортированных из других модулей. (Содержащиеся объекты, чей модуль отличается от *module*, игнорируются.)872- Для поиска имени файла, содержащего объект.873- Для помощи в определении номера строки объекта в его файле.874875Если *module* равен `False`, никаких попыток найти модуль не будет. Это неочевидное поведение, в основном используемое при тестировании самого doctest: если *module* равен `False` или `None`, но не может быть найден автоматически, то считается, что все объекты принадлежат (несуществующему) модулю, и поэтому все содержащиеся объекты будут (рекурсивно) проверены на наличие доктестов.876877Глобальные переменные для каждого [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest) формируются путём объединения *globs* и *extraglobs* (привязки в *extraglobs* переопределяют привязки в *globs*). Для каждого [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest) создаётся новая поверхностная копия словаря глобальных переменных. Если *globs* не указан, то по умолчанию используется *\_\_dict\_\_* модуля, если он указан, или `{}` в противном случае. Если *extraglobs* не указан, то по умолчанию `{}`.878879### 26.2.6.4. Объекты DocTestParser880881#### `class doctest.DocTestParser`882883Класс обработки, используемый для извлечения интерактивных примеров из строки и создания на их основе объекта [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest).884885[`DocTestParser`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestParser) определяет следующие методы:886887#### `get_doctest(string, globs, name, filename, lineno)`888889Извлекает все примеры доктестов из заданной строки и собирает их в объект [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest).890891*globs*, *name*, *filename* и *lineno* являются атрибутами нового объекта [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest). Дополнительные сведения см. в документации [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest).892893#### `get_examples(string, name='<string>')`894895Извлекает все примеры доктестов из заданной строки и возвращает их в виде списка объектов [`Example`](https://python-all.ru/3.4/library/doctest.html#doctest.Example). Номера строк начинаются с 0. Необязательный аргумент *name* – это имя, идентифицирующее данную строку; используется только для сообщений об ошибках.896897#### `parse(string, name='<string>')`898899Разделяет заданную строку на примеры и промежуточный текст и возвращает их в виде списка, чередующего объекты [`Example`](https://python-all.ru/3.4/library/doctest.html#doctest.Example) и строки. Номера строк для [`Example`](https://python-all.ru/3.4/library/doctest.html#doctest.Example) начинаются с 0. Необязательный аргумент *name* – это имя, идентифицирующее данную строку; используется только для сообщений об ошибках.900901### 26.2.6.5. Объекты DocTestRunner902903#### `class doctest.DocTestRunner(checker=None, verbose=None, optionflags=0)`904905Класс обработки, используемый для выполнения и проверки интерактивных примеров в [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest).906907Сравнение ожидаемых и фактических результатов выполняется с помощью [`OutputChecker`](https://python-all.ru/3.4/library/doctest.html#doctest.OutputChecker). Это сравнение можно настроить с помощью ряда флагов; дополнительную информацию см. в разделе [*Option Flags*](https://python-all.ru/3.4/library/doctest.html#doctest-options). Если флагов недостаточно, то сравнение также можно настроить, передав подкласс [`OutputChecker`](https://python-all.ru/3.4/library/doctest.html#doctest.OutputChecker) в конструктор.908909Вывод тестового исполнителя можно управлять двумя способами. Во-первых, можно передать функцию вывода в `TestRunner.run()`; эта функция будет вызываться со строками, которые нужно отобразить. По умолчанию используется `sys.stdout.write`. Если захвата вывода недостаточно, то вывод также можно настроить, создав подкласс DocTestRunner и переопределив методы [`report_start()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner.report_start), [`report_success()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner.report_success), [`report_unexpected_exception()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner.report_unexpected_exception) и [`report_failure()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner.report_failure).910911Необязательный именованный аргумент *checker* задаёт объект [`OutputChecker`](https://python-all.ru/3.4/library/doctest.html#doctest.OutputChecker) (или его замену), который должен использоваться для сравнения ожидаемых результатов с фактическими результатами примеров doctest.912913Необязательный именованный аргумент *verbose* управляет многословностью [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner). Если *verbose* равен `True`, то информация выводится о каждом примере по мере его выполнения. Если *verbose* равен `False`, то выводятся только неудачи. Если *verbose* не указан или равен `None`, то многословный вывод используется только тогда, когда используется флаг командной строки `-v`.914915Необязательный именованный аргумент *optionflags* позволяет управлять тем, как исполнитель тестов сравнивает ожидаемый вывод с фактическим и как отображает ошибки. Дополнительную информацию см. в разделе [*Флаги опций*](https://python-all.ru/3.4/library/doctest.html#doctest-options).916917[`DocTestParser`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestParser) определяет следующие методы:918919#### `report_start(out, test, example)`920921Сообщает, что исполнитель тестов собирается обработать данный пример. Этот метод предоставляется, чтобы подклассы [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner) могли настроить свой вывод; не следует вызывать его напрямую.922923*example* – это пример, который будет обработан. *test* – это тест, *содержащий пример*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner.run).924925#### `report_success(out, test, example, got)`926927Сообщает, что данный пример выполнился успешно. Этот метод предоставляется, чтобы подклассы [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner) могли настроить свой вывод; не следует вызывать его напрямую.928929*example* – это пример, который будет обработан. *got* – это фактический вывод из примера. *test* – это тест, содержащий *example*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner.run).930931#### `report_failure(out, test, example, got)`932933Сообщает, что данный пример завершился неудачей. Этот метод предоставляется, чтобы подклассы [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner) могли настроить свой вывод; не следует вызывать его напрямую.934935*example* – это пример, который будет обработан. *got* – это фактический вывод из примера. *test* – это тест, содержащий *example*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner.run).936937#### `report_unexpected_exception(out, test, example, exc_info)`938939Сообщает, что данный пример вызвал неожиданное исключение. Этот метод предоставляется, чтобы подклассы [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner) могли настроить свой вывод; не следует вызывать его напрямую.940941*example* – это пример, который будет обработан. *exc\_info* – это кортеж, содержащий информацию о неожиданном исключении (как возвращается [`sys.exc_info()`](https://python-all.ru/3.4/library/sys.html#sys.exc_info)). *test* – это тест, содержащий *example*. *out* – это функция вывода, переданная в [`DocTestRunner.run()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner.run).942943#### `run(test, compileflags=None, out=None, clear_globs=True)`944945Запускает примеры из *test* (объект [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest)) и отображает результаты с помощью функции записи *out*.946947Примеры выполняются в пространстве имён `test.globs`. Если *clear\_globs* равно истине (по умолчанию), то это пространство имён будет очищено после выполнения теста, чтобы помочь сборке мусора. Если требуется изучить пространство имён после завершения теста, используйте *clear\_globs=False*.948949*compileflags* задаёт набор флагов, которые должен использовать компилятор Python при выполнении примеров. Если не указан, по умолчанию используется набор флагов future-import, действующих для *globs*.950951Вывод каждого примера проверяется с помощью средства проверки вывода [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner), а результаты форматируются методами `DocTestRunner.report_*()`.952953#### `summarize(verbose=None)`954955Выводит сводку всех тестовых случаев, выполненных данным DocTestRunner, и возвращает [*именованный кортеж*](https://python-all.ru/3.4/glossary.html#term-named-tuple) `TestResults(failed, attempted)`.956957Необязательный аргумент *verbose* управляет детализацией сводки. Если многословность не указана, используется многословность [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner).958959### 26.2.6.6. Объекты OutputChecker960961#### `class doctest.OutputChecker`962963Класс, используемый для проверки, соответствует ли фактический вывод из примера doctest ожидаемому выводу. [`OutputChecker`](https://python-all.ru/3.4/library/doctest.html#doctest.OutputChecker) определяет два метода: [`check_output()`](https://python-all.ru/3.4/library/doctest.html#doctest.OutputChecker.check_output), который сравнивает заданную пару выводов и возвращает истину, если они совпадают; и [`output_difference()`](https://python-all.ru/3.4/library/doctest.html#doctest.OutputChecker.output_difference), который возвращает строку, описывающую различия между двумя выводами.964965[`OutputChecker`](https://python-all.ru/3.4/library/doctest.html#doctest.OutputChecker) определяет следующие методы:966967#### `check_output(want, got, optionflags)`968969Возвращает `True` тогда и только тогда, когда фактический вывод из примера (*got*) совпадает с ожидаемым выводом (*want*). Эти строки всегда считаются совпадающими, если они идентичны; но в зависимости от того, какие флаги опций использует исполнитель тестов, возможны также несколько типов нестрогого совпадения. См. раздел [*Option Flags*](https://python-all.ru/3.4/library/doctest.html#doctest-options) для получения дополнительной информации о флагах опций.970971#### `output_difference(example, got, optionflags)`972973Возвращает строку с описанием различий между ожидаемым выводом для заданного примера (*example*) и фактическим выводом (*got*). *optionflags* – это набор флагов опций, используемых для сравнения *want* и *got*.974975## 26.2.7. Отладка976977Doctest предоставляет несколько механизмов для отладки примеров doctest:978979- Several functions convert doctests to executable Python programs, which can be run under the Python debugger, [`pdb`](https://python-all.ru/3.4/library/pdb.html#module-pdb).980- Класс [`DebugRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DebugRunner) является подклассом [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner), который вызывает исключение при первом же несоответствии примера, содержащее информацию об этом примере. Эти сведения можно использовать для посмертной отладки примера.981- Тестовые случаи [`unittest`](https://python-all.ru/3.4/library/unittest.html#module-unittest), созданные функцией [`DocTestSuite()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestSuite), поддерживают метод [`debug()`](https://python-all.ru/3.4/library/doctest.html#doctest.debug), определённый в [`unittest.TestCase`](https://python-all.ru/3.4/library/unittest.html#unittest.TestCase).982- Можно добавить вызов [`pdb.set_trace()`](https://python-all.ru/3.4/library/pdb.html#pdb.set_trace) в примере doctest; при выполнении этой строки произойдёт вход в отладчик Python. После этого можно просматривать текущие значения переменных и т.д. Например, пусть `a.py` содержит только следующую строку документации модуля:983984  ```python985  """986  >>> def f(x):987  ...     g(x*2)988  >>> def g(x):989  ...     print(x+3)990  ...     import pdb; pdb.set_trace()991  >>> f(3)992  9993  """994  ```995996  Тогда интерактивный сеанс Python может выглядеть так:997998  ```python999  >>> import a, doctest1000  >>> doctest.testmod(a)1001  --Return--1002  > <doctest a[1]>(3)g()->None1003  -> import pdb; pdb.set_trace()1004  (Pdb) list1005    1     def g(x):1006    2         print(x+3)1007    3  ->     import pdb; pdb.set_trace()1008  [EOF]1009  (Pdb) p x1010  61011  (Pdb) step1012  --Return--1013  > <doctest a[0]>(2)f()->None1014  -> g(x*2)1015  (Pdb) list1016    1     def f(x):1017    2  ->     g(x*2)1018  [EOF]1019  (Pdb) p x1020  31021  (Pdb) step1022  --Return--1023  > <doctest a[2]>(1)?()->None1024  -> f(3)1025  (Pdb) cont1026  (0, 3)1027  >>>1028  ```10291030Функции, которые преобразуют doctest в код Python и, возможно, запускают полученный код под отладчиком:10311032#### `doctest.script_from_examples(s)`10331034Преобразует текст с примерами в скрипт.10351036Аргумент *s* – это строка, содержащая примеры doctest. Строка преобразуется в скрипт Python, где примеры doctest из *s* преобразуются в обычный код, а всё остальное – в комментарии Python. Сгенерированный скрипт возвращается в виде строки. Например,10371038```python1039import doctest1040print(doctest.script_from_examples(r"""1041    Set x and y to 1 and 2.1042    >>> x, y = 1, 210431044    Print their sum:1045    >>> print(x+y)1046    31047"""))1048```10491050выводит:10511052```python1053# Установите x и y в 1 и 2.1054x, y = 1, 21055#1056# Выведите их сумму:1057print(x+y)1058# Ожидаемый результат:1059## 31060```10611062Эта функция используется внутренне другими функциями (см. ниже), но также может быть полезна, когда требуется преобразовать интерактивный сеанс Python в скрипт Python.10631064#### `doctest.testsource(module, name)`10651066Преобразует доктест объекта в скрипт.10671068Аргумент *module* – это объект модуля или точечное имя модуля, содержащего объект, doctest-ы которого представляют интерес. Аргумент *name* – это имя (внутри модуля) объекта с интересующими doctest-ами. Результат – строка, содержащая docstring этого объекта, преобразованный в скрипт Python, как описано выше для [`script_from_examples()`](https://python-all.ru/3.4/library/doctest.html#doctest.script_from_examples). Например, если модуль `a.py` содержит функцию верхнего уровня `f()`, то10691070```python1071import a, doctest1072print(doctest.testsource(a, "a.f"))1073```10741075выводит скриптовую версию docstring функции `f()`, где doctest-ы преобразованы в код, а остальное помещено в комментарии.10761077#### `doctest.debug(module, name, pm=False)`10781079Отладка доктестов для объекта.10801081Аргументы *module* и *name* те же, что и для функции [`testsource()`](https://python-all.ru/3.4/library/doctest.html#doctest.testsource) выше. Синтезированный скрипт Python для docstring указанного объекта записывается во временный файл, а затем этот файл запускается под управлением отладчика Python, [`pdb`](https://python-all.ru/3.4/library/pdb.html#module-pdb).10821083Поверхностная копия `module.__dict__` используется как для локального, так и для глобального контекста выполнения.10841085Необязательный аргумент *pm* определяет, используется ли посмертная отладка. Если *pm* имеет истинное значение, скрипт выполняется напрямую, и отладчик подключается только в том случае, если скрипт завершается из-за необработанного исключения. Если это происходит, вызывается посмертная отладка через [`pdb.post_mortem()`](https://python-all.ru/3.4/library/pdb.html#pdb.post_mortem) с передачей объекта traceback из необработанного исключения. Если *pm* не указан или равен false, скрипт выполняется под отладчиком с самого начала, путём передачи соответствующего вызова [`exec()`](https://python-all.ru/3.4/library/functions.html#exec) в [`pdb.run()`](https://python-all.ru/3.4/library/pdb.html#pdb.run).10861087#### `doctest.debug_src(src, pm=False, globs=None)`10881089Отладка доктестов в строке.10901091Эта функция аналогична [`debug()`](https://python-all.ru/3.4/library/doctest.html#doctest.debug) выше, за исключением того, что строка с примерами doctest задаётся напрямую через аргумент *src*.10921093Необязательный аргумент *pm* имеет тот же смысл, что и в функции [`debug()`](https://python-all.ru/3.4/library/doctest.html#doctest.debug) выше.10941095Необязательный аргумент *globs* задаёт словарь, используемый как в качестве локального, так и глобального контекста выполнения. Если он не указан или равен `None`, используется пустой словарь. Если указан, используется поверхностная копия словаря.10961097Класс [`DebugRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DebugRunner) и специальные исключения, которые он может вызывать, представляют наибольший интерес для разработчиков тестовых фреймворков, и здесь будут лишь кратко описаны. Подробнее см. в исходном коде, особенно в docstring класса [`DebugRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DebugRunner) (который сам является doctest!).10981099#### `class doctest.DebugRunner(checker=None, verbose=None, optionflags=0)`11001101Подкласс [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner), который вызывает исключение сразу при обнаружении несоответствия. Если происходит неожиданное исключение, вызывается исключение [`UnexpectedException`](https://python-all.ru/3.4/library/doctest.html#doctest.UnexpectedException), содержащее тест, пример и исходное исключение. Если вывод не совпадает, вызывается исключение [`DocTestFailure`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestFailure), содержащее тест, пример и фактический вывод.11021103Информацию о параметрах конструктора и методах см. в документации [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner) в разделе [*Advanced API*](https://python-all.ru/3.4/library/doctest.html#doctest-advanced-api).11041105Существует два исключения, которые могут вызываться экземплярами [`DebugRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DebugRunner):11061107#### `exception doctest.DocTestFailure(test, example, got)`11081109Исключение, вызываемое [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner), чтобы сообщить, что фактический вывод примера doctest не совпал с ожидаемым. Аргументы конструктора используются для инициализации одноимённых атрибутов.11101111[`DocTestFailure`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestFailure) определяет следующие атрибуты:11121113#### `DocTestFailure.test`11141115Объект [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest), который выполнялся, когда пример завершился неудачей.11161117#### `DocTestFailure.example`11181119Объект [`Example`](https://python-all.ru/3.4/library/doctest.html#doctest.Example), который не прошёл проверку.11201121#### `DocTestFailure.got`11221123Фактический вывод примера.11241125#### `exception doctest.UnexpectedException(test, example, exc_info)`11261127Исключение, вызываемое [`DocTestRunner`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTestRunner), чтобы сообщить, что пример doctest вызвал неожиданное исключение. Аргументы конструктора используются для инициализации одноимённых атрибутов.11281129[`UnexpectedException`](https://python-all.ru/3.4/library/doctest.html#doctest.UnexpectedException) определяет следующие атрибуты:11301131#### `UnexpectedException.test`11321133Объект [`DocTest`](https://python-all.ru/3.4/library/doctest.html#doctest.DocTest), который выполнялся во время сбоя примера.11341135#### `UnexpectedException.example`11361137Объект [`Example`](https://python-all.ru/3.4/library/doctest.html#doctest.Example), в котором произошла ошибка.11381139#### `UnexpectedException.exc_info`11401141Кортеж с информацией о непредвиденном исключении, возвращаемый [`sys.exc_info()`](https://python-all.ru/3.4/library/sys.html#sys.exc_info).11421143## 26.2.8. Трибуна11441145Как уже упоминалось во введении, [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) со временем приобрёл три основных назначения:114611471. Проверка примеров в docstrings.11482. Регрессионное тестирование.11493. Исполняемая документация / литературное тестирование.11501151Эти варианты использования предъявляют разные требования, и важно их различать. В частности, наполнение строк документации запутанными тестовыми примерами приводит к плохой документации.11521153При написании docstring-строки следует тщательно выбирать примеры. Это искусство, которому нужно научиться – сначала оно может казаться неестественным. Примеры должны приносить реальную пользу документации. Хороший пример часто может заменить много слов. Если подойти к делу с умом, примеры станут бесценными для пользователей и многократно окупят время, потраченное на их сбор, с годами, когда всё меняется. Меня до сих пор поражает, как часто один из моих примеров [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest) перестаёт работать после «безобидного» изменения.11541155Doctest также отлично подходит для регрессионного тестирования, особенно если не жалеть пояснительного текста. Чередуя прозу и примеры, гораздо легче отслеживать, что именно тестируется и почему. Когда тест падает, хороший текст помогает быстрее понять, в чём проблема и как её исправить. Конечно, можно писать развёрнутые комментарии в коде тестов, но мало кто это делает. Многие заметили, что использование doctest вместо этого приводит к гораздо более понятным тестам. Возможно, просто потому, что в doctest писать прозу немного легче, чем код, а писать комментарии в коде – немного сложнее. Но я думаю, дело не только в этом: естественный подход при написании теста на основе doctest – это желание объяснить тонкости своего программного обеспечения и проиллюстрировать их примерами. Это, в свою очередь, естественным образом приводит к тестовым файлам, которые начинаются с самых простых функций и логически переходят к осложнениям и крайним случаям. В результате получается связное повествование, а не набор разрозненных функций, тестирующих отдельные фрагменты функциональности, казалось бы, случайным образом. Это другой подход, и он даёт другие результаты, стирая грань между тестированием и объяснением.11561157Регрессионное тестирование лучше всего проводить в отдельных объектах или файлах. Есть несколько вариантов организации тестов:11581159- Создавайте текстовые файлы, содержащие тестовые примеры в виде интерактивных примеров, и проверяйте эти файлы с помощью [`testfile()`](https://python-all.ru/3.4/library/doctest.html#doctest.testfile) или [`DocFileSuite()`](https://python-all.ru/3.4/library/doctest.html#doctest.DocFileSuite). Этот подход рекомендуется, хотя его проще всего применять в новых проектах, изначально спроектированных для работы с doctest.1160- Определяйте функции с именами вида `_regrtest_topic`, состоящие из одной строки документации, содержащей тестовые примеры для указанных тем. Такие функции можно включить в тот же файл, что и модуль, или вынести в отдельный тестовый файл.1161- Определите словарь `__test__`, отображающий темы регрессионного тестирования в строки документации, содержащие тестовые примеры.11621163Если вы поместили тесты в модуль, сам модуль может быть тестовым раннером. Когда тест падает, можно настроить раннер на повторный запуск только упавшего doctest'а, пока вы отлаживаете проблему. Вот минимальный пример такого тестового раннера:11641165```python1166if __name__ == '__main__':1167    import doctest1168    flags = doctest.REPORT_NDIFF|doctest.FAIL_FAST1169    if len(sys.argv) > 1:1170        name = sys.argv[1]1171        if name in globals():1172            obj = globals()[name]1173        else:1174            obj = __test__[name]1175        doctest.run_docstring_examples(obj, globals(), name=name,1176                                       optionflags=flags)1177    else:1178        fail, total = doctest.testmod(optionflags=flags)1179        print("{} failures out of {} tests".format(fail, total))1180```11811182Сноски11831184| [\[1\]](https://python-all.ru/3.4/library/doctest.html#id1) | Примеры, содержащие как ожидаемый вывод, так и исключение, не поддерживаются. Попытка угадать, где заканчивается одно и начинается другое, слишком чревата ошибками и приводит к запутанным тестам. |1185| --- | --- |1186