unittest.md

1> **Источник:** https://python-all.ru/3.3/library/unittest.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 26.3. [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest) – Фреймворк для модульного тестирования89(Если вы уже знакомы с основными понятиями тестирования, можете перейти к [*списку методов assert*](https://python-all.ru/3.3/library/unittest.html#assert-methods).)1011Фреймворк для модульного тестирования [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest) изначально был вдохновлён JUnit и по духу близок к основным фреймворкам модульного тестирования на других языках. Он поддерживает автоматизацию тестов, совместное использование кода настройки и завершения для тестов, объединение тестов в коллекции, а также независимость тестов от фреймворка для составления отчётов.1213Для этого [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest) поддерживает несколько важных концепций в объектно-ориентированном стиле:1415**тестовая фикстура**1617*Тестовая фикстура*1819представляет собой подготовку, необходимую для выполнения одного или нескольких тестов, и любые сопутствующие действия по очистке. Это может включать, например, создание временных или прокси-баз данных, каталогов или запуск серверного процесса.2021**тестовый случай**2223*Тестовый пример*2425– это отдельная единица тестирования. Он проверяет конкретную реакцию на определённый набор входных данных.2627[`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest)2829предоставляет базовый класс3031[`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase)3233, который можно использовать для создания новых тестовых примеров.3435**набор тестов**3637*Набор тестов*3839– это совокупность тестовых случаев, наборов тестов или и того, и другого. Он используется для объединения тестов, которые должны выполняться вместе.4041**исполнитель тестов**4243*Исполнитель тестов*4445– это компонент, который управляет выполнением тестов и предоставляет результат пользователю. Исполнитель может использовать графический интерфейс, текстовый интерфейс или возвращать специальное значение, указывающее на результаты выполнения тестов.4647> **См. также**48>49> **Модуль [`doctest`](https://python-all.ru/3.3/library/doctest.html#module-doctest)**50>51> Ещё один модуль поддержки тестирования с совершенно другим подходом.52>53> **[Простое тестирование в Smalltalk: с шаблонами](https://python-all.ru/3.3/library/unittest.html)**54>55> Оригинальная статья Кента Бека о фреймворках тестирования, использующих шаблон, общий для56>57> [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest)58>59> .60>61> **[Nose](https://python-all.ru/3.3/library/unittest.html) и [py.test](https://python-all.ru/3.3/library/unittest.html)**62>63> Сторонние фреймворки unittest с более лёгким синтаксисом для написания тестов. Например,64>65> `assert func(10) == 42`66>67> .68>69> **[Таксономия инструментов тестирования Python](https://python-all.ru/3.3/library/unittest.html)**70>71> Обширный список инструментов тестирования Python, включая фреймворки функционального тестирования и библиотеки имитационных объектов (mock).72>73> **[Список рассылки по тестированию в Python](https://python-all.ru/3.3/library/unittest.html)**74>75> Группа по интересам для обсуждения тестирования и инструментов тестирования в Python.76>77> Скрипт `Tools/unittestgui/unittestgui.py` в дистрибутиве исходного кода Python – это инструмент с графическим интерфейсом для обнаружения и выполнения тестов. Он предназначен в первую очередь для упрощения работы тех, кто только знакомится с модульным тестированием. Для производственных сред рекомендуется запускать тесты с помощью системы непрерывной интеграции, такой как [Buildbot](https://python-all.ru/3.3/library/unittest.html), [Jenkins](https://python-all.ru/3.3/library/unittest.html) или [Hudson](https://python-all.ru/3.3/library/unittest.html).7879## 26.3.1. Простой пример8081Модуль [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest) предоставляет богатый набор инструментов для создания и запуска тестов. В этом разделе показано, что даже небольшого подмножества этих инструментов достаточно для удовлетворения потребностей большинства пользователей.8283Вот короткий скрипт для тестирования трёх функций из модуля [`random`](https://python-all.ru/3.3/library/random.html#module-random):8485```python86import random87import unittest8889class TestSequenceFunctions(unittest.TestCase):9091    def setUp(self):92        self.seq = list(range(10))9394    def test_shuffle(self):95        # проверить, что перемешанная последовательность не теряет ни одного элемента96        random.shuffle(self.seq)97        self.seq.sort()98        self.assertEqual(self.seq, list(range(10)))99100        # должно вызывать исключение для неизменяемой последовательности101        self.assertRaises(TypeError, random.shuffle, (1,2,3))102103    def test_choice(self):104        element = random.choice(self.seq)105        self.assertTrue(element in self.seq)106107    def test_sample(self):108        with self.assertRaises(ValueError):109            random.sample(self.seq, 20)110        for element in random.sample(self.seq, 5):111            self.assertTrue(element in self.seq)112113if __name__ == '__main__':114    unittest.main()115```116117Тестовый пример создаётся путём создания подкласса [`unittest.TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase). Три отдельных теста определяются методами, имена которых начинаются с букв `test`. Это соглашение об именах сообщает программе запуска тестов, какие методы представляют собой тесты.118119Суть каждого теста сводится к вызову [`assertEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual) для проверки ожидаемого результата; [`assertTrue()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertTrue) – для проверки условия; или [`assertRaises()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaises) – чтобы убедиться, что возникает ожидаемое исключение. Эти методы используются вместо оператора [`assert`](https://python-all.ru/3.3/reference/simple_stmts.html#assert), чтобы средство запуска тестов могло накапливать все результаты и формировать отчёт.120121Если определён метод [`setUp()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.setUp), средство запуска тестов выполнит его перед каждым тестом. Аналогично, если определён метод [`tearDown()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.tearDown), средство запуска тестов вызовет его после каждого теста. В примере [`setUp()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.setUp) использовался для создания новой последовательности для каждого теста.122123Последний блок демонстрирует простой способ запуска тестов. [`unittest.main()`](https://python-all.ru/3.3/library/unittest.html#unittest.main) предоставляет интерфейс командной строки для тестового скрипта. При запуске из командной строки указанный скрипт выдаёт вывод, который выглядит так:124125```python126...127----------------------------------------------------------------------128Ran 3 tests in 0.000s129130OK131```132133Передача параметра `-v` тестовому скрипту укажет [`unittest.main()`](https://python-all.ru/3.3/library/unittest.html#unittest.main) включить более высокий уровень подробности и выдать следующий вывод:134135```python136test_choice (__main__.TestSequenceFunctions) ... ok137test_sample (__main__.TestSequenceFunctions) ... ok138test_shuffle (__main__.TestSequenceFunctions) ... ok139140----------------------------------------------------------------------141Ran 3 tests in 0.110s142143OK144```145146Приведённые выше примеры показывают наиболее часто используемые возможности [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest), которых достаточно для удовлетворения многих повседневных потребностей тестирования. В остальной части документации подробно рассматривается полный набор возможностей, начиная с основ.147148## 26.3.2. Интерфейс командной строки149150Модуль unittest можно использовать из командной строки для запуска тестов из модулей, классов или даже отдельных тестовых методов:151152```python153python -m unittest test_module1 test_module2154python -m unittest test_module.TestClass155python -m unittest test_module.TestClass.test_method156```157158Можно передать список с любой комбинацией имён модулей, а также полных имён классов или методов.159160Тестовые модули также можно указывать по пути к файлу:161162```python163python -m unittest tests/test_something.py164```165166Это позволяет использовать автодополнение имён файлов в оболочке для указания тестового модуля. Указанный файл по-прежнему должен быть импортируем как модуль. Путь преобразуется в имя модуля путём удаления ‘.py’ и замены разделителей пути на ‘.’. Если требуется выполнить тестовый файл, который не импортируется как модуль, следует запускать файл напрямую.167168Можно запускать тесты с большей детализацией (повышенной подробностью), передав флаг -v:169170```python171python -m unittest -v test_module172```173174При запуске без аргументов запускается [*автоматическое обнаружение тестов*](https://python-all.ru/3.3/library/unittest.html#unittest-test-discovery):175176```python177python -m unittest178```179180Чтобы получить список всех параметров командной строки:181182```python183python -m unittest -h184```185186Изменено в версии 3.2: В более ранних версиях можно было запускать только отдельные тестовые методы, а не модули или классы.187188### 26.3.2.1. Параметры командной строки189190**unittest** поддерживает следующие параметры командной строки:191192#### `-b, --buffer`193194Потоки стандартного вывода и стандартной ошибки буферизируются во время выполнения теста. Вывод при успешном тесте отбрасывается. При ошибке или провале теста вывод выводится обычным образом и добавляется к сообщениям о неудаче.195196#### `-c, --catch`197198Нажатие Control-C во время выполнения теста дожидается завершения текущего теста, после чего выводит все накопленные результаты. Второе нажатие Control-C вызывает обычное исключение [`KeyboardInterrupt`](https://python-all.ru/3.3/library/exceptions.html#KeyboardInterrupt).199200См. раздел [Обработка сигналов](https://python-all.ru/3.3/library/unittest.html#signal-handling) с описанием функций, предоставляющих эту возможность.201202#### `-f, --failfast`203204Остановить выполнение теста при первой же ошибке или неудаче.205206Новое в версии 3.2: Были добавлены параметры командной строки `-b`, `-c` и `-f`.207208Командная строка также может использоваться для автоматического обнаружения тестов, для запуска всех тестов в проекте или только их части.209210## 26.3.3. Обнаружение тестов211212Новое в версии 3.2.213214Unittest поддерживает простое обнаружение тестов. Чтобы быть совместимыми с обнаружением тестов, все тестовые файлы должны быть [*модулями*](https://python-all.ru/3.3/tutorial/modules.html#tut-modules) или [*пакетами*](https://python-all.ru/3.3/tutorial/modules.html#tut-packages), импортируемыми из корневого каталога проекта (это означает, что их имена файлов должны быть валидными [*идентификаторами*](https://python-all.ru/3.3/reference/lexical_analysis.html#identifiers)).215216Обнаружение тестов реализовано в [`TestLoader.discover()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader.discover), но также может использоваться из командной строки. Основное использование в командной строке:217218```python219cd project_directory220python -m unittest discover221```222223> **Примечание**224>225> В качестве сокращения `python -m unittest` эквивалентно `python -m unittest discover`. Если требуется передать аргументы для обнаружения тестов, подкоманду `discover` необходимо указывать явно.226227Подкоманда `discover` имеет следующие параметры:228229#### `-v, --verbose`230231Подробный вывод232233#### `-s, --start-directory directory`234235Каталог для начала обнаружения (по умолчанию `.`)236237#### `-p, --pattern pattern`238239Шаблон для сопоставления тестовых файлов (по умолчанию `test*.py`)240241#### `-t, --top-level-directory directory`242243Корневой каталог проекта (по умолчанию – каталог начала поиска)244245Параметры [*-s*](https://python-all.ru/3.3/library/unittest.html#cmdoption-unittest-discover-s), [*-p*](https://python-all.ru/3.3/library/unittest.html#cmdoption-unittest-discover-p) и [*-t*](https://python-all.ru/3.3/library/unittest.html#cmdoption-unittest-discover-t) можно передавать в качестве позиционных аргументов в указанном порядке. Следующие две командные строки эквивалентны:246247```python248python -m unittest discover -s project_directory -p '*_test.py'249python -m unittest discover project_directory '*_test.py'250```251252Помимо пути можно передать имя пакета, например `myproject.subpackage.test`, в качестве начального каталога. Указанное имя пакета будет импортировано, а его расположение в файловой системе будет использовано как начальный каталог.253254> **Внимание**255>256> Обнаружение тестов загружает тесты путём их импорта. Когда обнаружение найдёт все тестовые файлы в указанном начальном каталоге, оно преобразует пути в имена пакетов для импорта. Например, `foo/bar/baz.py` будет импортирован как `foo.bar.baz`.257>258> Если пакет установлен глобально, и предпринимается попытка обнаружения тестов в другой копии пакета, то импорт *может* произойти из неправильного места. Если это произойдет, обнаружение тестов выдаст предупреждение и завершится.259>260> Если указать начальный каталог как имя пакета, а не путь к каталогу, то discover считает, что местоположение, из которого он импортирует, и есть то, которое вы имели в виду, поэтому предупреждение не появится.261262Тестовые модули и пакеты могут настраивать загрузку и обнаружение тестов с помощью [протокола load\_tests](https://python-all.ru/3.3/library/unittest.html#load-tests-protocol).263264## 26.3.4. Организация тестового кода265266Основными строительными блоками модульного тестирования являются *тестовые сценарии* – отдельные сценарии, которые необходимо настроить и проверить на корректность. В [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest) тестовые сценарии представлены экземплярами [`unittest.TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase). Чтобы создать собственные тестовые сценарии, нужно написать подклассы [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) или использовать [`FunctionTestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.FunctionTestCase).267268Тестовый код экземпляра [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) должен быть полностью самодостаточным, чтобы его можно было запускать как изолированно, так и в произвольной комбинации с любым количеством других тестовых сценариев.269270Простейший подкласс [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) просто реализует тестовый метод (т.е. метод, имя которого начинается с `test`) для выполнения конкретного тестового кода:271272```python273import unittest274275class DefaultWidgetSizeTestCase(unittest.TestCase):276    def test_default_widget_size(self):277        widget = Widget('The widget')278        self.assertEqual(widget.size(), (50, 50))279```280281Обратите внимание, что для проверки чего-либо используются методы `assert*()`, предоставляемые базовым классом [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase). Если тест не пройден, будет возбуждено исключение, и [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest) определит тестовый сценарий как *неудачу*. Любые другие исключения будут рассматриваться как *ошибки*.282283Тестов может быть много, и их настройка может быть повторяющейся. К счастью, можно вынести код настройки, реализовав метод [`setUp()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.setUp), который тестовый фреймворк будет автоматически вызывать для каждого запускаемого теста:284285```python286import unittest287288class SimpleWidgetTestCase(unittest.TestCase):289    def setUp(self):290        self.widget = Widget('The widget')291292    def test_default_widget_size(self):293        self.assertEqual(self.widget.size(), (50,50),294                         'incorrect default size')295296    def test_widget_resize(self):297        self.widget.resize(100,150)298        self.assertEqual(self.widget.size(), (100,150),299                         'wrong size after resize')300```301302> **Примечание**303>304> Порядок выполнения различных тестов определяется сортировкой имен тестовых методов в соответствии со встроенным порядком строк.305306Если метод [`setUp()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.setUp) возбуждает исключение во время выполнения теста, фреймворк сочтёт, что в тесте произошла ошибка, и тестовый метод не будет выполнен.307308Аналогично можно предоставить метод [`tearDown()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.tearDown), который выполняет очистку после выполнения тестового метода:309310```python311import unittest312313class SimpleWidgetTestCase(unittest.TestCase):314    def setUp(self):315        self.widget = Widget('The widget')316317    def tearDown(self):318        self.widget.dispose()319```320321Если [`setUp()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.setUp) выполнился успешно, [`tearDown()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.tearDown) будет запущен вне зависимости от того, успешно ли выполнился тестовый метод.322323Такое рабочее окружение для тестового кода называется *фикстурой*.324325Экземпляры тестовых сценариев группируются по тестируемым функциям. [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest) предоставляет для этого механизм: *тестовый набор*, представленный классом [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest).[`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite). В большинстве случаев вызов [`unittest.main()`](https://python-all.ru/3.3/library/unittest.html#unittest.main) сделает всё правильно, соберёт все тестовые сценарии модуля и выполнит их.326327Однако, если требуется настроить сборку набора тестов, это можно сделать самостоятельно:328329```python330def suite():331    suite = unittest.TestSuite()332    suite.addTest(WidgetTestCase('test_default_size'))333    suite.addTest(WidgetTestCase('test_resize'))334    return suite335```336337Определения тестовых сценариев и тестовых наборов можно размещать в тех же модулях, что и тестируемый код (например, `widget.py`), но есть несколько преимуществ в размещении тестового кода в отдельном модуле, например `test_widget.py`:338339- Тестовый модуль можно запускать автономно из командной строки.340- Тестовый код проще отделить от поставляемого кода.341- Меньше соблазна изменять тестовый код, чтобы подогнать его под тестируемый код, без веской причины.342- Тестовый код должен изменяться гораздо реже, чем тестируемый код.343- Тестируемый код проще поддаётся рефакторингу.344- Тесты для модулей, написанных на C, всё равно должны быть в отдельных модулях – так почему бы не придерживаться этого подхода?345- Если стратегия тестирования меняется, нет необходимости изменять исходный код.346347## 26.3.5. Повторное использование старого тестового кода348349Некоторые пользователи могут обнаружить, что у них есть существующий тестовый код, который они хотели бы запускать из [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest), без преобразования каждой старой тестовой функции в подкласс [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase).350351По этой причине [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest) предоставляет класс [`FunctionTestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.FunctionTestCase). Этот подкласс [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) можно использовать для обёртывания существующей тестовой функции. Также можно предоставить функции настройки и очистки.352353Рассмотрим следующую тестовую функцию:354355```python356def testSomething():357    something = makeSomething()358    assert something.name is not None359    # ...360```361362можно создать эквивалентный экземпляр тестового случая следующим образом, с опциональными методами настройки и завершения:363364```python365testcase = unittest.FunctionTestCase(testSomething,366                                     setUp=makeSomethingDB,367                                     tearDown=deleteSomethingDB)368```369370> **Примечание**371>372> Хотя [`FunctionTestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.FunctionTestCase) можно использовать для быстрого преобразования существующей тестовой базы в систему на основе [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest), этот подход не рекомендуется. Уделив время созданию правильных подклассов [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase), можно значительно упростить будущий рефакторинг тестов.373374В некоторых случаях существующие тесты могут быть написаны с использованием модуля [`doctest`](https://python-all.ru/3.3/library/doctest.html#module-doctest). Если это так, [`doctest`](https://python-all.ru/3.3/library/doctest.html#module-doctest) предоставляет класс `DocTestSuite`, который может автоматически создавать экземпляры [`unittest.TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite) из существующих тестов на основе [`doctest`](https://python-all.ru/3.3/library/doctest.html#module-doctest).375376## 26.3.6. Пропуск тестов и ожидаемые сбои377378Новое в версии 3.1.379380Unittest поддерживает пропуск отдельных тестовых методов и даже целых классов тестов. Кроме того, он поддерживает пометку теста как «ожидаемого сбоя» – теста, который сломан и будет провален, но не должен учитываться как сбой в [`TestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult).381382Пропуск теста – это просто использование [`skip()`](https://python-all.ru/3.3/library/unittest.html#unittest.skip) [*декоратора*](https://python-all.ru/3.3/glossary.html#term-decorator) или одного из его условных вариантов.383384Базовый пропуск выглядит так:385386```python387class MyTestCase(unittest.TestCase):388389    @unittest.skip("demonstrating skipping")390    def test_nothing(self):391        self.fail("shouldn't happen")392393    @unittest.skipIf(mylib.__version__ < (1, 3),394                     "not supported in this library version")395    def test_format(self):396        # Тесты, которые работают только для определённой версии библиотеки.397        pass398399    @unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")400    def test_windows_support(self):401        # код тестирования для Windows402        pass403```404405Это вывод приведённого выше примера в подробном режиме:406407```python408test_format (__main__.MyTestCase) ... skipped 'not supported in this library version'409test_nothing (__main__.MyTestCase) ... skipped 'demonstrating skipping'410test_windows_support (__main__.MyTestCase) ... skipped 'requires Windows'411412----------------------------------------------------------------------413Ran 3 tests in 0.005s414415OK (skipped=3)416```417418Классы можно пропускать так же, как методы:419420```python421@unittest.skip("showing class skipping")422class MySkippedTestCase(unittest.TestCase):423    def test_not_run(self):424        pass425```426427[`TestCase.setUp()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.setUp) также может пропустить тест. Это полезно, когда ресурс, который необходимо настроить, недоступен.428429Ожидаемые сбои используют декоратор [`expectedFailure()`](https://python-all.ru/3.3/library/unittest.html#unittest.expectedFailure).430431```python432class ExpectedFailureTestCase(unittest.TestCase):433    @unittest.expectedFailure434    def test_fail(self):435        self.assertEqual(1, 0, "broken")436```437438Легко создать собственные декораторы пропуска, написав декоратор, который вызывает [`skip()`](https://python-all.ru/3.3/library/unittest.html#unittest.skip) для теста, когда его нужно пропустить. Этот декоратор пропускает тест, если переданный объект не имеет определённого атрибута:439440```python441def skipUnlessHasattr(obj, attr):442    if hasattr(obj, attr):443        return lambda func: func444    return unittest.skip("{!r} doesn't have {!r}".format(obj, attr))445```446447Следующие декораторы реализуют пропуск тестов и ожидаемые сбои:448449#### `@unittest.skip(reason)`450451Безусловно пропускает декорированный тест. Параметр *reason* должен описывать причину пропуска теста.452453#### `@unittest.skipIf(condition, reason)`454455Пропустить декорированный тест, если *condition* истинно.456457#### `@unittest.skipUnless(condition, reason)`458459Пропустить декорированный тест, если *condition* не истинно.460461#### `@unittest.expectedFailure`462463Помечает тест как ожидаемый сбой. Если тест завершается ошибкой при запуске, он не учитывается как сбой.464465#### `exception unittest.SkipTest(reason)`466467Это исключение возбуждается для пропуска теста.468469Обычно можно использовать [`TestCase.skipTest()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.skipTest) или один из декораторов пропуска, вместо прямого возбуждения этого исключения.470471Пропущенные тесты не будут выполнять `setUp()` или `tearDown()`. Пропущенные классы не будут выполнять `setUpClass()` или `tearDownClass()`.472473## 26.3.7. Классы и функции474475Этот раздел подробно описывает API [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest).476477### 26.3.7.1. Тестовые случаи478479#### `class unittest.TestCase(methodName='runTest')`480481Экземпляры класса [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) представляют логические тестовые единицы в вселенной [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest). Этот класс предназначен для использования в качестве базового класса, при этом конкретные тесты реализуются конкретными подклассами. Этот класс реализует интерфейс, необходимый тестовому исполнителю для управления тестами, и методы, которые тестовый код может использовать для проверки и сообщения о различных видах ошибок.482483Каждый экземпляр [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) выполнит один базовый метод: метод с именем *methodName*. Однако стандартная реализация *methodName* по умолчанию, `runTest()`, будет запускать каждый метод, начинающийся с `test`, как отдельный тест и соответствующим образом подсчитывать успехи и неудачи. Поэтому в большинстве случаев использования [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) не нужно ни менять *methodName*, ни переопределять метод `runTest()` по умолчанию.484485Изменено в версии 3.2: [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) может быть успешно создан без предоставления *methodName*. Это упрощает эксперименты с [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) из интерактивного интерпретатора.486487Экземпляры [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) предоставляют три группы методов: одна группа используется для запуска теста, другая – реализацией теста для проверки условий и сообщения об ошибках, а также некоторые запрашивающие методы, позволяющие получать информацию о самом тесте.488489Методы первой группы (выполнение теста):490491#### `setUp()`492493Метод, вызываемый для подготовки тестового окружения (fixture). Он вызывается непосредственно перед вызовом тестового метода; любое исключение, возбуждённое этим методом, будет считаться ошибкой, а не неудачей теста. Реализация по умолчанию ничего не делает.494495#### `tearDown()`496497Метод, вызываемый сразу после вызова тестового метода и записи результата. Он вызывается, даже если тестовый метод возбудил исключение, поэтому реализация в подклассах должна быть особенно внимательна при проверке внутреннего состояния. Любое исключение, возбуждённое этим методом, будет считаться ошибкой, а не неудачей теста. Этот метод вызывается только в случае успешного выполнения [`setUp()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.setUp), независимо от результата тестового метода. Реализация по умолчанию ничего не делает.498499#### `setUpClass()`500501Метод класса, вызываемый перед запуском тестов в отдельном классе. `setUpClass` вызывается с классом в качестве единственного аргумента и должен быть декорирован как [`classmethod()`](https://python-all.ru/3.3/library/functions.html#classmethod):502503```python504@classmethod505def setUpClass(cls):506    ...507```508509См. [Фикстуры классов и модулей](https://python-all.ru/3.3/library/unittest.html#class-and-module-fixtures) для получения дополнительных сведений.510511Новое в версии 3.2.512513#### `tearDownClass()`514515Метод класса, вызываемый после завершения тестов в отдельном классе. `tearDownClass` вызывается с классом в качестве единственного аргумента и должен быть декорирован как [`classmethod()`](https://python-all.ru/3.3/library/functions.html#classmethod):516517```python518@classmethod519def tearDownClass(cls):520    ...521```522523См. [Фикстуры классов и модулей](https://python-all.ru/3.3/library/unittest.html#class-and-module-fixtures) для получения дополнительных сведений.524525Новое в версии 3.2.526527#### `run(result=None)`528529Запускает тест, собирая результат в объект [`TestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult), переданный как *result*. Если *result* опущен или равен `None`, создаётся временный объект результата (путём вызова метода [`defaultTestResult()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.defaultTestResult)) и используется. Объект результата возвращается вызывающему [`run()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.run) вызывающему.530531Тот же эффект можно получить, просто вызвав экземпляр [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase).532533Изменено в версии 3.3: Предыдущие версии `run` не возвращали результат. Не возвращал его и вызов экземпляра.534535#### `skipTest(reason)`536537Вызов этого метода во время выполнения тестового метода или [`setUp()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.setUp) пропускает текущий тест. См. [*Пропуск тестов и ожидаемые сбои*](https://python-all.ru/3.3/library/unittest.html#unittest-skipping) для получения дополнительной информации.538539Новое в версии 3.1.540541#### `debug()`542543Запускает тест без сбора результата. Это позволяет исключениям, возникшим в тесте, распространяться до вызывающего кода, и может использоваться для поддержки запуска тестов под отладчиком.544545Класс [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) предоставляет ряд методов для проверки и сообщения об ошибках, таких как:546547| Метод | Проверяет, что | Новое в |548| --- | --- | --- |549| [`assertEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual) | `a == b` |  |550| [`assertNotEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertNotEqual) | `a != b` |  |551| [`assertTrue(x)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertTrue) | `bool(x) is True` |  |552| [`assertFalse(x)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertFalse) | `bool(x) is False` |  |553| [`assertIs(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertIs) | `a is b` | 3.1 |554| [`assertIsNot(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertIsNot) | `a is not b` | 3.1 |555| [`assertIsNone(x)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertIsNone) | `x is None` | 3.1 |556| [`assertIsNotNone(x)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertIsNotNone) | `x is not None` | 3.1 |557| [`assertIn(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertIn) | `a in b` | 3.1 |558| [`assertNotIn(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertNotIn) | `a not in b` | 3.1 |559| [`assertIsInstance(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertIsInstance) | `isinstance(a, b)` | 3.2 |560| [`assertNotIsInstance(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertNotIsInstance) | `not isinstance(a, b)` | 3.2 |561562Все методы assert принимают аргумент *msg*, который, если указан, используется в качестве сообщения об ошибке при неудаче (см. также [`longMessage`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.longMessage)). Обратите внимание, что аргумент-ключевое слово *msg* можно передавать в [`assertRaises()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaises), [`assertRaisesRegex()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaisesRegex), [`assertWarns()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertWarns), [`assertWarnsRegex()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertWarnsRegex) только когда они используются как контекстный менеджер.563564#### `assertEqual(first, second, msg=None)`565566Проверяет, что *first* и *second* равны. Если значения не равны, тест завершится с ошибкой.567568Кроме того, если *first* и *second* имеют один и тот же тип и являются одним из list, tuple, dict, set, frozenset или str, или любым типом, который подкласс регистрирует с помощью [`addTypeEqualityFunc()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.addTypeEqualityFunc), то будет вызвана функция сравнения, специфичная для этого типа, чтобы сгенерировать более полезное сообщение об ошибке по умолчанию (см. также [*список методов для конкретных типов*](https://python-all.ru/3.3/library/unittest.html#type-specific-methods)).569570Изменено в версии 3.1: Добавлен автоматический вызов типовой функции сравнения.571572Изменено в версии 3.2: добавлена функция [`assertMultiLineEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertMultiLineEqual) как функция сравнения по умолчанию для строк.573574#### `assertNotEqual(first, second, msg=None)`575576Проверяет, что *first* и *second* не равны. Если значения равны, тест завершится с ошибкой.577578#### `assertTrue(expr, msg=None)`579580#### `assertFalse(expr, msg=None)`581582Проверяет, что *expr* истинно (или ложно).583584Обратите внимание, что это эквивалентно `bool(expr) is True`, а не `expr is True` (для последнего используйте `assertIs(expr, True)`). Этого метода также следует избегать, когда доступны более специфичные методы (например, `assertEqual(a, b)` вместо `assertTrue(a == b)`), поскольку они предоставляют лучшее сообщение об ошибке в случае неудачи.585586#### `assertIs(first, second, msg=None)`587588#### `assertIsNot(first, second, msg=None)`589590Проверяет, что *first* и *second* вычисляются (или не вычисляются) в один и тот же объект.591592Новое в версии 3.1.593594#### `assertIsNone(expr, msg=None)`595596#### `assertIsNotNone(expr, msg=None)`597598Проверяет, что *expr* равен (или не равен) None.599600Новое в версии 3.1.601602#### `assertIn(first, second, msg=None)`603604#### `assertNotIn(first, second, msg=None)`605606Проверяет, находится ли *first* в *second* (или не находится).607608Новое в версии 3.1.609610#### `assertIsInstance(obj, cls, msg=None)`611612#### `assertNotIsInstance(obj, cls, msg=None)`613614Проверяет, что *obj* является (или не является) экземпляром *cls* (который может быть классом или кортежем классов, как поддерживается функцией [`isinstance()`](https://python-all.ru/3.3/library/functions.html#isinstance)). Чтобы проверить точный тип, используйте [`assertIs(type(obj), cls)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertIs).615616Новое в версии 3.2.617618Также можно проверить, что исключения и предупреждения возбуждаются с помощью следующих методов:619620| Метод | Проверяет, что | Новое в |621| --- | --- | --- |622| [`assertRaises(exc, fun, *args, **kwds)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaises) | `fun(*args, **kwds)` возбуждает *exc* |  |623| [`assertRaisesRegex(exc, r, fun, *args, **kwds)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaisesRegex) | `fun(*args, **kwds)` возбуждает *exc* и сообщение соответствует регулярному выражению *r* | 3.1 |624| [`assertWarns(warn, fun, *args, **kwds)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertWarns) | `fun(*args, **kwds)` возбуждает *warn* | 3.2 |625| [`assertWarnsRegex(warn, r, fun, *args, **kwds)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertWarnsRegex) | `fun(*args, **kwds)` возбуждает *warn* и сообщение соответствует регулярному выражению *r* | 3.2 |626627#### `assertRaises(exception, callable, *args, **kwds)`628629#### `assertRaises(exception, msg=None)`630631Проверяет, что исключение возбуждается, когда *callable* вызывается с любыми позиционными или ключевыми аргументами, которые также передаются в [`assertRaises()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaises). Тест проходит, если возбуждается *исключение*, является ошибкой, если возбуждается другое исключение, или завершается неудачей, если исключение не возбуждено. Чтобы перехватить любую из группы исключений, можно передать кортеж, содержащий классы исключений, как *исключение*.632633Если переданы только аргументы *исключение* и, возможно, *msg*, возвращается менеджер контекста, чтобы проверяемый код можно было написать встроенно, а не в виде функции:634635```python636with self.assertRaises(SomeException):637    do_something()638```639640При использовании в качестве менеджера контекста [`assertRaises()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaises) принимает дополнительный ключевой аргумент *msg*.641642Менеджер контекста сохранит перехваченный объект исключения в своем атрибуте `исключение`. Это может быть полезно, если требуется выполнить дополнительные проверки возбужденного исключения:643644```python645with self.assertRaises(SomeException) as cm:646    do_something()647648the_exception = cm.exception649self.assertEqual(the_exception.error_code, 3)650```651652Изменено в версии 3.1: Добавлена возможность использовать [`assertRaises()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaises) в качестве менеджера контекста.653654Изменено в версии 3.2: Добавлен атрибут `исключение`.655656Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.657658#### `assertRaisesRegex(exception, regex, callable, *args, **kwds)`659660#### `assertRaisesRegex(exception, regex, msg=None)`661662Как и [`assertRaises()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaises), но также проверяет, что *regex* соответствует строковому представлению возбужденного исключения. *regex* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, подходящей для использования в [`re.search()`](https://python-all.ru/3.3/library/re.html#re.search). Примеры:663664```python665self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$",666                       int, 'XYZ')667```668669или:670671```python672with self.assertRaisesRegex(ValueError, 'literal'):673   int('XYZ')674```675676Новое в версии 3.1: под именем `assertRaisesRegexp`.677678Изменено в версии 3.2: Переименован в [`assertRaisesRegex()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaisesRegex).679680Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.681682#### `assertWarns(warning, callable, *args, **kwds)`683684#### `assertWarns(warning, msg=None)`685686Проверяет, что предупреждение генерируется, когда *callable* вызывается с любыми позиционными или ключевыми аргументами, которые также передаются в [`assertWarns()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertWarns). Тест проходит, если генерируется *warning*, и завершается неудачей, если нет. Любое исключение является ошибкой. Чтобы перехватить любую из группы предупреждений, можно передать кортеж, содержащий классы предупреждений, как *warnings*.687688Если указаны только *предупреждение* и, возможно, *msg*, возвращается менеджер контекста, позволяющий писать тестируемый код inline, а не в виде функции:689690```python691with self.assertWarns(SomeWarning):692    do_something()693```694695При использовании в качестве менеджера контекста [`assertWarns()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertWarns) принимает дополнительный именованный аргумент *msg*.696697Менеджер контекста сохраняет перехваченный объект предупреждения в своём атрибуте `warning`, а исходную строку, вызвавшую предупреждение, в атрибутах `filename` и `lineno`. Это может быть полезно, если требуется выполнить дополнительные проверки перехваченного предупреждения:698699```python700with self.assertWarns(SomeWarning) as cm:701    do_something()702703self.assertIn('myfile.py', cm.filename)704self.assertEqual(320, cm.lineno)705```706707Этот метод работает независимо от фильтров предупреждений, установленных на момент его вызова.708709Новое в версии 3.2.710711Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.712713#### `assertWarnsRegex(warning, regex, callable, *args, **kwds)`714715#### `assertWarnsRegex(warning, regex, msg=None)`716717Аналогично [`assertWarns()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertWarns), но также проверяет, что *regex* соответствует сообщению перехваченного предупреждения. *regex* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, пригодное для использования с [`re.search()`](https://python-all.ru/3.3/library/re.html#re.search). Пример:718719```python720self.assertWarnsRegex(DeprecationWarning,721                      r'legacy_function\(\) is deprecated',722                      legacy_function, 'XYZ')723```724725или:726727```python728with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'):729    frobnicate('/etc/passwd')730```731732Новое в версии 3.2.733734Изменено в версии 3.3: добавлен ключевой аргумент *msg* при использовании в качестве менеджера контекста.735736Существуют также другие методы для выполнения более специфических проверок, например:737738| Метод | Проверяет, что | Новое в |739| --- | --- | --- |740| [`assertAlmostEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertAlmostEqual) | `round(a-b, 7) == 0` |  |741| [`assertNotAlmostEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertNotAlmostEqual) | `round(a-b, 7) != 0` |  |742| [`assertGreater(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertGreater) | `a > b` | 3.1 |743| [`assertGreaterEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertGreaterEqual) | `a >= b` | 3.1 |744| [`assertLess(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertLess) | `a < b` | 3.1 |745| [`assertLessEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertLessEqual) | `a <= b` | 3.1 |746| [`assertRegex(s, r)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRegex) | `r.search(s)` | 3.1 |747| [`assertNotRegex(s, r)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertNotRegex) | `not r.search(s)` | 3.2 |748| [`assertCountEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertCountEqual) | *a* и *b* содержат одни и те же элементы в одинаковом количестве, независимо от их порядка | 3.2 |749750#### `assertAlmostEqual(first, second, places=7, msg=None, delta=None)`751752#### `assertNotAlmostEqual(first, second, places=7, msg=None, delta=None)`753754Проверяет, что *first* и *second* приблизительно (или не приблизительно) равны, вычисляя разность, округляя до заданного числа десятичных *знаков* (по умолчанию 7) и сравнивая с нулём. Обратите внимание, что эти методы округляют значения до заданного числа *десятичных знаков* (т.е. как функция [`round()`](https://python-all.ru/3.3/library/functions.html#round)), а не до *значащих цифр*.755756Если указан *delta* вместо *places*, то разность между *first* и *second* должна быть меньше или равна (или больше) *delta*.757758Указание одновременно *delta* и *places* вызывает исключение `TypeError`.759760Изменено в версии 3.2: [`assertAlmostEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertAlmostEqual) автоматически считает почти равными объекты, которые сравниваются как равные. [`assertNotAlmostEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertNotAlmostEqual) автоматически завершается неудачей, если объекты сравниваются как равные. Добавлен именованный аргумент *delta*.761762#### `assertGreater(first, second, msg=None)`763764#### `assertGreaterEqual(first, second, msg=None)`765766#### `assertLess(first, second, msg=None)`767768#### `assertLessEqual(first, second, msg=None)`769770Проверяет, что *first* соответственно \>, \>=, \< или \<= по отношению к *second* в зависимости от имени метода. Если это не так, тест завершается ошибкой:771772```python773>>> self.assertGreaterEqual(3, 4)774AssertionError: "3" unexpectedly not greater than or equal to "4"775```776777Новое в версии 3.1.778779#### `assertRegex(text, regex, msg=None)`780781#### `assertNotRegex(text, regex, msg=None)`782783Проверяет, что поиск *regex* соответствует (или не соответствует) *text*. В случае неудачи сообщение об ошибке будет содержать шаблон и *text* (или шаблон и часть *text*, которая неожиданно совпала). *regex* может быть объектом регулярного выражения или строкой, содержащей регулярное выражение, пригодной для использования в [`re.search()`](https://python-all.ru/3.3/library/re.html#re.search).784785Новое в версии 3.1: под именем `assertRegexpMatches`.786787Изменено в версии 3.2: Метод `assertRegexpMatches()` переименован в [`assertRegex()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRegex).788789Новое в версии 3.2: [`assertNotRegex()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertNotRegex).790791#### `assertCountEqual(first, second, msg=None)`792793Проверяет, что последовательность *first* содержит те же элементы, что и *second*, независимо от их порядка. Если нет, генерируется сообщение об ошибке с перечислением различий между последовательностями.794795Дублирующиеся элементы *не* игнорируются при сравнении *first* и *second*. Проверяется, что каждый элемент имеет одинаковое количество в обеих последовательностях. Эквивалентно: `assertEqual(Counter(list(first)), Counter(list(second)))` но также работает с последовательностями нехэшируемых объектов.796797Новое в версии 3.2.798799Метод [`assertEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual) направляет проверку равенства для объектов одного типа к различным методам, специфичным для типа. Эти методы уже реализованы для большинства встроенных типов, но также можно зарегистрировать новые методы с помощью [`addTypeEqualityFunc()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.addTypeEqualityFunc):800801#### `addTypeEqualityFunc(typeobj, function)`802803Регистрирует метод, специфичный для типа, который вызывается [`assertEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual) для проверки, равны ли два объекта одного и того же *typeobj* (не подклассы). *function* должен принимать два позиционных аргумента и третий именованный аргумент msg=None, как и [`assertEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual). Он должен вызывать исключение [`self.failureException(msg)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.failureException) при обнаружении неравенства между первыми двумя параметрами – возможно, предоставляя полезную информацию и подробно объясняя неравенства в сообщении об ошибке.804805Новое в версии 3.1.806807Список методов, специфичных для типа, автоматически используемых [`assertEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual), приведен в следующей таблице. Обратите внимание, что обычно нет необходимости вызывать эти методы напрямую.808809| Метод | Используется для сравнения | Новое в |810| --- | --- | --- |811| [`assertMultiLineEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertMultiLineEqual) | строки | 3.1 |812| [`assertSequenceEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertSequenceEqual) | последовательности | 3.1 |813| [`assertListEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertListEqual) | списки | 3.1 |814| [`assertTupleEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertTupleEqual) | кортежи | 3.1 |815| [`assertSetEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertSetEqual) | множества или неизменяемые множества | 3.1 |816| [`assertDictEqual(a, b)`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertDictEqual) | словари | 3.1 |817818#### `assertMultiLineEqual(first, second, msg=None)`819820Проверяет, что многострочная строка *first* равна строке *second*. При неравенстве в сообщение об ошибке будет включена разница между двумя строками с выделением отличий. Этот метод используется по умолчанию при сравнении строк с [`assertEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual).821822Новое в версии 3.1.823824#### `assertSequenceEqual(first, second, msg=None, seq_type=None)`825826Проверяет, что две последовательности равны. Если передан *seq\_type*, то *first* и *second* должны быть экземплярами *seq\_type*, иначе будет вызвана ошибка. Если последовательности различаются, формируется сообщение об ошибке, показывающее разницу между ними.827828Этот метод не вызывается напрямую [`assertEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual), но используется для реализации [`assertListEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertListEqual) и [`assertTupleEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertTupleEqual).829830Новое в версии 3.1.831832#### `assertListEqual(first, second, msg=None)`833834#### `assertTupleEqual(first, second, msg=None)`835836Проверяет, что два списка или кортежа равны. Если нет, формируется сообщение об ошибке, показывающее только различия между ними. Ошибка также возникает, если какой-либо из параметров имеет неправильный тип. Эти методы используются по умолчанию при сравнении списков или кортежей с [`assertEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual).837838Новое в версии 3.1.839840#### `assertSetEqual(first, second, msg=None)`841842Проверяет, что два множества равны. Если нет, формируется сообщение об ошибке, в котором перечислены различия между множествами. Этот метод используется по умолчанию при сравнении множеств или frozensets с [`assertEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual).843844Завершается ошибкой, если *first* или *second* не имеют метода [`set.difference()`](https://python-all.ru/3.3/library/stdtypes.html#set.difference) .845846Новое в версии 3.1.847848#### `assertDictEqual(first, second, msg=None)`849850Проверяет, что два словаря равны. Если нет, формируется сообщение об ошибке, показывающее различия в словарях. Этот метод будет использоваться по умолчанию для сравнения словарей в вызовах [`assertEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual).851852Новое в версии 3.1.853854Наконец, [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) предоставляет следующие методы и атрибуты:855856#### `fail(msg=None)`857858Безусловно сообщает о провале теста, с *msg* или `None` в качестве сообщения об ошибке.859860#### `failureException`861862Этот атрибут класса задаёт исключение, возбуждаемое тестовым методом. Если тестовой платформе нужно использовать специализированное исключение, возможно, для передачи дополнительной информации, она должна создать подкласс этого исключения, чтобы корректно работать с платформой. Начальное значение этого атрибута – [`AssertionError`](https://python-all.ru/3.3/library/exceptions.html#AssertionError).863864#### `longMessage`865866Если установлено в `True`, то любое явное сообщение об ошибке, переданное в [*assert-методы*](https://python-all.ru/3.3/library/unittest.html#assert-methods), будет добавлено в конец стандартного сообщения об ошибке. Стандартные сообщения содержат полезную информацию о вовлечённых объектах, например, сообщение от assertEqual показывает repr двух неравных объектов. Установка этого атрибута в `True` позволяет иметь пользовательское сообщение об ошибке в дополнение к стандартному.867868Этот атрибут по умолчанию равен `True`. Если установлен в False, то пользовательское сообщение, переданное методу assert, подавит стандартное сообщение.869870Настройку класса можно переопределить в отдельных тестах, назначив атрибут экземпляра в `True` или `False` перед вызовом методов assert.871872Новое в версии 3.1.873874#### `maxDiff`875876Этот атрибут управляет максимальной длиной вывода различий методами assert, которые сообщают о различиях при неудаче. По умолчанию он равен 80\*8 символов. Методы assert, на которые влияет этот атрибут: [`assertSequenceEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertSequenceEqual) (включая все методы сравнения последовательностей, которые делегируют ему), [`assertDictEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertDictEqual) и [`assertMultiLineEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertMultiLineEqual).877878Установка `maxDiff` в None означает, что нет максимальной длины различий.879880Новое в версии 3.2.881882Тестовые фреймворки могут использовать следующие методы для сбора информации о тесте:883884#### `countTestCases()`885886Возвращает количество тестов, представленных этим тестовым объектом. Для экземпляров [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) это значение всегда равно `1`.887888#### `defaultTestResult()`889890Возвращает экземпляр класса результата теста, который следует использовать для этого класса тестового случая (если другой экземпляр результата не предоставлен методу [`run()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.run)).891892Для экземпляров [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) это всегда будет экземпляр [`TestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult); подклассы [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) должны переопределять это при необходимости.893894#### `id()`895896Возвращает строку, идентифицирующую конкретный тестовый случай. Обычно это полное имя тестового метода, включая имя модуля и класса.897898#### `shortDescription()`899900Возвращает описание теста или `None`, если описание не было предоставлено. Реализация по умолчанию этого метода возвращает первую строку докстринга тестового метода, если она есть, или `None`.901902Изменено в версии 3.1: В версии 3.1 это было изменено так, что имя теста добавляется в краткое описание даже при наличии докстринга. Это вызвало проблемы совместимости с расширениями unittest, и добавление имени теста было перенесено в [`TextTestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TextTestResult) в Python 3.2.903904#### `addCleanup(function, *args, **kwargs)`905906Добавляет функцию, которая будет вызвана после [`tearDown()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.tearDown) для очистки ресурсов, используемых во время теста. Функции будут вызываться в порядке, обратном порядку их добавления (LIFO). Они вызываются с теми аргументами и именованными аргументами, которые были переданы в [`addCleanup()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.addCleanup) при их добавлении.907908Если [`setUp()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.setUp) завершается неудачей, так что [`tearDown()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.tearDown) не вызывается, то все добавленные функции очистки всё равно будут вызваны.909910Новое в версии 3.1.911912#### `doCleanups()`913914Этот метод вызывается безусловно после [`tearDown()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.tearDown), или после [`setUp()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.setUp), если [`setUp()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.setUp) возбуждает исключение.915916Он отвечает за вызов всех функций очистки, добавленных с помощью [`addCleanup()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.addCleanup). Если нужно, чтобы функции очистки вызывались *до* [`tearDown()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.tearDown), то можно вызвать [`doCleanups()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.doCleanups) самостоятельно.917918[`doCleanups()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.doCleanups) извлекает методы из стека функций очистки по одному, поэтому его можно вызывать в любое время.919920Новое в версии 3.1.921922#### `class unittest.FunctionTestCase(testFunc, setUp=None, tearDown=None, description=None)`923924Этот класс реализует часть интерфейса [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase), которая позволяет тестовому раннеру управлять тестом, но не предоставляет методы, которые тестовый код может использовать для проверки и сообщения об ошибках. Он используется для создания тестовых случаев с использованием устаревшего тестового кода, позволяя интегрировать его в тестовый фреймворк на основе [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest).925926#### 26.3.7.1.1. Устаревшие псевдонимы927928По историческим причинам некоторые методы [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) имели один или несколько псевдонимов, которые теперь устарели. В следующей таблице перечислены правильные имена вместе с их устаревшими псевдонимами:929930> | Имя метода | Устаревший псевдоним | Устаревший псевдоним |931> | --- | --- | --- |932> | [`assertEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertEqual) | failUnlessEqual | assertEquals |933> | [`assertNotEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertNotEqual) | failIfEqual | assertNotEquals |934> | [`assertTrue()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertTrue) | failUnless | assert\_ |935> | [`assertFalse()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertFalse) | failIf |  |936> | [`assertRaises()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaises) | failUnlessRaises |  |937> | [`assertAlmostEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertAlmostEqual) | failUnlessAlmostEqual | assertAlmostEquals |938> | [`assertNotAlmostEqual()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertNotAlmostEqual) | failIfAlmostEqual | assertNotAlmostEquals |939> | [`assertRegex()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRegex) |  | assertRegexpMatches |940> | [`assertRaisesRegex()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaisesRegex) |  | assertRaisesRegexp |941>942> Устарело с версии 3.1: псевдонимы fail\*, перечисленные во втором столбце.943>944> Устарело с версии 3.2: псевдонимы assert\*, перечисленные в третьем столбце.945>946> Устарело с версии 3.2: `assertRegexpMatches` и `assertRaisesRegexp` были переименованы в [`assertRegex()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRegex) и [`assertRaisesRegex()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.assertRaisesRegex)947948### 26.3.7.2. Группировка тестов949950#### `class unittest.TestSuite(tests=())`951952Этот класс представляет собой агрегацию отдельных тестовых случаев и тестовых наборов. Он предоставляет интерфейс, необходимый тестовому раннеру, чтобы его можно было запускать как любой другой тестовый случай. Запуск экземпляра [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite) равносилен итерации по набору с запуском каждого теста по отдельности.953954Если задан *tests*, он должен быть итерабельным объектом, содержащим отдельные тестовые примеры или другие тестовые наборы, которые будут использоваться для первоначального построения набора. Дополнительные методы предоставляются для добавления тестовых примеров и наборов в коллекцию позже.955956Объекты [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite) во многом аналогичны объектам [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase), за исключением того, что они не реализуют тест напрямую. Вместо этого они служат для объединения тестов в группы, которые должны выполняться совместно. Есть несколько дополнительных методов для добавления тестов в экземпляры [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite):957958#### `addTest(test)`959960Добавляет объект [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) или [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite) в набор.961962#### `addTests(tests)`963964Добавляет все тесты из итерируемого объекта, содержащего экземпляры [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) и [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite), в данный тестовый набор.965966Это эквивалентно перебору *tests* с вызовом [`addTest()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite.addTest) для каждого элемента.967968[`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite) имеет общие следующие методы с [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase):969970#### `run(result)`971972Запускает тесты, связанные с этим набором, собирая результат в объект результата теста, переданный как *result*. Обратите внимание, что, в отличие от [`TestCase.run()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase.run), [`TestSuite.run()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite.run) требует обязательной передачи объекта результата.973974#### `debug()`975976Запускает тесты, связанные с этим набором, без сбора результата. Это позволяет исключениям, возбуждённым тестом, распространяться до вызывающего кода и может использоваться для поддержки запуска тестов под отладчиком.977978#### `countTestCases()`979980Возвращает количество тестов, представленных этим тестовым объектом, включая все отдельные тесты и поднаборы.981982#### `__iter__()`983984Тесты, сгруппированные в [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite), всегда извлекаются через итерацию. Подклассы могут предоставлять тесты лениво, переопределяя [`__iter__()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite.__iter__). Обратите внимание, что этот метод может вызываться несколько раз для одного набора (например, при подсчёте тестов или сравнении на равенство) поэтому на всех повторных итерациях должны возвращаться одни и те же тесты.985986Изменено в версии 3.2: В более ранних версиях [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite) обращался к тестам напрямую, а не через итерацию, поэтому переопределения [`__iter__()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite.__iter__) было недостаточно для предоставления тестов.987988В типичном использовании объекта [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite) метод [`run()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite.run) вызывается `TestRunner`, а не тестовым стендом конечного пользователя.989990### 26.3.7.3. Загрузка и запуск тестов991992#### `class unittest.TestLoader`993994Класс [`TestLoader`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader) используется для создания тестовых наборов из классов и модулей. Обычно нет необходимости создавать экземпляр этого класса; модуль [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest) предоставляет экземпляр, который может использоваться совместно как [`unittest.defaultTestLoader`](https://python-all.ru/3.3/library/unittest.html#unittest.defaultTestLoader). Однако использование подкласса или экземпляра позволяет настраивать некоторые конфигурируемые свойства.995996Объекты [`TestLoader`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader) имеют следующие методы:997998#### `loadTestsFromTestCase(testCaseClass)`9991000Возвращает набор всех тестовых случаев, содержащихся в классе `testCaseClass`, производном от [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase).10011002#### `loadTestsFromModule(module)`10031004Возвращает набор всех тестовых случаев, содержащихся в данном модуле. Этот метод ищет в *module* классы, производные от [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase), и создает экземпляр класса для каждого тестового метода, определенного в классе.10051006> **Примечание**1007>1008> Хотя использование иерархии классов, производных от [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase), может быть удобным для совместного использования фикстур и вспомогательных функций, определение тестовых методов в базовых классах, которые не предназначены для прямого инстанцирования, плохо сочетается с этим методом. Однако это может быть полезно, когда фикстуры различаются и определяются в подклассах.10091010Если модуль предоставляет функцию `load_tests`, она будет вызвана для загрузки тестов. Это позволяет модулям настраивать загрузку тестов. Это [протокол load\_tests](https://python-all.ru/3.3/library/unittest.html#load-tests-protocol).10111012Изменено в версии 3.2: Добавлена поддержка `load_tests`.10131014#### `loadTestsFromName(name, module=None)`10151016Возвращает набор всех тестовых случаев по строковому спецификатору.10171018Спецификатор *name* – это «точечное имя», которое может разрешаться в модуль, класс тестового случая, тестовый метод внутри класса тестового случая, экземпляр [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite) или вызываемый объект, возвращающий экземпляр [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) или [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite). Эти проверки применяются в указанном порядке; то есть метод в классе возможного тестового случая будет распознан как «тестовый метод внутри класса тестового случая», а не как «вызываемый объект».10191020Например, если у вас есть модуль `SampleTests`, содержащий класс `SampleTestCase`, производный от [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase), с тремя тестовыми методами (`test_one()`, `test_two()` и `test_three()`), то спецификатор `'SampleTests.SampleTestCase'` приведет к тому, что этот метод вернет набор, который запустит все три тестовых метода. Использование спецификатора `'SampleTests.SampleTestCase.test_two'` приведет к возврату тестового набора, который запустит только тестовый метод `test_two()`. Спецификатор может ссылаться на модули и пакеты, которые еще не были импортированы; они будут импортированы как побочный эффект.10211022Метод опционально разрешает *name* относительно заданного *module*.10231024#### `loadTestsFromNames(names, module=None)`10251026Аналогично [`loadTestsFromName()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader.loadTestsFromName), но принимает последовательность имён, а не одно имя. Возвращаемое значение – тестовый набор, содержащий все тесты, определённые для каждого имени.10271028#### `getTestCaseNames(testCaseClass)`10291030Возвращает отсортированную последовательность имён методов, найденных в *testCaseClass*; и он должен быть [подклассом `TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase).10311032#### `discover(start_dir, pattern='test*.py', top_level_dir=None)`10331034Находит все тестовые модули, рекурсивно обходя подкаталоги, начиная с указанного каталога, и возвращает объект TestSuite, содержащий их. Будут загружены только тестовые файлы, соответствующие *pattern*. (Используется сопоставление с образцом в стиле shell.) Будут загружены только имена модулей, которые можно импортировать (т.е. являются допустимыми идентификаторами Python).10351036Все тестовые модули должны быть импортируемыми из корневого каталога проекта. Если стартовый каталог не является корневым, то корневой каталог необходимо указать отдельно.10371038Если импорт модуля завершается неудачей, например из-за синтаксической ошибки, то это будет записано как одна ошибка, и обнаружение продолжится.10391040Если имя тестового пакета (каталог с `__init__.py`) соответствует шаблону, то в пакете будет проверено наличие функции `load_tests`. Если она существует, то она будет вызвана с аргументами *loader*, *tests*, *pattern*.10411042Если функция load\_tests существует, то обнаружение *не* выполняет рекурсивный обход пакета, `load_tests` отвечает за загрузку всех тестов в пакете.10431044Шаблон намеренно не хранится как атрибут загрузчика, чтобы пакеты могли продолжать поиск самостоятельно. *top\_level\_dir* хранится, чтобы `load_tests` не нужно было передавать этот аргумент в `loader.discover()`.10451046*start\_dir* может быть как точечным именем модуля, так и каталогом.10471048Новое в версии 3.2.10491050Следующие атрибуты [`TestLoader`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader) можно настроить либо через создание подкласса, либо присваиванием экземпляру:10511052#### `testMethodPrefix`10531054Строка, задающая префикс имён методов, которые будут интерпретироваться как тестовые методы. Значение по умолчанию – `'test'`.10551056Это влияет на [`getTestCaseNames()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader.getTestCaseNames) и все методы `loadTestsFrom*()`.10571058#### `sortTestMethodsUsing`10591060Функция, используемая для сравнения имён методов при сортировке в [`getTestCaseNames()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader.getTestCaseNames) и во всех методах `loadTestsFrom*()`.10611062#### `suiteClass`10631064Вызываемый объект, который создаёт тестовый набор из списка тестов. Никакие методы результирующего объекта не требуются. Значение по умолчанию – класс [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite).10651066Это влияет на все методы `loadTestsFrom*()`.10671068#### `class unittest.TestResult`10691070Этот класс используется для сбора информации о том, какие тесты прошли успешно, а какие завершились неудачей.10711072Объект [`TestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult) хранит результаты набора тестов. Классы [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) и [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite) обеспечивают корректную запись результатов; авторам тестов не нужно заботиться о записи результатов тестов.10731074Тестовые фреймворки, построенные на основе [`unittest`](https://python-all.ru/3.3/library/unittest.html#module-unittest), могут нуждаться в доступе к объекту [`TestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult), создаваемому при выполнении набора тестов для целей отчётности; экземпляр [`TestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult) возвращается методом `TestRunner.run()` для этой цели.10751076Экземпляры [`TestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult) имеют следующие атрибуты, которые будут интересны при просмотре результатов выполнения набора тестов:10771078#### `errors`10791080Список, содержащий кортежи из двух элементов: экземпляры [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) и строки с форматированными трассировками. Каждый кортеж представляет тест, вызвавший неожиданное исключение.10811082#### `failures`10831084Список, содержащий кортежи из двух элементов: экземпляры [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) и строки с форматированными трассировками. Каждый кортеж представляет тест, в котором ошибка была явно зафиксирована с помощью методов `TestCase.assert*()`.10851086#### `skipped`10871088Список, содержащий кортежи из двух элементов: экземпляры [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) и строки с причиной пропуска теста.10891090Новое в версии 3.1.10911092#### `expectedFailures`10931094Список, содержащий кортежи из двух элементов: экземпляры [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) и строки с форматированными трассировками. Каждый кортеж представляет ожидаемую ошибку тестового случая.10951096#### `unexpectedSuccesses`10971098Список, содержащий экземпляры [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase), которые были отмечены как ожидаемые ошибки, но прошли успешно.10991100#### `shouldStop`11011102Устанавливается в `True`, когда выполнение тестов должно быть остановлено вызовом [`stop()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.stop).11031104#### `testsRun`11051106Общее количество запущенных на данный момент тестов.11071108#### `buffer`11091110Если установлено в true, `sys.stdout` и `sys.stderr` будут буферизироваться между вызовами [`startTest()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.startTest) и [`stopTest()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.stopTest). Собранный вывод будет выводиться в настоящие `sys.stdout` и `sys.stderr` только если тест завершается неудачей или ошибкой. Любой вывод также присоединяется к сообщению об ошибке или сбое.11111112Новое в версии 3.2.11131114#### `failfast`11151116Если установлено в true, [`stop()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.stop) будет вызван при первой неудаче или ошибке, останавливая выполнение тестов.11171118Новое в версии 3.2.11191120#### `wasSuccessful()`11211122Возвращает `True`, если все выполненные на данный момент тесты прошли, иначе возвращает `False`.11231124#### `stop()`11251126Этот метод может быть вызван, чтобы сигнализировать, что выполняемый набор тестов должен быть прерван установкой атрибута [`shouldStop`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.shouldStop) в `True`. Объекты `TestRunner` должны учитывать этот флаг и возвращаться без выполнения дополнительных тестов.11271128Например, эта возможность используется классом [`TextTestRunner`](https://python-all.ru/3.3/library/unittest.html#unittest.TextTestRunner) для остановки тестового фреймворка, когда пользователь подает сигнал прерывания с клавиатуры. Интерактивные инструменты, предоставляющие реализации `TestRunner`, могут использовать это аналогичным образом.11291130Следующие методы класса [`TestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult) используются для поддержки внутренних структур данных и могут быть расширены в подклассах для поддержки дополнительных требований к отчетности. Это особенно полезно при создании инструментов, поддерживающих интерактивную отчетность во время выполнения тестов.11311132#### `startTest(test)`11331134Вызывается перед запуском тестового сценария *test*.11351136#### `stopTest(test)`11371138Вызывается после выполнения тестового сценария *test*, независимо от результата.11391140#### `startTestRun(test)`11411142Вызывается один раз перед выполнением любых тестов.11431144Новое в версии 3.1.11451146#### `stopTestRun(test)`11471148Вызывается один раз после выполнения всех тестов.11491150Новое в версии 3.1.11511152#### `addError(test, err)`11531154Вызывается, когда тестовый пример *test* вызывает неожиданное исключение. *err* – это кортеж в формате, возвращаемом [`sys.exc_info()`](https://python-all.ru/3.3/library/sys.html#sys.exc_info): `(type, value, traceback)`.11551156Реализация по умолчанию добавляет кортеж `(test, formatted_err)` в атрибут [`errors`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.errors) экземпляра, где *formatted\_err* – это форматированная трассировка, полученная из *err*.11571158#### `addFailure(test, err)`11591160Вызывается, когда тестовый пример *test* сигнализирует о неудаче. *err* – это кортеж в формате, возвращаемом [`sys.exc_info()`](https://python-all.ru/3.3/library/sys.html#sys.exc_info): `(type, value, traceback)`.11611162Реализация по умолчанию добавляет кортеж `(test, formatted_err)` в атрибут [`failures`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.failures) экземпляра, где *formatted\_err* – это форматированная трассировка, полученная из *err*.11631164#### `addSuccess(test)`11651166Вызывается, когда тестовый сценарий *test* завершается успешно.11671168Реализация по умолчанию ничего не делает.11691170#### `addSkip(test, reason)`11711172Вызывается, когда тестовый сценарий *test* пропускается. *reason* – причина, которую тест указал для пропуска.11731174Реализация по умолчанию добавляет кортеж `(test, reason)` в атрибут [`skipped`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.skipped) экземпляра.11751176#### `addExpectedFailure(test, err)`11771178Вызывается, когда тестовый пример *test* завершается неудачей, но был помечен декоратором [`expectedFailure()`](https://python-all.ru/3.3/library/unittest.html#unittest.expectedFailure).11791180Реализация по умолчанию добавляет кортеж `(test, formatted_err)` в атрибут [`expectedFailures`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.expectedFailures) экземпляра, где *formatted\_err* – это форматированная трассировка, полученная из *err*.11811182#### `addUnexpectedSuccess(test)`11831184Вызывается, когда тестовый пример *test* был помечен декоратором [`expectedFailure()`](https://python-all.ru/3.3/library/unittest.html#unittest.expectedFailure), но завершился успешно.11851186Реализация по умолчанию добавляет тест в атрибут [`unexpectedSuccesses`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.unexpectedSuccesses) экземпляра.11871188#### `class unittest.TextTestResult(stream, descriptions, verbosity)`11891190Конкретная реализация [`TestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult), используемая [`TextTestRunner`](https://python-all.ru/3.3/library/unittest.html#unittest.TextTestRunner).11911192Новое в версии 3.2: Ранее этот класс назывался `_TextTestResult`. Старое имя всё ещё существует как псевдоним, но является устаревшим.11931194#### `unittest.defaultTestLoader`11951196Экземпляр класса [`TestLoader`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader), предназначенный для совместного использования. Если настройка [`TestLoader`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader) не требуется, можно использовать этот экземпляр вместо многократного создания новых.11971198#### `class unittest.TextTestRunner(stream=None, descriptions=True, verbosity=1, failfast=False, buffer=False, resultclass=None, warnings=None)`11991200Базовая реализация средства запуска тестов, которая выводит результаты в поток данных. Если *stream* равен `None` (по умолчанию), в качестве выходного потока данных используется [`sys.stderr`](https://python-all.ru/3.3/library/sys.html#sys.stderr). Этот класс имеет несколько настраиваемых параметров, но в целом очень прост. Графические приложения, которые запускают наборы тестов, должны предоставлять альтернативные реализации.12011202По умолчанию этот запускатор показывает [`DeprecationWarning`](https://python-all.ru/3.3/library/exceptions.html#DeprecationWarning), [`PendingDeprecationWarning`](https://python-all.ru/3.3/library/exceptions.html#PendingDeprecationWarning), [`ResourceWarning`](https://python-all.ru/3.3/library/exceptions.html#ResourceWarning) и [`ImportWarning`](https://python-all.ru/3.3/library/exceptions.html#ImportWarning), даже если они [*игнорируются по умолчанию*](https://python-all.ru/3.3/library/warnings.html#warning-ignored). Предупреждения об устаревании, вызванные [*устаревшими методами unittest*](https://python-all.ru/3.3/library/unittest.html#deprecated-aliases), также обрабатываются особым образом: когда фильтры предупреждений установлены в `'default'` или `'always'`, они будут появляться только один раз на модуль, чтобы избежать слишком большого количества предупреждений. Это поведение можно переопределить с помощью опций *-Wd* или *-Wa*, оставив *warnings* равным `None`.12031204Изменено в версии 3.2: Добавлен аргумент `warnings`.12051206Изменено в версии 3.2: Поток по умолчанию устанавливается в [`sys.stderr`](https://python-all.ru/3.3/library/sys.html#sys.stderr) во время создания экземпляра, а не во время импорта.12071208#### `_makeResult()`12091210Этот метод возвращает экземпляр `TestResult`, используемый `run()`. Он не предназначен для прямого вызова, но может быть переопределён в подклассах для предоставления собственного `TestResult`.12111212`_makeResult()` создаёт экземпляр класса или вызываемого объекта, переданного в конструктор `TextTestRunner` в качестве аргумента `resultclass`. По умолчанию используется [`TextTestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TextTestResult), если `resultclass` не предоставлен. Класс результата создаётся со следующими аргументами:12131214```python1215stream, descriptions, verbosity1216```12171218#### `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)`12191220Программа командной строки, которая загружает набор тестов из *module* и запускает их; это в первую очередь для удобного выполнения тестовых модулей. Простейший способ использования этой функции – добавить следующую строку в конец тестового скрипта:12211222```python1223if __name__ == '__main__':1224    unittest.main()1225```12261227Можно запускать тесты с более подробной информацией, передав аргумент verbosity:12281229```python1230if __name__ == '__main__':1231    unittest.main(verbosity=2)1232```12331234Аргумент *defaultTest* задаёт имя теста, который будет запущен, если имена тестов не указаны в *argv*. Если он не указан или равен `None`, и имена тестов не переданы через *argv*, запускаются все тесты, найденные в *module*.12351236Аргумент *argv* может быть списком параметров, переданных программе, где первый элемент – имя программы. Если он не указан или равен `None`, используются значения [`sys.argv`](https://python-all.ru/3.3/library/sys.html#sys.argv).12371238Аргумент *testRunner* может быть либо классом средства запуска тестов, либо уже созданным экземпляром такого класса. По умолчанию `main` вызывает [`sys.exit()`](https://python-all.ru/3.3/library/sys.html#sys.exit) с кодом возврата, указывающим на успех или неудачу выполнения тестов.12391240Аргумент *testLoader* должен быть экземпляром [`TestLoader`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader), по умолчанию используется [`defaultTestLoader`](https://python-all.ru/3.3/library/unittest.html#unittest.defaultTestLoader).12411242`main` поддерживает использование из интерактивного интерпретатора путём передачи аргумента `exit=False`. При этом результат выводится на стандартный вывод без вызова [`sys.exit()`](https://python-all.ru/3.3/library/sys.html#sys.exit):12431244```python1245>>> from unittest import main1246>>> main(module='test_module', exit=False)1247```12481249Параметры *failfast*, *catchbreak* и *buffer* имеют тот же эффект, что и одноимённые [параметры командной строки](https://python-all.ru/3.3/library/unittest.html#command-line-options).12501251Аргумент *warning* задаёт [*фильтр предупреждений*](https://python-all.ru/3.3/library/warnings.html#warning-filter), который следует использовать во время выполнения тестов. Если он не указан, он останется равным `None`, если опция *-W* передана **python**, в противном случае он будет установлен в `'default'`.12521253Вызов `main` на самом деле возвращает экземпляр класса `TestProgram`. Результат выполнения тестов сохраняется в атрибуте `result`.12541255Изменено в версии 3.1: Добавлен параметр *exit*.12561257Изменено в версии 3.2: Добавлены параметры *verbosity*, *failfast*, *catchbreak*, *buffer* и *warnings*.12581259#### 26.3.7.3.1. Протокол load\_tests12601261Новое в версии 3.2.12621263Модули или пакеты могут настраивать загрузку тестов из себя во время обычного запуска тестов или обнаружения тестов, реализуя функцию с именем `load_tests`.12641265Если тестовый модуль определяет `load_tests`, он будет вызван [`TestLoader.loadTestsFromModule()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader.loadTestsFromModule) со следующими аргументами:12661267```python1268load_tests(loader, standard_tests, None)1269```12701271Она должна возвращать [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite).12721273*loader* – это экземпляр [`TestLoader`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader), который выполняет загрузку. *standard\_tests* – это тесты, которые загружаются по умолчанию из модуля. Обычно тестовые модули хотят только добавить или удалить тесты из стандартного набора. Третий аргумент используется при загрузке пакетов в ходе обнаружения тестов.12741275Типичная функция `load_tests`, которая загружает тесты из определённого набора классов [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase), может выглядеть так:12761277```python1278test_cases = (TestCase1, TestCase2, TestCase3)12791280def load_tests(loader, tests, pattern):1281    suite = TestSuite()1282    for test_class in test_cases:1283        tests = loader.loadTestsFromTestCase(test_class)1284        suite.addTests(tests)1285    return suite1286```12871288Если запущено обнаружение (из командной строки или вызовом [`TestLoader.discover()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestLoader.discover)) с шаблоном, соответствующим имени пакета, то в пакете `__init__.py` будет проверено наличие `load_tests`.12891290> **Примечание**1291>1292> Шаблон по умолчанию – `'test*.py'`. Он соответствует всем Python-файлам, начинающимся с `'test'`, но *не* соответствует тестовым каталогам.1293>1294> Шаблон вида `'test*'` будет соответствовать как тестовым пакетам, так и модулям.12951296Если в пакете `__init__.py` определена `load_tests`, то она будет вызвана, и обнаружение в пакете не продолжится. `load_tests` вызывается со следующими аргументами:12971298```python1299load_tests(loader, standard_tests, pattern)1300```13011302Она должна вернуть [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite), представляющий все тесты из пакета. (`standard_tests` будет содержать только тесты, собранные из `__init__.py`.)13031304Поскольку шаблон передаётся в `load_tests`, пакет может продолжить (и, возможно, изменить) обнаружение тестов. Функция `load_tests`, которая «ничего не делает» для тестового пакета, будет выглядеть так:13051306```python1307def load_tests(loader, standard_tests, pattern):1308    # корневой каталог, кэшированный на экземпляре загрузчика1309    this_dir = os.path.dirname(__file__)1310    package_tests = loader.discover(start_dir=this_dir, pattern=pattern)1311    standard_tests.addTests(package_tests)1312    return standard_tests1313```13141315## 26.3.8. Фикстуры классов и модулей13161317Фикстуры уровня класса и модуля реализованы в [`TestSuite`](https://python-all.ru/3.3/library/unittest.html#unittest.TestSuite). Когда тестовый набор встречает тест из нового класса, вызывается `tearDownClass()` из предыдущего класса (если он есть), а затем `setUpClass()` из нового класса.13181319Аналогично, если тест из другого модуля, отличного от предыдущего, то выполняется `tearDownModule` из предыдущего модуля, а затем `setUpModule` из нового модуля.13201321После выполнения всех тестов запускаются финальные `tearDownClass` и `tearDownModule`.13221323Обратите внимание, что общие фикстуры плохо совместимы с такими возможностями, как параллельное выполнение тестов, и нарушают изоляцию тестов. Их следует использовать с осторожностью.13241325Порядок тестов по умолчанию, создаваемый загрузчиками тестов unittest, группирует все тесты из одних и тех же модулей и классов вместе. Это приводит к тому, что `setUpClass` / `setUpModule` (и т.д.) вызываются ровно один раз для каждого класса и модуля. Если перемешать порядок так, чтобы тесты из разных модулей и классов оказались рядом, эти общие функции фикстур могут быть вызваны несколько раз в одном запуске тестов.13261327Общие фикстуры не предназначены для работы с наборами, имеющими нестандартный порядок. `BaseTestSuite` по-прежнему существует для фреймворков, которые не хотят поддерживать общие фикстуры.13281329Если в одной из общих функций фикстур возникает исключение, тест отмечается как ошибочный. Поскольку соответствующего экземпляра теста нет, создаётся объект `_ErrorHolder` (с тем же интерфейсом, что и у [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase)) для представления ошибки. Если используется стандартный исполнитель тестов unittest, эта деталь не имеет значения, но для авторов фреймворков она может быть актуальной.13301331### 26.3.8.1. setUpClass и tearDownClass13321333Они должны быть реализованы как методы класса:13341335```python1336import unittest13371338class Test(unittest.TestCase):1339    @classmethod1340    def setUpClass(cls):1341        cls._connection = createExpensiveConnectionObject()13421343    @classmethod1344    def tearDownClass(cls):1345        cls._connection.destroy()1346```13471348Если нужно, чтобы `setUpClass` и `tearDownClass` в базовых классах вызывались, то их необходимо вызывать явно. Реализации в [`TestCase`](https://python-all.ru/3.3/library/unittest.html#unittest.TestCase) пусты.13491350Если во время `setUpClass` возникает исключение, тесты в классе не выполняются, и `tearDownClass` не вызывается. Пропущенные классы не будут иметь выполненных `setUpClass` или `tearDownClass`. Если исключение – это [`SkipTest`](https://python-all.ru/3.3/library/unittest.html#unittest.SkipTest), то класс будет отмечен как пропущенный, а не как ошибочный.13511352### 26.3.8.2. setUpModule и tearDownModule13531354Их следует реализовывать как функции:13551356```python1357def setUpModule():1358    createConnection()13591360def tearDownModule():1361    closeConnection()1362```13631364Если в `setUpModule` возникает исключение, ни один из тестов в модуле не будет выполнен, и `tearDownModule` не будет вызван. Если исключение – это [`SkipTest`](https://python-all.ru/3.3/library/unittest.html#unittest.SkipTest), то модуль будет отмечен как пропущенный, а не как ошибочный.13651366## 26.3.9. Обработка сигналов13671368Новое в версии 3.2.13691370Параметр командной строки [*-c/--catch*](https://python-all.ru/3.3/library/unittest.html#cmdoption-unittest-c) для unittest, а также параметр `catchbreak` для [`unittest.main()`](https://python-all.ru/3.3/library/unittest.html#unittest.main), обеспечивают более удобную обработку Ctrl+C во время запуска тестов. При включённом поведении перехвата Ctrl+C позволяет завершиться текущему выполняющемуся тесту, а затем выполнение тестов завершается и выводятся все результаты на данный момент. Повторное нажатие Ctrl+C вызовет [`KeyboardInterrupt`](https://python-all.ru/3.3/library/exceptions.html#KeyboardInterrupt) обычным образом.13711372Обработчик сигнала Ctrl+C пытается оставаться совместимым с кодом или тестами, которые устанавливают свой собственный обработчик `signal.SIGINT`. Если вызывается обработчик `unittest`, но он *не является* установленным обработчиком `signal.SIGINT`, т.е. он был заменён тестируемой системой и делегирован ей, то вызывается обработчик по умолчанию. Обычно это ожидаемое поведение для кода, который заменяет установленный обработчик и делегирует ему. Для отдельных тестов, которым требуется отключить обработку Ctrl+C в `unittest`, можно использовать декоратор [`removeHandler()`](https://python-all.ru/3.3/library/unittest.html#unittest.removeHandler).13731374Существует несколько вспомогательных функций для разработчиков фреймворков, позволяющих включить обработку control-c в тестовых фреймворках.13751376#### `unittest.installHandler()`13771378Устанавливает обработчик Ctrl+C. При получении `signal.SIGINT` (обычно в ответ на нажатие пользователем Ctrl+C) у всех зарегистрированных результатов вызывается [`stop()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.stop).13791380#### `unittest.registerResult(result)`13811382Регистрирует объект [`TestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult) для обработки Ctrl+C. Регистрация результата сохраняет слабую ссылку на него, поэтому это не мешает сборщику мусора удалить результат.13831384Регистрация объекта [`TestResult`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult) не имеет побочных эффектов, если обработка Ctrl+C не включена, поэтому тестовые фреймворки могут безоговорочно регистрировать все создаваемые ими результаты независимо от того, включена ли обработка.13851386#### `unittest.removeResult(result)`13871388Удаляет зарегистрированный результат. После удаления результата [`stop()`](https://python-all.ru/3.3/library/unittest.html#unittest.TestResult.stop) больше не будет вызываться для этого объекта результата в ответ на Ctrl+C.13891390#### `unittest.removeHandler(function=None)`13911392При вызове без аргументов эта функция удаляет обработчик сочетания клавиш Control-C, если он был установлен. Эту функцию также можно использовать как декоратор теста, чтобы временно удалить обработчик на время выполнения теста:13931394```python1395@unittest.removeHandler1396def test_signal_handling(self):1397    ...1398```1399