unittest.md
1> **Источник:** https://python-all.ru/3.6/library/unittest.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 26.4. [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest) – фреймворк для модульного тестирования89**Исходный код:** [Lib/unittest/\_\_init\_\_.py](https://python-all.ru/src/3.6/Lib/unittest/__init__.py)1011---1213(Если вы уже знакомы с основными понятиями тестирования, можете перейти к [списку методов assert](https://python-all.ru/3.6/library/unittest.html#assert-methods).)1415Фреймворк модульного тестирования [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest) изначально был вдохновлён JUnit и имеет схожий подход с основными фреймворками модульного тестирования на других языках. Он поддерживает автоматизацию тестов, совместное использование кода подготовки и завершения тестов, объединение тестов в коллекции и независимость тестов от системы отчётов.1617Для этого [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest) поддерживает несколько важных концепций в объектно-ориентированном стиле:1819**тестовая фикстура**2021*Тестовая фикстура* представляет собой подготовку, необходимую для выполнения одного или нескольких тестов, и любые сопутствующие действия по очистке. Это может включать, например, создание временных или прокси-баз данных, каталогов или запуск серверного процесса.2223**тестовый случай**2425*Тестовый случай* – это отдельная единица тестирования. Он проверяет определённую реакцию на конкретный набор входных данных. [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest) предоставляет базовый класс [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase), который можно использовать для создания новых тестовых случаев.2627**набор тестов**2829*Набор тестов* – это совокупность тестовых случаев, наборов тестов или и того, и другого. Он используется для объединения тестов, которые должны выполняться вместе.3031**исполнитель тестов**3233*Исполнитель тестов* – это компонент, который управляет выполнением тестов и предоставляет результат пользователю. Исполнитель может использовать графический интерфейс, текстовый интерфейс или возвращать специальное значение, указывающее на результаты выполнения тестов.3435> **См. также**36>37> **Модуль [`doctest`](https://python-all.ru/3.6/library/doctest.html#module-doctest)**38>39> Ещё один модуль поддержки тестирования с совершенно другим подходом.40>41> **[Простое тестирование в Smalltalk: с шаблонами](https://python-all.ru/3.6/library/unittest.html)**42>43> Оригинальная статья Кента Бека о фреймворках тестирования, в которых используется тот же шаблон, что и в [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest).44>45> **[Nose](https://python-all.ru/3.6/library/unittest.html) и [pytest](https://python-all.ru/3.6/library/unittest.html)**46>47> Сторонние фреймворки для unittest с более лёгким синтаксисом написания тестов. Например, `assert func(10) == 42`.48>49> **[Таксономия инструментов тестирования Python](https://python-all.ru/3.6/library/unittest.html)**50>51> Обширный список инструментов тестирования Python, включая фреймворки функционального тестирования и библиотеки имитационных объектов (mock).52>53> **[Список рассылки по тестированию в Python](https://python-all.ru/3.6/library/unittest.html)**54>55> Группа по интересам для обсуждения тестирования и инструментов тестирования в Python.56>57> Скрипт `Tools/unittestgui/unittestgui.py` в дистрибутиве исходного кода Python – это GUI-инструмент для обнаружения и выполнения тестов. Он предназначен в первую очередь для удобства тех, кто только начинает знакомство с модульным тестированием. В рабочих средах рекомендуется, чтобы тесты управлялись системой непрерывной интеграции, такой как [Buildbot](https://python-all.ru/3.6/library/unittest.html), [Jenkins](https://python-all.ru/3.6/library/unittest.html) или [Hudson](https://python-all.ru/3.6/library/unittest.html).5859## 26.4.1. Простой пример6061Модуль [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest) предоставляет богатый набор инструментов для создания и запуска тестов. В этом разделе показано, что небольшого подмножества этих инструментов достаточно для удовлетворения потребностей большинства пользователей.6263Вот короткий скрипт для тестирования трёх строковых методов:6465```python66import unittest6768class TestStringMethods(unittest.TestCase):6970 def test_upper(self):71 self.assertEqual('foo'.upper(), 'FOO')7273 def test_isupper(self):74 self.assertTrue('FOO'.isupper())75 self.assertFalse('Foo'.isupper())7677 def test_split(self):78 s = 'hello world'79 self.assertEqual(s.split(), ['hello', 'world'])80 # проверить, что s.split завершается ошибкой, если разделитель не строка81 with self.assertRaises(TypeError):82 s.split(2)8384if __name__ == '__main__':85 unittest.main()86```8788Тестовый случай создаётся созданием подкласса [`unittest.TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase). Три отдельных теста определяются методами, имена которых начинаются с букв `test`. Это соглашение об именовании сообщает тестовому раннеру, какие методы являются тестами.8990Суть каждого теста – вызов [`assertEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual) для проверки ожидаемого результата; [`assertTrue()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertTrue) или [`assertFalse()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertFalse) для проверки условия; или [`assertRaises()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaises) для проверки того, что возбуждается определённое исключение. Эти методы используются вместо оператора [`assert`](https://python-all.ru/3.6/reference/simple_stmts.html#assert), чтобы исполнитель тестов мог накапливать все результаты тестов и формировать отчёт.9192Методы [`setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp) и [`tearDown()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.tearDown) позволяют определить инструкции, которые будут выполняться до и после каждого метода теста. Они подробнее рассматриваются в разделе [Организация тестового кода](https://python-all.ru/3.6/library/unittest.html#organizing-tests).9394В последнем блоке показан простой способ запуска тестов. [`unittest.main()`](https://python-all.ru/3.6/library/unittest.html#unittest.main) предоставляет интерфейс командной строки для тестового скрипта. При запуске из командной строки приведённый выше скрипт выдаёт вывод, который выглядит так:9596```python97...98----------------------------------------------------------------------99Ran 3 tests in 0.000s100101OK102```103104Передача флага `-v` вашему тестовому скрипту укажет [`unittest.main()`](https://python-all.ru/3.6/library/unittest.html#unittest.main) включить более высокий уровень подробности и выдать следующий вывод:105106```python107test_isupper (__main__.TestStringMethods) ... ok108test_split (__main__.TestStringMethods) ... ok109test_upper (__main__.TestStringMethods) ... ok110111----------------------------------------------------------------------112Ran 3 tests in 0.001s113114OK115```116117Представленные выше примеры демонстрируют наиболее часто используемые возможности [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest), которых достаточно для многих повседневных задач тестирования. Оставшаяся часть документации рассматривает полный набор функций с самого начала.118119## 26.4.2. Интерфейс командной строки120121Модуль unittest можно использовать из командной строки для запуска тестов из модулей, классов или даже отдельных тестовых методов:122123```python124python -m unittest test_module1 test_module2125python -m unittest test_module.TestClass126python -m unittest test_module.TestClass.test_method127```128129Можно передать список с любой комбинацией имён модулей, а также полных имён классов или методов.130131Тестовые модули также можно указывать по пути к файлу:132133```python134python -m unittest tests/test_something.py135```136137Это позволяет использовать автодополнение имён файлов в оболочке для указания тестового модуля. Указанный файл по-прежнему должен быть импортируем как модуль. Путь преобразуется в имя модуля путём удаления ‘.py’ и замены разделителей пути на ‘.’. Если требуется выполнить тестовый файл, который не импортируется как модуль, следует запускать файл напрямую.138139Можно запускать тесты с большей детализацией (повышенной подробностью), передав флаг -v:140141```python142python -m unittest -v test_module143```144145При запуске без аргументов запускается [автоматическое обнаружение тестов](https://python-all.ru/3.6/library/unittest.html#unittest-test-discovery):146147```python148python -m unittest149```150151Чтобы получить список всех параметров командной строки:152153```python154python -m unittest -h155```156157Изменено в версии 3.2: В более ранних версиях можно было запускать только отдельные тестовые методы, а не модули или классы.158159### 26.4.2.1. Параметры командной строки160161**unittest** поддерживает следующие параметры командной строки:162163#### `-b, --buffer`164165Потоки стандартного вывода и стандартной ошибки буферизируются во время выполнения теста. Вывод при успешном тесте отбрасывается. При ошибке или провале теста вывод выводится обычным образом и добавляется к сообщениям о неудаче.166167#### `-c, --catch`168169`Control-C` во время выполнения теста ожидает завершения текущего теста, а затем выводит все результаты, полученные на данный момент. Повторное нажатие `Control-C` вызывает обычное исключение [`KeyboardInterrupt`](https://python-all.ru/3.6/library/exceptions.html#KeyboardInterrupt).170171См. раздел [Обработка сигналов](https://python-all.ru/3.6/library/unittest.html#signal-handling) с описанием функций, предоставляющих эту возможность.172173#### `-f, --failfast`174175Остановить выполнение теста при первой же ошибке или неудаче.176177#### `--locals`178179Показывать локальные переменные в трассировках.180181Новое в версии 3.2: Добавлены опции командной строки `-b`, `-c` и `-f`.182183Новое в версии 3.5: Опция командной строки `--locals`.184185Командная строка также может использоваться для автоматического обнаружения тестов, для запуска всех тестов в проекте или только их части.186187## 26.4.3. Обнаружение тестов188189Новое в версии 3.2.190191Unittest поддерживает простой поиск тестов. Чтобы тесты были совместимы с поиском, все тестовые файлы должны быть [модулями](https://python-all.ru/3.6/tutorial/modules.html#tut-modules) или [пакетами](https://python-all.ru/3.6/tutorial/modules.html#tut-packages) (включая [пространственные пакеты](https://python-all.ru/3.6/glossary.html#term-namespace-package)), которые можно импортировать из корневого каталога проекта (это означает, что их имена файлов должны быть допустимыми [идентификаторами](https://python-all.ru/3.6/reference/lexical_analysis.html#identifiers)).192193Обнаружение тестов реализовано в [`TestLoader.discover()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader.discover), но также может использоваться из командной строки. Основное использование командной строки:194195```python196cd project_directory197python -m unittest discover198```199200> **Примечание**201>202> В качестве сокращения, `python -m unittest` эквивалентно `python -m unittest discover`. Если требуется передать аргументы для обнаружения тестов, необходимо явно указать подкоманду `discover`.203204Подкоманда `discover` имеет следующие опции:205206#### `-v, --verbose`207208Подробный вывод209210#### `-s, --start-directory directory`211212Каталог для начала обнаружения (по умолчанию `.`)213214#### `-p, --pattern pattern`215216Шаблон для сопоставления тестовых файлов (по умолчанию `test*.py`)217218#### `-t, --top-level-directory directory`219220Корневой каталог проекта (по умолчанию – каталог начала поиска)221222Параметры [`-s`](https://python-all.ru/3.6/library/unittest.html#cmdoption-unittest-discover-s), [`-p`](https://python-all.ru/3.6/library/unittest.html#cmdoption-unittest-discover-p) и [`-t`](https://python-all.ru/3.6/library/unittest.html#cmdoption-unittest-discover-t) можно передавать в качестве позиционных аргументов в указанном порядке. Следующие две командные строки эквивалентны:223224```python225python -m unittest discover -s project_directory -p "*_test.py"226python -m unittest discover project_directory "*_test.py"227```228229Помимо пути, в качестве начального каталога можно передать имя пакета, например `myproject.subpackage.test`. Указанное имя пакета будет импортировано, и его расположение в файловой системе будет использоваться в качестве начального каталога.230231> **Внимание**232>233> Обнаружение тестов загружает тесты путем их импорта. Как только обнаружение тестов найдет все тестовые файлы в указанном начальном каталоге, оно преобразует пути в имена пакетов для импорта. Например, `foo/bar/baz.py` будет импортирован как `foo.bar.baz`.234>235> Если пакет установлен глобально, и предпринимается попытка обнаружения тестов в другой копии пакета, то импорт *может* произойти из неправильного места. Если это произойдет, обнаружение тестов выдаст предупреждение и завершится.236>237> Если указать начальный каталог как имя пакета, а не путь к каталогу, то discover считает, что местоположение, из которого он импортирует, и есть то, которое вы имели в виду, поэтому предупреждение не появится.238239Тестовые модули и пакеты могут настраивать загрузку и обнаружение тестов с помощью [протокола load\_tests](https://python-all.ru/3.6/library/unittest.html#load-tests-protocol).240241Изменено в версии 3.4: Обнаружение тестов поддерживает [пакеты с пространством имен](https://python-all.ru/3.6/glossary.html#term-namespace-package).242243## 26.4.4. Организация тестового кода244245Основными строительными блоками модульного тестирования являются *тестовые случаи* – отдельные сценарии, которые необходимо настроить и проверить на корректность. В [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest) тестовые случаи представлены экземплярами [`unittest.TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase). Чтобы создать собственные тестовые случаи, необходимо написать подклассы [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) или использовать [`FunctionTestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.FunctionTestCase).246247Тестовый код экземпляра [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) должен быть полностью самодостаточным, чтобы его можно было запускать как изолированно, так и в произвольной комбинации с любым количеством других тестовых случаев.248249Простейший подкласс [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) просто реализует тестовый метод (т.е. метод, имя которого начинается с `test`) для выполнения определенного тестового кода:250251```python252import unittest253254class DefaultWidgetSizeTestCase(unittest.TestCase):255 def test_default_widget_size(self):256 widget = Widget('The widget')257 self.assertEqual(widget.size(), (50, 50))258```259260Обратите внимание: для тестирования используется один из методов `assert*()`, предоставляемых базовым классом [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase). Если тест не пройден, будет возбуждено исключение с поясняющим сообщением, и [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest) определит тестовый случай как *сбой*. Любые другие исключения будут считаться *ошибками*.261262Тестов может быть много, и их подготовка может быть повторяющейся. К счастью, можно вынести код подготовки в метод с именем [`setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp), который тестовый фреймворк будет автоматически вызывать для каждого запускаемого теста:263264```python265import unittest266267class WidgetTestCase(unittest.TestCase):268 def setUp(self):269 self.widget = Widget('The widget')270271 def test_default_widget_size(self):272 self.assertEqual(self.widget.size(), (50,50),273 'incorrect default size')274275 def test_widget_resize(self):276 self.widget.resize(100,150)277 self.assertEqual(self.widget.size(), (100,150),278 'wrong size after resize')279```280281> **Примечание**282>283> Порядок выполнения различных тестов определяется сортировкой имен тестовых методов в соответствии со встроенным порядком строк.284285Если метод [`setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp) возбуждает исключение во время выполнения теста, фреймворк посчитает, что тест завершился ошибкой, и тестовый метод не будет выполнен.286287Аналогично, можно предоставить метод [`tearDown()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.tearDown), который выполняет очистку после выполнения тестового метода:288289```python290import unittest291292class WidgetTestCase(unittest.TestCase):293 def setUp(self):294 self.widget = Widget('The widget')295296 def tearDown(self):297 self.widget.dispose()298```299300Если [`setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp) успешно выполнен, [`tearDown()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.tearDown) будет выполнен, независимо от того, завершился тестовый метод успешно или нет.301302Такое рабочее окружение для тестового кода называется *тестовой фикстурой*. Новый экземпляр TestCase создаётся как уникальная тестовая фикстура, используемая для выполнения каждого отдельного тестового метода. Таким образом, [`setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp), [`tearDown()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.tearDown) и `__init__()` будут вызываться один раз для каждого теста.303304Рекомендуется группировать тесты с помощью реализаций TestCase в соответствии с тестируемыми возможностями. [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest) предоставляет для этого механизм: *набор тестов*, представленный классом [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) из модуля [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest). В большинстве случаев вызов [`unittest.main()`](https://python-all.ru/3.6/library/unittest.html#unittest.main) сделает всё правильно: соберёт все тестовые случаи модуля и выполнит их.305306Однако, если требуется настроить сборку набора тестов, это можно сделать самостоятельно:307308```python309def suite():310 suite = unittest.TestSuite()311 suite.addTest(WidgetTestCase('test_default_widget_size'))312 suite.addTest(WidgetTestCase('test_widget_resize'))313 return suite314315if __name__ == '__main__':316 runner = unittest.TextTestRunner()317 runner.run(suite())318```319320Определения тестовых случаев и наборов тестов можно размещать в тех же модулях, что и тестируемый код (например, `widget.py`), но есть несколько преимуществ в размещении тестового кода в отдельном модуле, например, `test_widget.py`:321322- Тестовый модуль можно запускать автономно из командной строки.323- Тестовый код проще отделить от поставляемого кода.324- Меньше соблазна изменять тестовый код, чтобы подогнать его под тестируемый код, без веской причины.325- Тестовый код должен изменяться гораздо реже, чем тестируемый код.326- Тестируемый код проще поддаётся рефакторингу.327- Тесты для модулей, написанных на C, всё равно должны быть в отдельных модулях – так почему бы не придерживаться этого подхода?328- Если стратегия тестирования меняется, нет необходимости изменять исходный код.329330## 26.4.5. Повторное использование старого тестового кода331332Некоторые пользователи могут иметь существующий тестовый код, который они хотели бы запускать из [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest), не преобразовывая каждую старую тестовую функцию в подкласс [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase).333334По этой причине [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest) предоставляет класс [`FunctionTestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.FunctionTestCase). Этот подкласс [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) можно использовать для обёртывания существующей тестовой функции. Также можно предоставить функции настройки (set-up) и завершения (tear-down).335336Рассмотрим следующую тестовую функцию:337338```python339def testSomething():340 something = makeSomething()341 assert something.name is not None342 # ...343```344345можно создать эквивалентный экземпляр тестового случая следующим образом, с опциональными методами настройки и завершения:346347```python348testcase = unittest.FunctionTestCase(testSomething,349 setUp=makeSomethingDB,350 tearDown=deleteSomethingDB)351```352353> **Примечание**354>355> Хотя [`FunctionTestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.FunctionTestCase) можно использовать для быстрого преобразования существующей тестовой базы в систему на основе [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest), этот подход не рекомендуется. Затрата времени на создание правильных подклассов [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) значительно упростит будущий рефакторинг тестов.356357В некоторых случаях существующие тесты могли быть написаны с использованием модуля [`doctest`](https://python-all.ru/3.6/library/doctest.html#module-doctest). В этом случае [`doctest`](https://python-all.ru/3.6/library/doctest.html#module-doctest) предоставляет класс `DocTestSuite`, который может автоматически создавать экземпляры [`unittest.TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) из существующих тестов на основе [`doctest`](https://python-all.ru/3.6/library/doctest.html#module-doctest).358359## 26.4.6. Пропуск тестов и ожидаемые сбои360361Новое в версии 3.1.362363Unittest поддерживает пропуск отдельных тестовых методов и даже целых классов тестов. Кроме того, он поддерживает пометку теста как «ожидаемый сбой» – тест, который сломан и завершится неудачей, но не должен засчитываться как сбой в [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult).364365Пропустить тест можно просто с помощью [`skip()`](https://python-all.ru/3.6/library/unittest.html#unittest.skip) [декоратора](https://python-all.ru/3.6/glossary.html#term-decorator) или одного из его условных вариантов.366367Базовый пропуск выглядит так:368369```python370class MyTestCase(unittest.TestCase):371372 @unittest.skip("demonstrating skipping")373 def test_nothing(self):374 self.fail("shouldn't happen")375376 @unittest.skipIf(mylib.__version__ < (1, 3),377 "not supported in this library version")378 def test_format(self):379 # Тесты, которые работают только для определённой версии библиотеки.380 pass381382 @unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")383 def test_windows_support(self):384 # код тестирования для Windows385 pass386```387388Это вывод приведённого выше примера в подробном режиме:389390```python391test_format (__main__.MyTestCase) ... skipped 'not supported in this library version'392test_nothing (__main__.MyTestCase) ... skipped 'demonstrating skipping'393test_windows_support (__main__.MyTestCase) ... skipped 'requires Windows'394395----------------------------------------------------------------------396Ran 3 tests in 0.005s397398OK (skipped=3)399```400401Классы можно пропускать так же, как методы:402403```python404@unittest.skip("showing class skipping")405class MySkippedTestCase(unittest.TestCase):406 def test_not_run(self):407 pass408```409410[`TestCase.setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp) также может пропустить тест. Это полезно, когда ресурс, который необходимо настроить, недоступен.411412Для ожидаемых сбоев используется декоратор [`expectedFailure()`](https://python-all.ru/3.6/library/unittest.html#unittest.expectedFailure).413414```python415class ExpectedFailureTestCase(unittest.TestCase):416 @unittest.expectedFailure417 def test_fail(self):418 self.assertEqual(1, 0, "broken")419```420421Легко создать собственные декораторы пропуска, создав декоратор, который вызывает [`skip()`](https://python-all.ru/3.6/library/unittest.html#unittest.skip) для теста, когда нужно его пропустить. Этот декоратор пропускает тест, если только переданный объект не имеет определённого атрибута:422423```python424def skipUnlessHasattr(obj, attr):425 if hasattr(obj, attr):426 return lambda func: func427 return unittest.skip("{!r} doesn't have {!r}".format(obj, attr))428```429430Следующие декораторы реализуют пропуск тестов и ожидаемые сбои:431432#### `@unittest.skip(reason)`433434Безусловно пропускает декорированный тест. Параметр *reason* должен описывать причину пропуска теста.435436#### `@unittest.skipIf(condition, reason)`437438Пропустить декорированный тест, если *condition* истинно.439440#### `@unittest.skipUnless(condition, reason)`441442Пропустить декорированный тест, если *condition* не истинно.443444#### `@unittest.expectedFailure`445446Помечает тест как ожидаемый сбой. Если тест завершается ошибкой при запуске, он не учитывается как сбой.447448#### `exception unittest.SkipTest(reason)`449450Это исключение возбуждается для пропуска теста.451452Обычно можно использовать [`TestCase.skipTest()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.skipTest) или один из декораторов пропуска, вместо того чтобы возбуждать его напрямую.453454Пропущенные тесты не будут выполнять [`setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp) или [`tearDown()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.tearDown). Пропущенные классы не будут выполнять [`setUpClass()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUpClass) или [`tearDownClass()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.tearDownClass). Пропущенные модули не будут выполнять `setUpModule()` или `tearDownModule()`.455456## 26.4.7. Различение итераций теста с помощью подтестов457458Новое в версии 3.4.459460Когда между тестами есть очень небольшие различия, например некоторые параметры, unittest позволяет различать их внутри тела тестового метода с помощью контекстного менеджера [`subTest()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.subTest).461462Например, следующий тест:463464```python465class NumbersTest(unittest.TestCase):466467 def test_even(self):468 """469 Проверить, что все числа от 0 до 5 чётные.470 """471 for i in range(0, 6):472 with self.subTest(i=i):473 self.assertEqual(i % 2, 0)474```475476выдаст следующий результат:477478```python479======================================================================480FAIL: test_even (__main__.NumbersTest) (i=1)481----------------------------------------------------------------------482Traceback (most recent call last):483 File "subtests.py", line 32, in test_even484 self.assertEqual(i % 2, 0)485AssertionError: 1 != 0486487======================================================================488FAIL: test_even (__main__.NumbersTest) (i=3)489----------------------------------------------------------------------490Traceback (most recent call last):491 File "subtests.py", line 32, in test_even492 self.assertEqual(i % 2, 0)493AssertionError: 1 != 0494495======================================================================496FAIL: test_even (__main__.NumbersTest) (i=5)497----------------------------------------------------------------------498Traceback (most recent call last):499 File "subtests.py", line 32, in test_even500 self.assertEqual(i % 2, 0)501AssertionError: 1 != 0502```503504Без использования подтеста выполнение остановилось бы после первого сбоя, и ошибку было бы труднее диагностировать, поскольку значение `i` не отображалось бы:505506```python507======================================================================508FAIL: test_even (__main__.NumbersTest)509----------------------------------------------------------------------510Traceback (most recent call last):511 File "subtests.py", line 32, in test_even512 self.assertEqual(i % 2, 0)513AssertionError: 1 != 0514```515516## 26.4.8. Классы и функции517518В этом разделе подробно описывается API [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest).519520### 26.4.8.1. Тестовые случаи521522#### `class unittest.TestCase(methodName='runTest')`523524Экземпляры класса [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) представляют собой логические тестовые единицы в среде [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest). Этот класс предназначен для использования в качестве базового класса, при этом конкретные тесты реализуются в конкретных подклассах. Класс реализует интерфейс, необходимый тестовому исполнителю для управления тестами, а также методы, которые тестовый код может использовать для проверки и сообщения о различных видах сбоев.525526Каждый экземпляр [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) выполняет один базовый метод: метод с именем *methodName*. В большинстве случаев использования [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) не требуется ни изменять *methodName*, ни переопределять метод по умолчанию `runTest()`.527528Изменено в версии 3.2: [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) можно успешно создать без указания *methodName*. Это упрощает эксперименты с [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) в интерактивном интерпретаторе.529530Экземпляры [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) предоставляют три группы методов: одна группа используется для выполнения теста, другая – реализацией теста для проверки условий и сообщения о сбоях, и несколько запросных методов, позволяющих собирать информацию о самом тесте.531532Методы первой группы (выполнение теста):533534#### `setUp()`535536Метод, вызываемый для подготовки тестовой фикстуры. Он вызывается непосредственно перед вызовом тестового метода; за исключением [`AssertionError`](https://python-all.ru/3.6/library/exceptions.html#AssertionError) или [`SkipTest`](https://python-all.ru/3.6/library/unittest.html#unittest.SkipTest), любое исключение, возбуждённое этим методом, будет считаться ошибкой, а не сбоем теста. Реализация по умолчанию ничего не делает.537538#### `tearDown()`539540Метод, вызываемый сразу после вызова тестового метода и записи результата. Он вызывается, даже если тестовый метод возбудил исключение, поэтому реализация в подклассах должна быть особенно осторожна при проверке внутреннего состояния. Любое исключение, кроме [`AssertionError`](https://python-all.ru/3.6/library/exceptions.html#AssertionError) или [`SkipTest`](https://python-all.ru/3.6/library/unittest.html#unittest.SkipTest), возбуждённое этим методом, будет считаться дополнительной ошибкой, а не сбоем теста (таким образом увеличивая общее количество сообщённых ошибок). Этот метод будет вызван только если [`setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp) выполнится успешно, независимо от результата тестового метода. Реализация по умолчанию ничего не делает.541542#### `setUpClass()`543544Метод класса, вызываемый перед выполнением тестов в отдельном классе. `setUpClass` вызывается с классом в качестве единственного аргумента и должен быть декорирован как [`classmethod()`](https://python-all.ru/3.6/library/functions.html#classmethod):545546```python547@classmethod548def setUpClass(cls):549 ...550```551552См. [Фикстуры классов и модулей](https://python-all.ru/3.6/library/unittest.html#class-and-module-fixtures) для получения дополнительных сведений.553554Новое в версии 3.2.555556#### `tearDownClass()`557558Метод класса, вызываемый после выполнения тестов в отдельном классе. `tearDownClass` вызывается с классом в качестве единственного аргумента и должен быть декорирован как [`classmethod()`](https://python-all.ru/3.6/library/functions.html#classmethod):559560```python561@classmethod562def tearDownClass(cls):563 ...564```565566См. [Фикстуры классов и модулей](https://python-all.ru/3.6/library/unittest.html#class-and-module-fixtures) для получения дополнительных сведений.567568Новое в версии 3.2.569570#### `run(result=None)`571572Запускает тест, собирая результат в объект [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult), переданный как *result*. Если *result* опущен или равен `None`, создаётся временный объект результата (путем вызова метода [`defaultTestResult()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.defaultTestResult)), который и используется. Объект результата возвращается вызывающему коду [`run()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.run).573574Того же эффекта можно добиться простым вызовом экземпляра [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase).575576Изменено в версии 3.3: Предыдущие версии `run` не возвращали результат. Также не возвращал результат вызов экземпляра.577578#### `skipTest(reason)`579580Вызов этого метода внутри тестового метода или [`setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp) пропускает текущий тест. Подробнее см. [Пропуск тестов и ожидаемые сбои](https://python-all.ru/3.6/library/unittest.html#unittest-skipping).581582Новое в версии 3.1.583584#### `subTest(msg=None, **params)`585586Возвращает менеджер контекста, который выполняет вложенный блок кода как подтест. *msg* и *params* – необязательные произвольные значения, отображаемые при сбое подтеста, что позволяет однозначно их идентифицировать.587588Тестовый пример может содержать любое количество объявлений подтестов, и они могут быть произвольно вложены.589590Подробнее см. [Различение итераций тестов с помощью подтестов](https://python-all.ru/3.6/library/unittest.html#subtests).591592Новое в версии 3.4.593594#### `debug()`595596Запускает тест без сбора результата. Это позволяет исключениям, возникшим в тесте, распространяться до вызывающего кода, и может использоваться для поддержки запуска тестов под отладчиком.597598Класс [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) предоставляет несколько методов assert для проверки и сообщения об ошибках. В следующей таблице перечислены наиболее часто используемые методы (см. таблицы ниже для получения дополнительных методов assert):599600| Метод | Проверяет, что | Новое в |601| --- | --- | --- |602| [`assertEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual) | `a == b` | |603| [`assertNotEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotEqual) | `a != b` | |604| [`assertTrue(x)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertTrue) | `bool(x) is True` | |605| [`assertFalse(x)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertFalse) | `bool(x) is False` | |606| [`assertIs(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertIs) | `a is b` | 3.1 |607| [`assertIsNot(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertIsNot) | `a is not b` | 3.1 |608| [`assertIsNone(x)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertIsNone) | `x is None` | 3.1 |609| [`assertIsNotNone(x)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertIsNotNone) | `x is not None` | 3.1 |610| [`assertIn(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertIn) | `a in b` | 3.1 |611| [`assertNotIn(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotIn) | `a not in b` | 3.1 |612| [`assertIsInstance(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertIsInstance) | `isinstance(a, b)` | 3.2 |613| [`assertNotIsInstance(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotIsInstance) | `not isinstance(a, b)` | 3.2 |614615Все методы assert принимают аргумент *msg*, который, если указан, используется как сообщение об ошибке в случае сбоя (см. также [`longMessage`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.longMessage)). Обратите внимание, что ключевой аргумент *msg* может быть передан методам [`assertRaises()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaises), [`assertRaisesRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaisesRegex), [`assertWarns()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertWarns), [`assertWarnsRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertWarnsRegex) только когда они используются как менеджер контекста.616617#### `assertEqual(first, second, msg=None)`618619Проверяет, что *first* и *second* равны. Если значения не равны, тест завершится с ошибкой.620621Кроме того, если *first* и *second* относятся к одному и тому же типу и это list, tuple, dict, set, frozenset, str или любой тип, зарегистрированный подклассом с помощью [`addTypeEqualityFunc()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.addTypeEqualityFunc), то будет вызвана типовая функция сравнения для формирования более информативного сообщения об ошибке по умолчанию (см. также [список типовых методов](https://python-all.ru/3.6/library/unittest.html#type-specific-methods)).622623Изменено в версии 3.1: Добавлен автоматический вызов типовой функции сравнения.624625Изменено в версии 3.2: [`assertMultiLineEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertMultiLineEqual) добавлен в качестве типовой функции сравнения по умолчанию для сравнения строк.626627#### `assertNotEqual(first, second, msg=None)`628629Проверяет, что *first* и *second* не равны. Если значения равны, тест завершится с ошибкой.630631#### `assertTrue(expr, msg=None)`632633#### `assertFalse(expr, msg=None)`634635Проверяет, что *expr* истинно (или ложно).636637Обратите внимание, что это эквивалентно `bool(expr) is True`, а не `expr is True` (для последнего используйте `assertIs(expr, True)`). Этот метод также следует избегать, если доступны более специфические методы (например, `assertEqual(a, b)` вместо `assertTrue(a == b)`), потому что они предоставляют более информативное сообщение об ошибке в случае сбоя.638639#### `assertIs(first, second, msg=None)`640641#### `assertIsNot(first, second, msg=None)`642643Проверяет, что *first* и *second* вычисляются (или не вычисляются) в один и тот же объект.644645Новое в версии 3.1.646647#### `assertIsNone(expr, msg=None)`648649#### `assertIsNotNone(expr, msg=None)`650651Проверяет, что *expr* является (или не является) `None`.652653Новое в версии 3.1.654655#### `assertIn(first, second, msg=None)`656657#### `assertNotIn(first, second, msg=None)`658659Проверяет, находится ли *first* в *second* (или не находится).660661Новое в версии 3.1.662663#### `assertIsInstance(obj, cls, msg=None)`664665#### `assertNotIsInstance(obj, cls, msg=None)`666667Проверяет, что *obj* является (или не является) экземпляром *cls* (который может быть классом или кортежем классов, как поддерживается [`isinstance()`](https://python-all.ru/3.6/library/functions.html#isinstance)). Для проверки точного типа используйте [`assertIs(type(obj), cls)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertIs).668669Новое в версии 3.2.670671Также можно проверить возникновение исключений, предупреждений и сообщений журнала с помощью следующих методов:672673| Метод | Проверяет, что | Новое в |674| --- | --- | --- |675| [`assertRaises(exc, fun, *args, **kwds)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaises) | `fun(*args, **kwds)` возбуждает *exc* | |676| [`assertRaisesRegex(exc, r, fun, *args, **kwds)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaisesRegex) | `fun(*args, **kwds)` возбуждает *exc* и сообщение соответствует регулярному выражению *r* | 3.1 |677| [`assertWarns(warn, fun, *args, **kwds)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertWarns) | `fun(*args, **kwds)` возбуждает *warn* | 3.2 |678| [`assertWarnsRegex(warn, r, fun, *args, **kwds)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertWarnsRegex) | `fun(*args, **kwds)` возбуждает *warn* и сообщение соответствует регулярному выражению *r* | 3.2 |679| [`assertLogs(logger, level)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertLogs) | Блок `with` пишет в журнал *logger* с минимальным уровнем *level* | 3.4 |680681#### `assertRaises(exception, callable, *args, **kwds)`682683#### `assertRaises(exception, *, msg=None)`684685Проверяет, что исключение возбуждается, когда *callable* вызывается с любыми позиционными или именованными аргументами, которые также передаются в [`assertRaises()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaises). Тест проходит, если возбуждается *исключение*, считается ошибкой, если возбуждается другое исключение, или не проходит, если исключение не возбуждается. Чтобы перехватить любое из группы исключений, можно передать кортеж, содержащий классы исключений, как *исключение*.686687Если переданы только аргументы *исключение* и, возможно, *msg*, возвращается менеджер контекста, чтобы проверяемый код можно было написать встроенно, а не в виде функции:688689```python690with self.assertRaises(SomeException):691 do_something()692```693694При использовании в качестве менеджера контекста [`assertRaises()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaises) принимает дополнительный ключевой аргумент *msg*.695696Менеджер контекста сохраняет перехваченный объект исключения в своём атрибуте `exception`. Это может быть полезно, если нужно выполнить дополнительные проверки возникшего исключения:697698```python699with self.assertRaises(SomeException) as cm:700 do_something()701702the_exception = cm.exception703self.assertEqual(the_exception.error_code, 3)704```705706Изменено в версии 3.1: Добавлена возможность использовать [`assertRaises()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaises) в качестве менеджера контекста.707708Изменено в версии 3.2: Добавлен атрибут `exception`.709710Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.711712#### `assertRaisesRegex(exception, regex, callable, *args, **kwds)`713714#### `assertRaisesRegex(exception, regex, *, msg=None)`715716Как [`assertRaises()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaises), но также проверяет, что *regex* соответствует строковому представлению возбуждённого исключения. *regex* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, подходящее для использования [`re.search()`](https://python-all.ru/3.6/library/re.html#re.search). Примеры:717718```python719self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$",720 int, 'XYZ')721```722723или:724725```python726with self.assertRaisesRegex(ValueError, 'literal'):727 int('XYZ')728```729730Новое в версии 3.1: под именем `assertRaisesRegexp`.731732Изменено в версии 3.2: переименовано в [`assertRaisesRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaisesRegex).733734Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.735736#### `assertWarns(warning, callable, *args, **kwds)`737738#### `assertWarns(warning, *, msg=None)`739740Проверяет, что предупреждение вызывается, когда *вызываемый объект* вызывается с любыми позиционными или ключевыми аргументами, которые также передаются в [`assertWarns()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertWarns). Тест проходит, если *предупреждение* вызывается, и не проходит в противном случае. Любое исключение считается ошибкой. Чтобы перехватить любое из группы предупреждений, можно передать кортеж, содержащий классы предупреждений, в качестве *предупреждения*.741742Если указаны только *предупреждение* и, возможно, *msg*, возвращается менеджер контекста, позволяющий писать тестируемый код inline, а не в виде функции:743744```python745with self.assertWarns(SomeWarning):746 do_something()747```748749При использовании в качестве менеджера контекста [`assertWarns()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertWarns) принимает дополнительный ключевой аргумент *msg*.750751Менеджер контекста сохраняет перехваченный объект предупреждения в своём атрибуте `warning`, а также исходную строку, вызвавшую предупреждения, в атрибутах `filename` и `lineno`. Это может быть полезно, если требуется выполнить дополнительные проверки перехваченного предупреждения:752753```python754with self.assertWarns(SomeWarning) as cm:755 do_something()756757self.assertIn('myfile.py', cm.filename)758self.assertEqual(320, cm.lineno)759```760761Этот метод работает независимо от фильтров предупреждений, установленных на момент его вызова.762763Новое в версии 3.2.764765Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.766767#### `assertWarnsRegex(warning, regex, callable, *args, **kwds)`768769#### `assertWarnsRegex(warning, regex, *, msg=None)`770771Как и [`assertWarns()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertWarns), но также проверяет, что *регулярное выражение* соответствует сообщению вызванного предупреждения. *Регулярное выражение* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, пригодное для использования [`re.search()`](https://python-all.ru/3.6/library/re.html#re.search). Пример:772773```python774self.assertWarnsRegex(DeprecationWarning,775 r'legacy_function\(\) is deprecated',776 legacy_function, 'XYZ')777```778779или:780781```python782with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'):783 frobnicate('/etc/passwd')784```785786Новое в версии 3.2.787788Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.789790#### `assertLogs(logger=None, level=None)`791792Менеджер контекста для проверки того, что хотя бы одно сообщение зарегистрировано в *логгере* или одном из его потомков, с уровнем не ниже указанного *уровня*.793794Если указан, *логгер* должен быть объектом [`logging.Logger`](https://python-all.ru/3.6/library/logging.html#logging.Logger) или [`str`](https://python-all.ru/3.6/library/stdtypes.html#str), задающим имя логгера. По умолчанию используется корневой логгер, который перехватывает все сообщения.795796Если указан, *уровень* должен быть числовым уровнем логирования или его строковым эквивалентом (например, `"ERROR"` или `logging.ERROR`). По умолчанию `logging.INFO`.797798Тест проходит, если хотя бы одно сообщение, отправленное внутри блока `with`, соответствует условиям *логгера* и *уровня*, в противном случае тест не проходит.799800Объект, возвращаемый менеджером контекста, представляет собой вспомогательный объект для записи, который отслеживает соответствующие сообщения журнала. Он имеет два атрибута:801802#### `records`803804Список объектов [`logging.LogRecord`](https://python-all.ru/3.6/library/logging.html#logging.LogRecord) соответствующих сообщений журнала.805806#### `output`807808Список объектов [`str`](https://python-all.ru/3.6/library/stdtypes.html#str) с отформатированным выводом соответствующих сообщений.809810Пример:811812```python813with self.assertLogs('foo', level='INFO') as cm:814 logging.getLogger('foo').info('first message')815 logging.getLogger('foo.bar').error('second message')816self.assertEqual(cm.output, ['INFO:foo:first message',817 'ERROR:foo.bar:second message'])818```819820Новое в версии 3.4.821822Существуют также другие методы для выполнения более специфических проверок, например:823824| Метод | Проверяет, что | Новое в |825| --- | --- | --- |826| [`assertAlmostEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertAlmostEqual) | `round(a-b, 7) == 0` | |827| [`assertNotAlmostEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotAlmostEqual) | `round(a-b, 7) != 0` | |828| [`assertGreater(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertGreater) | `a > b` | 3.1 |829| [`assertGreaterEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertGreaterEqual) | `a >= b` | 3.1 |830| [`assertLess(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertLess) | `a < b` | 3.1 |831| [`assertLessEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertLessEqual) | `a <= b` | 3.1 |832| [`assertRegex(s, r)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRegex) | `r.search(s)` | 3.1 |833| [`assertNotRegex(s, r)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotRegex) | `not r.search(s)` | 3.2 |834| [`assertCountEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertCountEqual) | *a* и *b* содержат одни и те же элементы в одинаковом количестве, независимо от их порядка | 3.2 |835836#### `assertAlmostEqual(first, second, places=7, msg=None, delta=None)`837838#### `assertNotAlmostEqual(first, second, places=7, msg=None, delta=None)`839840Проверяет, что *first* и *second* приблизительно равны (или не равны), вычисляя разность, округляя до заданного числа десятичных знаков *places* (по умолчанию 7) и сравнивая с нулём. Обратите внимание, что эти методы округляют значения до заданного числа *десятичных знаков* (т.е. как функция [`round()`](https://python-all.ru/3.6/library/functions.html#round)), а не до *значащих цифр*.841842Если указан *delta* вместо *places*, то разность между *first* и *second* должна быть меньше или равна (или больше) *delta*.843844Одновременная передача *delta* и *places* вызывает [`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError).845846Изменено в версии 3.2: [`assertAlmostEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertAlmostEqual) теперь автоматически считает приблизительно равными объекты, которые сравниваются как равные. [`assertNotAlmostEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotAlmostEqual) теперь автоматически завершается ошибкой, если объекты сравниваются как равные. Добавлен именованный аргумент *delta*.847848#### `assertGreater(first, second, msg=None)`849850#### `assertGreaterEqual(first, second, msg=None)`851852#### `assertLess(first, second, msg=None)`853854#### `assertLessEqual(first, second, msg=None)`855856Проверяет, что *first* соответственно \>, \>=, \< или \<= по отношению к *second* в зависимости от имени метода. Если это не так, тест завершается ошибкой:857858```python859>>> self.assertGreaterEqual(3, 4)860AssertionError: "3" unexpectedly not greater than or equal to "4"861```862863Новое в версии 3.1.864865#### `assertRegex(text, regex, msg=None)`866867#### `assertNotRegex(text, regex, msg=None)`868869Проверяет, что поиск по *regex* совпадает (или не совпадает) с *text*. В случае неудачи сообщение об ошибке будет содержать шаблон и *text* (или шаблон и ту часть *text*, которая неожиданно совпала). *regex* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, подходящее для использования с [`re.search()`](https://python-all.ru/3.6/library/re.html#re.search).870871Новое в версии 3.1: под именем `assertRegexpMatches`.872873Изменено в версии 3.2: Метод `assertRegexpMatches()` был переименован в [`assertRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRegex).874875Новое в версии 3.2: [`assertNotRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotRegex).876877Добавлено в версии 3.5: имя `assertNotRegexpMatches` – устаревший псевдоним для [`assertNotRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotRegex).878879#### `assertCountEqual(first, second, msg=None)`880881Проверяет, что последовательность *first* содержит те же элементы, что и *second*, независимо от их порядка. Если нет, генерируется сообщение об ошибке с перечислением различий между последовательностями.882883Дублирующиеся элементы *не* игнорируются при сравнении *first* и *second*. Проверяется, что каждый элемент встречается одинаковое количество раз в обеих последовательностях. Эквивалентно: `assertEqual(Counter(list(first)), Counter(list(second)))` но также работает с последовательностями нехешируемых объектов.884885Новое в версии 3.2.886887Метод [`assertEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual) направляет проверку равенства для объектов одного типа к различным методам, специфичным для типа. Эти методы уже реализованы для большинства встроенных типов, но также можно зарегистрировать новые методы с помощью [`addTypeEqualityFunc()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.addTypeEqualityFunc):888889#### `addTypeEqualityFunc(typeobj, function)`890891Регистрирует метод, специфичный для типа, вызываемый с помощью [`assertEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual) для проверки, равны ли два объекта одного и того же *typeobj* (не подклассы). *function* должен принимать два позиционных аргумента и третий именованный аргумент msg=None, как и [`assertEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual). Он должен вызывать [`self.failureException(msg)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.failureException) при обнаружении неравенства между первыми двумя параметрами – возможно, предоставляя полезную информацию и подробно объясняя неравенства в сообщении об ошибке.892893Новое в версии 3.1.894895Список типовых методов, автоматически используемых [`assertEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual), приведён в следующей таблице. Обратите внимание, что обычно нет необходимости вызывать эти методы напрямую.896897| Метод | Используется для сравнения | Новое в |898| --- | --- | --- |899| [`assertMultiLineEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertMultiLineEqual) | строки | 3.1 |900| [`assertSequenceEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertSequenceEqual) | последовательности | 3.1 |901| [`assertListEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertListEqual) | списки | 3.1 |902| [`assertTupleEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertTupleEqual) | кортежи | 3.1 |903| [`assertSetEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertSetEqual) | множества или неизменяемые множества | 3.1 |904| [`assertDictEqual(a, b)`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertDictEqual) | словари | 3.1 |905906#### `assertMultiLineEqual(first, second, msg=None)`907908Проверяет, что многострочная строка *first* равна строке *second*. Если они не равны, в сообщение об ошибке включается diff двух строк с подсветкой различий. Этот метод используется по умолчанию при сравнении строк с помощью [`assertEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual).909910Новое в версии 3.1.911912#### `assertSequenceEqual(first, second, msg=None, seq_type=None)`913914Проверяет, что две последовательности равны. Если передан *seq\_type*, то *first* и *second* должны быть экземплярами *seq\_type*, иначе будет вызвана ошибка. Если последовательности различаются, формируется сообщение об ошибке, показывающее разницу между ними.915916Этот метод не вызывается напрямую методом [`assertEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual), но используется для реализации [`assertListEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertListEqual) и [`assertTupleEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertTupleEqual).917918Новое в версии 3.1.919920#### `assertListEqual(first, second, msg=None)`921922#### `assertTupleEqual(first, second, msg=None)`923924Проверяет, что два списка или кортежа равны. Если нет, формируется сообщение об ошибке, показывающее только различия между ними. Ошибка также возникает, если один из параметров имеет неверный тип. Эти методы используются по умолчанию при сравнении списков или кортежей с помощью [`assertEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual).925926Новое в версии 3.1.927928#### `assertSetEqual(first, second, msg=None)`929930Проверяет, что два множества равны. Если нет, формируется сообщение об ошибке, перечисляющее различия между множествами. Этот метод используется по умолчанию при сравнении множеств или неизменяемых множеств с помощью [`assertEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual).931932Завершается ошибкой, если *first* или *second* не имеет метода `set.difference()`.933934Новое в версии 3.1.935936#### `assertDictEqual(first, second, msg=None)`937938Проверяет, что два словаря равны. Если нет, формируется сообщение об ошибке, показывающее различия в словарях. Этот метод будет использоваться по умолчанию для сравнения словарей в вызовах [`assertEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual).939940Новое в версии 3.1.941942Наконец, [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) предоставляет следующие методы и атрибуты:943944#### `fail(msg=None)`945946Безусловно сигнализирует о сбое теста, используя *msg* или `None` в качестве сообщения об ошибке.947948#### `failureException`949950Этот атрибут класса задаёт исключение, которое вызывается тестовым методом. Если тестовому фреймворку требуется использовать специализированное исключение, возможно, для передачи дополнительной информации, он должен создать подкласс этого исключения, чтобы «честно играть» с фреймворком. Начальное значение этого атрибута – [`AssertionError`](https://python-all.ru/3.6/library/exceptions.html#AssertionError).951952#### `longMessage`953954Этот атрибут класса определяет, что происходит, когда пользовательское сообщение об ошибке передаётся в качестве аргумента msg в вызов assertXYY, который завершается сбоем. Значение по умолчанию – `True`. В этом случае пользовательское сообщение добавляется в конец стандартного сообщения об ошибке. Если установлено `False`, пользовательское сообщение заменяет стандартное.955956Настройку класса можно переопределить в отдельных тестовых методах, присвоив атрибуту экземпляра self.longMessage значение `True` или `False` перед вызовом assert-методов.957958Настройка класса сбрасывается перед каждым вызовом теста.959960Новое в версии 3.1.961962#### `maxDiff`963964Этот атрибут управляет максимальной длиной вывода различий, выводимых методами утверждения, которые сообщают о различиях при неудаче. По умолчанию – 80\*8 символов. Методы утверждения, на которые влияет этот атрибут: [`assertSequenceEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertSequenceEqual) (включая все методы сравнения последовательностей, которые делегируют ему), [`assertDictEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertDictEqual) и [`assertMultiLineEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertMultiLineEqual).965966Установка `maxDiff` в `None` означает, что максимальная длина различий не ограничена.967968Новое в версии 3.2.969970Тестовые фреймворки могут использовать следующие методы для сбора информации о тесте:971972#### `countTestCases()`973974Возвращает количество тестов, представленных этим тестовым объектом. Для экземпляров [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) это всегда будет `1`.975976#### `defaultTestResult()`977978Возвращает экземпляр класса результата теста, который следует использовать для данного класса тестового случая (если ни один другой экземпляр результата не был передан методу [`run()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.run)).979980Для экземпляров [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) это всегда будет экземпляр [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult); подклассы [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) должны при необходимости переопределять это.981982#### `id()`983984Возвращает строку, идентифицирующую конкретный тестовый случай. Обычно это полное имя тестового метода, включая имя модуля и класса.985986#### `shortDescription()`987988Возвращает описание теста или `None`, если описание не было предоставлено. Реализация по умолчанию этого метода возвращает первую строку докстринга тестового метода, если он доступен, или `None`.989990Изменено в версии 3.1: В 3.1 это было изменено, чтобы добавлять имя теста в краткое описание даже при наличии докстринга. Это вызвало проблемы совместимости с расширениями unittest, и добавление имени теста было перенесено в [`TextTestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TextTestResult) в Python 3.2.991992#### `addCleanup(function, *args, **kwargs)`993994Добавляет функцию, которая будет вызвана после [`tearDown()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.tearDown) для очистки ресурсов, использованных во время теста. Функции вызываются в порядке, обратном порядку их добавления (LIFO). Они вызываются с теми позиционными и именованными аргументами, которые были переданы в [`addCleanup()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.addCleanup) при их добавлении.995996Если [`setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp) завершается неудачей, то есть [`tearDown()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.tearDown) не вызывается, любые добавленные функции очистки всё равно будут вызваны.997998Новое в версии 3.1.9991000#### `doCleanups()`10011002Этот метод вызывается безусловно после [`tearDown()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.tearDown) или после [`setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp), если [`setUp()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.setUp) вызывает исключение.10031004Он отвечает за вызов всех функций очистки, добавленных с помощью [`addCleanup()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.addCleanup). Если необходимо, чтобы функции очистки вызывались *до* [`tearDown()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.tearDown), то можно вызвать [`doCleanups()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.doCleanups) самостоятельно.10051006[`doCleanups()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.doCleanups) извлекает методы из стека функций очистки по одному, поэтому его можно вызывать в любой момент.10071008Новое в версии 3.1.10091010#### `class unittest.FunctionTestCase(testFunc, setUp=None, tearDown=None, description=None)`10111012Этот класс реализует ту часть интерфейса [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase), которая позволяет исполнителю тестов управлять тестом, но не предоставляет методов, которые тестовый код может использовать для проверки и сообщения об ошибках. Это используется для создания тестовых примеров с использованием устаревшего тестового кода, что позволяет интегрировать его в тестовую среду на основе [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest).10131014#### 26.4.8.1.1. Устаревшие псевдонимы10151016По историческим причинам некоторые методы [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) имели один или несколько псевдонимов, которые сейчас устарели. В следующей таблице приведены корректные названия вместе с их устаревшими псевдонимами:10171018> | Имя метода | Устаревший псевдоним | Устаревший псевдоним |1019> | --- | --- | --- |1020> | [`assertEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertEqual) | failUnlessEqual | assertEquals |1021> | [`assertNotEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotEqual) | failIfEqual | assertNotEquals |1022> | [`assertTrue()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertTrue) | failUnless | assert\_ |1023> | [`assertFalse()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertFalse) | failIf | |1024> | [`assertRaises()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaises) | failUnlessRaises | |1025> | [`assertAlmostEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertAlmostEqual) | failUnlessAlmostEqual | assertAlmostEquals |1026> | [`assertNotAlmostEqual()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotAlmostEqual) | failIfAlmostEqual | assertNotAlmostEquals |1027> | [`assertRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRegex) | | assertRegexpMatches |1028> | [`assertNotRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotRegex) | | assertNotRegexpMatches |1029> | [`assertRaisesRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaisesRegex) | | assertRaisesRegexp |1030>1031> Устарело с версии 3.1: псевдонимы fail\*, перечисленные во втором столбце.1032>1033> Устарело с версии 3.2: псевдонимы assert\*, перечисленные в третьем столбце.1034>1035> Устарело с версии 3.2: `assertRegexpMatches` и `assertRaisesRegexp` переименованы в [`assertRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRegex) и [`assertRaisesRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertRaisesRegex).1036>1037> Устарело с версии 3.5: `assertNotRegexpMatches` имя в пользу [`assertNotRegex()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.assertNotRegex).10381039### 26.4.8.2. Группировка тестов10401041#### `class unittest.TestSuite(tests=())`10421043Этот класс представляет собой агрегацию отдельных тестовых примеров и тестовых наборов. Класс предоставляет интерфейс, необходимый исполнителю тестов, чтобы его можно было запускать как любой другой тестовый пример. Запуск экземпляра [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) равносилен итерации по набору с запуском каждого теста по отдельности.10441045Если задан *tests*, он должен быть итерабельным объектом, содержащим отдельные тестовые примеры или другие тестовые наборы, которые будут использоваться для первоначального построения набора. Дополнительные методы предоставляются для добавления тестовых примеров и наборов в коллекцию позже.10461047Объекты [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) ведут себя во многом как объекты [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase), за исключением того, что они не реализуют фактический тест. Вместо этого они используются для объединения тестов в группы, которые должны запускаться вместе. Некоторые дополнительные методы доступны для добавления тестов в экземпляры [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite):10481049#### `addTest(test)`10501051Добавляет [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) или [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) в набор.10521053#### `addTests(tests)`10541055Добавляет все тесты из итерабельного объекта, содержащего экземпляры [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) и [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite), в этот тестовый набор.10561057Это эквивалентно итерации по *tests* с вызовом [`addTest()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite.addTest) для каждого элемента.10581059[`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) разделяет следующие методы с [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase):10601061#### `run(result)`10621063Запускает тесты, связанные с этим набором, собирая результат в объект результата теста, переданный как *result*. Обратите внимание, что, в отличие от [`TestCase.run()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase.run), [`TestSuite.run()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite.run) требует, чтобы объект результата был передан.10641065#### `debug()`10661067Запускает тесты, связанные с этим набором, без сбора результата. Это позволяет исключениям, возбуждённым тестом, распространяться до вызывающего кода и может использоваться для поддержки запуска тестов под отладчиком.10681069#### `countTestCases()`10701071Возвращает количество тестов, представленных этим тестовым объектом, включая все отдельные тесты и поднаборы.10721073#### `__iter__()`10741075Тесты, сгруппированные с помощью [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite), всегда доступны через итерацию. Подклассы могут лениво предоставлять тесты, переопределяя [`__iter__()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite.__iter__). Обратите внимание, что этот метод может вызываться несколько раз для одного набора (например, при подсчёте тестов или сравнении на равенство), поэтому тесты, возвращаемые повторными итерациями до [`TestSuite.run()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite.run), должны быть одинаковыми для каждого вызова итерации. После [`TestSuite.run()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite.run) вызывающий код не должен полагаться на тесты, возвращаемые этим методом, если только вызывающий код не использует подкласс, который переопределяет `TestSuite._removeTestAtIndex()` для сохранения ссылок на тесты.10761077Изменено в версии 3.2: В более ранних версиях [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) обращался к тестам напрямую, а не через итерацию, поэтому переопределения [`__iter__()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite.__iter__) было недостаточно для предоставления тестов.10781079Изменено в версии 3.4: В более ранних версиях [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) хранил ссылки на каждый [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) после [`TestSuite.run()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite.run). Подклассы могут восстановить такое поведение, переопределив `TestSuite._removeTestAtIndex()`.10801081При типичном использовании объекта [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) метод [`run()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite.run) вызывается с помощью `TestRunner`, а не через тестовую оболочку конечного пользователя.10821083### 26.4.8.3. Загрузка и запуск тестов10841085#### `class unittest.TestLoader`10861087Класс [`TestLoader`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader) используется для создания тестовых наборов из классов и модулей. Обычно нет необходимости создавать экземпляр этого класса; модуль [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest) предоставляет экземпляр, который можно использовать совместно как [`unittest.defaultTestLoader`](https://python-all.ru/3.6/library/unittest.html#unittest.defaultTestLoader). Однако использование подкласса или экземпляра позволяет настраивать некоторые конфигурируемые свойства.10881089Объекты [`TestLoader`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader) имеют следующие атрибуты:10901091#### `errors`10921093Список некритических ошибок, возникших при загрузке тестов. Не сбрасывается загрузчиком ни в какой момент. Критические ошибки сигнализируются вызовом соответствующего метода, возбуждающего исключение для вызывающей стороны. Некритические ошибки также обозначаются синтетическим тестом, который возбуждает исходную ошибку при выполнении.10941095Новое в версии 3.5.10961097Объекты [`TestLoader`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader) имеют следующие методы:10981099#### `loadTestsFromTestCase(testCaseClass)`11001101Возвращает набор всех тестов, содержащихся в `testCaseClass`, производном от [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase).11021103Экземпляр тестового случая создаётся для каждого метода, именованного [`getTestCaseNames()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader.getTestCaseNames). По умолчанию это имена методов, начинающиеся с `test`. Если [`getTestCaseNames()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader.getTestCaseNames) не возвращает ни одного метода, но метод `runTest()` реализован, то вместо этого создаётся один тестовый случай для этого метода.11041105#### `loadTestsFromModule(module, pattern=None)`11061107Возвращает набор всех тестовых случаев, содержащихся в данном модуле. Этот метод ищет в *module* классы, производные от [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase), и создаёт экземпляр класса для каждого тестового метода, определённого для этого класса.11081109> **Примечание**1110>1111> Хотя использование иерархии классов, производных от [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase), может быть удобным для совместного использования фикстур и вспомогательных функций, определение тестовых методов в базовых классах, которые не предназначены для прямого создания экземпляров, плохо сочетается с этим методом. Однако это может быть полезно, когда фикстуры различаются и определены в подклассах.11121113Если модуль предоставляет функцию `load_tests`, она будет вызвана для загрузки тестов. Это позволяет модулям настраивать загрузку тестов. Это называется [протокол load\_tests](https://python-all.ru/3.6/library/unittest.html#load-tests-protocol). Аргумент *pattern* передаётся как третий аргумент в `load_tests`.11141115Изменено в версии 3.2: Добавлена поддержка `load_tests`.11161117Изменено в версии 3.5: Незадокументированный и неофициальный аргумент по умолчанию *use\_load\_tests* устарел и игнорируется, хотя всё ещё принимается для обратной совместимости. Метод также теперь принимает аргумент *pattern*, который передаётся в `load_tests` в качестве третьего аргумента.11181119#### `loadTestsFromName(name, module=None)`11201121Возвращает набор всех тестовых случаев по заданному строковому спецификатору.11221123Спецификатор *name* – это «точечное имя», которое может указывать на модуль, класс тестового случая, тестовый метод внутри класса тестового случая, экземпляр [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) или вызываемый объект, возвращающий экземпляр [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) или [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite). Эти проверки применяются в указанном порядке; то есть метод в возможном классе тестового случая будет распознан как «тестовый метод внутри класса тестового случая», а не как «вызываемый объект».11241125Например, если у вас есть модуль `SampleTests`, содержащий класс `SampleTestCase`, производный от [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase), с тремя тестовыми методами (`test_one()`, `test_two()` и `test_three()`), спецификатор `'SampleTests.SampleTestCase'` заставит этот метод вернуть набор, который выполнит все три тестовых метода. Использование спецификатора `'SampleTests.SampleTestCase.test_two'` приведёт к возврату тестового набора, который выполнит только тестовый метод `test_two()`. Спецификатор может ссылаться на модули и пакеты, которые не были импортированы; они будут импортированы как побочный эффект.11261127Метод опционально разрешает *name* относительно заданного *module*.11281129Изменено в версии 3.5: Если при обходе *name* возникает [`ImportError`](https://python-all.ru/3.6/library/exceptions.html#ImportError) или [`AttributeError`](https://python-all.ru/3.6/library/exceptions.html#AttributeError), то будет возвращён синтетический тест, который при выполнении вызывает эту ошибку. Эти ошибки включаются в ошибки, накопленные self.errors.11301131#### `loadTestsFromNames(names, module=None)`11321133Аналогичен [`loadTestsFromName()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader.loadTestsFromName), но принимает последовательность имён, а не одно имя. Возвращаемое значение – тестовый набор, который включает все тесты, определённые для каждого имени.11341135#### `getTestCaseNames(testCaseClass)`11361137Возвращает отсортированную последовательность имён методов, найденных в *testCaseClass*; это должен быть подкласс [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase).11381139#### `discover(start_dir, pattern='test*.py', top_level_dir=None)`11401141Находит все тестовые модули, рекурсивно обходя подкаталоги, начиная с указанного каталога, и возвращает объект TestSuite, содержащий их. Будут загружены только тестовые файлы, соответствующие *pattern*. (Используется сопоставление с образцом в стиле shell.) Будут загружены только имена модулей, которые можно импортировать (т.е. являются допустимыми идентификаторами Python).11421143Все тестовые модули должны быть импортируемыми из корневого каталога проекта. Если стартовый каталог не является корневым, то корневой каталог необходимо указать отдельно.11441145Если импорт модуля завершается неудачей, например из-за синтаксической ошибки, это записывается как одна ошибка, и поиск продолжается. Если неудача импорта связана с возникновением [`SkipTest`](https://python-all.ru/3.6/library/unittest.html#unittest.SkipTest), это будет записано как пропуск, а не как ошибка.11461147Если найден пакет (каталог, содержащий файл с именем `__init__.py`), в пакете проверяется наличие функции `load_tests`. Если она существует, она вызывается с помощью `package.load_tests(loader, tests, pattern)`. Поиск тестов гарантирует, что пакет проверяется на наличие тестов только один раз за вызов, даже если сама функция load\_tests вызывает `loader.discover`.11481149Если `load_tests` существует, то поиск *не* рекурсирует в пакет, `load_tests` отвечает за загрузку всех тестов в пакете.11501151Шаблон намеренно не хранится как атрибут загрузчика, чтобы пакеты могли продолжать самостоятельное обнаружение. *top\_level\_dir* сохраняется, поэтому `load_tests` не нужно передавать этот аргумент в `loader.discover()`.11521153*start\_dir* может быть как точечным именем модуля, так и каталогом.11541155Новое в версии 3.2.11561157Изменено в версии 3.4: Модули, вызывающие [`SkipTest`](https://python-all.ru/3.6/library/unittest.html#unittest.SkipTest) при импорте, регистрируются как пропуски, а не ошибки. Обнаружение работает для [пакетов пространств имён](https://python-all.ru/3.6/glossary.html#term-namespace-package). Пути сортируются перед импортом, чтобы порядок выполнения был одинаковым, даже если порядок сортировки в нижележащей файловой системе не зависит от имени файла.11581159Изменено в версии 3.5: Найденные пакеты теперь проверяются на наличие `load_tests` независимо от того, соответствует ли их путь *pattern*, поскольку имя пакета не может соответствовать шаблону по умолчанию.11601161Следующие атрибуты [`TestLoader`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader) можно настроить либо через наследование, либо через присваивание экземпляру:11621163#### `testMethodPrefix`11641165Строка, задающая префикс имён методов, которые будут интерпретироваться как тестовые методы. Значение по умолчанию – `'test'`.11661167Это влияет на [`getTestCaseNames()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader.getTestCaseNames) и все методы `loadTestsFrom*()`.11681169#### `sortTestMethodsUsing`11701171Функция, используемая для сравнения имён методов при их сортировке в [`getTestCaseNames()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader.getTestCaseNames) и во всех методах `loadTestsFrom*()`.11721173#### `suiteClass`11741175Вызываемый объект, который создаёт тестовый набор из списка тестов. Никакие методы результирующего объекта не требуются. Значение по умолчанию – класс [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite).11761177Это влияет на все методы `loadTestsFrom*()`.11781179#### `class unittest.TestResult`11801181Этот класс используется для сбора информации о том, какие тесты прошли успешно, а какие завершились неудачей.11821183Объект [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult) хранит результаты набора тестов. Классы [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) и [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) обеспечивают правильную запись результатов; авторам тестов не нужно беспокоиться о записи результатов тестов.11841185Тестовые фреймворки, построенные на базе [`unittest`](https://python-all.ru/3.6/library/unittest.html#module-unittest), могут нуждаться в доступе к объекту [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult), созданному при запуске набора тестов для целей отчетности; для этого метод `TestRunner.run()` возвращает экземпляр [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult).11861187Экземпляры [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult) имеют следующие атрибуты, которые будут интересны при проверке результатов запуска набора тестов:11881189#### `errors`11901191Список, содержащий 2-кортежи экземпляров [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) и строк с форматированными трассировками. Каждый кортеж представляет тест, вызвавший неожиданное исключение.11921193#### `failures`11941195Список, содержащий кортежи из двух элементов: экземпляры [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) и строки с форматированными трассировками стека. Каждый кортеж соответствует тесту, в котором сбой был явно зафиксирован с помощью методов `TestCase.assert*()`.11961197#### `skipped`11981199Список, содержащий 2-кортежи экземпляров [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) и строк с причиной пропуска теста.12001201Новое в версии 3.1.12021203#### `expectedFailures`12041205Список, содержащий кортежи из двух элементов: экземпляров [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) и строк с форматированными трассировками. Каждый кортеж представляет ожидаемый сбой тестового случая.12061207#### `unexpectedSuccesses`12081209Список, содержащий экземпляры [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase), которые были помечены как ожидаемые сбои, но завершились успешно.12101211#### `shouldStop`12121213Устанавливается в `True`, когда выполнение тестов должно быть остановлено с помощью [`stop()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.stop).12141215#### `testsRun`12161217Общее количество запущенных на данный момент тестов.12181219#### `buffer`12201221Если установлено в true, `sys.stdout` и `sys.stderr` будут буферизироваться между вызовами [`startTest()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.startTest) и [`stopTest()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.stopTest). Собранный вывод будет передаваться на реальные `sys.stdout` и `sys.stderr` только в случае сбоя или ошибки теста. Любой вывод также прикрепляется к сообщению о сбое/ошибке.12221223Новое в версии 3.2.12241225#### `failfast`12261227Если установлено в true, [`stop()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.stop) будет вызван при первой ошибке или сбое, останавливая выполнение теста.12281229Новое в версии 3.2.12301231#### `tb_locals`12321233Если установлено в true, то локальные переменные будут отображаться в трассировках.12341235Новое в версии 3.5.12361237#### `wasSuccessful()`12381239Возвращает `True`, если все запущенные на данный момент тесты пройдены, в противном случае возвращает `False`.12401241Изменено в версии 3.4: Возвращает `False`, если были какие-либо [`unexpectedSuccesses`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.unexpectedSuccesses) от тестов, помеченных декоратором [`expectedFailure()`](https://python-all.ru/3.6/library/unittest.html#unittest.expectedFailure).12421243#### `stop()`12441245Этот метод может быть вызван, чтобы указать, что выполняемый набор тестов должен быть прерван установкой атрибута [`shouldStop`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.shouldStop) в `True`. Объекты `TestRunner` должны учитывать этот флаг и возвращаться без запуска дополнительных тестов.12461247Например, эта возможность используется классом [`TextTestRunner`](https://python-all.ru/3.6/library/unittest.html#unittest.TextTestRunner) для остановки тестового фреймворка, когда пользователь подает сигнал прерывания с клавиатуры. Интерактивные инструменты, предоставляющие реализации `TestRunner`, могут использовать это аналогичным образом.12481249Следующие методы класса [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult) используются для поддержки внутренних структур данных и могут быть расширены в подклассах для поддержки дополнительных требований к отчетности. Это особенно полезно при создании инструментов, поддерживающих интерактивную отчетность во время выполнения тестов.12501251#### `startTest(test)`12521253Вызывается перед запуском тестового сценария *test*.12541255#### `stopTest(test)`12561257Вызывается после выполнения тестового сценария *test*, независимо от результата.12581259#### `startTestRun()`12601261Вызывается один раз перед выполнением любых тестов.12621263Новое в версии 3.1.12641265#### `stopTestRun()`12661267Вызывается один раз после выполнения всех тестов.12681269Новое в версии 3.1.12701271#### `addError(test, err)`12721273Вызывается, когда тестовый сценарий *test* порождает неожиданное исключение. *err* – кортеж вида, возвращаемого [`sys.exc_info()`](https://python-all.ru/3.6/library/sys.html#sys.exc_info): `(type, value, traceback)`.12741275Реализация по умолчанию добавляет кортеж `(test, formatted_err)` к атрибуту [`errors`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.errors) экземпляра, где *formatted\_err* – форматированная трассировка, полученная из *err*.12761277#### `addFailure(test, err)`12781279Вызывается, когда тестовый сценарий *test* сигнализирует о сбое. *err* – кортеж вида, возвращаемого [`sys.exc_info()`](https://python-all.ru/3.6/library/sys.html#sys.exc_info): `(type, value, traceback)`.12801281Реализация по умолчанию добавляет кортеж `(test, formatted_err)` к атрибуту [`failures`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.failures) экземпляра, где *formatted\_err* – форматированная трассировка, полученная из *err*.12821283#### `addSuccess(test)`12841285Вызывается, когда тестовый сценарий *test* завершается успешно.12861287Реализация по умолчанию ничего не делает.12881289#### `addSkip(test, reason)`12901291Вызывается, когда тестовый сценарий *test* пропускается. *reason* – причина, которую тест указал для пропуска.12921293Реализация по умолчанию добавляет кортеж `(test, reason)` к атрибуту [`skipped`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.skipped) экземпляра.12941295#### `addExpectedFailure(test, err)`12961297Вызывается, когда тестовый случай *test* завершается ошибкой, но был помечен декоратором [`expectedFailure()`](https://python-all.ru/3.6/library/unittest.html#unittest.expectedFailure).12981299Реализация по умолчанию добавляет кортеж `(test, formatted_err)` к атрибуту [`expectedFailures`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.expectedFailures) экземпляра, где *formatted\_err* – форматированная трассировка, полученная из *err*.13001301#### `addUnexpectedSuccess(test)`13021303Вызывается, когда тестовый сценарий *test* был помечен декоратором [`expectedFailure()`](https://python-all.ru/3.6/library/unittest.html#unittest.expectedFailure), но завершился успешно.13041305Реализация по умолчанию добавляет тест к атрибуту [`unexpectedSuccesses`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.unexpectedSuccesses) экземпляра.13061307#### `addSubTest(test, subtest, outcome)`13081309Вызывается, когда завершается подтест. *test* – тестовый сценарий, соответствующий тестовому методу. *subtest* – пользовательский экземпляр [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase), описывающий подтест.13101311Если *outcome* равен [`None`](https://python-all.ru/3.6/library/constants.html#None), подтест завершился успешно. В противном случае он завершился исключением, где *outcome* – кортеж вида, возвращаемого [`sys.exc_info()`](https://python-all.ru/3.6/library/sys.html#sys.exc_info): `(type, value, traceback)`.13121313Реализация по умолчанию ничего не делает, если результат – успех, и записывает сбои подтестов как обычные сбои.13141315Новое в версии 3.4.13161317#### `class unittest.TextTestResult(stream, descriptions, verbosity)`13181319Конкретная реализация [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult), используемая [`TextTestRunner`](https://python-all.ru/3.6/library/unittest.html#unittest.TextTestRunner).13201321Новое в версии 3.2: Раньше этот класс назывался `_TextTestResult`. Старое имя всё ещё существует как псевдоним, но оно устарело.13221323#### `unittest.defaultTestLoader`13241325Экземпляр класса [`TestLoader`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader), предназначенный для совместного использования. Если настройка [`TestLoader`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader) не требуется, можно использовать этот экземпляр вместо повторного создания новых.13261327#### `class unittest.TextTestRunner(stream=None, descriptions=True, verbosity=1, failfast=False, buffer=False, resultclass=None, warnings=None, *, tb_locals=False)`13281329Базовая реализация запуска тестов, которая выводит результаты в поток данных. Если *stream* равен `None` (значение по умолчанию), в качестве выходного потока данных используется [`sys.stderr`](https://python-all.ru/3.6/library/sys.html#sys.stderr). Этот класс имеет несколько настраиваемых параметров, но в целом очень прост. Графические приложения, запускающие наборы тестов, должны предоставлять альтернативные реализации. Такие реализации должны принимать `**kwargs`, поскольку интерфейс для создания запускаторов меняется при добавлении новых возможностей в unittest.13301331По умолчанию этот исполнитель показывает [`DeprecationWarning`](https://python-all.ru/3.6/library/exceptions.html#DeprecationWarning), [`PendingDeprecationWarning`](https://python-all.ru/3.6/library/exceptions.html#PendingDeprecationWarning), [`ResourceWarning`](https://python-all.ru/3.6/library/exceptions.html#ResourceWarning) и [`ImportWarning`](https://python-all.ru/3.6/library/exceptions.html#ImportWarning), даже если они [игнорируются по умолчанию](https://python-all.ru/3.6/library/warnings.html#warning-ignored). Предупреждения об устаревании, вызванные [устаревшими методами unittest](https://python-all.ru/3.6/library/unittest.html#deprecated-aliases), обрабатываются особым образом: когда фильтры предупреждений установлены в `'default'` или `'always'`, они появляются только один раз на модуль, чтобы избежать слишком большого количества сообщений. Это поведение можно переопределить с помощью опций Python `-Wd` или `-Wa` (см. [Управление предупреждениями](https://python-all.ru/3.6/using/cmdline.html#using-on-warnings)) и оставить *warnings* равным `None`.13321333Изменено в версии 3.2: Добавлен аргумент `warnings`.13341335Изменено в версии 3.2: Поток по умолчанию устанавливается на [`sys.stderr`](https://python-all.ru/3.6/library/sys.html#sys.stderr) в момент создания экземпляра, а не при импорте.13361337Изменено в версии 3.5: Добавлен параметр tb\_locals.13381339#### `_makeResult()`13401341Этот метод возвращает экземпляр `TestResult`, используемый [`run()`](https://python-all.ru/3.6/library/unittest.html#unittest.TextTestRunner.run). Он не предназначен для прямого вызова, но может быть переопределён в подклассах для предоставления собственного `TestResult`.13421343`_makeResult()` создаёт экземпляр класса или вызываемого объекта, переданного в конструктор `TextTestRunner` как аргумент `resultclass`. По умолчанию используется [`TextTestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TextTestResult), если `resultclass` не предоставлен. Класс результата создаётся со следующими аргументами:13441345```python1346stream, descriptions, verbosity1347```13481349#### `run(test)`13501351Этот метод является основным публичным интерфейсом для *TextTestRunner*. Этот метод принимает экземпляр [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite) или [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase). [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult) создаётся вызовом [`_makeResult()`](https://python-all.ru/3.6/library/unittest.html#unittest.TextTestRunner._makeResult), и тесты выполняются, а результаты выводятся в stdout.13521353#### `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)`13541355Программа командной строки, которая загружает набор тестов из *module* и запускает их; это в первую очередь для удобного выполнения тестовых модулей. Простейший способ использования этой функции – добавить следующую строку в конец тестового скрипта:13561357```python1358if __name__ == '__main__':1359 unittest.main()1360```13611362Можно запускать тесты с более подробной информацией, передав аргумент verbosity:13631364```python1365if __name__ == '__main__':1366 unittest.main(verbosity=2)1367```13681369Аргумент *defaultTest* может быть либо именем одного теста, либо итерируемым объектом с именами тестов для запуска, если имена тестов не указаны через *argv*. Если он не задан или равен `None`, а имена тестов не переданы через *argv*, выполняются все тесты, найденные в *module*.13701371Аргумент *argv* может быть списком параметров, переданных программе, где первый элемент – имя программы. Если он не задан или равен `None`, используются значения [`sys.argv`](https://python-all.ru/3.6/library/sys.html#sys.argv).13721373Аргумент *testRunner* может быть либо классом исполнителя тестов, либо уже созданным экземпляром этого класса. По умолчанию `main` вызывает [`sys.exit()`](https://python-all.ru/3.6/library/sys.html#sys.exit) с кодом возврата, указывающим на успех или неудачу выполнения тестов.13741375Аргумент *testLoader* должен быть экземпляром [`TestLoader`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader) и по умолчанию равен [`defaultTestLoader`](https://python-all.ru/3.6/library/unittest.html#unittest.defaultTestLoader).13761377`main` поддерживает использование из интерактивного интерпретатора при передаче аргумента `exit=False`. При этом результат выводится в стандартный вывод без вызова [`sys.exit()`](https://python-all.ru/3.6/library/sys.html#sys.exit):13781379```python1380>>> from unittest import main1381>>> main(module='test_module', exit=False)1382```13831384Параметры *failfast*, *catchbreak* и *buffer* имеют тот же эффект, что и одноимённые [параметры командной строки](https://python-all.ru/3.6/library/unittest.html#command-line-options).13851386Аргумент *warnings* задаёт [фильтр предупреждений](https://python-all.ru/3.6/library/warnings.html#warning-filter), который следует использовать при выполнении тестов. Если он не указан, он останется `None` при передаче опции `-W` в **python** (см. [Управление предупреждениями](https://python-all.ru/3.6/using/cmdline.html#using-on-warnings)), в противном случае будет установлен в `'default'`.13871388Вызов `main` на самом деле возвращает экземпляр класса `TestProgram`. Этот экземпляр сохраняет результат выполнения тестов в атрибуте `result`.13891390Изменено в версии 3.1: Добавлен параметр *exit*.13911392Изменено в версии 3.2: Добавлены параметры *verbosity*, *failfast*, *catchbreak*, *buffer* и *warnings*.13931394Изменено в версии 3.4: Параметр *defaultTest* был изменён: теперь он также принимает итерируемый объект с именами тестов.13951396#### 26.4.8.3.1. load\_tests Протокол13971398Новое в версии 3.2.13991400Модули или пакеты могут настраивать загрузку тестов из себя во время обычного запуска тестов или их обнаружения, реализуя функцию с именем `load_tests`.14011402Если тестовый модуль определяет `load_tests`, то он будет вызван функцией [`TestLoader.loadTestsFromModule()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader.loadTestsFromModule) со следующими аргументами:14031404```python1405load_tests(loader, standard_tests, pattern)1406```14071408где *pattern* передаётся напрямую из `loadTestsFromModule`. По умолчанию он равен `None`.14091410Она должна возвращать объект [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite).14111412*loader* – это экземпляр [`TestLoader`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader), выполняющий загрузку. *standard\_tests* – это тесты, которые будут загружены по умолчанию из модуля. Часто тестовые модули хотят только добавить или удалить тесты из стандартного набора. Третий аргумент используется при загрузке пакетов в рамках обнаружения тестов.14131414Типичная функция `load_tests`, загружающая тесты из определённого набора классов [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase), может выглядеть так:14151416```python1417test_cases = (TestCase1, TestCase2, TestCase3)14181419def load_tests(loader, tests, pattern):1420 suite = TestSuite()1421 for test_class in test_cases:1422 tests = loader.loadTestsFromTestCase(test_class)1423 suite.addTests(tests)1424 return suite1425```14261427Если обнаружение запускается в каталоге, содержащем пакет, либо из командной строки, либо вызовом [`TestLoader.discover()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestLoader.discover), то у пакета `__init__.py` проверяется наличие `load_tests`. Если такой функции нет, обнаружение рекурсивно обходит пакет, как если бы это был просто ещё один каталог. В противном случае обнаружение тестов пакета передаётся функции `load_tests`, которая вызывается со следующими аргументами:14281429```python1430load_tests(loader, standard_tests, pattern)1431```14321433Она должна возвращать объект [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite), представляющий все тесты из пакета. (`standard_tests` будет содержать только тесты, собранные из `__init__.py`.)14341435Поскольку шаблон передаётся в `load_tests`, пакет может продолжить (и, возможно, изменить) обнаружение тестов. Функция `load_tests`, которая ничего не делает, для тестового пакета может выглядеть так:14361437```python1438def load_tests(loader, standard_tests, pattern):1439 # корневой каталог, кэшированный на экземпляре загрузчика1440 this_dir = os.path.dirname(__file__)1441 package_tests = loader.discover(start_dir=this_dir, pattern=pattern)1442 standard_tests.addTests(package_tests)1443 return standard_tests1444```14451446Изменено в версии 3.5: Обнаружение больше не проверяет имена пакетов на соответствие *pattern* из-за невозможности соответствия имён пакетов шаблону по умолчанию.14471448## 26.4.9. Фикстуры классов и модулей14491450Фикстуры уровня класса и модуля реализуются в [`TestSuite`](https://python-all.ru/3.6/library/unittest.html#unittest.TestSuite). Когда набор тестов встречает тест из нового класса, вызывается `tearDownClass()` из предыдущего класса (если он есть), а затем `setUpClass()` из нового класса.14511452Аналогично, если тест из другого модуля, отличного от предыдущего, то запускается `tearDownModule` предыдущего модуля, а затем `setUpModule` нового модуля.14531454После выполнения всех тестов запускаются финальные `tearDownClass` и `tearDownModule`.14551456Обратите внимание, что общие фикстуры плохо совместимы с такими возможностями, как параллельное выполнение тестов, и нарушают изоляцию тестов. Их следует использовать с осторожностью.14571458Упорядочивание тестов по умолчанию, создаваемое загрузчиками тестов unittest, группирует все тесты из одних и тех же модулей и классов вместе. Это приводит к тому, что `setUpClass` / `setUpModule` (и т.д.) вызываются ровно один раз на класс и модуль. Если изменить порядок случайным образом, так что тесты из разных модулей и классов будут соседствовать друг с другом, то эти общие фикстуры могут вызываться несколько раз за один прогон тестов.14591460Общие фикстуры не предназначены для работы с наборами тестов, имеющими нестандартный порядок. `BaseTestSuite` всё ещё существует для фреймворков, которые не хотят поддерживать общие фикстуры.14611462Если во время выполнения одной из общих фикстур возникает исключение, тест помечается как ошибочный. Поскольку нет соответствующего экземпляра теста, создаётся объект `_ErrorHolder` (имеющий тот же интерфейс, что и [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase)) для представления ошибки. Если вы просто используете стандартный исполнитель тестов unittest, эта деталь не имеет значения, но если вы разработчик фреймворка, это может быть актуально.14631464### 26.4.9.1. setUpClass and tearDownClass14651466Они должны быть реализованы как методы класса:14671468```python1469import unittest14701471class Test(unittest.TestCase):1472 @classmethod1473 def setUpClass(cls):1474 cls._connection = createExpensiveConnectionObject()14751476 @classmethod1477 def tearDownClass(cls):1478 cls._connection.destroy()1479```14801481Если нужно, чтобы `setUpClass` и `tearDownClass` базовых классов вызывались, необходимо вызвать их самостоятельно. Реализации в [`TestCase`](https://python-all.ru/3.6/library/unittest.html#unittest.TestCase) пусты.14821483Если во время выполнения `setUpClass` возникает исключение, тесты в классе не запускаются, и `tearDownClass` не выполняется. Пропущенные классы не будут выполнять `setUpClass` или `tearDownClass`. Если исключением является [`SkipTest`](https://python-all.ru/3.6/library/unittest.html#unittest.SkipTest), то класс будет помечен как пропущенный, а не как ошибочный.14841485### 26.4.9.2. setUpModule and tearDownModule14861487Их следует реализовывать как функции:14881489```python1490def setUpModule():1491 createConnection()14921493def tearDownModule():1494 closeConnection()1495```14961497Если в `setUpModule` возникает исключение, то ни один тест в модуле не будет запущен, и `tearDownModule` не будет выполнен. Если исключением является [`SkipTest`](https://python-all.ru/3.6/library/unittest.html#unittest.SkipTest), то модуль будет помечен как пропущенный, а не как ошибочный.14981499## 26.4.10. Обработка сигналов15001501Новое в версии 3.2.15021503Параметр командной строки [`-c/--catch`](https://python-all.ru/3.6/library/unittest.html#cmdoption-unittest-c) для unittest вместе с параметром `catchbreak` для [`unittest.main()`](https://python-all.ru/3.6/library/unittest.html#unittest.main) обеспечивают более удобную обработку control-C во время выполнения тестов. Когда поведение catch-break включено, control-C позволяет завершить текущий тест, после чего выполнение тестов завершается и выводятся все результаты на данный момент. Повторное нажатие control-C вызовет исключение [`KeyboardInterrupt`](https://python-all.ru/3.6/library/exceptions.html#KeyboardInterrupt) обычным образом.15041505Обработчик сигнала control-c старается оставаться совместимым с кодом или тестами, которые устанавливают собственный обработчик `signal.SIGINT`. Если обработчик `unittest` вызывается, но *не является* установленным обработчиком `signal.SIGINT`, то есть был заменён тестируемой системой и делегирован, то он вызывает стандартный обработчик. Обычно это ожидаемое поведение для кода, который заменяет установленный обработчик и делегирует ему. Для отдельных тестов, где требуется `unittest` отключить обработку control-c, можно использовать декоратор [`removeHandler()`](https://python-all.ru/3.6/library/unittest.html#unittest.removeHandler).15061507Существует несколько вспомогательных функций для разработчиков фреймворков, позволяющих включить обработку control-c в тестовых фреймворках.15081509#### `unittest.installHandler()`15101511Устанавливает обработчик control-c. Когда получен сигнал `signal.SIGINT` (обычно в ответ на нажатие пользователем control-c), у всех зарегистрированных результатов вызывается [`stop()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.stop).15121513#### `unittest.registerResult(result)`15141515Регистрирует объект [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult) для обработки control-c. При регистрации результата сохраняется слабая ссылка на него, поэтому это не препятствует сборке мусора объекта результата.15161517Регистрация объекта [`TestResult`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult) не имеет побочных эффектов, если обработка control-c не включена, поэтому тестовые фреймворки могут безусловно регистрировать все создаваемые ими результаты, независимо от того, включена обработка или нет.15181519#### `unittest.removeResult(result)`15201521Удаляет зарегистрированный результат. После удаления результата [`stop()`](https://python-all.ru/3.6/library/unittest.html#unittest.TestResult.stop) больше не будет вызываться для этого объекта результата в ответ на control-c.15221523#### `unittest.removeHandler(function=None)`15241525При вызове без аргументов эта функция удаляет обработчик control-c, если он был установлен. Эту функцию также можно использовать как тестовый декоратор для временного удаления обработчика на время выполнения теста:15261527```python1528@unittest.removeHandler1529def test_signal_handling(self):1530 ...1531```1532