unittest.md

1> **Источник:** https://python-all.ru/3.10/library/unittest.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest) – фреймворк для модульного тестирования89**Исходный код:** [Lib/unittest/\_\_init\_\_.py](https://python-all.ru/src/3.10/Lib/unittest/__init__.py)1011---1213(Если вы уже знакомы с основными понятиями тестирования, можете перейти к [списку методов assert](https://python-all.ru/3.10/library/unittest.html#assert-methods).)1415Фреймворк модульного тестирования [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest) изначально был вдохновлён JUnit и имеет схожий подход с основными фреймворками модульного тестирования на других языках. Он поддерживает автоматизацию тестов, совместное использование кода подготовки и завершения тестов, объединение тестов в коллекции и независимость тестов от системы отчётов.1617Для этого [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest) поддерживает несколько важных концепций в объектно-ориентированном стиле:1819**тестовая фикстура**2021*Тестовая фикстура* представляет собой подготовку, необходимую для выполнения одного или нескольких тестов, а также все связанные действия по очистке. Это может включать, например, создание временных или прокси-баз данных, каталогов или запуск серверного процесса.2223**тестовый случай**2425*Тестовый случай* – это отдельная единица тестирования. Он проверяет определённую реакцию на конкретный набор входных данных. [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest) предоставляет базовый класс [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase), который можно использовать для создания новых тестовых случаев.2627**набор тестов**2829*Набор тестов* – это совокупность тестовых случаев, наборов тестов или и того, и другого. Он используется для объединения тестов, которые должны выполняться вместе.3031**исполнитель тестов**3233*Исполнитель тестов* – это компонент, который управляет выполнением тестов и предоставляет результат пользователю. Исполнитель может использовать графический интерфейс, текстовый интерфейс или возвращать специальное значение, указывающее на результаты выполнения тестов.3435> **См. также**36>37> **Модуль [`doctest`](https://python-all.ru/3.10/library/doctest.html#module-doctest)**38>39> Ещё один модуль поддержки тестирования с совершенно другим подходом.40>41> **[Простое тестирование в Smalltalk: с шаблонами](https://python-all.ru/3.10/library/unittest.html)**42>43> Оригинальная статья Кента Бека о фреймворках тестирования, в которых используется тот же шаблон, что и в [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest).44>45> **[pytest](https://python-all.ru/3.10/library/unittest.html)**46>47> Сторонний фреймворк модульного тестирования с более лёгким синтаксисом для написания тестов. Например, `assert func(10) == 42`.48>49> **[Таксономия инструментов тестирования Python](https://python-all.ru/3.10/library/unittest.html)**50>51> Обширный список инструментов тестирования Python, включая фреймворки функционального тестирования и библиотеки имитационных объектов (mock).52>53> **[Список рассылки по тестированию в Python](https://python-all.ru/3.10/library/unittest.html)**54>55> Группа по интересам для обсуждения тестирования и инструментов тестирования в Python.56>57> Скрипт `Tools/unittestgui/unittestgui.py` в дистрибутиве исходных кодов Python – это графическая утилита для поиска и выполнения тестов. Он предназначен главным образом для упрощения работы с модульным тестированием для новичков. В рабочих средах рекомендуется запускать тесты через систему непрерывной интеграции, например [Buildbot](https://python-all.ru/3.10/library/unittest.html), [Jenkins](https://python-all.ru/3.10/library/unittest.html), [Travis-CI](https://python-all.ru/3.10/library/unittest.html) или [AppVeyor](https://python-all.ru/3.10/library/unittest.html).5859## Простой пример6061Модуль [`unittest`](https://python-all.ru/3.10/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.10/library/unittest.html#unittest.TestCase). Три отдельных теста определяются методами, имена которых начинаются с букв `test`. Это соглашение об именовании сообщает тестовому раннеру, какие методы являются тестами.8990Суть каждого теста – вызов [`assertEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual) для проверки ожидаемого результата; [`assertTrue()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertTrue) или [`assertFalse()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertFalse) для проверки условия; или [`assertRaises()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaises) для проверки того, что возбуждается определённое исключение. Эти методы используются вместо оператора [`assert`](https://python-all.ru/3.10/reference/simple_stmts.html#assert), чтобы исполнитель тестов мог накапливать все результаты тестов и формировать отчёт.9192Методы [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp) и [`tearDown()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDown) позволяют определить инструкции, которые будут выполняться до и после каждого метода теста. Они подробнее рассматриваются в разделе [Организация тестового кода](https://python-all.ru/3.10/library/unittest.html#organizing-tests).9394В последнем блоке показан простой способ запуска тестов. [`unittest.main()`](https://python-all.ru/3.10/library/unittest.html#unittest.main) предоставляет интерфейс командной строки для тестового скрипта. При запуске из командной строки приведённый выше скрипт выдаёт вывод, который выглядит так:9596```python97...98----------------------------------------------------------------------99Ran 3 tests in 0.000s100101OK102```103104Передача флага `-v` вашему тестовому скрипту укажет [`unittest.main()`](https://python-all.ru/3.10/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.10/library/unittest.html#module-unittest), которых достаточно для многих повседневных задач тестирования. Оставшаяся часть документации рассматривает полный набор функций с самого начала.118119## Интерфейс командной строки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.10/library/unittest.html#unittest-test-discovery):146147```python148python -m unittest149```150151Чтобы получить список всех параметров командной строки:152153```python154python -m unittest -h155```156157Изменено в версии 3.2: В более ранних версиях можно было запускать только отдельные тестовые методы, а не модули или классы.158159### Параметры командной строки160161**unittest** поддерживает следующие параметры командной строки:162163#### `-b, --buffer`164165Потоки стандартного вывода и стандартной ошибки буферизируются во время выполнения теста. Вывод при успешном тесте отбрасывается. При ошибке или провале теста вывод выводится обычным образом и добавляется к сообщениям о неудаче.166167#### `-c, --catch`168169`Control-C` во время выполнения теста ожидает завершения текущего теста, а затем выводит все результаты, полученные на данный момент. Повторное нажатие `Control-C` вызывает обычное исключение [`KeyboardInterrupt`](https://python-all.ru/3.10/library/exceptions.html#KeyboardInterrupt).170171См. раздел [Обработка сигналов](https://python-all.ru/3.10/library/unittest.html#signal-handling) с описанием функций, предоставляющих эту возможность.172173#### `-f, --failfast`174175Остановить выполнение теста при первой же ошибке или неудаче.176177#### `-k`178179Запускать только те тестовые методы и классы, которые соответствуют шаблону или подстроке. Этот параметр можно использовать несколько раз; в этом случае включаются все тесты, соответствующие любому из заданных шаблонов.180181Шаблоны, содержащие символ подстановки (`*`), сопоставляются с именем теста с помощью [`fnmatch.fnmatchcase()`](https://python-all.ru/3.10/library/fnmatch.html#fnmatch.fnmatchcase); в противном случае используется простое сопоставление подстрок с учётом регистра.182183Шаблоны сопоставляются с полным именем тестового метода, импортированным загрузчиком тестов.184185Например, `-k foo` соответствует `foo_tests.SomeTest.test_something`, `bar_tests.SomeTest.test_foo`, но не `bar_tests.FooTest.test_something`.186187#### `--locals`188189Показывать локальные переменные в трассировках.190191Новое в версии 3.2: Добавлены опции командной строки `-b`, `-c` и `-f`.192193Новое в версии 3.5: Опция командной строки `--locals`.194195Новое в версии 3.7: Опция командной строки `-k`.196197Командная строка также может использоваться для автоматического обнаружения тестов, для запуска всех тестов в проекте или только их части.198199## Обнаружение тестов200201Новое в версии 3.2.202203Unittest поддерживает простой поиск тестов. Чтобы тесты были совместимы с поиском, все тестовые файлы должны быть [модулями](https://python-all.ru/3.10/tutorial/modules.html#tut-modules) или [пакетами](https://python-all.ru/3.10/tutorial/modules.html#tut-packages) (включая [пространственные пакеты](https://python-all.ru/3.10/glossary.html#term-namespace-package)), которые можно импортировать из корневого каталога проекта (это означает, что их имена файлов должны быть допустимыми [идентификаторами](https://python-all.ru/3.10/reference/lexical_analysis.html#identifiers)).204205Обнаружение тестов реализовано в [`TestLoader.discover()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader.discover), но также может использоваться из командной строки. Основное использование командной строки:206207```python208cd project_directory209python -m unittest discover210```211212> **Примечание**213>214> В качестве сокращения, `python -m unittest` эквивалентно `python -m unittest discover`. Если требуется передать аргументы для обнаружения тестов, необходимо явно указать подкоманду `discover`.215216Подкоманда `discover` имеет следующие опции:217218#### `-v, --verbose`219220Подробный вывод221222#### `-s, --start-directory directory`223224Каталог для начала обнаружения (по умолчанию `.`)225226#### `-p, --pattern pattern`227228Шаблон для сопоставления тестовых файлов (по умолчанию `test*.py`)229230#### `-t, --top-level-directory directory`231232Корневой каталог проекта (по умолчанию – каталог начала поиска)233234Параметры [`-s`](https://python-all.ru/3.10/library/unittest.html#cmdoption-unittest-discover-s), [`-p`](https://python-all.ru/3.10/library/unittest.html#cmdoption-unittest-discover-p) и [`-t`](https://python-all.ru/3.10/library/unittest.html#cmdoption-unittest-discover-t) можно передавать в качестве позиционных аргументов в указанном порядке. Следующие две командные строки эквивалентны:235236```python237python -m unittest discover -s project_directory -p "*_test.py"238python -m unittest discover project_directory "*_test.py"239```240241Помимо пути, в качестве начального каталога можно передать имя пакета, например `myproject.subpackage.test`. Указанное имя пакета будет импортировано, и его расположение в файловой системе будет использоваться в качестве начального каталога.242243> **Внимание**244>245> Обнаружение тестов загружает тесты путем их импорта. Как только обнаружение тестов найдет все тестовые файлы в указанном начальном каталоге, оно преобразует пути в имена пакетов для импорта. Например, `foo/bar/baz.py` будет импортирован как `foo.bar.baz`.246>247> Если пакет установлен глобально, и предпринимается попытка обнаружения тестов в другой копии пакета, то импорт *может* произойти из неправильного места. Если это произойдет, обнаружение тестов выдаст предупреждение и завершится.248>249> Если указать начальный каталог как имя пакета, а не путь к каталогу, то discover считает, что местоположение, из которого он импортирует, и есть то, которое вы имели в виду, поэтому предупреждение не появится.250251Тестовые модули и пакеты могут настраивать загрузку и обнаружение тестов с помощью [протокола load\_tests](https://python-all.ru/3.10/library/unittest.html#load-tests-protocol).252253Изменено в версии 3.4: Обнаружение тестов поддерживает [пакеты пространств имён](https://python-all.ru/3.10/glossary.html#term-namespace-package) для начального каталога. Обратите внимание: нужно указать также каталог верхнего уровня (например, `python -m unittest discover -s root/namespace -t root`).254255## Организация тестового кода256257Основными строительными блоками модульного тестирования являются *тестовые случаи* – отдельные сценарии, которые необходимо настроить и проверить на корректность. В [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest) тестовые случаи представлены экземплярами [`unittest.TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase). Чтобы создать собственные тестовые случаи, необходимо написать подклассы [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) или использовать [`FunctionTestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.FunctionTestCase).258259Тестовый код экземпляра [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) должен быть полностью самодостаточным, чтобы его можно было запускать как изолированно, так и в произвольной комбинации с любым количеством других тестовых случаев.260261Простейший подкласс [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) просто реализует тестовый метод (т.е. метод, имя которого начинается с `test`) для выполнения определенного тестового кода:262263```python264import unittest265266class DefaultWidgetSizeTestCase(unittest.TestCase):267    def test_default_widget_size(self):268        widget = Widget('The widget')269        self.assertEqual(widget.size(), (50, 50))270```271272Обратите внимание: для тестирования используется один из методов `assert*()`, предоставляемых базовым классом [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase). Если тест не пройден, будет возбуждено исключение с поясняющим сообщением, и [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest) определит тестовый случай как *сбой*. Любые другие исключения будут считаться *ошибками*.273274Тестов может быть много, и их подготовка может быть повторяющейся. К счастью, можно вынести код подготовки в метод с именем [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp), который тестовый фреймворк будет автоматически вызывать для каждого запускаемого теста:275276```python277import unittest278279class WidgetTestCase(unittest.TestCase):280    def setUp(self):281        self.widget = Widget('The widget')282283    def test_default_widget_size(self):284        self.assertEqual(self.widget.size(), (50,50),285                         'incorrect default size')286287    def test_widget_resize(self):288        self.widget.resize(100,150)289        self.assertEqual(self.widget.size(), (100,150),290                         'wrong size after resize')291```292293> **Примечание**294>295> Порядок выполнения различных тестов определяется сортировкой имен тестовых методов в соответствии со встроенным порядком строк.296297Если метод [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp) возбуждает исключение во время выполнения теста, фреймворк посчитает, что тест завершился ошибкой, и тестовый метод не будет выполнен.298299Аналогично, можно предоставить метод [`tearDown()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDown), который выполняет очистку после выполнения тестового метода:300301```python302import unittest303304class WidgetTestCase(unittest.TestCase):305    def setUp(self):306        self.widget = Widget('The widget')307308    def tearDown(self):309        self.widget.dispose()310```311312Если [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp) успешно выполнен, [`tearDown()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDown) будет выполнен, независимо от того, завершился тестовый метод успешно или нет.313314Такое рабочее окружение для тестового кода называется *тестовой фикстурой*. Новый экземпляр TestCase создаётся как уникальная тестовая фикстура, используемая для выполнения каждого отдельного тестового метода. Таким образом, [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp), [`tearDown()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDown) и `__init__()` будут вызываться один раз для каждого теста.315316Рекомендуется группировать тесты с помощью реализаций TestCase в соответствии с тестируемыми возможностями. [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest) предоставляет для этого механизм: *набор тестов*, представленный классом [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) из модуля [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest). В большинстве случаев вызов [`unittest.main()`](https://python-all.ru/3.10/library/unittest.html#unittest.main) сделает всё правильно: соберёт все тестовые случаи модуля и выполнит их.317318Однако, если требуется настроить сборку набора тестов, это можно сделать самостоятельно:319320```python321def suite():322    suite = unittest.TestSuite()323    suite.addTest(WidgetTestCase('test_default_widget_size'))324    suite.addTest(WidgetTestCase('test_widget_resize'))325    return suite326327if __name__ == '__main__':328    runner = unittest.TextTestRunner()329    runner.run(suite())330```331332Определения тестовых случаев и наборов тестов можно размещать в тех же модулях, что и тестируемый код (например, `widget.py`), но есть несколько преимуществ в размещении тестового кода в отдельном модуле, например, `test_widget.py`:333334- Тестовый модуль можно запускать автономно из командной строки.335- Тестовый код проще отделить от поставляемого кода.336- Меньше соблазна изменять тестовый код, чтобы подогнать его под тестируемый код, без веской причины.337- Тестовый код должен изменяться гораздо реже, чем тестируемый код.338- Тестируемый код проще поддаётся рефакторингу.339- Тесты для модулей, написанных на C, всё равно должны быть в отдельных модулях – так почему бы не придерживаться этого подхода?340- Если стратегия тестирования меняется, нет необходимости изменять исходный код.341342## Повторное использование старого тестового кода343344Некоторые пользователи могут иметь существующий тестовый код, который они хотели бы запускать из [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest), не преобразовывая каждую старую тестовую функцию в подкласс [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase).345346По этой причине [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest) предоставляет класс [`FunctionTestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.FunctionTestCase). Этот подкласс [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) можно использовать для обёртывания существующей тестовой функции. Также можно предоставить функции настройки (set-up) и завершения (tear-down).347348Рассмотрим следующую тестовую функцию:349350```python351def testSomething():352    something = makeSomething()353    assert something.name is not None354    # ...355```356357можно создать эквивалентный экземпляр тестового случая следующим образом, с опциональными методами настройки и завершения:358359```python360testcase = unittest.FunctionTestCase(testSomething,361                                     setUp=makeSomethingDB,362                                     tearDown=deleteSomethingDB)363```364365> **Примечание**366>367> Хотя [`FunctionTestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.FunctionTestCase) можно использовать для быстрого преобразования существующей тестовой базы в систему на основе [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest), этот подход не рекомендуется. Затрата времени на создание правильных подклассов [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) значительно упростит будущий рефакторинг тестов.368369В некоторых случаях существующие тесты могли быть написаны с использованием модуля [`doctest`](https://python-all.ru/3.10/library/doctest.html#module-doctest). В этом случае [`doctest`](https://python-all.ru/3.10/library/doctest.html#module-doctest) предоставляет класс `DocTestSuite`, который может автоматически создавать экземпляры [`unittest.TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) из существующих тестов на основе [`doctest`](https://python-all.ru/3.10/library/doctest.html#module-doctest).370371## Пропуск тестов и ожидаемые сбои372373Новое в версии 3.1.374375Unittest поддерживает пропуск отдельных тестовых методов и даже целых классов тестов. Кроме того, он поддерживает пометку теста как «ожидаемый сбой» – тест, который сломан и завершится неудачей, но не должен засчитываться как сбой в [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult).376377Пропуск теста – это просто использование [`skip()`](https://python-all.ru/3.10/library/unittest.html#unittest.skip) [декоратора](https://python-all.ru/3.10/glossary.html#term-decorator) или одного из его условных вариантов, вызов [`TestCase.skipTest()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.skipTest) внутри [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp) или тестового метода, или непосредственное возбуждение [`SkipTest`](https://python-all.ru/3.10/library/unittest.html#unittest.SkipTest).378379Базовый пропуск выглядит так:380381```python382class MyTestCase(unittest.TestCase):383384    @unittest.skip("demonstrating skipping")385    def test_nothing(self):386        self.fail("shouldn't happen")387388    @unittest.skipIf(mylib.__version__ < (1, 3),389                     "not supported in this library version")390    def test_format(self):391        # Тесты, которые работают только для определённой версии библиотеки.392        pass393394    @unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")395    def test_windows_support(self):396        # код тестирования для Windows397        pass398399    def test_maybe_skipped(self):400        if not external_resource_available():401            self.skipTest("external resource not available")402        # тестовый код, зависящий от внешнего ресурса403        pass404```405406Это вывод приведённого выше примера в подробном режиме:407408```python409test_format (__main__.MyTestCase) ... skipped 'not supported in this library version'410test_nothing (__main__.MyTestCase) ... skipped 'demonstrating skipping'411test_maybe_skipped (__main__.MyTestCase) ... skipped 'external resource not available'412test_windows_support (__main__.MyTestCase) ... skipped 'requires Windows'413414----------------------------------------------------------------------415Ran 4 tests in 0.005s416417OK (skipped=4)418```419420Классы можно пропускать так же, как методы:421422```python423@unittest.skip("showing class skipping")424class MySkippedTestCase(unittest.TestCase):425    def test_not_run(self):426        pass427```428429[`TestCase.setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp) также может пропустить тест. Это полезно, когда ресурс, который необходимо настроить, недоступен.430431Для ожидаемых сбоев используется декоратор [`expectedFailure()`](https://python-all.ru/3.10/library/unittest.html#unittest.expectedFailure).432433```python434class ExpectedFailureTestCase(unittest.TestCase):435    @unittest.expectedFailure436    def test_fail(self):437        self.assertEqual(1, 0, "broken")438```439440Легко создать собственные декораторы пропуска, создав декоратор, который вызывает [`skip()`](https://python-all.ru/3.10/library/unittest.html#unittest.skip) для теста, когда нужно его пропустить. Этот декоратор пропускает тест, если только переданный объект не имеет определённого атрибута:441442```python443def skipUnlessHasattr(obj, attr):444    if hasattr(obj, attr):445        return lambda func: func446    return unittest.skip("{!r} doesn't have {!r}".format(obj, attr))447```448449Следующие декораторы и исключение реализуют пропуск тестов и ожидаемые сбои:450451#### `@unittest.skip(reason)`452453Безусловно пропускает декорированный тест. Параметр *reason* должен описывать причину пропуска теста.454455#### `@unittest.skipIf(condition, reason)`456457Пропустить декорированный тест, если *condition* истинно.458459#### `@unittest.skipUnless(condition, reason)`460461Пропустить декорированный тест, если *condition* не истинно.462463#### `@unittest.expectedFailure`464465Помечает тест как ожидаемый сбой или ошибку. Если тест завершается ошибкой или сбоем в самой тестовой функции (а не в одном из методов *тестовой фикстуры*), то он будет считаться успешным. Если тест проходит, он будет считаться неудачным.466467#### `exception unittest.SkipTest(reason)`468469Это исключение возбуждается для пропуска теста.470471Обычно можно использовать [`TestCase.skipTest()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.skipTest) или один из декораторов пропуска, вместо того чтобы возбуждать его напрямую.472473Пропущенные тесты не будут выполнять [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp) или [`tearDown()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDown). Пропущенные классы не будут выполнять [`setUpClass()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUpClass) или [`tearDownClass()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDownClass). Пропущенные модули не будут выполнять `setUpModule()` или `tearDownModule()`.474475## Различение итераций теста с помощью подтестов476477Новое в версии 3.4.478479Когда между тестами есть очень небольшие различия, например некоторые параметры, unittest позволяет различать их внутри тела тестового метода с помощью контекстного менеджера [`subTest()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.subTest).480481Например, следующий тест:482483```python484class NumbersTest(unittest.TestCase):485486    def test_even(self):487        """488        Проверить, что все числа от 0 до 5 чётные.489        """490        for i in range(0, 6):491            with self.subTest(i=i):492                self.assertEqual(i % 2, 0)493```494495выдаст следующий результат:496497```python498======================================================================499FAIL: test_even (__main__.NumbersTest) (i=1)500----------------------------------------------------------------------501Traceback (most recent call last):502  File "subtests.py", line 32, in test_even503    self.assertEqual(i % 2, 0)504AssertionError: 1 != 0505506======================================================================507FAIL: test_even (__main__.NumbersTest) (i=3)508----------------------------------------------------------------------509Traceback (most recent call last):510  File "subtests.py", line 32, in test_even511    self.assertEqual(i % 2, 0)512AssertionError: 1 != 0513514======================================================================515FAIL: test_even (__main__.NumbersTest) (i=5)516----------------------------------------------------------------------517Traceback (most recent call last):518  File "subtests.py", line 32, in test_even519    self.assertEqual(i % 2, 0)520AssertionError: 1 != 0521```522523Без использования подтеста выполнение остановилось бы после первого сбоя, и ошибку было бы труднее диагностировать, поскольку значение `i` не отображалось бы:524525```python526======================================================================527FAIL: test_even (__main__.NumbersTest)528----------------------------------------------------------------------529Traceback (most recent call last):530  File "subtests.py", line 32, in test_even531    self.assertEqual(i % 2, 0)532AssertionError: 1 != 0533```534535## Классы и функции536537В этом разделе подробно описывается API [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest).538539### Тестовые примеры540541#### `class unittest.TestCase(methodName='runTest')`542543Экземпляры класса [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) представляют собой логические тестовые единицы в среде [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest). Этот класс предназначен для использования в качестве базового класса, при этом конкретные тесты реализуются в конкретных подклассах. Класс реализует интерфейс, необходимый тестовому исполнителю для управления тестами, а также методы, которые тестовый код может использовать для проверки и сообщения о различных видах сбоев.544545Каждый экземпляр [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) выполняет один базовый метод: метод с именем *methodName*. В большинстве случаев использования [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) не требуется ни изменять *methodName*, ни переопределять метод по умолчанию `runTest()`.546547Изменено в версии 3.2: [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) можно успешно создать без указания *methodName*. Это упрощает эксперименты с [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) в интерактивном интерпретаторе.548549Экземпляры [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) предоставляют три группы методов: одна группа используется для выполнения теста, другая – реализацией теста для проверки условий и сообщения о сбоях, и несколько запросных методов, позволяющих собирать информацию о самом тесте.550551Методы первой группы (выполнение теста):552553#### `setUp()`554555Метод, вызываемый для подготовки тестовой фикстуры. Он вызывается непосредственно перед вызовом тестового метода; за исключением [`AssertionError`](https://python-all.ru/3.10/library/exceptions.html#AssertionError) или [`SkipTest`](https://python-all.ru/3.10/library/unittest.html#unittest.SkipTest), любое исключение, возбуждённое этим методом, будет считаться ошибкой, а не сбоем теста. Реализация по умолчанию ничего не делает.556557#### `tearDown()`558559Метод, вызываемый сразу после вызова тестового метода и записи результата. Он вызывается, даже если тестовый метод возбудил исключение, поэтому реализация в подклассах должна быть особенно осторожна при проверке внутреннего состояния. Любое исключение, кроме [`AssertionError`](https://python-all.ru/3.10/library/exceptions.html#AssertionError) или [`SkipTest`](https://python-all.ru/3.10/library/unittest.html#unittest.SkipTest), возбуждённое этим методом, будет считаться дополнительной ошибкой, а не сбоем теста (таким образом увеличивая общее количество сообщённых ошибок). Этот метод будет вызван только если [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp) выполнится успешно, независимо от результата тестового метода. Реализация по умолчанию ничего не делает.560561#### `setUpClass()`562563Метод класса, вызываемый перед выполнением тестов в отдельном классе. `setUpClass` вызывается с классом в качестве единственного аргумента и должен быть декорирован как [`classmethod()`](https://python-all.ru/3.10/library/functions.html#classmethod):564565```python566@classmethod567def setUpClass(cls):568    ...569```570571См. [Фикстуры классов и модулей](https://python-all.ru/3.10/library/unittest.html#class-and-module-fixtures) для получения дополнительных сведений.572573Новое в версии 3.2.574575#### `tearDownClass()`576577Метод класса, вызываемый после выполнения тестов в отдельном классе. `tearDownClass` вызывается с классом в качестве единственного аргумента и должен быть декорирован как [`classmethod()`](https://python-all.ru/3.10/library/functions.html#classmethod):578579```python580@classmethod581def tearDownClass(cls):582    ...583```584585См. [Фикстуры классов и модулей](https://python-all.ru/3.10/library/unittest.html#class-and-module-fixtures) для получения дополнительных сведений.586587Новое в версии 3.2.588589#### `run(result=None)`590591Запускает тест, собирая результат в объект [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult), переданный как *result*. Если *result* опущен или равен `None`, создаётся временный объект результата (путем вызова метода [`defaultTestResult()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.defaultTestResult)), который и используется. Объект результата возвращается вызывающему коду [`run()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.run).592593Того же эффекта можно добиться простым вызовом экземпляра [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase).594595Изменено в версии 3.3: Предыдущие версии `run` не возвращали результат. Также не возвращал результат вызов экземпляра.596597#### `skipTest(reason)`598599Вызов этого метода внутри тестового метода или [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp) пропускает текущий тест. Подробнее см. [Пропуск тестов и ожидаемые сбои](https://python-all.ru/3.10/library/unittest.html#unittest-skipping).600601Новое в версии 3.1.602603#### `subTest(msg=None, **params)`604605Возвращает менеджер контекста, который выполняет вложенный блок кода как подтест. *msg* и *params* – необязательные произвольные значения, отображаемые при сбое подтеста, что позволяет однозначно их идентифицировать.606607Тестовый пример может содержать любое количество объявлений подтестов, и они могут быть произвольно вложены.608609Подробнее см. [Различение итераций тестов с помощью подтестов](https://python-all.ru/3.10/library/unittest.html#subtests).610611Новое в версии 3.4.612613#### `debug()`614615Запускает тест без сбора результата. Это позволяет исключениям, возникшим в тесте, распространяться до вызывающего кода, и может использоваться для поддержки запуска тестов под отладчиком.616617Класс [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) предоставляет несколько методов assert для проверки и сообщения об ошибках. В следующей таблице перечислены наиболее часто используемые методы (см. таблицы ниже для получения дополнительных методов assert):618619| Метод | Проверяет, что | Новое в |620| --- | --- | --- |621| [`assertEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual) | `a == b` |  |622| [`assertNotEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotEqual) | `a != b` |  |623| [`assertTrue(x)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertTrue) | `bool(x) is True` |  |624| [`assertFalse(x)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertFalse) | `bool(x) is False` |  |625| [`assertIs(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertIs) | `a is b` | 3.1 |626| [`assertIsNot(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertIsNot) | `a is not b` | 3.1 |627| [`assertIsNone(x)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertIsNone) | `x is None` | 3.1 |628| [`assertIsNotNone(x)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertIsNotNone) | `x is not None` | 3.1 |629| [`assertIn(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertIn) | `a in b` | 3.1 |630| [`assertNotIn(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotIn) | `a not in b` | 3.1 |631| [`assertIsInstance(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertIsInstance) | `isinstance(a, b)` | 3.2 |632| [`assertNotIsInstance(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotIsInstance) | `not isinstance(a, b)` | 3.2 |633634Все методы assert принимают аргумент *msg*, который, если указан, используется как сообщение об ошибке в случае сбоя (см. также [`longMessage`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.longMessage)). Обратите внимание, что ключевой аргумент *msg* может быть передан методам [`assertRaises()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaises), [`assertRaisesRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaisesRegex), [`assertWarns()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertWarns), [`assertWarnsRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertWarnsRegex) только когда они используются как менеджер контекста.635636#### `assertEqual(first, second, msg=None)`637638Проверяет, что *first* и *second* равны. Если значения не равны, тест завершится с ошибкой.639640Кроме того, если *first* и *second* относятся к одному и тому же типу и это list, tuple, dict, set, frozenset, str или любой тип, зарегистрированный подклассом с помощью [`addTypeEqualityFunc()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.addTypeEqualityFunc), то будет вызвана типовая функция сравнения для формирования более информативного сообщения об ошибке по умолчанию (см. также [список типовых методов](https://python-all.ru/3.10/library/unittest.html#type-specific-methods)).641642Изменено в версии 3.1: Добавлен автоматический вызов типовой функции сравнения.643644Изменено в версии 3.2: [`assertMultiLineEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertMultiLineEqual) добавлен в качестве типовой функции сравнения по умолчанию для сравнения строк.645646#### `assertNotEqual(first, second, msg=None)`647648Проверяет, что *first* и *second* не равны. Если значения равны, тест завершится с ошибкой.649650#### `assertTrue(expr, msg=None)`651652#### `assertFalse(expr, msg=None)`653654Проверяет, что *expr* истинно (или ложно).655656Обратите внимание, что это эквивалентно `bool(expr) is True`, а не `expr is True` (для последнего используйте `assertIs(expr, True)`). Этот метод также следует избегать, если доступны более специфические методы (например, `assertEqual(a, b)` вместо `assertTrue(a == b)`), потому что они предоставляют более информативное сообщение об ошибке в случае сбоя.657658#### `assertIs(first, second, msg=None)`659660#### `assertIsNot(first, second, msg=None)`661662Проверяет, что *first* и *second* являются (или не являются) одним и тем же объектом.663664Новое в версии 3.1.665666#### `assertIsNone(expr, msg=None)`667668#### `assertIsNotNone(expr, msg=None)`669670Проверяет, что *expr* является (или не является) `None`.671672Новое в версии 3.1.673674#### `assertIn(member, container, msg=None)`675676#### `assertNotIn(member, container, msg=None)`677678Проверяет, что *member* находится (или не находится) в *container*.679680Новое в версии 3.1.681682#### `assertIsInstance(obj, cls, msg=None)`683684#### `assertNotIsInstance(obj, cls, msg=None)`685686Проверяет, что *obj* является (или не является) экземпляром *cls* (который может быть классом или кортежем классов, как поддерживается [`isinstance()`](https://python-all.ru/3.10/library/functions.html#isinstance)). Для проверки точного типа используйте [`assertIs(type(obj), cls)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertIs).687688Новое в версии 3.2.689690Также можно проверить возникновение исключений, предупреждений и сообщений журнала с помощью следующих методов:691692| Метод | Проверяет, что | Новое в |693| --- | --- | --- |694| [`assertRaises(exc, fun, *args, **kwds)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaises) | `fun(*args, **kwds)` возбуждает *exc* |  |695| [`assertRaisesRegex(exc, r, fun, *args, **kwds)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaisesRegex) | `fun(*args, **kwds)` возбуждает *exc* и сообщение соответствует регулярному выражению *r* | 3.1 |696| [`assertWarns(warn, fun, *args, **kwds)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertWarns) | `fun(*args, **kwds)` возбуждает *warn* | 3.2 |697| [`assertWarnsRegex(warn, r, fun, *args, **kwds)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertWarnsRegex) | `fun(*args, **kwds)` возбуждает *warn* и сообщение соответствует регулярному выражению *r* | 3.2 |698| [`assertLogs(logger, level)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertLogs) | Блок `with` пишет в журнал *logger* с минимальным уровнем *level* | 3.4 |699| [`assertNoLogs(logger, level)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNoLogs) | Блок `with` не пишет в журнал*logger* с минимальным *level* | 3.10 |700701#### `assertRaises(exception, callable, *args, **kwds)`702703#### `assertRaises(exception, *, msg=None)`704705Проверяет, что исключение возбуждается, когда *callable* вызывается с любыми позиционными или именованными аргументами, которые также передаются в [`assertRaises()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaises). Тест проходит, если возбуждается *исключение*, считается ошибкой, если возбуждается другое исключение, или не проходит, если исключение не возбуждается. Чтобы перехватить любое из группы исключений, можно передать кортеж, содержащий классы исключений, как *исключение*.706707Если переданы только аргументы *исключение* и, возможно, *msg*, возвращается менеджер контекста, чтобы проверяемый код можно было написать встроенно, а не в виде функции:708709```python710with self.assertRaises(SomeException):711    do_something()712```713714При использовании в качестве менеджера контекста [`assertRaises()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaises) принимает дополнительный ключевой аргумент *msg*.715716Менеджер контекста сохраняет перехваченный объект исключения в своём атрибуте `exception`. Это может быть полезно, если нужно выполнить дополнительные проверки возникшего исключения:717718```python719with self.assertRaises(SomeException) as cm:720    do_something()721722the_exception = cm.exception723self.assertEqual(the_exception.error_code, 3)724```725726Изменено в версии 3.1: Добавлена возможность использовать [`assertRaises()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaises) в качестве менеджера контекста.727728Изменено в версии 3.2: Добавлен атрибут `exception`.729730Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.731732#### `assertRaisesRegex(exception, regex, callable, *args, **kwds)`733734#### `assertRaisesRegex(exception, regex, *, msg=None)`735736Как [`assertRaises()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaises), но также проверяет, что *regex* соответствует строковому представлению возбуждённого исключения. *regex* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, подходящее для использования [`re.search()`](https://python-all.ru/3.10/library/re.html#re.search). Примеры:737738```python739self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$",740                       int, 'XYZ')741```742743или:744745```python746with self.assertRaisesRegex(ValueError, 'literal'):747   int('XYZ')748```749750Добавлено в версии 3.1: под именем `assertRaisesRegexp`.751752Изменено в версии 3.2: переименовано в [`assertRaisesRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaisesRegex).753754Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.755756#### `assertWarns(warning, callable, *args, **kwds)`757758#### `assertWarns(warning, *, msg=None)`759760Проверяет, что предупреждение вызывается, когда *вызываемый объект* вызывается с любыми позиционными или ключевыми аргументами, которые также передаются в [`assertWarns()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertWarns). Тест проходит, если *предупреждение* вызывается, и не проходит в противном случае. Любое исключение считается ошибкой. Чтобы перехватить любое из группы предупреждений, можно передать кортеж, содержащий классы предупреждений, в качестве *предупреждения*.761762Если указаны только *предупреждение* и, возможно, *msg*, возвращается менеджер контекста, позволяющий писать тестируемый код inline, а не в виде функции:763764```python765with self.assertWarns(SomeWarning):766    do_something()767```768769При использовании в качестве менеджера контекста [`assertWarns()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertWarns) принимает дополнительный ключевой аргумент *msg*.770771Менеджер контекста сохраняет перехваченный объект предупреждения в своём атрибуте `warning`, а также исходную строку, вызвавшую предупреждения, в атрибутах `filename` и `lineno`. Это может быть полезно, если требуется выполнить дополнительные проверки перехваченного предупреждения:772773```python774with self.assertWarns(SomeWarning) as cm:775    do_something()776777self.assertIn('myfile.py', cm.filename)778self.assertEqual(320, cm.lineno)779```780781Этот метод работает независимо от фильтров предупреждений, установленных на момент его вызова.782783Новое в версии 3.2.784785Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.786787#### `assertWarnsRegex(warning, regex, callable, *args, **kwds)`788789#### `assertWarnsRegex(warning, regex, *, msg=None)`790791Как и [`assertWarns()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertWarns), но также проверяет, что *регулярное выражение* соответствует сообщению вызванного предупреждения. *Регулярное выражение* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, пригодное для использования [`re.search()`](https://python-all.ru/3.10/library/re.html#re.search). Пример:792793```python794self.assertWarnsRegex(DeprecationWarning,795                      r'legacy_function\(\) is deprecated',796                      legacy_function, 'XYZ')797```798799или:800801```python802with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'):803    frobnicate('/etc/passwd')804```805806Новое в версии 3.2.807808Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.809810#### `assertLogs(logger=None, level=None)`811812Менеджер контекста для проверки того, что хотя бы одно сообщение зарегистрировано в *логгере* или одном из его потомков, с уровнем не ниже указанного *уровня*.813814Если указан, *логгер* должен быть объектом [`logging.Logger`](https://python-all.ru/3.10/library/logging.html#logging.Logger) или [`str`](https://python-all.ru/3.10/library/stdtypes.html#str), задающим имя логгера. По умолчанию используется корневой логгер, который перехватывает все сообщения, не заблокированные непропагандирующим дочерним логгером.815816Если указан, *уровень* должен быть числовым уровнем логирования или его строковым эквивалентом (например, `"ERROR"` или `logging.ERROR`). По умолчанию `logging.INFO`.817818Тест проходит, если хотя бы одно сообщение, отправленное внутри блока `with`, соответствует условиям *логгера* и *уровня*, в противном случае тест не проходит.819820Объект, возвращаемый менеджером контекста, представляет собой вспомогательный объект для записи, который отслеживает соответствующие сообщения журнала. Он имеет два атрибута:821822#### `records`823824Список объектов [`logging.LogRecord`](https://python-all.ru/3.10/library/logging.html#logging.LogRecord) соответствующих сообщений журнала.825826#### `output`827828Список объектов [`str`](https://python-all.ru/3.10/library/stdtypes.html#str) с отформатированным выводом соответствующих сообщений.829830Пример:831832```python833with self.assertLogs('foo', level='INFO') as cm:834    logging.getLogger('foo').info('first message')835    logging.getLogger('foo.bar').error('second message')836self.assertEqual(cm.output, ['INFO:foo:first message',837                             'ERROR:foo.bar:second message'])838```839840Новое в версии 3.4.841842#### `assertNoLogs(logger=None, level=None)`843844Менеджер контекста для проверки того, что на *логгере* или одном из его потомков не зарегистрировано ни одного сообщения с уровнем не ниже указанного *уровня*.845846Если указан, *логгер* должен быть объектом [`logging.Logger`](https://python-all.ru/3.10/library/logging.html#logging.Logger) или [`str`](https://python-all.ru/3.10/library/stdtypes.html#str), задающим имя логгера. По умолчанию используется корневой логгер, который перехватывает все сообщения.847848Если указан, *уровень* должен быть числовым уровнем логирования или его строковым эквивалентом (например, `"ERROR"` или `logging.ERROR`). По умолчанию `logging.INFO`.849850В отличие от [`assertLogs()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertLogs), менеджер контекста ничего не возвращает.851852Новое в версии 3.10.853854Существуют также другие методы для выполнения более специфических проверок, например:855856| Метод | Проверяет, что | Новое в |857| --- | --- | --- |858| [`assertAlmostEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertAlmostEqual) | `round(a-b, 7) == 0` |  |859| [`assertNotAlmostEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotAlmostEqual) | `round(a-b, 7) != 0` |  |860| [`assertGreater(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertGreater) | `a > b` | 3.1 |861| [`assertGreaterEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertGreaterEqual) | `a >= b` | 3.1 |862| [`assertLess(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertLess) | `a < b` | 3.1 |863| [`assertLessEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertLessEqual) | `a <= b` | 3.1 |864| [`assertRegex(s, r)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRegex) | `r.search(s)` | 3.1 |865| [`assertNotRegex(s, r)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotRegex) | `not r.search(s)` | 3.2 |866| [`assertCountEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertCountEqual) | *a* и *b* содержат одинаковые элементы в одинаковом количестве, независимо от их порядка. | 3.2 |867868#### `assertAlmostEqual(first, second, places=7, msg=None, delta=None)`869870#### `assertNotAlmostEqual(first, second, places=7, msg=None, delta=None)`871872Проверяет, что *first* и *second* приблизительно равны (или не равны), вычисляя разность, округляя до заданного числа десятичных знаков *places* (по умолчанию 7) и сравнивая с нулём. Обратите внимание, что эти методы округляют значения до заданного числа *десятичных знаков* (т.е. как функция [`round()`](https://python-all.ru/3.10/library/functions.html#round)), а не до *значащих цифр*.873874Если указан *delta* вместо *places*, то разность между *first* и *second* должна быть меньше или равна (или больше) *delta*.875876Одновременная передача *delta* и *places* вызывает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError).877878Изменено в версии 3.2: [`assertAlmostEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertAlmostEqual) теперь автоматически считает приблизительно равными объекты, которые сравниваются как равные. [`assertNotAlmostEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotAlmostEqual) теперь автоматически завершается ошибкой, если объекты сравниваются как равные. Добавлен именованный аргумент *delta*.879880#### `assertGreater(first, second, msg=None)`881882#### `assertGreaterEqual(first, second, msg=None)`883884#### `assertLess(first, second, msg=None)`885886#### `assertLessEqual(first, second, msg=None)`887888Проверяет, что *first* соответственно \>, \>=, \< или \<= по отношению к *second* в зависимости от имени метода. Если это не так, тест завершается ошибкой:889890```python891>>> self.assertGreaterEqual(3, 4)892AssertionError: "3" unexpectedly not greater than or equal to "4"893```894895Новое в версии 3.1.896897#### `assertRegex(text, regex, msg=None)`898899#### `assertNotRegex(text, regex, msg=None)`900901Проверяет, что поиск по *regex* совпадает (или не совпадает) с *text*. В случае неудачи сообщение об ошибке будет содержать шаблон и *text* (или шаблон и ту часть *text*, которая неожиданно совпала). *regex* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, подходящее для использования с [`re.search()`](https://python-all.ru/3.10/library/re.html#re.search).902903Добавлено в версии 3.1: под именем `assertRegexpMatches`.904905Изменено в версии 3.2: Метод `assertRegexpMatches()` был переименован в [`assertRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRegex).906907Новое в версии 3.2: [`assertNotRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotRegex).908909Добавлено в версии 3.5: имя `assertNotRegexpMatches` – устаревший псевдоним для [`assertNotRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotRegex).910911#### `assertCountEqual(first, second, msg=None)`912913Проверяет, что последовательность *first* содержит те же элементы, что и *second*, независимо от их порядка. Если нет, генерируется сообщение об ошибке с перечислением различий между последовательностями.914915Дублирующиеся элементы *не* игнорируются при сравнении *first* и *second*. Проверяется, что каждый элемент встречается одинаковое количество раз в обеих последовательностях. Эквивалентно: `assertEqual(Counter(list(first)), Counter(list(second)))` но также работает с последовательностями нехешируемых объектов.916917Новое в версии 3.2.918919Метод [`assertEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual) направляет проверку равенства для объектов одного типа к различным методам, специфичным для типа. Эти методы уже реализованы для большинства встроенных типов, но также можно зарегистрировать новые методы с помощью [`addTypeEqualityFunc()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.addTypeEqualityFunc):920921#### `addTypeEqualityFunc(typeobj, function)`922923Регистрирует метод, специфичный для типа, вызываемый с помощью [`assertEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual) для проверки, равны ли два объекта одного и того же *typeobj* (не подклассы). *function* должен принимать два позиционных аргумента и третий именованный аргумент msg=None, как и [`assertEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual). Он должен вызывать [`self.failureException(msg)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.failureException) при обнаружении неравенства между первыми двумя параметрами – возможно, предоставляя полезную информацию и подробно объясняя неравенства в сообщении об ошибке.924925Новое в версии 3.1.926927Список типовых методов, автоматически используемых [`assertEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual), приведён в следующей таблице. Обратите внимание, что обычно нет необходимости вызывать эти методы напрямую.928929| Метод | Используется для сравнения | Новое в |930| --- | --- | --- |931| [`assertMultiLineEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertMultiLineEqual) | строки | 3.1 |932| [`assertSequenceEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertSequenceEqual) | последовательности | 3.1 |933| [`assertListEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertListEqual) | списки | 3.1 |934| [`assertTupleEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertTupleEqual) | кортежи | 3.1 |935| [`assertSetEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertSetEqual) | множества или неизменяемые множества | 3.1 |936| [`assertDictEqual(a, b)`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertDictEqual) | словари | 3.1 |937938#### `assertMultiLineEqual(first, second, msg=None)`939940Проверяет, что многострочная строка *first* равна строке *second*. Если они не равны, в сообщение об ошибке включается diff двух строк с подсветкой различий. Этот метод используется по умолчанию при сравнении строк с помощью [`assertEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual).941942Новое в версии 3.1.943944#### `assertSequenceEqual(first, second, msg=None, seq_type=None)`945946Проверяет, что две последовательности равны. Если передан *seq\_type*, то *first* и *second* должны быть экземплярами *seq\_type*, иначе будет вызвана ошибка. Если последовательности различаются, формируется сообщение об ошибке, показывающее разницу между ними.947948Этот метод не вызывается напрямую методом [`assertEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual), но используется для реализации [`assertListEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertListEqual) и [`assertTupleEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertTupleEqual).949950Новое в версии 3.1.951952#### `assertListEqual(first, second, msg=None)`953954#### `assertTupleEqual(first, second, msg=None)`955956Проверяет, что два списка или кортежа равны. Если нет, формируется сообщение об ошибке, показывающее только различия между ними. Ошибка также возникает, если один из параметров имеет неверный тип. Эти методы используются по умолчанию при сравнении списков или кортежей с помощью [`assertEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual).957958Новое в версии 3.1.959960#### `assertSetEqual(first, second, msg=None)`961962Проверяет, что два множества равны. Если нет, формируется сообщение об ошибке, перечисляющее различия между множествами. Этот метод используется по умолчанию при сравнении множеств или неизменяемых множеств с помощью [`assertEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual).963964Завершается ошибкой, если *first* или *second* не имеет метода `set.difference()`.965966Новое в версии 3.1.967968#### `assertDictEqual(first, second, msg=None)`969970Проверяет, что два словаря равны. Если нет, формируется сообщение об ошибке, показывающее различия в словарях. Этот метод будет использоваться по умолчанию для сравнения словарей в вызовах [`assertEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual).971972Новое в версии 3.1.973974Наконец, [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) предоставляет следующие методы и атрибуты:975976#### `fail(msg=None)`977978Безусловно сигнализирует о сбое теста, используя *msg* или `None` в качестве сообщения об ошибке.979980#### `failureException`981982Этот атрибут класса задаёт исключение, которое вызывается тестовым методом. Если тестовому фреймворку требуется использовать специализированное исключение, возможно, для передачи дополнительной информации, он должен создать подкласс этого исключения, чтобы «честно играть» с фреймворком. Начальное значение этого атрибута – [`AssertionError`](https://python-all.ru/3.10/library/exceptions.html#AssertionError).983984#### `longMessage`985986Этот атрибут класса определяет, что происходит, когда пользовательское сообщение об ошибке передаётся в качестве аргумента msg в вызов assertXYY, который завершается сбоем. Значение по умолчанию – `True`. В этом случае пользовательское сообщение добавляется в конец стандартного сообщения об ошибке. Если установлено `False`, пользовательское сообщение заменяет стандартное.987988Настройку класса можно переопределить в отдельных тестовых методах, присвоив атрибуту экземпляра self.longMessage значение `True` или `False` перед вызовом assert-методов.989990Настройка класса сбрасывается перед каждым вызовом теста.991992Новое в версии 3.1.993994#### `maxDiff`995996Этот атрибут управляет максимальной длиной вывода различий, выводимых методами утверждения, которые сообщают о различиях при неудаче. По умолчанию – 80\*8 символов. Методы утверждения, на которые влияет этот атрибут: [`assertSequenceEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertSequenceEqual) (включая все методы сравнения последовательностей, которые делегируют ему), [`assertDictEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertDictEqual) и [`assertMultiLineEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertMultiLineEqual).997998Установка `maxDiff` в `None` означает, что максимальная длина различий не ограничена.9991000Новое в версии 3.2.10011002Тестовые фреймворки могут использовать следующие методы для сбора информации о тесте:10031004#### `countTestCases()`10051006Возвращает количество тестов, представленных этим тестовым объектом. Для экземпляров [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) это всегда будет `1`.10071008#### `defaultTestResult()`10091010Возвращает экземпляр класса результата теста, который следует использовать для данного класса тестового случая (если ни один другой экземпляр результата не был передан методу [`run()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.run)).10111012Для экземпляров [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) это всегда будет экземпляр [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult); подклассы [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) должны при необходимости переопределять это.10131014#### `id()`10151016Возвращает строку, идентифицирующую конкретный тестовый случай. Обычно это полное имя тестового метода, включая имя модуля и класса.10171018#### `shortDescription()`10191020Возвращает описание теста или `None`, если описание не было предоставлено. Реализация по умолчанию этого метода возвращает первую строку докстринга тестового метода, если он доступен, или `None`.10211022Изменено в версии 3.1: В 3.1 это было изменено, чтобы добавлять имя теста в краткое описание даже при наличии докстринга. Это вызвало проблемы совместимости с расширениями unittest, и добавление имени теста было перенесено в [`TextTestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TextTestResult) в Python 3.2.10231024#### `addCleanup(function, /, *args, **kwargs)`10251026Добавляет функцию, которая будет вызвана после [`tearDown()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDown) для очистки ресурсов, использованных во время теста. Функции вызываются в порядке, обратном порядку их добавления (LIFO). Они вызываются с теми позиционными и именованными аргументами, которые были переданы в [`addCleanup()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.addCleanup) при их добавлении.10271028Если [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp) завершается неудачей, то есть [`tearDown()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDown) не вызывается, любые добавленные функции очистки всё равно будут вызваны.10291030Новое в версии 3.1.10311032#### `doCleanups()`10331034Этот метод вызывается безусловно после [`tearDown()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDown) или после [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp), если [`setUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUp) вызывает исключение.10351036Он отвечает за вызов всех функций очистки, добавленных с помощью [`addCleanup()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.addCleanup). Если необходимо, чтобы функции очистки вызывались *до* [`tearDown()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDown), то можно вызвать [`doCleanups()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.doCleanups) самостоятельно.10371038[`doCleanups()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.doCleanups) извлекает методы из стека функций очистки по одному, поэтому его можно вызывать в любой момент.10391040Новое в версии 3.1.10411042#### `classmethod addClassCleanup(function, /, *args, **kwargs)`10431044Добавляет функцию, которая будет вызвана после [`tearDownClass()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDownClass) для очистки ресурсов, использованных во время тестового класса. Функции вызываются в обратном порядке по сравнению с порядком их добавления (LIFO). Они вызываются с теми аргументами и именованными аргументами, которые были переданы в [`addClassCleanup()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.addClassCleanup) при их добавлении.10451046Если [`setUpClass()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUpClass) завершается ошибкой, то есть [`tearDownClass()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDownClass) не вызывается, то все добавленные функции очистки всё равно будут вызваны.10471048Новое в версии 3.8.10491050#### `classmethod doClassCleanups()`10511052Этот метод вызывается безусловно после [`tearDownClass()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDownClass) или после [`setUpClass()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUpClass), если [`setUpClass()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.setUpClass) вызывает исключение.10531054Он отвечает за вызов всех функций очистки, добавленных с помощью [`addClassCleanup()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.addClassCleanup). Если нужно, чтобы функции очистки вызывались *до* [`tearDownClass()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.tearDownClass), то можно вызвать [`doClassCleanups()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.doClassCleanups) самостоятельно.10551056[`doClassCleanups()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.doClassCleanups) извлекает методы из стека функций очистки по одному, поэтому его можно вызывать в любой момент.10571058Новое в версии 3.8.10591060#### `class unittest.IsolatedAsyncioTestCase(methodName='runTest')`10611062Этот класс предоставляет API, похожий на [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase), и также принимает корутины в качестве тестовых функций.10631064Новое в версии 3.8.10651066#### `coroutine asyncSetUp()`10671068Метод вызывается для подготовки тестового окружения. Он вызывается после `setUp()`, непосредственно перед вызовом тестового метода; любое исключение, возбуждённое этим методом, за исключением [`AssertionError`](https://python-all.ru/3.10/library/exceptions.html#AssertionError) или [`SkipTest`](https://python-all.ru/3.10/library/unittest.html#unittest.SkipTest), считается ошибкой, а не неудачей теста. Реализация по умолчанию ничего не делает.10691070#### `coroutine asyncTearDown()`10711072Метод, вызываемый сразу после вызова тестового метода и записи результата. Вызывается перед `tearDown()`. Вызывается даже если тестовый метод возбудил исключение, поэтому реализация в подклассах должна быть особенно осторожна при проверке внутреннего состояния. Любое исключение, возбуждённое этим методом, за исключением [`AssertionError`](https://python-all.ru/3.10/library/exceptions.html#AssertionError) или [`SkipTest`](https://python-all.ru/3.10/library/unittest.html#unittest.SkipTest), считается дополнительной ошибкой, а не неудачей теста (таким образом, увеличивая общее количество сообщённых ошибок). Этот метод вызывается только в случае успеха [`asyncSetUp()`](https://python-all.ru/3.10/library/unittest.html#unittest.IsolatedAsyncioTestCase.asyncSetUp), независимо от результата тестового метода. Реализация по умолчанию ничего не делает.10731074#### `addAsyncCleanup(function, /, *args, **kwargs)`10751076Этот метод принимает корутину, которая может использоваться как функция очистки.10771078#### `run(result=None)`10791080Настраивает новый цикл событий для выполнения теста, собирая результат в объект [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult), переданный как *result*. Если *result* опущен или равен `None`, создаётся временный объект результата (вызовом метода `defaultTestResult()`) и используется. Объект результата возвращается вызывающему [`run()`](https://python-all.ru/3.10/library/unittest.html#unittest.IsolatedAsyncioTestCase.run). В конце теста все задачи в цикле событий отменяются.10811082Пример, иллюстрирующий порядок:10831084```python1085from unittest import IsolatedAsyncioTestCase10861087events = []10881089class Test(IsolatedAsyncioTestCase):10901091    def setUp(self):1092        events.append("setUp")10931094    async def asyncSetUp(self):1095        self._async_connection = await AsyncConnection()1096        events.append("asyncSetUp")10971098    async def test_response(self):1099        events.append("test_response")1100        response = await self._async_connection.get("https://example.com")1101        self.assertEqual(response.status_code, 200)1102        self.addAsyncCleanup(self.on_cleanup)11031104    def tearDown(self):1105        events.append("tearDown")11061107    async def asyncTearDown(self):1108        await self._async_connection.close()1109        events.append("asyncTearDown")11101111    async def on_cleanup(self):1112        events.append("cleanup")11131114if __name__ == "__main__":1115    unittest.main()1116```11171118После запуска теста `events` будет содержать `["setUp", "asyncSetUp", "test_response", "asyncTearDown", "tearDown", "cleanup"]`.11191120#### `class unittest.FunctionTestCase(testFunc, setUp=None, tearDown=None, description=None)`11211122Этот класс реализует ту часть интерфейса [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase), которая позволяет исполнителю тестов управлять тестом, но не предоставляет методов, которые тестовый код может использовать для проверки и сообщения об ошибках. Это используется для создания тестовых примеров с использованием устаревшего тестового кода, что позволяет интегрировать его в тестовую среду на основе [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest).11231124#### Устаревшие псевдонимы11251126По историческим причинам некоторые методы [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) имели один или несколько псевдонимов, которые сейчас устарели. В следующей таблице приведены корректные названия вместе с их устаревшими псевдонимами:11271128> | Имя метода | Устаревший псевдоним | Устаревший псевдоним |1129> | --- | --- | --- |1130> | [`assertEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertEqual) | failUnlessEqual | assertEquals |1131> | [`assertNotEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotEqual) | failIfEqual | assertNotEquals |1132> | [`assertTrue()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertTrue) | failUnless | assert\_ |1133> | [`assertFalse()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertFalse) | failIf |  |1134> | [`assertRaises()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaises) | failUnlessRaises |  |1135> | [`assertAlmostEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertAlmostEqual) | failUnlessAlmostEqual | assertAlmostEquals |1136> | [`assertNotAlmostEqual()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotAlmostEqual) | failIfAlmostEqual | assertNotAlmostEquals |1137> | [`assertRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRegex) |  | assertRegexpMatches |1138> | [`assertNotRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotRegex) |  | assertNotRegexpMatches |1139> | [`assertRaisesRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaisesRegex) |  | assertRaisesRegexp |1140>1141> Устарело с версии 3.1: Псевдонимы fail\*, перечисленные во втором столбце, устарели.1142>1143> Устарело с версии 3.2: Псевдонимы assert\*, перечисленные в третьем столбце, устарели.1144>1145> Устарело с версии 3.2: `assertRegexpMatches` и `assertRaisesRegexp` переименованы в [`assertRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRegex) и [`assertRaisesRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertRaisesRegex).1146>1147> Устарело с версии 3.5: Имя `assertNotRegexpMatches` устарело; вместо него следует использовать [`assertNotRegex()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.assertNotRegex).11481149### Группировка тестов11501151#### `class unittest.TestSuite(tests=())`11521153Этот класс представляет собой агрегацию отдельных тестовых примеров и тестовых наборов. Класс предоставляет интерфейс, необходимый исполнителю тестов, чтобы его можно было запускать как любой другой тестовый пример. Запуск экземпляра [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) равносилен итерации по набору с запуском каждого теста по отдельности.11541155Если задан *tests*, он должен быть итерабельным объектом, содержащим отдельные тестовые примеры или другие тестовые наборы, которые будут использоваться для первоначального построения набора. Дополнительные методы предоставляются для добавления тестовых примеров и наборов в коллекцию позже.11561157Объекты [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) ведут себя во многом как объекты [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase), за исключением того, что они не реализуют фактический тест. Вместо этого они используются для объединения тестов в группы, которые должны запускаться вместе. Некоторые дополнительные методы доступны для добавления тестов в экземпляры [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite):11581159#### `addTest(test)`11601161Добавляет [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) или [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) в набор.11621163#### `addTests(tests)`11641165Добавляет все тесты из итерабельного объекта, содержащего экземпляры [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) и [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite), в этот тестовый набор.11661167Это эквивалентно итерации по *tests* с вызовом [`addTest()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite.addTest) для каждого элемента.11681169[`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) разделяет следующие методы с [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase):11701171#### `run(result)`11721173Запускает тесты, связанные с этим набором, собирая результат в объект результата теста, переданный как *result*. Обратите внимание, что, в отличие от [`TestCase.run()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase.run), [`TestSuite.run()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite.run) требует, чтобы объект результата был передан.11741175#### `debug()`11761177Запускает тесты, связанные с этим набором, без сбора результата. Это позволяет исключениям, возбуждённым тестом, распространяться до вызывающего кода и может использоваться для поддержки запуска тестов под отладчиком.11781179#### `countTestCases()`11801181Возвращает количество тестов, представленных этим тестовым объектом, включая все отдельные тесты и поднаборы.11821183#### `__iter__()`11841185Тесты, сгруппированные с помощью [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite), всегда доступны через итерацию. Подклассы могут лениво предоставлять тесты, переопределяя [`__iter__()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite.__iter__). Обратите внимание, что этот метод может вызываться несколько раз для одного набора (например, при подсчёте тестов или сравнении на равенство), поэтому тесты, возвращаемые повторными итерациями до [`TestSuite.run()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite.run), должны быть одинаковыми для каждого вызова итерации. После [`TestSuite.run()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite.run) вызывающий код не должен полагаться на тесты, возвращаемые этим методом, если только вызывающий код не использует подкласс, который переопределяет `TestSuite._removeTestAtIndex()` для сохранения ссылок на тесты.11861187Изменено в версии 3.2: В более ранних версиях [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) обращался к тестам напрямую, а не через итерацию, поэтому переопределения [`__iter__()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite.__iter__) было недостаточно для предоставления тестов.11881189Изменено в версии 3.4: В более ранних версиях [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) хранил ссылки на каждый [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) после [`TestSuite.run()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite.run). Подклассы могут восстановить такое поведение, переопределив `TestSuite._removeTestAtIndex()`.11901191При типичном использовании объекта [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) метод [`run()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite.run) вызывается с помощью `TestRunner`, а не через тестовую оболочку конечного пользователя.11921193### Загрузка и запуск тестов11941195#### `class unittest.TestLoader`11961197Класс [`TestLoader`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader) используется для создания тестовых наборов из классов и модулей. Обычно нет необходимости создавать экземпляр этого класса; модуль [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest) предоставляет экземпляр, который можно использовать совместно как [`unittest.defaultTestLoader`](https://python-all.ru/3.10/library/unittest.html#unittest.defaultTestLoader). Однако использование подкласса или экземпляра позволяет настраивать некоторые конфигурируемые свойства.11981199Объекты [`TestLoader`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader) имеют следующие атрибуты:12001201#### `errors`12021203Список нефатальных ошибок, возникших при загрузке тестов. Не сбрасывается загрузчиком ни в какой момент. Фатальные ошибки сигнализируются соответствующим методом, который генерирует исключение для вызывающего кода. Нефатальные ошибки также указываются синтетическим тестом, который при выполнении вызовет исходную ошибку.12041205Новое в версии 3.5.12061207Объекты [`TestLoader`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader) имеют следующие методы:12081209#### `loadTestsFromTestCase(testCaseClass)`12101211Возвращает набор всех тестов, содержащихся в `testCaseClass`, производном от [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase).12121213Экземпляр тестового случая создаётся для каждого метода, именованного [`getTestCaseNames()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader.getTestCaseNames). По умолчанию это имена методов, начинающиеся с `test`. Если [`getTestCaseNames()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader.getTestCaseNames) не возвращает ни одного метода, но метод `runTest()` реализован, то вместо этого создаётся один тестовый случай для этого метода.12141215#### `loadTestsFromModule(module, pattern=None)`12161217Возвращает набор всех тестовых случаев, содержащихся в данном модуле. Этот метод ищет в *module* классы, производные от [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase), и создаёт экземпляр класса для каждого тестового метода, определённого для этого класса.12181219> **Примечание**1220>1221> Хотя использование иерархии классов, производных от [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase), может быть удобным для совместного использования фикстур и вспомогательных функций, определение тестовых методов в базовых классах, которые не предназначены для прямого создания экземпляров, плохо сочетается с этим методом. Однако это может быть полезно, когда фикстуры различаются и определены в подклассах.12221223Если модуль предоставляет функцию `load_tests`, она будет вызвана для загрузки тестов. Это позволяет модулям настраивать загрузку тестов. Это называется [протокол load\_tests](https://python-all.ru/3.10/library/unittest.html#load-tests-protocol). Аргумент *pattern* передаётся как третий аргумент в `load_tests`.12241225Изменено в версии 3.2: Добавлена поддержка `load_tests`.12261227Изменено в версии 3.5: Незадокументированный и неофициальный аргумент по умолчанию *use\_load\_tests* устарел и игнорируется, хотя всё ещё принимается для обратной совместимости. Метод также теперь принимает аргумент *pattern*, который передаётся в `load_tests` в качестве третьего аргумента.12281229#### `loadTestsFromName(name, module=None)`12301231Возвращает набор всех тестовых случаев по заданному строковому спецификатору.12321233Спецификатор *name* – это «точечное имя», которое может указывать на модуль, класс тестового случая, тестовый метод внутри класса тестового случая, экземпляр [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) или вызываемый объект, возвращающий экземпляр [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) или [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite). Эти проверки применяются в указанном порядке; то есть метод в возможном классе тестового случая будет распознан как «тестовый метод внутри класса тестового случая», а не как «вызываемый объект».12341235Например, если у вас есть модуль `SampleTests`, содержащий класс `SampleTestCase`, производный от [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase), с тремя тестовыми методами (`test_one()`, `test_two()` и `test_three()`), спецификатор `'SampleTests.SampleTestCase'` заставит этот метод вернуть набор, который выполнит все три тестовых метода. Использование спецификатора `'SampleTests.SampleTestCase.test_two'` приведёт к возврату тестового набора, который выполнит только тестовый метод `test_two()`. Спецификатор может ссылаться на модули и пакеты, которые не были импортированы; они будут импортированы как побочный эффект.12361237Метод опционально разрешает *name* относительно заданного *module*.12381239Изменено в версии 3.5: Если при обходе *name* возникает [`ImportError`](https://python-all.ru/3.10/library/exceptions.html#ImportError) или [`AttributeError`](https://python-all.ru/3.10/library/exceptions.html#AttributeError), то будет возвращён синтетический тест, который при выполнении вызывает эту ошибку. Эти ошибки включаются в ошибки, накопленные self.errors.12401241#### `loadTestsFromNames(names, module=None)`12421243Аналогичен [`loadTestsFromName()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader.loadTestsFromName), но принимает последовательность имён, а не одно имя. Возвращаемое значение – тестовый набор, который включает все тесты, определённые для каждого имени.12441245#### `getTestCaseNames(testCaseClass)`12461247Возвращает отсортированную последовательность имён методов, найденных в *testCaseClass*; это должен быть подкласс [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase).12481249#### `discover(start_dir, pattern='test*.py', top_level_dir=None)`12501251Находит все тестовые модули, рекурсивно обходя подкаталоги, начиная с указанного каталога, и возвращает объект TestSuite, содержащий их. Будут загружены только тестовые файлы, соответствующие *pattern*. (Используется сопоставление с образцом в стиле shell.) Будут загружены только имена модулей, которые можно импортировать (т.е. являются допустимыми идентификаторами Python).12521253Все тестовые модули должны быть импортируемыми из корневого каталога проекта. Если стартовый каталог не является корневым, то корневой каталог необходимо указать отдельно.12541255Если импорт модуля завершается неудачей, например из-за синтаксической ошибки, это записывается как одна ошибка, и поиск продолжается. Если неудача импорта связана с возникновением [`SkipTest`](https://python-all.ru/3.10/library/unittest.html#unittest.SkipTest), это будет записано как пропуск, а не как ошибка.12561257Если найден пакет (каталог, содержащий файл с именем `__init__.py`), в пакете проверяется наличие функции `load_tests`. Если она существует, она вызывается с помощью `package.load_tests(loader, tests, pattern)`. Поиск тестов гарантирует, что пакет проверяется на наличие тестов только один раз за вызов, даже если сама функция load\_tests вызывает `loader.discover`.12581259Если `load_tests` существует, то поиск *не* рекурсирует в пакет, `load_tests` отвечает за загрузку всех тестов в пакете.12601261Шаблон намеренно не хранится как атрибут загрузчика, чтобы пакеты могли продолжать самостоятельное обнаружение. *top\_level\_dir* сохраняется, поэтому `load_tests` не нужно передавать этот аргумент в `loader.discover()`.12621263*start\_dir* может быть как точечным именем модуля, так и каталогом.12641265Новое в версии 3.2.12661267Изменено в версии 3.4: Модули, вызывающие [`SkipTest`](https://python-all.ru/3.10/library/unittest.html#unittest.SkipTest) при импорте, записываются как пропуски, а не ошибки.12681269Изменено в версии 3.4: *start\_dir* может быть [пакетом пространства имён](https://python-all.ru/3.10/glossary.html#term-namespace-package).12701271Изменено в версии 3.4: Пути сортируются перед импортом, так что порядок выполнения остаётся одинаковым, даже если порядок, задаваемый файловой системой, не зависит от имени файла.12721273Изменено в версии 3.5: Найденные пакеты теперь проверяются на наличие `load_tests` независимо от того, соответствует ли их путь *pattern*, поскольку имя пакета не может соответствовать шаблону по умолчанию.12741275Следующие атрибуты [`TestLoader`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader) можно настроить либо через наследование, либо через присваивание экземпляру:12761277#### `testMethodPrefix`12781279Строка, задающая префикс имён методов, которые будут интерпретироваться как тестовые методы. Значение по умолчанию – `'test'`.12801281Это влияет на [`getTestCaseNames()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader.getTestCaseNames) и все методы `loadTestsFrom*()`.12821283#### `sortTestMethodsUsing`12841285Функция, используемая для сравнения имён методов при их сортировке в [`getTestCaseNames()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader.getTestCaseNames) и во всех методах `loadTestsFrom*()`.12861287#### `suiteClass`12881289Вызываемый объект, который создаёт тестовый набор из списка тестов. Никакие методы результирующего объекта не требуются. Значение по умолчанию – класс [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite).12901291Это влияет на все методы `loadTestsFrom*()`.12921293#### `testNamePatterns`12941295Список шаблонов имён тестов в стиле оболочки Unix (символы подстановки), которым должны соответствовать тестовые методы для включения в наборы тестов (см. опцию `-k`).12961297Если этот атрибут не равен `None` (по умолчанию), все тестовые методы, которые должны быть включены в тестовые наборы, должны соответствовать одному из шаблонов в этом списке. Обратите внимание, что сопоставление всегда выполняется с помощью [`fnmatch.fnmatchcase()`](https://python-all.ru/3.10/library/fnmatch.html#fnmatch.fnmatchcase), поэтому, в отличие от шаблонов, переданных опции `-k`, простые шаблоны подстрок придётся преобразовать с использованием подстановочных знаков `*`.12981299Это влияет на все методы `loadTestsFrom*()`.13001301Добавлено в версии 3.7.13021303#### `class unittest.TestResult`13041305Этот класс используется для сбора информации о том, какие тесты прошли успешно, а какие завершились неудачей.13061307Объект [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult) хранит результаты набора тестов. Классы [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) и [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) обеспечивают правильную запись результатов; авторам тестов не нужно беспокоиться о записи результатов тестов.13081309Тестовые фреймворки, построенные на базе [`unittest`](https://python-all.ru/3.10/library/unittest.html#module-unittest), могут нуждаться в доступе к объекту [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult), созданному при запуске набора тестов для целей отчетности; для этого метод `TestRunner.run()` возвращает экземпляр [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult).13101311Экземпляры [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult) имеют следующие атрибуты, которые будут интересны при проверке результатов запуска набора тестов:13121313#### `errors`13141315Список, содержащий 2-кортежи экземпляров [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) и строк с форматированными трассировками. Каждый кортеж представляет тест, вызвавший неожиданное исключение.13161317#### `failures`13181319Список, содержащий кортежи из двух элементов: экземпляры [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) и строки с форматированными трассировками стека. Каждый кортеж соответствует тесту, в котором сбой был явно зафиксирован с помощью методов `TestCase.assert*()`.13201321#### `skipped`13221323Список, содержащий 2-кортежи экземпляров [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) и строк с причиной пропуска теста.13241325Новое в версии 3.1.13261327#### `expectedFailures`13281329Список, содержащий 2-кортежи экземпляров [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) и строк с форматированными трассировками. Каждый кортеж представляет ожидаемый сбой или ошибку тестового случая.13301331#### `unexpectedSuccesses`13321333Список, содержащий экземпляры [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase), которые были помечены как ожидаемые сбои, но завершились успешно.13341335#### `shouldStop`13361337Устанавливается в `True`, когда выполнение тестов должно быть остановлено с помощью [`stop()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.stop).13381339#### `testsRun`13401341Общее количество запущенных на данный момент тестов.13421343#### `buffer`13441345Если установлено в true, `sys.stdout` и `sys.stderr` будут буферизироваться между вызовами [`startTest()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.startTest) и [`stopTest()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.stopTest). Собранный вывод будет передаваться на реальные `sys.stdout` и `sys.stderr` только в случае сбоя или ошибки теста. Любой вывод также прикрепляется к сообщению о сбое/ошибке.13461347Новое в версии 3.2.13481349#### `failfast`13501351Если установлено в true, [`stop()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.stop) будет вызван при первой ошибке или сбое, останавливая выполнение теста.13521353Новое в версии 3.2.13541355#### `tb_locals`13561357Если установлено в true, то локальные переменные будут отображаться в трассировках.13581359Новое в версии 3.5.13601361#### `wasSuccessful()`13621363Возвращает `True`, если все запущенные на данный момент тесты пройдены, в противном случае возвращает `False`.13641365Изменено в версии 3.4: Возвращает `False`, если были какие-либо [`unexpectedSuccesses`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.unexpectedSuccesses) от тестов, помеченных декоратором [`expectedFailure()`](https://python-all.ru/3.10/library/unittest.html#unittest.expectedFailure).13661367#### `stop()`13681369Этот метод может быть вызван, чтобы указать, что выполняемый набор тестов должен быть прерван установкой атрибута [`shouldStop`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.shouldStop) в `True`. Объекты `TestRunner` должны учитывать этот флаг и возвращаться без запуска дополнительных тестов.13701371Например, эта возможность используется классом [`TextTestRunner`](https://python-all.ru/3.10/library/unittest.html#unittest.TextTestRunner) для остановки тестового фреймворка, когда пользователь подает сигнал прерывания с клавиатуры. Интерактивные инструменты, предоставляющие реализации `TestRunner`, могут использовать это аналогичным образом.13721373Следующие методы класса [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult) используются для поддержки внутренних структур данных и могут быть расширены в подклассах для поддержки дополнительных требований к отчетности. Это особенно полезно при создании инструментов, поддерживающих интерактивную отчетность во время выполнения тестов.13741375#### `startTest(test)`13761377Вызывается перед запуском тестового сценария *test*.13781379#### `stopTest(test)`13801381Вызывается после выполнения тестового сценария *test*, независимо от результата.13821383#### `startTestRun()`13841385Вызывается один раз перед выполнением любых тестов.13861387Новое в версии 3.1.13881389#### `stopTestRun()`13901391Вызывается один раз после выполнения всех тестов.13921393Новое в версии 3.1.13941395#### `addError(test, err)`13961397Вызывается, когда тестовый сценарий *test* порождает неожиданное исключение. *err* – кортеж вида, возвращаемого [`sys.exc_info()`](https://python-all.ru/3.10/library/sys.html#sys.exc_info): `(type, value, traceback)`.13981399Реализация по умолчанию добавляет кортеж `(test, formatted_err)` к атрибуту [`errors`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.errors) экземпляра, где *formatted\_err* – форматированная трассировка, полученная из *err*.14001401#### `addFailure(test, err)`14021403Вызывается, когда тестовый сценарий *test* сигнализирует о сбое. *err* – кортеж вида, возвращаемого [`sys.exc_info()`](https://python-all.ru/3.10/library/sys.html#sys.exc_info): `(type, value, traceback)`.14041405Реализация по умолчанию добавляет кортеж `(test, formatted_err)` к атрибуту [`failures`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.failures) экземпляра, где *formatted\_err* – форматированная трассировка, полученная из *err*.14061407#### `addSuccess(test)`14081409Вызывается, когда тестовый сценарий *test* завершается успешно.14101411Реализация по умолчанию ничего не делает.14121413#### `addSkip(test, reason)`14141415Вызывается, когда тестовый сценарий *test* пропускается. *reason* – причина, которую тест указал для пропуска.14161417Реализация по умолчанию добавляет кортеж `(test, reason)` к атрибуту [`skipped`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.skipped) экземпляра.14181419#### `addExpectedFailure(test, err)`14201421Вызывается, когда тестовый сценарий *test* завершается неудачей или ошибкой, но был помечен декоратором [`expectedFailure()`](https://python-all.ru/3.10/library/unittest.html#unittest.expectedFailure).14221423Реализация по умолчанию добавляет кортеж `(test, formatted_err)` к атрибуту [`expectedFailures`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.expectedFailures) экземпляра, где *formatted\_err* – форматированная трассировка, полученная из *err*.14241425#### `addUnexpectedSuccess(test)`14261427Вызывается, когда тестовый сценарий *test* был помечен декоратором [`expectedFailure()`](https://python-all.ru/3.10/library/unittest.html#unittest.expectedFailure), но завершился успешно.14281429Реализация по умолчанию добавляет тест к атрибуту [`unexpectedSuccesses`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.unexpectedSuccesses) экземпляра.14301431#### `addSubTest(test, subtest, outcome)`14321433Вызывается, когда завершается подтест. *test* – тестовый сценарий, соответствующий тестовому методу. *subtest* – пользовательский экземпляр [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase), описывающий подтест.14341435Если *outcome* равен [`None`](https://python-all.ru/3.10/library/constants.html#None), подтест завершился успешно. В противном случае он завершился исключением, где *outcome* – кортеж вида, возвращаемого [`sys.exc_info()`](https://python-all.ru/3.10/library/sys.html#sys.exc_info): `(type, value, traceback)`.14361437Реализация по умолчанию ничего не делает, если результат – успех, и записывает сбои подтестов как обычные сбои.14381439Новое в версии 3.4.14401441#### `class unittest.TextTestResult(stream, descriptions, verbosity)`14421443Конкретная реализация [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult), используемая [`TextTestRunner`](https://python-all.ru/3.10/library/unittest.html#unittest.TextTestRunner).14441445Новое в версии 3.2: Раньше этот класс назывался `_TextTestResult`. Старое имя всё ещё существует как псевдоним, но оно устарело.14461447#### `unittest.defaultTestLoader`14481449Экземпляр класса [`TestLoader`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader), предназначенный для совместного использования. Если настройка [`TestLoader`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader) не требуется, можно использовать этот экземпляр вместо повторного создания новых.14501451#### `class unittest.TextTestRunner(stream=None, descriptions=True, verbosity=1, failfast=False, buffer=False, resultclass=None, warnings=None, *, tb_locals=False)`14521453Базовая реализация запуска тестов, которая выводит результаты в поток данных. Если *stream* равен `None` (значение по умолчанию), в качестве выходного потока данных используется [`sys.stderr`](https://python-all.ru/3.10/library/sys.html#sys.stderr). Этот класс имеет несколько настраиваемых параметров, но в целом очень прост. Графические приложения, запускающие наборы тестов, должны предоставлять альтернативные реализации. Такие реализации должны принимать `**kwargs`, поскольку интерфейс для создания запускаторов меняется при добавлении новых возможностей в unittest.14541455По умолчанию этот исполнитель показывает [`DeprecationWarning`](https://python-all.ru/3.10/library/exceptions.html#DeprecationWarning), [`PendingDeprecationWarning`](https://python-all.ru/3.10/library/exceptions.html#PendingDeprecationWarning), [`ResourceWarning`](https://python-all.ru/3.10/library/exceptions.html#ResourceWarning) и [`ImportWarning`](https://python-all.ru/3.10/library/exceptions.html#ImportWarning), даже если они [игнорируются по умолчанию](https://python-all.ru/3.10/library/warnings.html#warning-ignored). Предупреждения об устаревании, вызванные [устаревшими методами unittest](https://python-all.ru/3.10/library/unittest.html#deprecated-aliases), обрабатываются особым образом: когда фильтры предупреждений установлены в `'default'` или `'always'`, они появляются только один раз на модуль, чтобы избежать слишком большого количества сообщений. Это поведение можно переопределить с помощью опций Python `-Wd` или `-Wa` (см. [Управление предупреждениями](https://python-all.ru/3.10/using/cmdline.html#using-on-warnings)) и оставить *warnings* равным `None`.14561457Изменено в версии 3.2: Добавлен аргумент `warnings`.14581459Изменено в версии 3.2: Поток по умолчанию устанавливается на [`sys.stderr`](https://python-all.ru/3.10/library/sys.html#sys.stderr) в момент создания экземпляра, а не при импорте.14601461Изменено в версии 3.5: Добавлен параметр tb\_locals.14621463#### `_makeResult()`14641465Этот метод возвращает экземпляр `TestResult`, используемый [`run()`](https://python-all.ru/3.10/library/unittest.html#unittest.TextTestRunner.run). Он не предназначен для прямого вызова, но может быть переопределён в подклассах для предоставления собственного `TestResult`.14661467`_makeResult()` создаёт экземпляр класса или вызываемого объекта, переданного в конструктор `TextTestRunner` как аргумент `resultclass`. По умолчанию используется [`TextTestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TextTestResult), если `resultclass` не предоставлен. Класс результата создаётся со следующими аргументами:14681469```python1470stream, descriptions, verbosity1471```14721473#### `run(test)`14741475Этот метод является основным публичным интерфейсом `TextTestRunner`. Он принимает экземпляр [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite) или [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase). [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult) создаётся вызовом [`_makeResult()`](https://python-all.ru/3.10/library/unittest.html#unittest.TextTestRunner._makeResult), после чего тест(ы) выполняются, а результаты выводятся в stdout.14761477#### `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)`14781479Программа командной строки, которая загружает набор тестов из *module* и запускает их; это в первую очередь для удобного выполнения тестовых модулей. Простейший способ использования этой функции – добавить следующую строку в конец тестового скрипта:14801481```python1482if __name__ == '__main__':1483    unittest.main()1484```14851486Можно запускать тесты с более подробной информацией, передав аргумент verbosity:14871488```python1489if __name__ == '__main__':1490    unittest.main(verbosity=2)1491```14921493Аргумент *defaultTest* может быть либо именем одного теста, либо итерируемым объектом с именами тестов для запуска, если имена тестов не указаны через *argv*. Если он не задан или равен `None`, а имена тестов не переданы через *argv*, выполняются все тесты, найденные в *module*.14941495Аргумент *argv* может быть списком параметров, переданных программе, где первый элемент – имя программы. Если он не задан или равен `None`, используются значения [`sys.argv`](https://python-all.ru/3.10/library/sys.html#sys.argv).14961497Аргумент *testRunner* может быть либо классом исполнителя тестов, либо уже созданным экземпляром этого класса. По умолчанию `main` вызывает [`sys.exit()`](https://python-all.ru/3.10/library/sys.html#sys.exit) с кодом возврата, указывающим на успех или неудачу выполнения тестов.14981499Аргумент *testLoader* должен быть экземпляром [`TestLoader`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader) и по умолчанию равен [`defaultTestLoader`](https://python-all.ru/3.10/library/unittest.html#unittest.defaultTestLoader).15001501`main` поддерживает использование из интерактивного интерпретатора при передаче аргумента `exit=False`. При этом результат выводится в стандартный вывод без вызова [`sys.exit()`](https://python-all.ru/3.10/library/sys.html#sys.exit):15021503```python1504>>> from unittest import main1505>>> main(module='test_module', exit=False)1506```15071508Параметры *failfast*, *catchbreak* и *buffer* имеют тот же эффект, что и одноимённые [параметры командной строки](https://python-all.ru/3.10/library/unittest.html#command-line-options).15091510Аргумент *warnings* задаёт [фильтр предупреждений](https://python-all.ru/3.10/library/warnings.html#warning-filter), который следует использовать при выполнении тестов. Если он не указан, он останется `None` при передаче опции `-W` в **python** (см. [Управление предупреждениями](https://python-all.ru/3.10/using/cmdline.html#using-on-warnings)), в противном случае будет установлен в `'default'`.15111512Вызов `main` на самом деле возвращает экземпляр класса `TestProgram`. Этот экземпляр сохраняет результат выполнения тестов в атрибуте `result`.15131514Изменено в версии 3.1: Добавлен параметр *exit*.15151516Изменено в версии 3.2: Добавлены параметры *verbosity*, *failfast*, *catchbreak*, *buffer* и *warnings*.15171518Изменено в версии 3.4: Параметр *defaultTest* был изменён: теперь он также принимает итерируемый объект с именами тестов.15191520#### Протокол load\_tests15211522Новое в версии 3.2.15231524Модули или пакеты могут настраивать загрузку тестов из себя во время обычного запуска тестов или их обнаружения, реализуя функцию с именем `load_tests`.15251526Если тестовый модуль определяет `load_tests`, то он будет вызван функцией [`TestLoader.loadTestsFromModule()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader.loadTestsFromModule) со следующими аргументами:15271528```python1529load_tests(loader, standard_tests, pattern)1530```15311532где *pattern* передаётся напрямую из `loadTestsFromModule`. По умолчанию он равен `None`.15331534Она должна возвращать объект [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite).15351536*loader* – это экземпляр [`TestLoader`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader), выполняющий загрузку. *standard\_tests* – это тесты, которые будут загружены по умолчанию из модуля. Часто тестовые модули хотят только добавить или удалить тесты из стандартного набора. Третий аргумент используется при загрузке пакетов в рамках обнаружения тестов.15371538Типичная функция `load_tests`, загружающая тесты из определённого набора классов [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase), может выглядеть так:15391540```python1541test_cases = (TestCase1, TestCase2, TestCase3)15421543def load_tests(loader, tests, pattern):1544    suite = TestSuite()1545    for test_class in test_cases:1546        tests = loader.loadTestsFromTestCase(test_class)1547        suite.addTests(tests)1548    return suite1549```15501551Если обнаружение запускается в каталоге, содержащем пакет, либо из командной строки, либо вызовом [`TestLoader.discover()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestLoader.discover), то у пакета `__init__.py` проверяется наличие `load_tests`. Если такой функции нет, обнаружение рекурсивно обходит пакет, как если бы это был просто ещё один каталог. В противном случае обнаружение тестов пакета передаётся функции `load_tests`, которая вызывается со следующими аргументами:15521553```python1554load_tests(loader, standard_tests, pattern)1555```15561557Она должна возвращать объект [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite), представляющий все тесты из пакета. (`standard_tests` будет содержать только тесты, собранные из `__init__.py`.)15581559Поскольку шаблон передаётся в `load_tests`, пакет может продолжить (и, возможно, изменить) обнаружение тестов. Функция `load_tests`, которая ничего не делает, для тестового пакета может выглядеть так:15601561```python1562def load_tests(loader, standard_tests, pattern):1563    # корневой каталог, кэшированный на экземпляре загрузчика1564    this_dir = os.path.dirname(__file__)1565    package_tests = loader.discover(start_dir=this_dir, pattern=pattern)1566    standard_tests.addTests(package_tests)1567    return standard_tests1568```15691570Изменено в версии 3.5: Обнаружение больше не проверяет имена пакетов на соответствие *pattern* из-за невозможности соответствия имён пакетов шаблону по умолчанию.15711572## Фикстуры классов и модулей15731574Фикстуры уровня класса и модуля реализуются в [`TestSuite`](https://python-all.ru/3.10/library/unittest.html#unittest.TestSuite). Когда набор тестов встречает тест из нового класса, вызывается `tearDownClass()` из предыдущего класса (если он есть), а затем `setUpClass()` из нового класса.15751576Аналогично, если тест из другого модуля, отличного от предыдущего, то запускается `tearDownModule` предыдущего модуля, а затем `setUpModule` нового модуля.15771578После выполнения всех тестов запускаются финальные `tearDownClass` и `tearDownModule`.15791580Обратите внимание, что общие фикстуры плохо совместимы с такими возможностями, как параллельное выполнение тестов, и нарушают изоляцию тестов. Их следует использовать с осторожностью.15811582Упорядочивание тестов по умолчанию, создаваемое загрузчиками тестов unittest, группирует все тесты из одних и тех же модулей и классов вместе. Это приводит к тому, что `setUpClass` / `setUpModule` (и т.д.) вызываются ровно один раз на класс и модуль. Если изменить порядок случайным образом, так что тесты из разных модулей и классов будут соседствовать друг с другом, то эти общие фикстуры могут вызываться несколько раз за один прогон тестов.15831584Общие фикстуры не предназначены для работы с наборами тестов, имеющими нестандартный порядок. `BaseTestSuite` всё ещё существует для фреймворков, которые не хотят поддерживать общие фикстуры.15851586Если во время выполнения одной из общих фикстур возникает исключение, тест помечается как ошибочный. Поскольку нет соответствующего экземпляра теста, создаётся объект `_ErrorHolder` (имеющий тот же интерфейс, что и [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase)) для представления ошибки. Если вы просто используете стандартный исполнитель тестов unittest, эта деталь не имеет значения, но если вы разработчик фреймворка, это может быть актуально.15871588### setUpClass и tearDownClass15891590Они должны быть реализованы как методы класса:15911592```python1593import unittest15941595class Test(unittest.TestCase):1596    @classmethod1597    def setUpClass(cls):1598        cls._connection = createExpensiveConnectionObject()15991600    @classmethod1601    def tearDownClass(cls):1602        cls._connection.destroy()1603```16041605Если нужно, чтобы `setUpClass` и `tearDownClass` базовых классов вызывались, необходимо вызвать их самостоятельно. Реализации в [`TestCase`](https://python-all.ru/3.10/library/unittest.html#unittest.TestCase) пусты.16061607Если во время выполнения `setUpClass` возникает исключение, тесты в классе не запускаются, и `tearDownClass` не выполняется. Пропущенные классы не будут выполнять `setUpClass` или `tearDownClass`. Если исключением является [`SkipTest`](https://python-all.ru/3.10/library/unittest.html#unittest.SkipTest), то класс будет помечен как пропущенный, а не как ошибочный.16081609### setUpModule и tearDownModule16101611Их следует реализовывать как функции:16121613```python1614def setUpModule():1615    createConnection()16161617def tearDownModule():1618    closeConnection()1619```16201621Если в `setUpModule` возникает исключение, то ни один тест в модуле не будет запущен, и `tearDownModule` не будет выполнен. Если исключением является [`SkipTest`](https://python-all.ru/3.10/library/unittest.html#unittest.SkipTest), то модуль будет помечен как пропущенный, а не как ошибочный.16221623Чтобы добавить код очистки, который должен выполняться даже в случае исключения, используйте `addModuleCleanup`:16241625#### `unittest.addModuleCleanup(function, /, *args, **kwargs)`16261627Добавляет функцию, которая будет вызвана после `tearDownModule()` для очистки ресурсов, использованных во время тестового класса. Функции вызываются в обратном порядке по сравнению с порядком их добавления (LIFO). Они вызываются с теми аргументами и именованными аргументами, которые были переданы в [`addModuleCleanup()`](https://python-all.ru/3.10/library/unittest.html#unittest.addModuleCleanup) при их добавлении.16281629Если `setUpModule()` завершается ошибкой, то есть `tearDownModule()` не вызывается, то все добавленные функции очистки всё равно будут вызваны.16301631Новое в версии 3.8.16321633#### `unittest.doModuleCleanups()`16341635Эта функция вызывается безусловно после `tearDownModule()` или после `setUpModule()`, если `setUpModule()` вызывает исключение.16361637Он отвечает за вызов всех функций очистки, добавленных с помощью [`addModuleCleanup()`](https://python-all.ru/3.10/library/unittest.html#unittest.addModuleCleanup). Если нужно, чтобы функции очистки вызывались *до* `tearDownModule()`, то можно вызвать [`doModuleCleanups()`](https://python-all.ru/3.10/library/unittest.html#unittest.doModuleCleanups) самостоятельно.16381639[`doModuleCleanups()`](https://python-all.ru/3.10/library/unittest.html#unittest.doModuleCleanups) извлекает методы из стека функций очистки по одному, поэтому его можно вызывать в любой момент.16401641Новое в версии 3.8.16421643## Обработка сигналов16441645Новое в версии 3.2.16461647Параметр командной строки [`-c/--catch`](https://python-all.ru/3.10/library/unittest.html#cmdoption-unittest-c) для unittest вместе с параметром `catchbreak` для [`unittest.main()`](https://python-all.ru/3.10/library/unittest.html#unittest.main) обеспечивают более удобную обработку control-C во время выполнения тестов. Когда поведение catch-break включено, control-C позволяет завершить текущий тест, после чего выполнение тестов завершается и выводятся все результаты на данный момент. Повторное нажатие control-C вызовет исключение [`KeyboardInterrupt`](https://python-all.ru/3.10/library/exceptions.html#KeyboardInterrupt) обычным образом.16481649Обработчик сигнала control-c старается оставаться совместимым с кодом или тестами, которые устанавливают собственный обработчик [`signal.SIGINT`](https://python-all.ru/3.10/library/signal.html#signal.SIGINT). Если обработчик `unittest` вызывается, но *не является* установленным обработчиком [`signal.SIGINT`](https://python-all.ru/3.10/library/signal.html#signal.SIGINT), то есть был заменён тестируемой системой и делегирован, то он вызывает стандартный обработчик. Обычно это ожидаемое поведение для кода, который заменяет установленный обработчик и делегирует ему. Для отдельных тестов, где требуется `unittest` отключить обработку control-c, можно использовать декоратор [`removeHandler()`](https://python-all.ru/3.10/library/unittest.html#unittest.removeHandler).16501651Существует несколько вспомогательных функций для разработчиков фреймворков, позволяющих включить обработку control-c в тестовых фреймворках.16521653#### `unittest.installHandler()`16541655Устанавливает обработчик control-c. Когда получен сигнал [`signal.SIGINT`](https://python-all.ru/3.10/library/signal.html#signal.SIGINT) (обычно в ответ на нажатие пользователем control-c), у всех зарегистрированных результатов вызывается [`stop()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.stop).16561657#### `unittest.registerResult(result)`16581659Регистрирует объект [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult) для обработки control-c. При регистрации результата сохраняется слабая ссылка на него, поэтому это не препятствует сборке мусора объекта результата.16601661Регистрация объекта [`TestResult`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult) не имеет побочных эффектов, если обработка control-c не включена, поэтому тестовые фреймворки могут безусловно регистрировать все создаваемые ими результаты, независимо от того, включена обработка или нет.16621663#### `unittest.removeResult(result)`16641665Удаляет зарегистрированный результат. После удаления результата [`stop()`](https://python-all.ru/3.10/library/unittest.html#unittest.TestResult.stop) больше не будет вызываться для этого объекта результата в ответ на control-c.16661667#### `unittest.removeHandler(function=None)`16681669При вызове без аргументов эта функция удаляет обработчик control-c, если он был установлен. Эту функцию также можно использовать как тестовый декоратор для временного удаления обработчика на время выполнения теста:16701671```python1672@unittest.removeHandler1673def test_signal_handling(self):1674    ...1675```1676