> **Источник:** https://python-all.ru/3.15/library/unittest.html > > «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor. --- # `unittest` – фреймворк для модульного тестирования **Исходный код:** [Lib/unittest/\_\_init\_\_.py](https://python-all.ru/src/3.15/Lib/unittest/__init__.py) --- (Если вы уже знакомы с основными понятиями тестирования, можете перейти к [списку методов assert](https://python-all.ru/3.15/library/unittest.html#assert-methods).) Фреймворк модульного тестирования `unittest` изначально был вдохновлён JUnit и имеет схожий подход с основными фреймворками модульного тестирования на других языках. Он поддерживает автоматизацию тестов, совместное использование кода подготовки и завершения тестов, объединение тестов в коллекции и независимость тестов от системы отчётов. Для этого `unittest` поддерживает несколько важных концепций в объектно-ориентированном стиле: **тестовая фикстура** *Тестовая фикстура* представляет собой подготовку, необходимую для выполнения одного или нескольких тестов, а также все связанные действия по очистке. Это может включать, например, создание временных или прокси-баз данных, каталогов или запуск серверного процесса. **тестовый случай** *Тестовый случай* – это отдельная единица тестирования. Он проверяет определённую реакцию на конкретный набор входных данных. `unittest` предоставляет базовый класс [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase), который можно использовать для создания новых тестовых случаев. **набор тестов** *Набор тестов* – это совокупность тестовых случаев, наборов тестов или и того, и другого. Он используется для объединения тестов, которые должны выполняться вместе. **исполнитель тестов** *Исполнитель тестов* – это компонент, который управляет выполнением тестов и предоставляет результат пользователю. Исполнитель может использовать графический интерфейс, текстовый интерфейс или возвращать специальное значение, указывающее на результаты выполнения тестов. > **См. также** > > **Модуль [`doctest`](https://python-all.ru/3.15/library/doctest.html#module-doctest)** > > Ещё один модуль поддержки тестирования с совершенно другим подходом. > > **[Простое тестирование в Smalltalk: с шаблонами](https://python-all.ru/3.15/library/unittest.html)** > > Оригинальная статья Кента Бека о фреймворках тестирования, в которых используется тот же шаблон, что и в `unittest`. > > **[pytest](https://python-all.ru/3.15/library/unittest.html)** > > Сторонний фреймворк модульного тестирования с более лёгким синтаксисом для написания тестов. Например, `assert func(10) == 42`. > > **[Таксономия инструментов тестирования Python](https://python-all.ru/3.15/library/unittest.html)** > > Обширный список инструментов тестирования Python, включая фреймворки функционального тестирования и библиотеки имитационных объектов (mock). > > **[Список рассылки по тестированию в Python](https://python-all.ru/3.15/library/unittest.html)** > > Группа по интересам для обсуждения тестирования и инструментов тестирования в Python. > > Скрипт `Tools/unittestgui/unittestgui.py` в дистрибутиве исходных кодов Python – это графический инструмент для обнаружения и выполнения тестов. Он в значительной степени предназначен для упрощения работы с тестированием для новичков в модульном тестировании. Для производственных сред рекомендуется, чтобы тесты запускались системой непрерывной интеграции, такой как [Buildbot](https://python-all.ru/3.15/library/unittest.html), [Jenkins](https://python-all.ru/3.15/library/unittest.html), [GitHub Actions](https://python-all.ru/3.15/library/unittest.html) или [AppVeyor](https://python-all.ru/3.15/library/unittest.html). ## Простой пример Модуль `unittest` предоставляет богатый набор инструментов для создания и запуска тестов. В этом разделе показано, что небольшого подмножества этих инструментов достаточно для удовлетворения потребностей большинства пользователей. Вот короткий скрипт для тестирования трёх строковых методов: ```python import unittest class TestStringMethods(unittest.TestCase): def test_upper(self): self.assertEqual('foo'.upper(), 'FOO') def test_isupper(self): self.assertTrue('FOO'.isupper()) self.assertFalse('Foo'.isupper()) def test_split(self): s = 'hello world' self.assertEqual(s.split(), ['hello', 'world']) # проверить, что s.split завершается ошибкой, если разделитель не строка with self.assertRaises(TypeError): s.split(2) if __name__ == '__main__': unittest.main() ``` Тестовый случай создаётся путём создания подкласса [`unittest.TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase). Три отдельных теста определяются методами, имена которых начинаются с букв `test`. Это соглашение об именах сообщает исполнителю тестов, какие методы являются тестами. Суть каждого теста – вызов [`assertEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertEqual) для проверки ожидаемого результата; [`assertTrue()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertTrue) или [`assertFalse()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertFalse) для проверки условия; или [`assertRaises()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertRaises) для проверки того, что возбуждается определённое исключение. Эти методы используются вместо оператора [`assert`](https://python-all.ru/3.15/reference/simple_stmts.html#assert), чтобы исполнитель тестов мог накапливать все результаты тестов и формировать отчёт. Методы [`setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp) и [`tearDown()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDown) позволяют определить инструкции, которые будут выполняться до и после каждого метода теста. Они подробнее рассматриваются в разделе [Организация тестового кода](https://python-all.ru/3.15/library/unittest.html#organizing-tests). В последнем блоке показан простой способ запуска тестов. [`unittest.main()`](https://python-all.ru/3.15/library/unittest.html#unittest.main) предоставляет интерфейс командной строки для тестового скрипта. При запуске из командной строки приведённый выше скрипт выдаёт вывод, который выглядит так: ```python ... ---------------------------------------------------------------------- Ran 3 tests in 0.000s OK ``` Передача флага `-v` вашему тестовому скрипту укажет [`unittest.main()`](https://python-all.ru/3.15/library/unittest.html#unittest.main) включить более высокий уровень подробности и выдать следующий вывод: ```python test_isupper (__main__.TestStringMethods.test_isupper) ... ok test_split (__main__.TestStringMethods.test_split) ... ok test_upper (__main__.TestStringMethods.test_upper) ... ok ---------------------------------------------------------------------- Ran 3 tests in 0.001s OK ``` Представленные выше примеры демонстрируют наиболее часто используемые возможности `unittest`, которых достаточно для многих повседневных задач тестирования. Оставшаяся часть документации рассматривает полный набор функций с самого начала. Изменено в версии 3.11: Возврат значения из тестового метода (кроме значения по умолчанию `None`) теперь считается устаревшим. ## Интерфейс командной строки Модуль unittest можно использовать из командной строки для запуска тестов из модулей, классов или даже отдельных тестовых методов: ```python python -m unittest test_module1 test_module2 python -m unittest test_module.TestClass python -m unittest test_module.TestClass.test_method ``` Можно передать список с любой комбинацией имён модулей, а также полных имён классов или методов. Тестовые модули также можно указывать по пути к файлу: ```python python -m unittest tests/test_something.py ``` Это позволяет использовать автодополнение имён файлов в оболочке для указания тестового модуля. Указанный файл по-прежнему должен быть импортируем как модуль. Путь преобразуется в имя модуля путём удаления ‘.py’ и замены разделителей пути на ‘.’. Если требуется выполнить тестовый файл, который не импортируется как модуль, следует запускать файл напрямую. Можно запускать тесты с большей детализацией (повышенной подробностью), передав флаг -v: ```python python -m unittest -v test_module ``` При запуске без аргументов запускается [автоматическое обнаружение тестов](https://python-all.ru/3.15/library/unittest.html#unittest-test-discovery): ```python python -m unittest ``` Чтобы получить список всех параметров командной строки: ```python python -m unittest -h ``` Изменено в версии 3.2: В более ранних версиях можно было запускать только отдельные тестовые методы, а не модули или классы. Добавлено в версии 3.14: Вывод по умолчанию раскрашивается, и это можно [настроить с помощью переменных окружения](https://python-all.ru/3.15/using/cmdline.html#using-on-controlling-color). ### Параметры командной строки **unittest** поддерживает следующие параметры командной строки: #### `-b, --buffer` Потоки стандартного вывода и стандартной ошибки буферизируются во время выполнения теста. Вывод при успешном тесте отбрасывается. При ошибке или провале теста вывод выводится обычным образом и добавляется к сообщениям о неудаче. #### `-c, --catch` `Control`-`C` во время выполнения теста ожидает завершения текущего теста и затем выводит все результаты на данный момент. Повторное нажатие `Control`-`C` вызывает обычное исключение [`KeyboardInterrupt`](https://python-all.ru/3.15/library/exceptions.html#KeyboardInterrupt). См. раздел [Обработка сигналов](https://python-all.ru/3.15/library/unittest.html#signal-handling) с описанием функций, предоставляющих эту возможность. #### `-f, --failfast` Остановить выполнение теста при первой же ошибке или неудаче. #### `-k` Запускать только те тестовые методы и классы, которые соответствуют шаблону или подстроке. Этот параметр можно использовать несколько раз; в этом случае включаются все тесты, соответствующие любому из заданных шаблонов. Шаблоны, содержащие символ подстановки (`*`), сопоставляются с именем теста с помощью [`fnmatch.fnmatchcase()`](https://python-all.ru/3.15/library/fnmatch.html#fnmatch.fnmatchcase); в противном случае используется простое сопоставление подстрок с учётом регистра. Шаблоны сопоставляются с полным именем тестового метода, импортированным загрузчиком тестов. Например, `-k foo` соответствует `foo_tests.SomeTest.test_something`, `bar_tests.SomeTest.test_foo`, но не `bar_tests.FooTest.test_something`. #### `--locals` Показывать локальные переменные в трассировках. #### `--durations N` Показывать N самых медленных тестов (N=0 – все). Добавлено в версии 3.2: Были добавлены параметры командной строки `-b`, `-c` и `-f`. Добавлено в версии 3.5: Параметр командной строки `--locals`. Добавлено в версии 3.7: Параметр командной строки `-k`. Добавлено в версии 3.12: Параметр командной строки `--durations`. Командная строка также может использоваться для автоматического обнаружения тестов, для запуска всех тестов в проекте или только их части. ## Обнаружение тестов Добавлено в версии 3.2. Unittest поддерживает простое обнаружение тестов. Чтобы быть совместимыми с обнаружением тестов, все тестовые файлы должны быть [модулями](https://python-all.ru/3.15/tutorial/modules.html#tut-modules) или [пакетами](https://python-all.ru/3.15/tutorial/modules.html#tut-packages), импортируемыми из корневого каталога проекта (это означает, что их имена файлов должны быть допустимыми [идентификаторами](https://python-all.ru/3.15/reference/lexical_analysis.html#identifiers)). Обнаружение тестов реализовано в [`TestLoader.discover()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestLoader.discover), но также может использоваться из командной строки. Основное использование командной строки: ```python cd project_directory python -m unittest discover ``` > **Примечание** > > В качестве сокращения, `python -m unittest` эквивалентно `python -m unittest discover`. Если требуется передать аргументы для обнаружения тестов, необходимо явно указать подкоманду `discover`. Подкоманда `discover` имеет следующие опции: #### `-v, --verbose` Подробный вывод #### `-s, --start-directory directory` Каталог для начала обнаружения (по умолчанию `.`) #### `-p, --pattern pattern` Шаблон для сопоставления тестовых файлов (по умолчанию `test*.py`) #### `-t, --top-level-directory directory` Корневой каталог проекта (по умолчанию – каталог начала поиска) Параметры [`-s`](https://python-all.ru/3.15/library/unittest.html#cmdoption-unittest-discover-s), [`-p`](https://python-all.ru/3.15/library/unittest.html#cmdoption-unittest-discover-p) и [`-t`](https://python-all.ru/3.15/library/unittest.html#cmdoption-unittest-discover-t) можно передавать в качестве позиционных аргументов в указанном порядке. Следующие две командные строки эквивалентны: ```python python -m unittest discover -s project_directory -p "*_test.py" python -m unittest discover project_directory "*_test.py" ``` Помимо пути, в качестве начального каталога можно передать имя пакета, например `myproject.subpackage.test`. Указанное имя пакета будет импортировано, и его расположение в файловой системе будет использоваться в качестве начального каталога. > **Внимание** > > Обнаружение тестов загружает тесты путем их импорта. Как только обнаружение тестов найдет все тестовые файлы в указанном начальном каталоге, оно преобразует пути в имена пакетов для импорта. Например, `foo/bar/baz.py` будет импортирован как `foo.bar.baz`. > > Если пакет установлен глобально, и предпринимается попытка обнаружения тестов в другой копии пакета, то импорт *может* произойти из неправильного места. Если это произойдет, обнаружение тестов выдаст предупреждение и завершится. > > Если указать начальный каталог как имя пакета, а не путь к каталогу, то discover считает, что местоположение, из которого он импортирует, и есть то, которое вы имели в виду, поэтому предупреждение не появится. Тестовые модули и пакеты могут настраивать загрузку и обнаружение тестов с помощью [протокола load\_tests](https://python-all.ru/3.15/library/unittest.html#id1). Изменено в версии 3.4: Обнаружение тестов поддерживает [пакеты с пространством имен](https://python-all.ru/3.15/glossary.html#term-namespace-package). Изменено в версии 3.11: Обнаружение тестов прекратило поддержку [пакетов с пространством имен](https://python-all.ru/3.15/glossary.html#term-namespace-package). Она была нарушена начиная с Python 3.7. Начальный каталог и его подкаталоги, содержащие тесты, должны быть обычными пакетами, имеющими файл `__init__.py`. Если начальный каталог является точечным именем пакета, родительские пакеты могут быть пакетами с пространством имен. Изменено в версии 3.14: Обнаружение тестов снова поддерживает [пакет с пространством имен](https://python-all.ru/3.15/glossary.html#term-namespace-package) в качестве начального каталога. Чтобы избежать сканирования каталогов, не связанных с Python, тесты не ищутся в подкаталогах, не содержащих `__init__.py`. ## Организация тестового кода Основными строительными блоками модульного тестирования являются *тестовые случаи* – отдельные сценарии, которые необходимо настроить и проверить на корректность. В `unittest` тестовые случаи представлены экземплярами [`unittest.TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase). Чтобы создать собственные тестовые случаи, необходимо написать подклассы [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) или использовать [`FunctionTestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.FunctionTestCase). Тестовый код экземпляра [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) должен быть полностью самодостаточным, чтобы его можно было запускать как изолированно, так и в произвольной комбинации с любым количеством других тестовых случаев. Простейший подкласс [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) просто реализует тестовый метод (т.е. метод, имя которого начинается с `test`) для выполнения определенного тестового кода: ```python import unittest class DefaultWidgetSizeTestCase(unittest.TestCase): def test_default_widget_size(self): widget = Widget('The widget') self.assertEqual(widget.size(), (50, 50)) ``` Обратите внимание, что для проверки чего-либо используются [методы assert\*](https://python-all.ru/3.15/library/unittest.html#assert-methods), предоставляемые базовым классом [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase). Если тест не пройден, будет возбуждено исключение с пояснительным сообщением, и `unittest` определит тестовый случай как *сбой*. Любые другие исключения будут расцениваться как *ошибки*. Тестов может быть много, и их подготовка может быть повторяющейся. К счастью, можно вынести код подготовки в метод с именем [`setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp), который тестовый фреймворк будет автоматически вызывать для каждого запускаемого теста: ```python import unittest class WidgetTestCase(unittest.TestCase): def setUp(self): self.widget = Widget('The widget') def test_default_widget_size(self): self.assertEqual(self.widget.size(), (50,50), 'incorrect default size') def test_widget_resize(self): self.widget.resize(100,150) self.assertEqual(self.widget.size(), (100,150), 'wrong size after resize') ``` > **Примечание** > > Порядок выполнения различных тестов определяется сортировкой имен тестовых методов в соответствии со встроенным порядком строк. Если метод [`setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp) возбуждает исключение во время выполнения теста, фреймворк посчитает, что тест завершился ошибкой, и тестовый метод не будет выполнен. Аналогично, можно предоставить метод [`tearDown()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDown), который выполняет очистку после выполнения тестового метода: ```python import unittest class WidgetTestCase(unittest.TestCase): def setUp(self): self.widget = Widget('The widget') def tearDown(self): self.widget.dispose() ``` Если [`setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp) успешно выполнен, [`tearDown()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDown) будет выполнен, независимо от того, завершился тестовый метод успешно или нет. Такое рабочее окружение для тестового кода называется *тестовой фикстурой*. Новый экземпляр TestCase создаётся как уникальная тестовая фикстура, используемая для выполнения каждого отдельного тестового метода. Таким образом, [`setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp), [`tearDown()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDown) и `TestCase.__init__()` будут вызываться один раз для каждого теста. Рекомендуется группировать тесты с помощью реализаций TestCase в соответствии с тестируемыми возможностями. `unittest` предоставляет для этого механизм: *набор тестов*, представленный классом [`TestSuite`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite) из модуля `unittest`. В большинстве случаев вызов [`unittest.main()`](https://python-all.ru/3.15/library/unittest.html#unittest.main) сделает всё правильно: соберёт все тестовые случаи модуля и выполнит их. Однако, если требуется настроить сборку набора тестов, это можно сделать самостоятельно: ```python def suite(): suite = unittest.TestSuite() suite.addTest(WidgetTestCase('test_default_widget_size')) suite.addTest(WidgetTestCase('test_widget_resize')) return suite if __name__ == '__main__': runner = unittest.TextTestRunner() runner.run(suite()) ``` Определения тестовых случаев и наборов тестов можно размещать в тех же модулях, что и тестируемый код (например, `widget.py`), но есть несколько преимуществ в размещении тестового кода в отдельном модуле, например, `test_widget.py`: - Тестовый модуль можно запускать автономно из командной строки. - Тестовый код проще отделить от поставляемого кода. - Меньше соблазна изменять тестовый код, чтобы подогнать его под тестируемый код, без веской причины. - Тестовый код должен изменяться гораздо реже, чем тестируемый код. - Тестируемый код проще поддаётся рефакторингу. - Тесты для модулей, написанных на C, всё равно должны быть в отдельных модулях – так почему бы не придерживаться этого подхода? - Если стратегия тестирования меняется, нет необходимости изменять исходный код. ## Повторное использование старого тестового кода Некоторые пользователи могут иметь существующий тестовый код, который они хотели бы запускать из `unittest`, не преобразовывая каждую старую тестовую функцию в подкласс [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase). По этой причине `unittest` предоставляет класс [`FunctionTestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.FunctionTestCase). Этот подкласс [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) можно использовать для обёртывания существующей тестовой функции. Также можно предоставить функции настройки (set-up) и завершения (tear-down). Рассмотрим следующую тестовую функцию: ```python def testSomething(): something = makeSomething() assert something.name is not None # ... ``` можно создать эквивалентный экземпляр тестового случая следующим образом, с опциональными методами настройки и завершения: ```python testcase = unittest.FunctionTestCase(testSomething, setUp=makeSomethingDB, tearDown=deleteSomethingDB) ``` > **Примечание** > > Хотя [`FunctionTestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.FunctionTestCase) можно использовать для быстрого преобразования существующей тестовой базы в систему на основе `unittest`, этот подход не рекомендуется. Затрата времени на создание правильных подклассов [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) значительно упростит будущий рефакторинг тестов. В некоторых случаях существующие тесты могли быть написаны с использованием модуля [`doctest`](https://python-all.ru/3.15/library/doctest.html#module-doctest). В этом случае `doctest` предоставляет класс [`DocTestSuite`](https://python-all.ru/3.15/library/doctest.html#doctest.DocTestSuite), который может автоматически создавать экземпляры [`unittest.TestSuite`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite) из существующих тестов на основе `doctest`. ## Пропуск тестов и ожидаемые сбои Добавлено в версии 3.1. Unittest поддерживает пропуск отдельных тестовых методов и даже целых классов тестов. Кроме того, он поддерживает пометку теста как «ожидаемый сбой» – тест, который сломан и завершится неудачей, но не должен засчитываться как сбой в [`TestResult`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult). Пропуск теста – это просто использование [`skip()`](https://python-all.ru/3.15/library/unittest.html#unittest.skip) [декоратора](https://python-all.ru/3.15/glossary.html#term-decorator) или одного из его условных вариантов, вызов [`TestCase.skipTest()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.skipTest) внутри [`setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp) или тестового метода, или непосредственное возбуждение [`SkipTest`](https://python-all.ru/3.15/library/unittest.html#unittest.SkipTest). Базовый пропуск выглядит так: ```python class MyTestCase(unittest.TestCase): @unittest.skip("demonstrating skipping") def test_nothing(self): self.fail("shouldn't happen") @unittest.skipIf(mylib.__version__ < (1, 3), "not supported in this library version") def test_format(self): # Тесты, которые работают только для определённой версии библиотеки. pass @unittest.skipUnless(sys.platform.startswith("win"), "requires Windows") def test_windows_support(self): # код тестирования для Windows pass def test_maybe_skipped(self): if not external_resource_available(): self.skipTest("external resource not available") # тестовый код, зависящий от внешнего ресурса pass ``` Это вывод приведённого выше примера в подробном режиме: ```python test_format (__main__.MyTestCase.test_format) ... skipped 'not supported in this library version' test_nothing (__main__.MyTestCase.test_nothing) ... skipped 'demonstrating skipping' test_maybe_skipped (__main__.MyTestCase.test_maybe_skipped) ... skipped 'external resource not available' test_windows_support (__main__.MyTestCase.test_windows_support) ... skipped 'requires Windows' ---------------------------------------------------------------------- Ran 4 tests in 0.005s OK (skipped=4) ``` Классы можно пропускать так же, как методы: ```python @unittest.skip("showing class skipping") class MySkippedTestCase(unittest.TestCase): def test_not_run(self): pass ``` [`TestCase.setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp) также может пропустить тест. Это полезно, когда ресурс, который необходимо настроить, недоступен. Для ожидаемых сбоев используется декоратор [`expectedFailure()`](https://python-all.ru/3.15/library/unittest.html#unittest.expectedFailure). ```python class ExpectedFailureTestCase(unittest.TestCase): @unittest.expectedFailure def test_fail(self): self.assertEqual(1, 0, "broken") ``` Легко создать собственные декораторы пропуска, создав декоратор, который вызывает [`skip()`](https://python-all.ru/3.15/library/unittest.html#unittest.skip) для теста, когда нужно его пропустить. Этот декоратор пропускает тест, если только переданный объект не имеет определённого атрибута: ```python def skipUnlessHasattr(obj, attr): if hasattr(obj, attr): return lambda func: func return unittest.skip("{!r} doesn't have {!r}".format(obj, attr)) ``` Следующие декораторы и исключение реализуют пропуск тестов и ожидаемые сбои: #### `@unittest.skip(reason)` Безусловно пропускает декорированный тест. Параметр *reason* должен описывать причину пропуска теста. #### `@unittest.skipIf(condition, reason)` Пропустить декорированный тест, если *condition* истинно. #### `@unittest.skipUnless(condition, reason)` Пропустить декорированный тест, если *condition* не истинно. #### `@unittest.expectedFailure` Помечает тест как ожидаемый сбой или ошибку. Если тест завершается ошибкой или сбоем в самой тестовой функции (а не в одном из методов *тестовой фикстуры*), то он будет считаться успешным. Если тест проходит, он будет считаться неудачным. #### `exception unittest.SkipTest(reason)` Это исключение возбуждается для пропуска теста. Обычно можно использовать [`TestCase.skipTest()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.skipTest) или один из декораторов пропуска, вместо того чтобы возбуждать его напрямую. Пропущенные тесты не будут выполнять [`setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp) или [`tearDown()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDown). Пропущенные классы не будут выполнять [`setUpClass()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUpClass) или [`tearDownClass()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDownClass). Пропущенные модули не будут выполнять [`setUpModule()`](https://python-all.ru/3.15/library/unittest.html#unittest.setUpModule) или [`tearDownModule()`](https://python-all.ru/3.15/library/unittest.html#unittest.tearDownModule). ## Различение итераций теста с помощью подтестов Добавлено в версии 3.4. Когда между тестами есть очень небольшие различия, например некоторые параметры, unittest позволяет различать их внутри тела тестового метода с помощью контекстного менеджера [`subTest()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.subTest). Например, следующий тест: ```python class NumbersTest(unittest.TestCase): def test_even(self): """ Проверить, что все числа от 0 до 5 чётные. """ for i in range(0, 6): with self.subTest(i=i): self.assertEqual(i % 2, 0) ``` выдаст следующий результат: ```python ====================================================================== FAIL: test_even (__main__.NumbersTest.test_even) (i=1) Test that numbers between 0 and 5 are all even. ---------------------------------------------------------------------- Traceback (most recent call last): File "subtests.py", line 11, in test_even self.assertEqual(i % 2, 0) ^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError: 1 != 0 ====================================================================== FAIL: test_even (__main__.NumbersTest.test_even) (i=3) Test that numbers between 0 and 5 are all even. ---------------------------------------------------------------------- Traceback (most recent call last): File "subtests.py", line 11, in test_even self.assertEqual(i % 2, 0) ^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError: 1 != 0 ====================================================================== FAIL: test_even (__main__.NumbersTest.test_even) (i=5) Test that numbers between 0 and 5 are all even. ---------------------------------------------------------------------- Traceback (most recent call last): File "subtests.py", line 11, in test_even self.assertEqual(i % 2, 0) ^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError: 1 != 0 ``` Без использования подтеста выполнение остановилось бы после первого сбоя, и ошибку было бы труднее диагностировать, поскольку значение `i` не отображалось бы: ```python ====================================================================== FAIL: test_even (__main__.NumbersTest.test_even) ---------------------------------------------------------------------- Traceback (most recent call last): File "subtests.py", line 32, in test_even self.assertEqual(i % 2, 0) AssertionError: 1 != 0 ``` ## Классы и функции В этом разделе подробно описывается API `unittest`. ### Тестовые примеры #### `class unittest.TestCase(methodName='runTest')` Экземпляры класса `TestCase` представляют собой логические тестовые единицы в среде `unittest`. Этот класс предназначен для использования в качестве базового класса, при этом конкретные тесты реализуются в конкретных подклассах. Класс реализует интерфейс, необходимый тестовому исполнителю для управления тестами, а также методы, которые тестовый код может использовать для проверки и сообщения о различных видах сбоев. Каждый экземпляр `TestCase` выполняет один базовый метод: метод с именем *methodName*. В большинстве случаев использования `TestCase` не требуется ни изменять *methodName*, ни переопределять метод по умолчанию `runTest()`. Изменено в версии 3.2: `TestCase` можно успешно создать без указания *methodName*. Это упрощает эксперименты с `TestCase` в интерактивном интерпретаторе. Экземпляры `TestCase` предоставляют три группы методов: одна группа используется для выполнения теста, другая – реализацией теста для проверки условий и сообщения о сбоях, и несколько запросных методов, позволяющих собирать информацию о самом тесте. Методы первой группы (выполнение теста): #### `setUp()` Метод, вызываемый для подготовки тестовой фикстуры. Он вызывается непосредственно перед вызовом тестового метода; за исключением [`AssertionError`](https://python-all.ru/3.15/library/exceptions.html#AssertionError) или [`SkipTest`](https://python-all.ru/3.15/library/unittest.html#unittest.SkipTest), любое исключение, возбуждённое этим методом, будет считаться ошибкой, а не сбоем теста. Реализация по умолчанию ничего не делает. #### `tearDown()` Метод, вызываемый сразу после вызова тестового метода и записи результата. Он вызывается, даже если тестовый метод возбудил исключение, поэтому реализация в подклассах должна быть особенно осторожна при проверке внутреннего состояния. Любое исключение, кроме [`AssertionError`](https://python-all.ru/3.15/library/exceptions.html#AssertionError) или [`SkipTest`](https://python-all.ru/3.15/library/unittest.html#unittest.SkipTest), возбуждённое этим методом, будет считаться дополнительной ошибкой, а не сбоем теста (таким образом увеличивая общее количество сообщённых ошибок). Этот метод будет вызван только если [`setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp) выполнится успешно, независимо от результата тестового метода. Реализация по умолчанию ничего не делает. #### `setUpClass()` Метод класса, вызываемый перед выполнением тестов в отдельном классе. `setUpClass` вызывается с классом в качестве единственного аргумента и должен быть декорирован как [`classmethod()`](https://python-all.ru/3.15/library/functions.html#classmethod): ```python @classmethod def setUpClass(cls): ... ``` См. [Фикстуры классов и модулей](https://python-all.ru/3.15/library/unittest.html#class-and-module-fixtures) для получения дополнительных сведений. Добавлено в версии 3.2. #### `tearDownClass()` Метод класса, вызываемый после выполнения тестов в отдельном классе. `tearDownClass` вызывается с классом в качестве единственного аргумента и должен быть декорирован как [`classmethod()`](https://python-all.ru/3.15/library/functions.html#classmethod): ```python @classmethod def tearDownClass(cls): ... ``` См. [Фикстуры классов и модулей](https://python-all.ru/3.15/library/unittest.html#class-and-module-fixtures) для получения дополнительных сведений. Добавлено в версии 3.2. #### `run(result=None)` Запускает тест, собирая результат в объект [`TestResult`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult), переданный как *result*. Если *result* опущен или равен `None`, создаётся временный объект результата (путем вызова метода [`defaultTestResult()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.defaultTestResult)), который и используется. Объект результата возвращается вызывающему коду `run()`. Того же эффекта можно добиться простым вызовом экземпляра `TestCase`. Изменено в версии 3.3: Предыдущие версии `run` не возвращали результат. Также не возвращал результат вызов экземпляра. #### `skipTest(reason)` Вызов этого метода внутри тестового метода или [`setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp) пропускает текущий тест. Подробнее см. [Пропуск тестов и ожидаемые сбои](https://python-all.ru/3.15/library/unittest.html#unittest-skipping). Добавлено в версии 3.1. #### `subTest(msg=None, **params)` Возвращает менеджер контекста, который выполняет вложенный блок кода как подтест. *msg* и *params* – необязательные произвольные значения, отображаемые при сбое подтеста, что позволяет однозначно их идентифицировать. Тестовый пример может содержать любое количество объявлений подтестов, и они могут быть произвольно вложены. Подробнее см. [Различение итераций тестов с помощью подтестов](https://python-all.ru/3.15/library/unittest.html#subtests). Добавлено в версии 3.4. #### `debug()` Запускает тест без сбора результата. Это позволяет исключениям, возникшим в тесте, распространяться до вызывающего кода, и может использоваться для поддержки запуска тестов под отладчиком. Класс `TestCase` предоставляет несколько методов assert для проверки и сообщения об ошибках. В следующей таблице перечислены наиболее часто используемые методы (см. таблицы ниже для получения дополнительных методов assert): | Метод | Проверяет, что | Новое в | | --- | --- | --- | | [`assertEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertEqual) | `a == b` | | | [`assertNotEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertNotEqual) | `a != b` | | | [`assertTrue(x)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertTrue) | `bool(x) is True` | | | [`assertFalse(x)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertFalse) | `bool(x) is False` | | | [`assertIs(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertIs) | `a is b` | 3.1 | | [`assertIsNot(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertIsNot) | `a is not b` | 3.1 | | [`assertIsNone(x)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertIsNone) | `x is None` | 3.1 | | [`assertIsNotNone(x)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertIsNotNone) | `x is not None` | 3.1 | | [`assertIn(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertIn) | `a in b` | 3.1 | | [`assertNotIn(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertNotIn) | `a not in b` | 3.1 | | [`assertIsInstance(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertIsInstance) | `isinstance(a, b)` | 3.2 | | [`assertNotIsInstance(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertNotIsInstance) | `not isinstance(a, b)` | 3.2 | | [`assertIsSubclass(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertIsSubclass) | `issubclass(a, b)` | 3.14 | | [`assertNotIsSubclass(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertNotIsSubclass) | `not issubclass(a, b)` | 3.14 | Все методы assert принимают аргумент *msg*, который, если указан, используется как сообщение об ошибке в случае сбоя (см. также [`longMessage`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.longMessage)). Обратите внимание, что ключевой аргумент *msg* может быть передан методам [`assertRaises()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertRaises), [`assertRaisesRegex()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertRaisesRegex), [`assertWarns()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertWarns), [`assertWarnsRegex()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertWarnsRegex) только когда они используются как менеджер контекста. #### `assertEqual(first, second, msg=None)` Проверяет, что *first* и *second* равны. Если значения не равны, тест завершится с ошибкой. Кроме того, если *first* и *second* относятся к одному и тому же типу и это list, tuple, dict, set, frozenset, str или любой тип, зарегистрированный подклассом с помощью [`addTypeEqualityFunc()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.addTypeEqualityFunc), то будет вызвана типовая функция сравнения для формирования более информативного сообщения об ошибке по умолчанию (см. также [список типовых методов](https://python-all.ru/3.15/library/unittest.html#type-specific-methods)). Изменено в версии 3.1: Добавлен автоматический вызов типовой функции сравнения. Изменено в версии 3.2: [`assertMultiLineEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertMultiLineEqual) добавлен в качестве типовой функции сравнения по умолчанию для сравнения строк. #### `assertNotEqual(first, second, msg=None)` Проверяет, что *first* и *second* не равны. Если значения равны, тест завершится с ошибкой. #### `assertTrue(expr, msg=None)` #### `assertFalse(expr, msg=None)` Проверяет, что *expr* истинно (или ложно). Обратите внимание, что это эквивалентно `bool(expr) is True`, а не `expr is True` (для последнего используйте `assertIs(expr, True)`). Этот метод также следует избегать, если доступны более специфические методы (например, `assertEqual(a, b)` вместо `assertTrue(a == b)`), потому что они предоставляют более информативное сообщение об ошибке в случае сбоя. #### `assertIs(first, second, msg=None)` #### `assertIsNot(first, second, msg=None)` Проверяет, что *first* и *second* являются (или не являются) одним и тем же объектом. Добавлено в версии 3.1. #### `assertIsNone(expr, msg=None)` #### `assertIsNotNone(expr, msg=None)` Проверяет, что *expr* является (или не является) `None`. Добавлено в версии 3.1. #### `assertIn(member, container, msg=None)` #### `assertNotIn(member, container, msg=None)` Проверяет, что *member* находится (или не находится) в *container*. Добавлено в версии 3.1. #### `assertIsInstance(obj, cls, msg=None)` #### `assertNotIsInstance(obj, cls, msg=None)` Проверяет, что *obj* является (или не является) экземпляром *cls* (который может быть классом или кортежем классов, как поддерживается [`isinstance()`](https://python-all.ru/3.15/library/functions.html#isinstance)). Для проверки точного типа используйте [`assertIs(type(obj), cls)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertIs). Добавлено в версии 3.2. #### `assertIsSubclass(cls, superclass, msg=None)` #### `assertNotIsSubclass(cls, superclass, msg=None)` Проверяет, что *cls* является (или не является) подклассом *superclass* (который может быть классом или кортежем классов, как поддерживается [`issubclass()`](https://python-all.ru/3.15/library/functions.html#issubclass)). Для проверки точного типа используйте [`assertIs(cls, superclass)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertIs). Добавлено в версии 3.14. Также можно проверить возникновение исключений, предупреждений и сообщений журнала с помощью следующих методов: | Метод | Проверяет, что | Новое в | | --- | --- | --- | | [`assertRaises(exc, fun, *args, **kwds)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertRaises) | `fun(*args, **kwds)` возбуждает *exc* | | | [`assertRaisesRegex(exc, r, fun, *args, **kwds)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertRaisesRegex) | `fun(*args, **kwds)` возбуждает *exc* и сообщение соответствует регулярному выражению *r* | 3.1 | | [`assertWarns(warn, fun, *args, **kwds)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertWarns) | `fun(*args, **kwds)` возбуждает *warn* | 3.2 | | [`assertWarnsRegex(warn, r, fun, *args, **kwds)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertWarnsRegex) | `fun(*args, **kwds)` возбуждает *warn* и сообщение соответствует регулярному выражению *r* | 3.2 | | [`assertLogs(logger, level)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertLogs) | Блок `with` пишет в журнал *logger* с минимальным уровнем *level* | 3.4 | | [`assertNoLogs(logger, level)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertNoLogs) | Блок `with` не пишет в журнал*logger* с минимальным *level* | 3.10 | #### `assertRaises(exception, callable, *args, **kwds)` #### `assertRaises(exception, *, msg=None)` Проверяет, что исключение возбуждается, когда *callable* вызывается с любыми позиционными или именованными аргументами, которые также передаются в `assertRaises()`. Тест проходит, если возбуждается *исключение*, считается ошибкой, если возбуждается другое исключение, или не проходит, если исключение не возбуждается. Чтобы перехватить любое из группы исключений, можно передать кортеж, содержащий классы исключений, как *исключение*. Если переданы только аргументы *исключение* и, возможно, *msg*, возвращается менеджер контекста, чтобы проверяемый код можно было написать встроенно, а не в виде функции: ```python with self.assertRaises(SomeException): do_something() ``` При использовании в качестве менеджера контекста `assertRaises()` принимает дополнительный ключевой аргумент *msg*. Менеджер контекста сохраняет перехваченный объект исключения в своём атрибуте `exception`. Это может быть полезно, если нужно выполнить дополнительные проверки возникшего исключения: ```python with self.assertRaises(SomeException) as cm: do_something() the_exception = cm.exception self.assertEqual(the_exception.error_code, 3) ``` Изменено в версии 3.1: Добавлена возможность использовать `assertRaises()` в качестве менеджера контекста. Изменено в версии 3.2: Добавлен атрибут `exception`. Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста. #### `assertRaisesRegex(exception, regex, callable, *args, **kwds)` #### `assertRaisesRegex(exception, regex, *, msg=None)` Как [`assertRaises()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertRaises), но также проверяет, что *regex* соответствует строковому представлению возбуждённого исключения. *regex* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, подходящее для использования [`re.search()`](https://python-all.ru/3.15/library/re.html#re.search). Примеры: ```python self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$", int, 'XYZ') ``` или: ```python with self.assertRaisesRegex(ValueError, 'literal'): int('XYZ') ``` Добавлено в версии 3.1: Добавлено под именем `assertRaisesRegexp`. Изменено в версии 3.2: переименовано в `assertRaisesRegex()`. Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста. #### `assertWarns(warning, callable, *args, **kwds)` #### `assertWarns(warning, *, msg=None)` Проверяет, что предупреждение вызывается, когда *вызываемый объект* вызывается с любыми позиционными или ключевыми аргументами, которые также передаются в `assertWarns()`. Тест проходит, если *предупреждение* вызывается, и не проходит в противном случае. Любое исключение считается ошибкой. Чтобы перехватить любое из группы предупреждений, можно передать кортеж, содержащий классы предупреждений, в качестве *предупреждения*. Если указаны только *предупреждение* и, возможно, *msg*, возвращается менеджер контекста, позволяющий писать тестируемый код inline, а не в виде функции: ```python with self.assertWarns(SomeWarning): do_something() ``` При использовании в качестве менеджера контекста `assertWarns()` принимает дополнительный ключевой аргумент *msg*. Менеджер контекста сохраняет перехваченный объект предупреждения в своём атрибуте `warning`, а также исходную строку, вызвавшую предупреждения, в атрибутах `filename` и `lineno`. Это может быть полезно, если требуется выполнить дополнительные проверки перехваченного предупреждения: ```python with self.assertWarns(SomeWarning) as cm: do_something() self.assertIn('myfile.py', cm.filename) self.assertEqual(320, cm.lineno) ``` Менеджеры контекста можно вкладывать друг в друга, чтобы проверять, что выдаётся несколько разных предупреждений: ```python with (self.assertWarns(SomeWarning), self.assertWarns(OtherWarning)): do_something() ``` Этот метод работает независимо от фильтров предупреждений, установленных на момент его вызова. Добавлено в версии 3.2. Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста. Изменено в версии 3.15: Предупреждения, не соответствующие указанной категории, больше не подавляются. Теперь поддерживаются вложенные менеджеры контекста. #### `assertWarnsRegex(warning, regex, callable, *args, **kwds)` #### `assertWarnsRegex(warning, regex, *, msg=None)` Как и [`assertWarns()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertWarns), но также проверяет, что *регулярное выражение* соответствует сообщению вызванного предупреждения. *Регулярное выражение* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, пригодное для использования [`re.search()`](https://python-all.ru/3.15/library/re.html#re.search). Пример: ```python self.assertWarnsRegex(DeprecationWarning, r'legacy_function\(\) is deprecated', legacy_function, 'XYZ') ``` или: ```python with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'): frobnicate('/etc/passwd') ``` Менеджеры контекста можно вкладывать друг в друга, чтобы проверять, что выдаётся несколько разных предупреждений: ```python with (self.assertWarns(SomeWarning, regex1), self.assertWarns(OtherWarning, regex2)): do_something() ``` Добавлено в версии 3.2. Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста. Изменено в версии 3.15: Предупреждения, не соответствующие указанной категории или регулярному выражению, больше не подавляются. Теперь поддерживаются вложенные менеджеры контекста. #### `assertLogs(logger=None, level=None, formatter=None)` Менеджер контекста для проверки того, что хотя бы одно сообщение зарегистрировано в *логгере* или одном из его потомков, с уровнем не ниже указанного *уровня*. Если указан, *логгер* должен быть объектом [`logging.Logger`](https://python-all.ru/3.15/library/logging.html#logging.Logger) или [`str`](https://python-all.ru/3.15/library/stdtypes.html#str), задающим имя логгера. По умолчанию используется корневой логгер, который перехватывает все сообщения, не заблокированные непропагандирующим дочерним логгером. Если указан, *уровень* должен быть числовым уровнем логирования или его строковым эквивалентом (например, `"ERROR"` или [`logging.ERROR`](https://python-all.ru/3.15/library/logging.html#logging.ERROR)). По умолчанию [`logging.INFO`](https://python-all.ru/3.15/library/logging.html#logging.INFO). Если указан, *formatter* должен быть объектом [`logging.Formatter`](https://python-all.ru/3.15/library/logging.html#logging.Formatter). По умолчанию используется форматтер со строкой форматирования `"%(levelname)s:%(name)s:%(message)s"` Тест проходит, если хотя бы одно сообщение, отправленное внутри блока `with`, соответствует условиям *логгера* и *уровня*, в противном случае тест не проходит. Объект, возвращаемый менеджером контекста, представляет собой вспомогательный объект для записи, который отслеживает соответствующие сообщения журнала. Он имеет два атрибута: #### `records` Список объектов [`logging.LogRecord`](https://python-all.ru/3.15/library/logging.html#logging.LogRecord) соответствующих сообщений журнала. #### `output` Список объектов [`str`](https://python-all.ru/3.15/library/stdtypes.html#str) с отформатированным выводом соответствующих сообщений. Пример: ```python with self.assertLogs('foo', level='INFO') as cm: logging.getLogger('foo').info('first message') logging.getLogger('foo.bar').error('second message') self.assertEqual(cm.output, ['INFO:foo:first message', 'ERROR:foo.bar:second message']) ``` Добавлено в версии 3.4. Изменено в версии 3.15: Теперь принимает *formatter* для управления форматированием сообщений. #### `assertNoLogs(logger=None, level=None)` Менеджер контекста для проверки того, что на *логгере* или одном из его потомков не зарегистрировано ни одного сообщения с уровнем не ниже указанного *уровня*. Если указан, *логгер* должен быть объектом [`logging.Logger`](https://python-all.ru/3.15/library/logging.html#logging.Logger) или [`str`](https://python-all.ru/3.15/library/stdtypes.html#str), задающим имя логгера. По умолчанию используется корневой логгер, который перехватывает все сообщения. Если указан, *уровень* должен быть числовым уровнем логирования или его строковым эквивалентом (например, `"ERROR"` или [`logging.ERROR`](https://python-all.ru/3.15/library/logging.html#logging.ERROR)). По умолчанию [`logging.INFO`](https://python-all.ru/3.15/library/logging.html#logging.INFO). В отличие от [`assertLogs()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertLogs), менеджер контекста ничего не возвращает. Добавлено в версии 3.10. Существуют также другие методы для выполнения более специфических проверок, например: | Метод | Проверяет, что | Новое в | | --- | --- | --- | | [`assertAlmostEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertAlmostEqual) | `round(a-b, 7) == 0` | | | [`assertNotAlmostEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertNotAlmostEqual) | `round(a-b, 7) != 0` | | | [`assertGreater(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertGreater) | `a > b` | 3.1 | | [`assertGreaterEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertGreaterEqual) | `a >= b` | 3.1 | | [`assertLess(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertLess) | `a < b` | 3.1 | | [`assertLessEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertLessEqual) | `a <= b` | 3.1 | | [`assertRegex(s, r)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertRegex) | `r.search(s)` | 3.1 | | [`assertNotRegex(s, r)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertNotRegex) | `not r.search(s)` | 3.2 | | [`assertCountEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertCountEqual) | *a* содержит те же элементы, что и *b*, независимо от их порядка. | 3.2 | | [`assertStartsWith(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertStartsWith) | `a.startswith(b)` | 3.14 | | [`assertNotStartsWith(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertNotStartsWith) | `not a.startswith(b)` | 3.14 | | [`assertEndsWith(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertEndsWith) | `a.endswith(b)` | 3.14 | | [`assertNotEndsWith(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertNotEndsWith) | `not a.endswith(b)` | 3.14 | | [`assertHasAttr(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertHasAttr) | `hasattr(a, b)` | 3.14 | | [`assertNotHasAttr(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertNotHasAttr) | `not hasattr(a, b)` | 3.14 | #### `assertAlmostEqual(first, second, places=7, msg=None, delta=None)` #### `assertNotAlmostEqual(first, second, places=7, msg=None, delta=None)` Проверяет, что *first* и *second* приблизительно равны (или не равны), вычисляя разность, округляя до заданного числа десятичных знаков *places* (по умолчанию 7) и сравнивая с нулём. Обратите внимание, что эти методы округляют значения до заданного числа *десятичных знаков* (т.е. как функция [`round()`](https://python-all.ru/3.15/library/functions.html#round)), а не до *значащих цифр*. Если указан *delta* вместо *places*, то разность между *first* и *second* должна быть меньше или равна (или больше) *delta*. Одновременная передача *delta* и *places* вызывает [`TypeError`](https://python-all.ru/3.15/library/exceptions.html#TypeError). Изменено в версии 3.2: `assertAlmostEqual()` теперь автоматически считает приблизительно равными объекты, которые сравниваются как равные. `assertNotAlmostEqual()` теперь автоматически завершается ошибкой, если объекты сравниваются как равные. Добавлен именованный аргумент *delta*. #### `assertGreater(first, second, msg=None)` #### `assertGreaterEqual(first, second, msg=None)` #### `assertLess(first, second, msg=None)` #### `assertLessEqual(first, second, msg=None)` Проверяет, что *first* соответственно \>, \>=, \< или \<= по отношению к *second* в зависимости от имени метода. Если это не так, тест завершается ошибкой: ```python >>> self.assertGreaterEqual(3, 4) AssertionError: "3" unexpectedly not greater than or equal to "4" ``` Добавлено в версии 3.1. #### `assertRegex(text, regex, msg=None)` #### `assertNotRegex(text, regex, msg=None)` Проверяет, что поиск по *regex* совпадает (или не совпадает) с *text*. В случае неудачи сообщение об ошибке будет содержать шаблон и *text* (или шаблон и ту часть *text*, которая неожиданно совпала). *regex* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, подходящее для использования с [`re.search()`](https://python-all.ru/3.15/library/re.html#re.search). Добавлено в версии 3.1: Добавлено под именем `assertRegexpMatches`. Изменено в версии 3.2: Метод `assertRegexpMatches()` был переименован в `assertRegex()`. Добавлено в версии 3.2: `assertNotRegex()`. #### `assertCountEqual(first, second, msg=None)` Проверяет, что последовательность *first* содержит те же элементы, что и *second*, независимо от их порядка. Если нет, генерируется сообщение об ошибке с перечислением различий между последовательностями. Дублирующиеся элементы *не* игнорируются при сравнении *first* и *second*. Проверяется, что каждый элемент встречается одинаковое количество раз в обеих последовательностях. Эквивалентно: `assertEqual(Counter(list(first)), Counter(list(second)))` но также работает с последовательностями нехешируемых объектов. Добавлено в версии 3.2. #### `assertStartsWith(s, prefix, msg=None)` #### `assertNotStartsWith(s, prefix, msg=None)` Проверяет, что строка Unicode или байтовая строка *s* начинается (или не начинается) с *prefix*. *prefix* также может быть кортежем строк для проверки. Добавлено в версии 3.14. #### `assertEndsWith(s, suffix, msg=None)` #### `assertNotEndsWith(s, suffix, msg=None)` Проверяет, что строка Unicode или байтовая строка *s* заканчивается (или не заканчивается) на *suffix*. *suffix* также может быть кортежем строк для проверки. Добавлено в версии 3.14. #### `assertHasAttr(obj, name, msg=None)` #### `assertNotHasAttr(obj, name, msg=None)` Проверяет, что объект *obj* имеет (или не имеет) атрибут *name*. Добавлено в версии 3.14. Метод [`assertEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertEqual) направляет проверку равенства для объектов одного типа к различным методам, специфичным для типа. Эти методы уже реализованы для большинства встроенных типов, но также можно зарегистрировать новые методы с помощью [`addTypeEqualityFunc()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.addTypeEqualityFunc): #### `addTypeEqualityFunc(typeobj, function)` Регистрирует метод, специфичный для типа, вызываемый с помощью [`assertEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertEqual) для проверки, равны ли два объекта одного и того же *typeobj* (не подклассы). *function* должен принимать два позиционных аргумента и третий именованный аргумент msg=None, как и `assertEqual()`. Он должен вызывать [`self.failureException(msg)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.failureException) при обнаружении неравенства между первыми двумя параметрами – возможно, предоставляя полезную информацию и подробно объясняя неравенства в сообщении об ошибке. Добавлено в версии 3.1. Список типовых методов, автоматически используемых [`assertEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertEqual), приведён в следующей таблице. Обратите внимание, что обычно нет необходимости вызывать эти методы напрямую. | Метод | Используется для сравнения | Новое в | | --- | --- | --- | | [`assertMultiLineEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertMultiLineEqual) | строки | 3.1 | | [`assertSequenceEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertSequenceEqual) | последовательности | 3.1 | | [`assertListEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertListEqual) | списки | 3.1 | | [`assertTupleEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertTupleEqual) | кортежи | 3.1 | | [`assertSetEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertSetEqual) | множества или неизменяемые множества | 3.1 | | [`assertDictEqual(a, b)`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertDictEqual) | словари | 3.1 | #### `assertMultiLineEqual(first, second, msg=None)` Проверяет, что многострочная строка *first* равна строке *second*. Если они не равны, в сообщение об ошибке включается diff двух строк с подсветкой различий. Этот метод используется по умолчанию при сравнении строк с помощью [`assertEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertEqual). Добавлено в версии 3.1. #### `assertSequenceEqual(first, second, msg=None, seq_type=None)` Проверяет, что две последовательности равны. Если передан *seq\_type*, то *first* и *second* должны быть экземплярами *seq\_type*, иначе будет вызвана ошибка. Если последовательности различаются, формируется сообщение об ошибке, показывающее разницу между ними. Этот метод не вызывается напрямую методом [`assertEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertEqual), но используется для реализации [`assertListEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertListEqual) и [`assertTupleEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertTupleEqual). Добавлено в версии 3.1. #### `assertListEqual(first, second, msg=None)` #### `assertTupleEqual(first, second, msg=None)` Проверяет, что два списка или кортежа равны. Если нет, формируется сообщение об ошибке, показывающее только различия между ними. Ошибка также возникает, если один из параметров имеет неверный тип. Эти методы используются по умолчанию при сравнении списков или кортежей с помощью [`assertEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertEqual). Добавлено в версии 3.1. #### `assertSetEqual(first, second, msg=None)` Проверяет, что два множества равны. Если нет, формируется сообщение об ошибке, перечисляющее различия между множествами. Этот метод используется по умолчанию при сравнении множеств или неизменяемых множеств с помощью [`assertEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertEqual). Завершается ошибкой, если *first* или *second* не имеет метода [`difference()`](https://python-all.ru/3.15/library/stdtypes.html#frozenset.difference). Добавлено в версии 3.1. #### `assertDictEqual(first, second, msg=None)` Проверяет, что два словаря равны. Если нет, формируется сообщение об ошибке, показывающее различия в словарях. Этот метод будет использоваться по умолчанию для сравнения словарей в вызовах [`assertEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertEqual). Добавлено в версии 3.1. Наконец, `TestCase` предоставляет следующие методы и атрибуты: #### `fail(msg=None)` Безусловно сигнализирует о сбое теста, используя *msg* или `None` в качестве сообщения об ошибке. #### `failureException` Этот атрибут класса задаёт исключение, которое вызывается тестовым методом. Если тестовому фреймворку требуется использовать специализированное исключение, возможно, для передачи дополнительной информации, он должен создать подкласс этого исключения, чтобы «честно играть» с фреймворком. Начальное значение этого атрибута – [`AssertionError`](https://python-all.ru/3.15/library/exceptions.html#AssertionError). #### `longMessage` Этот атрибут класса определяет, что происходит, когда пользовательское сообщение об ошибке передаётся в качестве аргумента msg в вызов assertXYY, который завершается сбоем. Значение по умолчанию – `True`. В этом случае пользовательское сообщение добавляется в конец стандартного сообщения об ошибке. Если установлено `False`, пользовательское сообщение заменяет стандартное. Настройку класса можно переопределить в отдельных тестовых методах, присвоив атрибуту экземпляра self.longMessage значение `True` или `False` перед вызовом assert-методов. Настройка класса сбрасывается перед каждым вызовом теста. Добавлено в версии 3.1. #### `maxDiff` Этот атрибут управляет максимальной длиной вывода различий, выводимых методами утверждения, которые сообщают о различиях при неудаче. По умолчанию – 80\*8 символов. Методы утверждения, на которые влияет этот атрибут: [`assertSequenceEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertSequenceEqual) (включая все методы сравнения последовательностей, которые делегируют ему), [`assertDictEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertDictEqual) и [`assertMultiLineEqual()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.assertMultiLineEqual). Установка `maxDiff` в `None` означает, что максимальная длина различий не ограничена. Добавлено в версии 3.2. Тестовые фреймворки могут использовать следующие методы для сбора информации о тесте: #### `countTestCases()` Возвращает количество тестов, представленных этим тестовым объектом. Для экземпляров `TestCase` это всегда будет `1`. #### `defaultTestResult()` Возвращает экземпляр класса результата теста, который следует использовать для данного класса тестового случая (если ни один другой экземпляр результата не был передан методу [`run()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.run)). Для экземпляров `TestCase` это всегда будет экземпляр [`TestResult`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult); подклассы `TestCase` должны при необходимости переопределять это. #### `id()` Возвращает строку, идентифицирующую конкретный тестовый случай. Обычно это полное имя тестового метода, включая имя модуля и класса. #### `shortDescription()` Возвращает описание теста или `None`, если описание не было предоставлено. Реализация по умолчанию этого метода возвращает первую строку докстринга тестового метода, если он доступен, или `None`. Изменено в версии 3.1: В 3.1 это было изменено, чтобы добавлять имя теста в краткое описание даже при наличии докстринга. Это вызвало проблемы совместимости с расширениями unittest, и добавление имени теста было перенесено в [`TextTestResult`](https://python-all.ru/3.15/library/unittest.html#unittest.TextTestResult) в Python 3.2. #### `addCleanup(function, /, *args, **kwargs)` Добавляет функцию, которая будет вызвана после [`tearDown()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDown) для очистки ресурсов, использованных во время теста. Функции вызываются в порядке, обратном порядку их добавления (LIFO). Они вызываются с теми позиционными и именованными аргументами, которые были переданы в `addCleanup()` при их добавлении. Если [`setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp) завершается неудачей, то есть [`tearDown()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDown) не вызывается, любые добавленные функции очистки всё равно будут вызваны. Добавлено в версии 3.1. #### `enterContext(cm)` Входит в предоставленный [менеджер контекста](https://python-all.ru/3.15/glossary.html#term-context-manager). В случае успеха также добавляет его метод [`__exit__()`](https://python-all.ru/3.15/reference/datamodel.html#object.__exit__) как функцию очистки с помощью [`addCleanup()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.addCleanup) и возвращает результат метода [`__enter__()`](https://python-all.ru/3.15/reference/datamodel.html#object.__enter__). Добавлено в версии 3.12. #### `doCleanups()` Этот метод вызывается безусловно после [`tearDown()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDown) или после [`setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp), если `setUp()` вызывает исключение. Он отвечает за вызов всех функций очистки, добавленных с помощью [`addCleanup()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.addCleanup). Если необходимо, чтобы функции очистки вызывались *до* [`tearDown()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDown), то можно вызвать `doCleanups()` самостоятельно. `doCleanups()` извлекает методы из стека функций очистки по одному, поэтому его можно вызывать в любой момент. Добавлено в версии 3.1. #### `classmethod addClassCleanup(function, /, *args, **kwargs)` Добавляет функцию, которая будет вызвана после [`tearDownClass()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDownClass) для очистки ресурсов, использованных во время тестового класса. Функции вызываются в обратном порядке по сравнению с порядком их добавления (LIFO). Они вызываются с теми аргументами и именованными аргументами, которые были переданы в `addClassCleanup()` при их добавлении. Если [`setUpClass()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUpClass) завершается ошибкой, то есть [`tearDownClass()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDownClass) не вызывается, то все добавленные функции очистки всё равно будут вызваны. Добавлено в версии 3.8. #### `classmethod enterClassContext(cm)` Входит в предоставленный [менеджер контекста](https://python-all.ru/3.15/glossary.html#term-context-manager). В случае успеха также добавляет его метод [`__exit__()`](https://python-all.ru/3.15/reference/datamodel.html#object.__exit__) как функцию очистки с помощью [`addClassCleanup()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.addClassCleanup) и возвращает результат метода [`__enter__()`](https://python-all.ru/3.15/reference/datamodel.html#object.__enter__). Добавлено в версии 3.12. #### `classmethod doClassCleanups()` Этот метод вызывается безусловно после [`tearDownClass()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDownClass) или после [`setUpClass()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUpClass), если `setUpClass()` вызывает исключение. Он отвечает за вызов всех функций очистки, добавленных с помощью [`addClassCleanup()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.addClassCleanup). Если нужно, чтобы функции очистки вызывались *до* [`tearDownClass()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDownClass), то можно вызвать `doClassCleanups()` самостоятельно. `doClassCleanups()` извлекает методы из стека функций очистки по одному, поэтому его можно вызывать в любой момент. Добавлено в версии 3.8. #### `class unittest.IsolatedAsyncioTestCase(methodName='runTest')` Этот класс предоставляет API, похожий на [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase), и также принимает корутины в качестве тестовых функций. Добавлено в версии 3.8. #### `loop_factory` Значение *loop\_factory*, переданное в [`asyncio.Runner`](https://python-all.ru/3.15/library/asyncio-runner.html#asyncio.Runner). Переопределите его в подклассах с помощью [`asyncio.EventLoop`](https://python-all.ru/3.15/library/asyncio-eventloop.html#asyncio.EventLoop), чтобы не использовать систему политик asyncio. Добавлено в версии 3.13. #### `async asyncSetUp()` Метод вызывается для подготовки тестового окружения. Он вызывается после [`TestCase.setUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUp), непосредственно перед вызовом тестового метода; любое исключение, возбуждённое этим методом, за исключением [`AssertionError`](https://python-all.ru/3.15/library/exceptions.html#AssertionError) или [`SkipTest`](https://python-all.ru/3.15/library/unittest.html#unittest.SkipTest), считается ошибкой, а не неудачей теста. Реализация по умолчанию ничего не делает. #### `async asyncTearDown()` Метод, вызываемый сразу после вызова тестового метода и записи результата. Вызывается перед [`tearDown()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDown). Вызывается даже если тестовый метод возбудил исключение, поэтому реализация в подклассах должна быть особенно осторожна при проверке внутреннего состояния. Любое исключение, возбуждённое этим методом, за исключением [`AssertionError`](https://python-all.ru/3.15/library/exceptions.html#AssertionError) или [`SkipTest`](https://python-all.ru/3.15/library/unittest.html#unittest.SkipTest), считается дополнительной ошибкой, а не неудачей теста (таким образом, увеличивая общее количество сообщённых ошибок). Этот метод вызывается только в случае успеха [`asyncSetUp()`](https://python-all.ru/3.15/library/unittest.html#unittest.IsolatedAsyncioTestCase.asyncSetUp), независимо от результата тестового метода. Реализация по умолчанию ничего не делает. #### `addAsyncCleanup(function, /, *args, **kwargs)` Этот метод принимает корутину, которая может использоваться как функция очистки. #### `async enterAsyncContext(cm)` Входит в предоставленный [асинхронный менеджер контекста](https://python-all.ru/3.15/glossary.html#term-asynchronous-context-manager). В случае успеха также добавляет его метод [`__aexit__()`](https://python-all.ru/3.15/reference/datamodel.html#object.__aexit__) как функцию очистки с помощью [`addAsyncCleanup()`](https://python-all.ru/3.15/library/unittest.html#unittest.IsolatedAsyncioTestCase.addAsyncCleanup) и возвращает результат метода [`__aenter__()`](https://python-all.ru/3.15/reference/datamodel.html#object.__aenter__). Добавлено в версии 3.12. #### `run(result=None)` Настраивает новый цикл событий для выполнения теста, собирая результат в объект [`TestResult`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult), переданный как *result*. Если *result* опущен или равен `None`, создаётся временный объект результата (вызовом метода [`defaultTestResult()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.defaultTestResult)) и используется. Объект результата возвращается вызывающему `run()`. В конце теста все задачи в цикле событий отменяются. Пример, иллюстрирующий порядок: ```python from unittest import IsolatedAsyncioTestCase events = [] class Test(IsolatedAsyncioTestCase): def setUp(self): events.append("setUp") async def asyncSetUp(self): self._async_connection = await AsyncConnection() events.append("asyncSetUp") async def test_response(self): events.append("test_response") response = await self._async_connection.get("https://example.com") self.assertEqual(response.status_code, 200) self.addAsyncCleanup(self.on_cleanup) def tearDown(self): events.append("tearDown") async def asyncTearDown(self): await self._async_connection.close() events.append("asyncTearDown") async def on_cleanup(self): events.append("cleanup") if __name__ == "__main__": unittest.main() ``` После запуска теста `events` будет содержать `["setUp", "asyncSetUp", "test_response", "asyncTearDown", "tearDown", "cleanup"]`. #### `class unittest.FunctionTestCase(testFunc, setUp=None, tearDown=None, description=None)` Этот класс реализует ту часть интерфейса [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase), которая позволяет исполнителю тестов управлять тестом, но не предоставляет методов, которые тестовый код может использовать для проверки и сообщения об ошибках. Это используется для создания тестовых примеров с использованием устаревшего тестового кода, что позволяет интегрировать его в тестовую среду на основе `unittest`. ### Группировка тестов #### `class unittest.TestSuite(tests=())` Этот класс представляет собой агрегацию отдельных тестовых примеров и тестовых наборов. Класс предоставляет интерфейс, необходимый исполнителю тестов, чтобы его можно было запускать как любой другой тестовый пример. Запуск экземпляра `TestSuite` равносилен итерации по набору с запуском каждого теста по отдельности. Если задан *tests*, он должен быть итерабельным объектом, содержащим отдельные тестовые примеры или другие тестовые наборы, которые будут использоваться для первоначального построения набора. Дополнительные методы предоставляются для добавления тестовых примеров и наборов в коллекцию позже. Объекты `TestSuite` ведут себя во многом как объекты [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase), за исключением того, что они не реализуют фактический тест. Вместо этого они используются для объединения тестов в группы, которые должны запускаться вместе. Некоторые дополнительные методы доступны для добавления тестов в экземпляры `TestSuite`: #### `addTest(test)` Добавляет [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) или `TestSuite` в набор. #### `addTests(tests)` Добавляет все тесты из итерабельного объекта, содержащего экземпляры [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) и `TestSuite`, в этот тестовый набор. Это эквивалентно итерации по *tests* с вызовом [`addTest()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite.addTest) для каждого элемента. `TestSuite` разделяет следующие методы с [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase): #### `run(result)` Запускает тесты, связанные с этим набором, собирая результат в объект результата теста, переданный как *result*. Обратите внимание, что, в отличие от [`TestCase.run()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.run), `TestSuite.run()` требует, чтобы объект результата был передан. #### `debug()` Запускает тесты, связанные с этим набором, без сбора результата. Это позволяет исключениям, возбуждённым тестом, распространяться до вызывающего кода и может использоваться для поддержки запуска тестов под отладчиком. #### `countTestCases()` Возвращает количество тестов, представленных этим тестовым объектом, включая все отдельные тесты и поднаборы. #### `__iter__()` Тесты, сгруппированные с помощью `TestSuite`, всегда доступны через итерацию. Подклассы могут лениво предоставлять тесты, переопределяя `__iter__()`. Обратите внимание, что этот метод может вызываться несколько раз для одного набора (например, при подсчёте тестов или сравнении на равенство), поэтому тесты, возвращаемые повторными итерациями до [`TestSuite.run()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite.run), должны быть одинаковыми для каждого вызова итерации. После `TestSuite.run()` вызывающий код не должен полагаться на тесты, возвращаемые этим методом, если только вызывающий код не использует подкласс, который переопределяет `TestSuite._removeTestAtIndex()` для сохранения ссылок на тесты. Изменено в версии 3.2: В более ранних версиях `TestSuite` обращался к тестам напрямую, а не через итерацию, поэтому переопределения `__iter__()` было недостаточно для предоставления тестов. Изменено в версии 3.4: В более ранних версиях `TestSuite` хранил ссылки на каждый [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) после [`TestSuite.run()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite.run). Подклассы могут восстановить такое поведение, переопределив `TestSuite._removeTestAtIndex()`. При типичном использовании объекта `TestSuite` метод [`run()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite.run) вызывается с помощью `TestRunner`, а не через тестовую оболочку конечного пользователя. ### Загрузка и запуск тестов #### `class unittest.TestLoader` Класс `TestLoader` используется для создания тестовых наборов из классов и модулей. Обычно нет необходимости создавать экземпляр этого класса; модуль `unittest` предоставляет экземпляр, который можно использовать совместно как [`unittest.defaultTestLoader`](https://python-all.ru/3.15/library/unittest.html#unittest.defaultTestLoader). Однако использование подкласса или экземпляра позволяет настраивать некоторые конфигурируемые свойства. Объекты `TestLoader` имеют следующие атрибуты: #### `errors` Список нефатальных ошибок, возникших при загрузке тестов. Не сбрасывается загрузчиком ни в какой момент. Фатальные ошибки сигнализируются соответствующим методом, который генерирует исключение для вызывающего кода. Нефатальные ошибки также указываются синтетическим тестом, который при выполнении вызовет исходную ошибку. Добавлено в версии 3.5. Объекты `TestLoader` имеют следующие методы: #### `loadTestsFromTestCase(testCaseClass)` Возвращает набор всех тестов, содержащихся в `testCaseClass`, производном от [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase). Экземпляр тестового случая создаётся для каждого метода, именованного [`getTestCaseNames()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestLoader.getTestCaseNames). По умолчанию это имена методов, начинающиеся с `test`. Если `getTestCaseNames()` не возвращает ни одного метода, но метод `runTest()` реализован, то вместо этого создаётся один тестовый случай для этого метода. #### `loadTestsFromModule(module, *, pattern=None)` Возвращает набор всех тестовых случаев, содержащихся в данном модуле. Этот метод ищет в *module* классы, производные от [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase), и создаёт экземпляр класса для каждого тестового метода, определённого для этого класса. > **Примечание** > > Хотя использование иерархии классов, производных от [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase), может быть удобным для совместного использования фикстур и вспомогательных функций, определение тестовых методов в базовых классах, которые не предназначены для прямого создания экземпляров, плохо сочетается с этим методом. Однако это может быть полезно, когда фикстуры различаются и определены в подклассах. Если модуль предоставляет функцию `load_tests`, она будет вызвана для загрузки тестов. Это позволяет модулям настраивать загрузку тестов. Это называется [протокол load\_tests](https://python-all.ru/3.15/library/unittest.html#id1). Аргумент *pattern* передаётся как третий аргумент в `load_tests`. Изменено в версии 3.2: Добавлена поддержка `load_tests`. Изменено в версии 3.5: Добавлена поддержка аргумента, передаваемого только по ключу, *pattern*. Изменено в версии 3.12: Незадокументированный и неофициальный параметр *use\_load\_tests* был удалён. #### `loadTestsFromName(name, module=None)` Возвращает набор всех тестовых случаев по заданному строковому спецификатору. Спецификатор *name* – это «точечное имя», которое может указывать на модуль, класс тестового случая, тестовый метод внутри класса тестового случая, экземпляр [`TestSuite`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite) или вызываемый объект, возвращающий экземпляр [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) или `TestSuite`. Эти проверки применяются в указанном порядке; то есть метод в возможном классе тестового случая будет распознан как «тестовый метод внутри класса тестового случая», а не как «вызываемый объект». Например, если у вас есть модуль `SampleTests`, содержащий класс `SampleTestCase`, производный от [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase), с тремя тестовыми методами (`test_one()`, `test_two()` и `test_three()`), спецификатор `'SampleTests.SampleTestCase'` заставит этот метод вернуть набор, который выполнит все три тестовых метода. Использование спецификатора `'SampleTests.SampleTestCase.test_two'` приведёт к возврату тестового набора, который выполнит только тестовый метод `test_two()`. Спецификатор может ссылаться на модули и пакеты, которые не были импортированы; они будут импортированы как побочный эффект. Метод опционально разрешает *name* относительно заданного *module*. Изменено в версии 3.5: Если при обходе *name* возникает [`ImportError`](https://python-all.ru/3.15/library/exceptions.html#ImportError) или [`AttributeError`](https://python-all.ru/3.15/library/exceptions.html#AttributeError), то будет возвращён синтетический тест, который при выполнении вызывает эту ошибку. Эти ошибки включаются в ошибки, накопленные self.errors. #### `loadTestsFromNames(names, module=None)` Аналогичен [`loadTestsFromName()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestLoader.loadTestsFromName), но принимает последовательность имён, а не одно имя. Возвращаемое значение – тестовый набор, который включает все тесты, определённые для каждого имени. #### `getTestCaseNames(testCaseClass)` Возвращает отсортированную последовательность имён методов, найденных в *testCaseClass*; это должен быть подкласс [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase). #### `discover(start_dir, pattern='test*.py', top_level_dir=None)` Находит все тестовые модули, рекурсивно обходя подкаталоги, начиная с указанного каталога, и возвращает объект TestSuite, содержащий их. Будут загружены только тестовые файлы, соответствующие *pattern*. (Используется сопоставление с образцом в стиле shell.) Будут загружены только имена модулей, которые можно импортировать (т.е. являются допустимыми идентификаторами Python). Все тестовые модули должны быть импортируемы из корневого каталога проекта. Если начальный каталог не является корневым, то *top\_level\_dir* необходимо указать отдельно. Если импорт модуля завершается неудачей, например из-за синтаксической ошибки, это записывается как одна ошибка, и поиск продолжается. Если неудача импорта связана с возникновением [`SkipTest`](https://python-all.ru/3.15/library/unittest.html#unittest.SkipTest), это будет записано как пропуск, а не как ошибка. Если найден пакет (каталог, содержащий файл с именем `__init__.py`), в пакете проверяется наличие функции `load_tests`. Если она существует, она вызывается с помощью `package.load_tests(loader, tests, pattern)`. Поиск тестов гарантирует, что пакет проверяется на наличие тестов только один раз за вызов, даже если сама функция load\_tests вызывает `loader.discover`. Если `load_tests` существует, то поиск *не* рекурсирует в пакет, `load_tests` отвечает за загрузку всех тестов в пакете. Шаблон намеренно не хранится как атрибут загрузчика, чтобы пакеты могли продолжать поиск самостоятельно. *top\_level\_dir* хранится внутренне и используется по умолчанию для любых вложенных вызовов `discover()`. То есть, если `load_tests` пакета вызывает `loader.discover()`, ему не нужно передавать этот аргумент. *start\_dir* может быть как точечным именем модуля, так и каталогом. Добавлено в версии 3.2. Изменено в версии 3.4: Модули, вызывающие [`SkipTest`](https://python-all.ru/3.15/library/unittest.html#unittest.SkipTest) при импорте, записываются как пропуски, а не ошибки. *start\_dir* может быть [пакетом пространства имён](https://python-all.ru/3.15/glossary.html#term-namespace-package). Пути сортируются перед импортом, чтобы порядок выполнения оставался одинаковым, даже если порядок в файловой системе не зависит от имени файла. Изменено в версии 3.5: Найденные пакеты теперь проверяются на наличие `load_tests` независимо от того, соответствует ли их путь *pattern*, поскольку имя пакета не может соответствовать шаблону по умолчанию. Изменено в версии 3.11: *start\_dir* не может быть [пакетом пространства имён](https://python-all.ru/3.15/glossary.html#term-namespace-package). Это было сломано начиная с Python 3.7, и Python 3.11 официально удаляет эту возможность. Изменено в версии 3.13: *top\_level\_dir* сохраняется только на время вызова *discover*. Изменено в версии 3.14: *start\_dir* снова может быть [пакетом пространства имён](https://python-all.ru/3.15/glossary.html#term-namespace-package). Следующие атрибуты `TestLoader` можно настроить либо через наследование, либо через присваивание экземпляру: #### `testMethodPrefix` Строка, задающая префикс имён методов, которые будут интерпретироваться как тестовые методы. Значение по умолчанию – `'test'`. Это влияет на [`getTestCaseNames()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestLoader.getTestCaseNames) и все методы `loadTestsFrom*`. #### `sortTestMethodsUsing` Функция, используемая для сравнения имён методов при их сортировке в [`getTestCaseNames()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestLoader.getTestCaseNames) и во всех методах `loadTestsFrom*`. #### `suiteClass` Вызываемый объект, который создаёт тестовый набор из списка тестов. Никакие методы результирующего объекта не требуются. Значение по умолчанию – класс [`TestSuite`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite). Это влияет на все методы `loadTestsFrom*`. #### `testNamePatterns` Список шаблонов имён тестов в стиле оболочки Unix (символы подстановки), которым должны соответствовать тестовые методы для включения в наборы тестов (см. опцию `-k`). Если этот атрибут не равен `None` (по умолчанию), все тестовые методы, которые должны быть включены в тестовые наборы, должны соответствовать одному из шаблонов в этом списке. Обратите внимание, что сопоставление всегда выполняется с помощью [`fnmatch.fnmatchcase()`](https://python-all.ru/3.15/library/fnmatch.html#fnmatch.fnmatchcase), поэтому, в отличие от шаблонов, переданных опции `-k`, простые шаблоны подстрок придётся преобразовать с использованием подстановочных знаков `*`. Это влияет на все методы `loadTestsFrom*`. Добавлено в версии 3.7. #### `class unittest.TestResult` Этот класс используется для сбора информации о том, какие тесты прошли успешно, а какие завершились неудачей. Объект `TestResult` хранит результаты набора тестов. Классы [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) и [`TestSuite`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite) обеспечивают правильную запись результатов; авторам тестов не нужно беспокоиться о записи результатов тестов. Тестовые фреймворки, построенные на базе `unittest`, могут нуждаться в доступе к объекту `TestResult`, созданному при запуске набора тестов для целей отчетности; для этого метод `TestRunner.run()` возвращает экземпляр `TestResult`. Экземпляры `TestResult` имеют следующие атрибуты, которые будут интересны при проверке результатов запуска набора тестов: #### `errors` Список, содержащий 2-кортежи экземпляров [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) и строк с форматированными трассировками. Каждый кортеж представляет тест, вызвавший неожиданное исключение. #### `failures` Список, содержащий 2-кортежи экземпляров [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) и строк с форматированными трассировками. Каждый кортеж представляет тест, в котором сбой был явно обозначен с помощью методов [assert\*](https://python-all.ru/3.15/library/unittest.html#assert-methods). #### `skipped` Список, содержащий 2-кортежи экземпляров [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) и строк с причиной пропуска теста. Добавлено в версии 3.1. #### `expectedFailures` Список, содержащий 2-кортежи экземпляров [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) и строк с форматированными трассировками. Каждый кортеж представляет ожидаемый сбой или ошибку тестового случая. #### `unexpectedSuccesses` Список, содержащий экземпляры [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase), которые были помечены как ожидаемые сбои, но завершились успешно. #### `collectedDurations` Список, содержащий 2-кортежи имен тестовых случаев и чисел с плавающей точкой, представляющих затраченное время каждого запущенного теста. Добавлено в версии 3.12. #### `shouldStop` Устанавливается в `True`, когда выполнение тестов должно быть остановлено с помощью [`stop()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.stop). #### `testsRun` Общее количество запущенных на данный момент тестов. #### `buffer` Если установлено в true, `sys.stdout` и `sys.stderr` будут буферизироваться между вызовами [`startTest()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.startTest) и [`stopTest()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.stopTest). Собранный вывод будет передаваться на реальные `sys.stdout` и `sys.stderr` только в случае сбоя или ошибки теста. Любой вывод также прикрепляется к сообщению о сбое/ошибке. Добавлено в версии 3.2. #### `failfast` Если установлено в true, [`stop()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.stop) будет вызван при первой ошибке или сбое, останавливая выполнение теста. Добавлено в версии 3.2. #### `tb_locals` Если установлено в true, то локальные переменные будут отображаться в трассировках. Добавлено в версии 3.5. #### `wasSuccessful()` Возвращает `True`, если все запущенные на данный момент тесты пройдены, в противном случае возвращает `False`. Изменено в версии 3.4: Возвращает `False`, если были какие-либо [`unexpectedSuccesses`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.unexpectedSuccesses) от тестов, помеченных декоратором [`expectedFailure()`](https://python-all.ru/3.15/library/unittest.html#unittest.expectedFailure). #### `stop()` Этот метод может быть вызван, чтобы указать, что выполняемый набор тестов должен быть прерван установкой атрибута [`shouldStop`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.shouldStop) в `True`. Объекты `TestRunner` должны учитывать этот флаг и возвращаться без запуска дополнительных тестов. Например, эта возможность используется классом [`TextTestRunner`](https://python-all.ru/3.15/library/unittest.html#unittest.TextTestRunner) для остановки тестового фреймворка, когда пользователь подает сигнал прерывания с клавиатуры. Интерактивные инструменты, предоставляющие реализации `TestRunner`, могут использовать это аналогичным образом. Следующие методы класса `TestResult` используются для поддержки внутренних структур данных и могут быть расширены в подклассах для поддержки дополнительных требований к отчетности. Это особенно полезно при создании инструментов, поддерживающих интерактивную отчетность во время выполнения тестов. #### `startTest(test)` Вызывается перед запуском тестового сценария *test*. #### `stopTest(test)` Вызывается после выполнения тестового сценария *test*, независимо от результата. #### `startTestRun()` Вызывается один раз перед выполнением любых тестов. Добавлено в версии 3.1. #### `stopTestRun()` Вызывается один раз после выполнения всех тестов. Добавлено в версии 3.1. #### `addError(test, err)` Вызывается, когда тестовый сценарий *test* порождает неожиданное исключение. *err* – кортеж вида, возвращаемого [`sys.exc_info()`](https://python-all.ru/3.15/library/sys.html#sys.exc_info): `(type, value, traceback)`. Реализация по умолчанию добавляет кортеж `(test, formatted_err)` к атрибуту [`errors`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.errors) экземпляра, где *formatted\_err* – форматированная трассировка, полученная из *err*. #### `addFailure(test, err)` Вызывается, когда тестовый сценарий *test* сигнализирует о сбое. *err* – кортеж вида, возвращаемого [`sys.exc_info()`](https://python-all.ru/3.15/library/sys.html#sys.exc_info): `(type, value, traceback)`. Реализация по умолчанию добавляет кортеж `(test, formatted_err)` к атрибуту [`failures`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.failures) экземпляра, где *formatted\_err* – форматированная трассировка, полученная из *err*. #### `addSuccess(test)` Вызывается, когда тестовый сценарий *test* завершается успешно. Реализация по умолчанию ничего не делает. #### `addSkip(test, reason)` Вызывается, когда тестовый сценарий *test* пропускается. *reason* – причина, которую тест указал для пропуска. Реализация по умолчанию добавляет кортеж `(test, reason)` к атрибуту [`skipped`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.skipped) экземпляра. #### `addExpectedFailure(test, err)` Вызывается, когда тестовый сценарий *test* завершается неудачей или ошибкой, но был помечен декоратором [`expectedFailure()`](https://python-all.ru/3.15/library/unittest.html#unittest.expectedFailure). Реализация по умолчанию добавляет кортеж `(test, formatted_err)` к атрибуту [`expectedFailures`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.expectedFailures) экземпляра, где *formatted\_err* – форматированная трассировка, полученная из *err*. #### `addUnexpectedSuccess(test)` Вызывается, когда тестовый сценарий *test* был помечен декоратором [`expectedFailure()`](https://python-all.ru/3.15/library/unittest.html#unittest.expectedFailure), но завершился успешно. Реализация по умолчанию добавляет тест к атрибуту [`unexpectedSuccesses`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.unexpectedSuccesses) экземпляра. #### `addSubTest(test, subtest, outcome)` Вызывается, когда завершается подтест. *test* – тестовый сценарий, соответствующий тестовому методу. *subtest* – пользовательский экземпляр [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase), описывающий подтест. Если *outcome* равен [`None`](https://python-all.ru/3.15/library/constants.html#None), подтест завершился успешно. В противном случае он завершился исключением, где *outcome* – кортеж вида, возвращаемого [`sys.exc_info()`](https://python-all.ru/3.15/library/sys.html#sys.exc_info): `(type, value, traceback)`. Реализация по умолчанию ничего не делает, если результат – успех, и записывает сбои подтестов как обычные сбои. Добавлено в версии 3.4. #### `addDuration(test, elapsed)` Вызывается после завершения тестового сценария. *elapsed* – время, выраженное в секундах, включающее выполнение функций очистки. Добавлено в версии 3.12. #### `class unittest.TextTestResult(stream, descriptions, verbosity, *, durations=None)` Конкретная реализация [`TestResult`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult), используемая [`TextTestRunner`](https://python-all.ru/3.15/library/unittest.html#unittest.TextTestRunner). Подклассы должны принимать `**kwargs`, чтобы обеспечить совместимость при изменении интерфейса. Добавлено в версии 3.2. Изменено в версии 3.12: Добавлен именованный параметр *durations*. #### `unittest.defaultTestLoader` Экземпляр класса [`TestLoader`](https://python-all.ru/3.15/library/unittest.html#unittest.TestLoader), предназначенный для совместного использования. Если настройка `TestLoader` не требуется, можно использовать этот экземпляр вместо повторного создания новых. #### `class unittest.TextTestRunner(stream=None, descriptions=True, verbosity=1, failfast=False, buffer=False, resultclass=None, warnings=None, *, tb_locals=False, durations=None)` Базовая реализация запуска тестов, которая выводит результаты в поток данных. Если *stream* равен `None` (значение по умолчанию), в качестве выходного потока данных используется [`sys.stderr`](https://python-all.ru/3.15/library/sys.html#sys.stderr). Этот класс имеет несколько настраиваемых параметров, но в целом очень прост. Графические приложения, запускающие наборы тестов, должны предоставлять альтернативные реализации. Такие реализации должны принимать `**kwargs`, поскольку интерфейс для создания запускаторов меняется при добавлении новых возможностей в unittest. По умолчанию этот запускатор показывает [`DeprecationWarning`](https://python-all.ru/3.15/library/exceptions.html#DeprecationWarning), [`PendingDeprecationWarning`](https://python-all.ru/3.15/library/exceptions.html#PendingDeprecationWarning), [`ResourceWarning`](https://python-all.ru/3.15/library/exceptions.html#ResourceWarning) и [`ImportWarning`](https://python-all.ru/3.15/library/exceptions.html#ImportWarning), даже если они [игнорируются по умолчанию](https://python-all.ru/3.15/library/warnings.html#warning-ignored). Это поведение можно переопределить с помощью опций Python `-Wd` или `-Wa` (см. [Управление предупреждениями](https://python-all.ru/3.15/using/cmdline.html#using-on-warnings)), оставив *warnings* равным `None`. Изменено в версии 3.2: Добавлен параметр *warnings*. Изменено в версии 3.2: Поток по умолчанию устанавливается на [`sys.stderr`](https://python-all.ru/3.15/library/sys.html#sys.stderr) в момент создания экземпляра, а не при импорте. Изменено в версии 3.5: Добавлен параметр *tb\_locals*. Изменено в версии 3.12: Добавлен параметр *durations*. #### `_makeResult()` Этот метод возвращает экземпляр `TestResult`, используемый [`run()`](https://python-all.ru/3.15/library/unittest.html#unittest.TextTestRunner.run). Он не предназначен для прямого вызова, но может быть переопределён в подклассах для предоставления собственного `TestResult`. `_makeResult()` создаёт экземпляр класса или вызываемого объекта, переданного в конструктор `TextTestRunner` как аргумент `resultclass`. По умолчанию используется [`TextTestResult`](https://python-all.ru/3.15/library/unittest.html#unittest.TextTestResult), если `resultclass` не предоставлен. Класс результата создаётся со следующими аргументами: ```python stream, descriptions, verbosity ``` #### `run(test)` Этот метод является основным публичным интерфейсом `TextTestRunner`. Он принимает экземпляр [`TestSuite`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite) или [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase). [`TestResult`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult) создаётся вызовом [`_makeResult()`](https://python-all.ru/3.15/library/unittest.html#unittest.TextTestRunner._makeResult), после чего тест(ы) выполняются, а результаты выводятся в stdout. #### `unittest.main(module='__main__', defaultTest=None, argv=None, testRunner=None, testLoader=unittest.defaultTestLoader, exit=True, verbosity=1, failfast=None, catchbreak=None, buffer=None, warnings=None)` Программа командной строки, которая загружает набор тестов из *module* и запускает их; это в первую очередь для удобного выполнения тестовых модулей. Простейший способ использования этой функции – добавить следующую строку в конец тестового скрипта: ```python if __name__ == '__main__': unittest.main() ``` Можно запускать тесты с более подробной информацией, передав аргумент verbosity: ```python if __name__ == '__main__': unittest.main(verbosity=2) ``` Аргумент *defaultTest* может быть либо именем одного теста, либо итерируемым объектом с именами тестов для запуска, если имена тестов не указаны через *argv*. Если он не задан или равен `None`, а имена тестов не переданы через *argv*, выполняются все тесты, найденные в *module*. Аргумент *argv* может быть списком параметров, переданных программе, где первый элемент – имя программы. Если он не задан или равен `None`, используются значения [`sys.argv`](https://python-all.ru/3.15/library/sys.html#sys.argv). Аргумент *testRunner* может быть либо классом запускатора тестов, либо уже созданным экземпляром такого класса. По умолчанию `main` вызывает [`sys.exit()`](https://python-all.ru/3.15/library/sys.html#sys.exit) с кодом возврата, указывающим на успех (0) или неудачу (1) выполненных тестов. Код возврата 5 означает, что тесты не выполнялись или были пропущены. Аргумент *testLoader* должен быть экземпляром [`TestLoader`](https://python-all.ru/3.15/library/unittest.html#unittest.TestLoader) и по умолчанию равен [`defaultTestLoader`](https://python-all.ru/3.15/library/unittest.html#unittest.defaultTestLoader). `main` поддерживает использование из интерактивного интерпретатора при передаче аргумента `exit=False`. При этом результат выводится в стандартный вывод без вызова [`sys.exit()`](https://python-all.ru/3.15/library/sys.html#sys.exit): ```python >>> from unittest import main >>> main(module='test_module', exit=False) ``` Параметры *failfast*, *catchbreak* и *buffer* имеют тот же эффект, что и одноимённые [параметры командной строки](https://python-all.ru/3.15/library/unittest.html#command-line-options). Аргумент *warnings* задаёт [фильтр предупреждений](https://python-all.ru/3.15/library/warnings.html#warning-filter), который следует использовать при выполнении тестов. Если он не указан, он останется `None` при передаче опции `-W` в **python** (см. [Управление предупреждениями](https://python-all.ru/3.15/using/cmdline.html#using-on-warnings)), в противном случае будет установлен в `'default'`. Вызов `main` возвращает объект с атрибутом `result`, содержащим результат выполнения тестов в виде [`unittest.TestResult`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult). Изменено в версии 3.1: Добавлен параметр *exit*. Изменено в версии 3.2: Добавлены параметры *verbosity*, *failfast*, *catchbreak*, *buffer* и *warnings*. Изменено в версии 3.4: Параметр *defaultTest* был изменён: теперь он также принимает итерируемый объект с именами тестов. #### Протокол load\_tests Добавлено в версии 3.2. Модули или пакеты могут настраивать загрузку тестов из себя во время обычного запуска тестов или их обнаружения, реализуя функцию с именем `load_tests`. Если тестовый модуль определяет `load_tests`, то он будет вызван функцией [`TestLoader.loadTestsFromModule()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestLoader.loadTestsFromModule) со следующими аргументами: ```python load_tests(loader, standard_tests, pattern) ``` где *pattern* передаётся напрямую из `loadTestsFromModule`. По умолчанию он равен `None`. Она должна возвращать объект [`TestSuite`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite). *loader* – это экземпляр [`TestLoader`](https://python-all.ru/3.15/library/unittest.html#unittest.TestLoader), выполняющий загрузку. *standard\_tests* – это тесты, которые будут загружены по умолчанию из модуля. Часто тестовые модули хотят только добавить или удалить тесты из стандартного набора. Третий аргумент используется при загрузке пакетов в рамках обнаружения тестов. Типичная функция `load_tests`, загружающая тесты из определённого набора классов [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase), может выглядеть так: ```python test_cases = (TestCase1, TestCase2, TestCase3) def load_tests(loader, tests, pattern): suite = TestSuite() for test_class in test_cases: tests = loader.loadTestsFromTestCase(test_class) suite.addTests(tests) return suite ``` Если обнаружение запускается в каталоге, содержащем пакет, либо из командной строки, либо вызовом [`TestLoader.discover()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestLoader.discover), то у пакета `__init__.py` проверяется наличие `load_tests`. Если такой функции нет, обнаружение рекурсивно обходит пакет, как если бы это был просто ещё один каталог. В противном случае обнаружение тестов пакета передаётся функции `load_tests`, которая вызывается со следующими аргументами: ```python load_tests(loader, standard_tests, pattern) ``` Она должна возвращать объект [`TestSuite`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite), представляющий все тесты из пакета. (`standard_tests` будет содержать только тесты, собранные из `__init__.py`.) Поскольку шаблон передаётся в `load_tests`, пакет может продолжить (и, возможно, изменить) обнаружение тестов. Функция `load_tests`, которая ничего не делает, для тестового пакета может выглядеть так: ```python def load_tests(loader, standard_tests, pattern): # корневой каталог, кэшированный на экземпляре загрузчика this_dir = os.path.dirname(__file__) package_tests = loader.discover(start_dir=this_dir, pattern=pattern) standard_tests.addTests(package_tests) return standard_tests ``` Изменено в версии 3.5: Обнаружение больше не проверяет имена пакетов на соответствие *pattern* из-за невозможности соответствия имён пакетов шаблону по умолчанию. ## Фикстуры классов и модулей Фикстуры на уровне класса и модуля реализованы в [`TestSuite`](https://python-all.ru/3.15/library/unittest.html#unittest.TestSuite). Когда набор тестов встречает тест из нового класса, вызывается [`tearDownClass()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.tearDownClass) предыдущего класса (если он есть), а затем [`setUpClass()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase.setUpClass) нового класса. Аналогично, если тест из другого модуля, отличного от предыдущего, то запускается `tearDownModule` предыдущего модуля, а затем `setUpModule` нового модуля. После выполнения всех тестов запускаются финальные `tearDownClass` и `tearDownModule`. Обратите внимание, что общие фикстуры плохо совместимы с такими возможностями, как параллельное выполнение тестов, и нарушают изоляцию тестов. Их следует использовать с осторожностью. Упорядочивание тестов по умолчанию, создаваемое загрузчиками тестов unittest, группирует все тесты из одних и тех же модулей и классов вместе. Это приводит к тому, что `setUpClass` / `setUpModule` (и т.д.) вызываются ровно один раз на класс и модуль. Если изменить порядок случайным образом, так что тесты из разных модулей и классов будут соседствовать друг с другом, то эти общие фикстуры могут вызываться несколько раз за один прогон тестов. Общие фикстуры не предназначены для работы с наборами тестов, имеющими нестандартный порядок. `BaseTestSuite` всё ещё существует для фреймворков, которые не хотят поддерживать общие фикстуры. Если во время выполнения одной из общих фикстур возникает исключение, тест помечается как ошибочный. Поскольку нет соответствующего экземпляра теста, создаётся объект `_ErrorHolder` (имеющий тот же интерфейс, что и [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase)) для представления ошибки. Если вы просто используете стандартный исполнитель тестов unittest, эта деталь не имеет значения, но если вы разработчик фреймворка, это может быть актуально. ### setUpClass и tearDownClass Они должны быть реализованы как методы класса: ```python import unittest class Test(unittest.TestCase): @classmethod def setUpClass(cls): cls._connection = createExpensiveConnectionObject() @classmethod def tearDownClass(cls): cls._connection.destroy() ``` Если нужно, чтобы `setUpClass` и `tearDownClass` базовых классов вызывались, необходимо вызвать их самостоятельно. Реализации в [`TestCase`](https://python-all.ru/3.15/library/unittest.html#unittest.TestCase) пусты. Если во время выполнения `setUpClass` возникает исключение, тесты в классе не запускаются, и `tearDownClass` не выполняется. Пропущенные классы не будут выполнять `setUpClass` или `tearDownClass`. Если исключением является [`SkipTest`](https://python-all.ru/3.15/library/unittest.html#unittest.SkipTest), то класс будет помечен как пропущенный, а не как ошибочный. ### setUpModule и tearDownModule Они должны быть реализованы как функции: ```python def setUpModule(): createConnection() def tearDownModule(): closeConnection() ``` Если в `setUpModule` возникает исключение, то ни один тест в модуле не будет запущен, и `tearDownModule` не будет выполнен. Если исключением является [`SkipTest`](https://python-all.ru/3.15/library/unittest.html#unittest.SkipTest), то модуль будет помечен как пропущенный, а не как ошибочный. Чтобы добавить код очистки, который должен выполняться даже в случае исключения, используйте `addModuleCleanup`: #### `unittest.addModuleCleanup(function, /, *args, **kwargs)` Добавляет функцию, которая будет вызвана после [`tearDownModule()`](https://python-all.ru/3.15/library/unittest.html#unittest.tearDownModule) для очистки ресурсов, использованных во время тестового класса. Функции вызываются в обратном порядке по сравнению с порядком их добавления (LIFO). Они вызываются с теми аргументами и именованными аргументами, которые были переданы в `addModuleCleanup()` при их добавлении. Если [`setUpModule()`](https://python-all.ru/3.15/library/unittest.html#unittest.setUpModule) завершается ошибкой, то есть [`tearDownModule()`](https://python-all.ru/3.15/library/unittest.html#unittest.tearDownModule) не вызывается, то все добавленные функции очистки всё равно будут вызваны. Добавлено в версии 3.8. #### `unittest.enterModuleContext(cm)` Входит в предоставленный [менеджер контекста](https://python-all.ru/3.15/glossary.html#term-context-manager). В случае успеха также добавляет его метод [`__exit__()`](https://python-all.ru/3.15/reference/datamodel.html#object.__exit__) как функцию очистки с помощью [`addModuleCleanup()`](https://python-all.ru/3.15/library/unittest.html#unittest.addModuleCleanup) и возвращает результат метода [`__enter__()`](https://python-all.ru/3.15/reference/datamodel.html#object.__enter__). Добавлено в версии 3.12. #### `unittest.doModuleCleanups()` Эта функция вызывается безусловно после [`tearDownModule()`](https://python-all.ru/3.15/library/unittest.html#unittest.tearDownModule) или после [`setUpModule()`](https://python-all.ru/3.15/library/unittest.html#unittest.setUpModule), если `setUpModule()` вызывает исключение. Он отвечает за вызов всех функций очистки, добавленных с помощью [`addModuleCleanup()`](https://python-all.ru/3.15/library/unittest.html#unittest.addModuleCleanup). Если нужно, чтобы функции очистки вызывались *до* [`tearDownModule()`](https://python-all.ru/3.15/library/unittest.html#unittest.tearDownModule), то можно вызвать `doModuleCleanups()` самостоятельно. `doModuleCleanups()` извлекает методы из стека функций очистки по одному, поэтому его можно вызывать в любой момент. Добавлено в версии 3.8. ## Обработка сигналов Добавлено в версии 3.2. Параметр командной строки [`-c/--catch`](https://python-all.ru/3.15/library/unittest.html#cmdoption-unittest-c) для unittest вместе с параметром `catchbreak` для [`unittest.main()`](https://python-all.ru/3.15/library/unittest.html#unittest.main) обеспечивают более удобную обработку control-C во время выполнения тестов. Когда поведение catch-break включено, control-C позволяет завершить текущий тест, после чего выполнение тестов завершается и выводятся все результаты на данный момент. Повторное нажатие control-C вызовет исключение [`KeyboardInterrupt`](https://python-all.ru/3.15/library/exceptions.html#KeyboardInterrupt) обычным образом. Обработчик сигнала control-c старается оставаться совместимым с кодом или тестами, которые устанавливают собственный обработчик [`signal.SIGINT`](https://python-all.ru/3.15/library/signal.html#signal.SIGINT). Если обработчик `unittest` вызывается, но *не является* установленным обработчиком `signal.SIGINT`, то есть был заменён тестируемой системой и делегирован, то он вызывает стандартный обработчик. Обычно это ожидаемое поведение для кода, который заменяет установленный обработчик и делегирует ему. Для отдельных тестов, где требуется `unittest` отключить обработку control-c, можно использовать декоратор [`removeHandler()`](https://python-all.ru/3.15/library/unittest.html#unittest.removeHandler). Существует несколько вспомогательных функций для разработчиков фреймворков, позволяющих включить обработку control-c в тестовых фреймворках. #### `unittest.installHandler()` Устанавливает обработчик control-c. Когда получен сигнал [`signal.SIGINT`](https://python-all.ru/3.15/library/signal.html#signal.SIGINT) (обычно в ответ на нажатие пользователем control-c), у всех зарегистрированных результатов вызывается [`stop()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.stop). #### `unittest.registerResult(result)` Регистрирует объект [`TestResult`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult) для обработки control-c. При регистрации результата сохраняется слабая ссылка на него, поэтому это не препятствует сборке мусора объекта результата. Регистрация объекта [`TestResult`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult) не имеет побочных эффектов, если обработка control-c не включена, поэтому тестовые фреймворки могут безусловно регистрировать все создаваемые ими результаты, независимо от того, включена обработка или нет. #### `unittest.removeResult(result)` Удаляет зарегистрированный результат. После удаления результата [`stop()`](https://python-all.ru/3.15/library/unittest.html#unittest.TestResult.stop) больше не будет вызываться для этого объекта результата в ответ на control-c. #### `unittest.removeHandler(function=None)` При вызове без аргументов эта функция удаляет обработчик control-c, если он был установлен. Эту функцию также можно использовать как тестовый декоратор для временного удаления обработчика на время выполнения теста: ```python @unittest.removeHandler def test_signal_handling(self): ... ```