> **Источник:** https://python-all.ru/3.2/library/test.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# 25.5. [`test`](https://python-all.ru/3.2/library/test.html#module-test) – Пакет регрессионных тестов для Python

> **Примечание**
>
> Пакет [`test`](https://python-all.ru/3.2/library/test.html#module-test) предназначен только для внутреннего использования Python. Он документирован для пользы основных разработчиков Python. Любое использование этого пакета за пределами стандартной библиотеки Python не рекомендуется, так как упомянутый здесь код может быть изменён или удалён без предупреждения между выпусками Python.

Пакет [`test`](https://python-all.ru/3.2/library/test.html#module-test) содержит все регрессионные тесты для Python, а также модули [`test.support`](https://python-all.ru/3.2/library/test.html#module-test.support) и `test.regrtest`. [`test.support`](https://python-all.ru/3.2/library/test.html#module-test.support) используется для улучшения тестов, а `test.regrtest` управляет набором тестов.

Каждый модуль в пакете [`test`](https://python-all.ru/3.2/library/test.html#module-test), имя которого начинается с `test_`, является набором тестов для конкретного модуля или функции. Все новые тесты следует писать с использованием модуля [`unittest`](https://python-all.ru/3.2/library/unittest.html#module-unittest) или [`doctest`](https://python-all.ru/3.2/library/doctest.html#module-doctest). Некоторые старые тесты написаны в «традиционном» стиле тестирования, который сравнивает вывод, напечатанный в `sys.stdout`; такой стиль тестов считается устаревшим.

> **См. также**
>
> **Модуль [`unittest`](https://python-all.ru/3.2/library/unittest.html#module-unittest)**
>
> Написание регрессионных тестов PyUnit.
>
> **Модуль [`doctest`](https://python-all.ru/3.2/library/doctest.html#module-doctest)**
>
> Тесты, встроенные в строки документации.

## 25.5.1. Написание модульных тестов для пакета [`test`](https://python-all.ru/3.2/library/test.html#module-test)

Рекомендуется, чтобы тесты, использующие модуль [`unittest`](https://python-all.ru/3.2/library/unittest.html#module-unittest), следовали нескольким рекомендациям. Одна из них – называть тестовый модуль, начиная его с `test_` и заканчивая именем тестируемого модуля. Методы тестирования в тестовом модуле должны начинаться с `test_` и заканчиваться описанием того, что тестирует метод. Это необходимо, чтобы драйвер тестов распознавал методы как тестовые. Кроме того, не следует включать строку документации для метода. Вместо этого следует использовать комментарий (например, `# Тестирует функция возвращает только True или False`) для документирования тестовых методов. Это сделано потому, что строки документации выводятся на печать, если они существуют, и, таким образом, не указывается, какой именно тест выполняется.

Часто используется стандартная заготовка:

```python
import unittest
from test import support

class MyTestCase1(unittest.TestCase):

    # Используйте setUp() и tearDown() только при необходимости

    def setUp(self):
        ... code to execute in preparation for tests ...

    def tearDown(self):
        ... code to execute to clean up after tests ...

    def test_feature_one(self):
        # Тест первой возможности.
        ... testing code ...

    def test_feature_two(self):
        # Тест второй возможности.
        ... testing code ...

    ... more test methods ...

class MyTestCase2(unittest.TestCase):
    ... same structure as MyTestCase1 ...

... more test classes ...

def test_main():
    support.run_unittest(MyTestCase1,
                              MyTestCase2,
                              ... list other tests ...
                             )

if __name__ == '__main__':
    test_main()
```

Этот шаблонный код позволяет запускать тестовый набор как с помощью `test.regrtest`, так и самостоятельно в качестве скрипта.

Цель регрессионного тестирования – попытаться сломать код. Это приводит к нескольким правилам, которым следует следовать:

- Набор тестов должен задействовать все классы, функции и константы. Это включает не только внешний API, который будет представлен внешнему миру, но и «приватный» код.
- Предпочтительно тестирование методом белого ящика (анализ тестируемого кода при написании тестов). Тестирование методом чёрного ящика (тестирование только опубликованного пользовательского интерфейса) недостаточно для проверки всех граничных и крайних случаев.
- Убедитесь, что все возможные значения протестированы, включая недопустимые. Это гарантирует, что не только все допустимые значения принимаются, но и неправильные значения обрабатываются корректно.
- Исчерпайте как можно больше путей выполнения кода. Тестируйте места ветвления и соответственно подбирайте входные данные, чтобы гарантировать, что проходит как можно больше различных путей.
- Добавляйте явные тесты для любых ошибок, обнаруженных в тестируемом коде. Это гарантирует, что ошибка не возникнет снова, если код будет изменён в будущем.
- Убедитесь, что после тестов выполнена очистка (например, закрыты и удалены все временные файлы).
- Если тест зависит от конкретного условия операционной системы, то проверьте, что условие уже выполняется, прежде чем запускать тест.
- Импортируйте как можно меньше модулей и делайте это как можно раньше. Это минимизирует внешние зависимости тестов, а также уменьшает возможные аномальные поведения из-за побочных эффектов импорта модуля.
- Старайтесь максимально повторно использовать код. Иногда тесты могут различаться такой мелочью, как тип используемых входных данных. Минимизируйте дублирование кода, создавая подкласс базового тестового класса, который определяет входные данные:

  ```python
  class TestFuncAcceptsSequences(unittest.TestCase):

      func = mySuperWhammyFunction

      def test_func(self):
          self.func(self.arg)

  class AcceptLists(TestFuncAcceptsSequences):
      arg = [1, 2, 3]

  class AcceptStrings(TestFuncAcceptsSequences):
      arg = 'abc'

  class AcceptTuples(TestFuncAcceptsSequences):
      arg = (1, 2, 3)
  ```

> **См. также**
>
> **Разработка через тестирование**
>
> Книга Кента Бека о написании тестов до кода.

## 25.5.2. Запуск тестов с помощью интерфейса командной строки

Пакет [`test`](https://python-all.ru/3.2/library/test.html#module-test) можно запускать как скрипт для управления регрессионным набором тестов Python благодаря опции [*-m*](https://python-all.ru/3.2/using/cmdline.html#cmdoption-m): **python -m test**. Под капотом он использует `test.regrtest`; вызов **python -m test.regrtest**, использовавшийся в предыдущих версиях Python, всё ещё работает). Запуск скрипта самостоятельно автоматически запускает выполнение всех регрессионных тестов в пакете [`test`](https://python-all.ru/3.2/library/test.html#module-test). Это делается путём поиска всех модулей в пакете, имена которых начинаются с `test_`, их импорта и выполнения функции `test_main()`, если она присутствует. Имена тестов для выполнения также можно передать скрипту. Указание одного регрессионного теста (**python -m test test\_spam**) минимизирует вывод и печатает только результат теста (пройден или не пройден), тем самым минимизируя вывод.

Запуск [`test`](https://python-all.ru/3.2/library/test.html#module-test) напрямую позволяет задать, какие ресурсы доступны для использования тестам. Это делается с помощью опции командной строки `-u`. Указание `all` в качестве значения опции `-u` включает все возможные ресурсы: **python -m test -uall**. Если нужны все ресурсы, кроме одного (более частый случай), после `all` можно перечислить через запятую ресурсы, которые не нужны. Команда **python -m test -uall,-audio,-largefile** запустит [`test`](https://python-all.ru/3.2/library/test.html#module-test) со всеми ресурсами, кроме `audio` и `largefile`. Для списка всех ресурсов и дополнительных опций командной строки выполните **python -m test -h**.

Некоторые другие способы выполнения регрессионных тестов зависят от платформы, на которой они выполняются. В Unix можно выполнить **make test** в корневом каталоге, где был собран Python. В Windows выполнение **rt.bat** из каталога `PCBuild` запустит все регрессионные тесты.

# 25.6. [`test.support`](https://python-all.ru/3.2/library/test.html#module-test.support) – Утилиты для набора тестов Python

Модуль [`test.support`](https://python-all.ru/3.2/library/test.html#module-test.support) обеспечивает поддержку набора регрессионных тестов Python.

> **Примечание**
>
> [`test.support`](https://python-all.ru/3.2/library/test.html#module-test.support) не является публичным модулем. Он документирован здесь, чтобы помочь разработчикам Python писать тесты. API этого модуля может изменяться без обеспечения обратной совместимости между выпусками.

В этом модуле определены следующие исключения:

#### `exception test.support.TestFailed`

Исключение, возбуждаемое при сбое теста. Это устарело в пользу тестов на основе [`unittest`](https://python-all.ru/3.2/library/unittest.html#module-unittest) и методов утверждений [`unittest.TestCase`](https://python-all.ru/3.2/library/unittest.html#unittest.TestCase).

#### `exception test.support.ResourceDenied`

Подкласс [`unittest.SkipTest`](https://python-all.ru/3.2/library/unittest.html#unittest.SkipTest). Возбуждается, когда ресурс (например, сетевое соединение) недоступен. Возбуждается функцией [`requires()`](https://python-all.ru/3.2/library/test.html#test.support.requires).

Модуль [`test.support`](https://python-all.ru/3.2/library/test.html#module-test.support) определяет следующие константы:

#### `test.support.verbose`

[`True`](https://python-all.ru/3.2/library/constants.html#True), если включён подробный вывод. Следует проверять, когда требуется более детальная информация о выполняющемся тесте. *verbose* устанавливается `test.regrtest`.

#### `test.support.is_jython`

[`True`](https://python-all.ru/3.2/library/constants.html#True), если текущий интерпретатор – Jython.

#### `test.support.TESTFN`

Устанавливается в имя, безопасное для использования в качестве имени временного файла. Любой созданный временный файл должен быть закрыт и удалён.

Модуль [`test.support`](https://python-all.ru/3.2/library/test.html#module-test.support) определяет следующие функции:

#### `test.support.forget(module_name)`

Удаляет модуль с именем *module\_name* из `sys.modules` и удаляет все скомпилированные в байт-код файлы этого модуля.

#### `test.support.is_resource_enabled(resource)`

Возвращает [`True`](https://python-all.ru/3.2/library/constants.html#True), если *resource* включён и доступен. Список доступных ресурсов устанавливается только при выполнении тестов `test.regrtest`.

#### `test.support.requires(resource, msg=None)`

Вызывает [`ResourceDenied`](https://python-all.ru/3.2/library/test.html#test.support.ResourceDenied), если *resource* недоступен. *msg* – это аргумент для [`ResourceDenied`](https://python-all.ru/3.2/library/test.html#test.support.ResourceDenied), если он возбуждён. Всегда возвращает [`True`](https://python-all.ru/3.2/library/constants.html#True), если вызывается из функции, чьё `__name__` равно `'__main__'`. Используется при выполнении тестов `test.regrtest`.

#### `test.support.findfile(filename)`

Возвращает путь к файлу с именем *filename*. Если совпадений не найдено, возвращается *filename*. Это не считается ошибкой, так как оно может быть путём к файлу.

#### `test.support.run_unittest(*classes)`

Выполняет подклассы [`unittest.TestCase`](https://python-all.ru/3.2/library/unittest.html#unittest.TestCase), переданные в функцию. Функция просматривает классы в поисках методов, начинающихся с префикса `test_`, и выполняет тесты по отдельности.

Также допускается передача строк в качестве параметров; они должны быть ключами в `sys.modules`. Каждый соответствующий модуль будет просканирован с помощью `unittest.TestLoader.loadTestsFromModule()`. Обычно это встречается в следующей функции `test_main()`:

```python
def test_main():
    support.run_unittest(__name__)
```

Это запустит все тесты, определенные в указанном модуле.

#### `test.support.check_warnings(*filters, quiet=True)`

Удобная обёртка для [`warnings.catch_warnings()`](https://python-all.ru/3.2/library/warnings.html#warnings.catch_warnings), упрощающая проверку того, что предупреждение было правильно вызвано. Она примерно эквивалентна вызову `warnings.catch_warnings(record=True)` с [`warnings.simplefilter()`](https://python-all.ru/3.2/library/warnings.html#warnings.simplefilter), установленным в `always`, и возможностью автоматически проверять записанные результаты.

`check_warnings` принимает 2-кортежи вида `("message regexp", WarningCategory)` в качестве позиционных аргументов. Если указан один или несколько *filters*, или необязательный ключевой аргумент *quiet* равен [`False`](https://python-all.ru/3.2/library/constants.html#False), то проверяется, что предупреждения соответствуют ожидаемым: каждый указанный фильтр должен совпадать хотя бы с одним предупреждением, возбуждённым вложенным кодом, иначе тест не пройден; если возбуждены какие-либо предупреждения, не совпадающие ни с одним из указанных фильтров, тест также не пройден. Чтобы отключить первую из этих проверок, установите *quiet* в [`True`](https://python-all.ru/3.2/library/constants.html#True).

Если аргументы не указаны, по умолчанию используется:

```python
check_warnings(("", Warning), quiet=True)
```

В этом случае перехватываются все предупреждения и исключения не возбуждаются.

При входе в контекстный менеджер возвращается экземпляр `WarningRecorder`. Базовый список предупреждений из [`catch_warnings()`](https://python-all.ru/3.2/library/warnings.html#warnings.catch_warnings) доступен через атрибут [`warnings`](https://python-all.ru/3.2/library/warnings.html#module-warnings) объекта-регистратора. Для удобства атрибуты объекта, представляющего самое последнее предупреждение, также можно получить напрямую через объект-регистратор (см. пример ниже). Если предупреждений не было, то любой из атрибутов, которые обычно ожидаются у объекта, представляющего предупреждение, вернёт [`None`](https://python-all.ru/3.2/library/constants.html#None).

Объект recorder также имеет метод `reset()`, который очищает список предупреждений.

Менеджер контекста предназначен для использования следующим образом:

```python
with check_warnings(("assertion is always true", SyntaxWarning),
                    ("", UserWarning)):
    exec('assert(False, "Hey!")')
    warnings.warn(UserWarning("Hide me!"))
```

В этом случае, если одно из предупреждений не было вызвано или было вызвано другое предупреждение, [`check_warnings()`](https://python-all.ru/3.2/library/test.html#test.support.check_warnings) вызовет ошибку.

Когда тесту требуется более глубоко изучить предупреждения, а не просто проверить, были ли они, можно использовать такой код:

```python
with check_warnings(quiet=True) as w:
    warnings.warn("foo")
    assert str(w.args[0]) == "foo"
    warnings.warn("bar")
    assert str(w.args[0]) == "bar"
    assert str(w.warnings[0].args[0]) == "foo"
    assert str(w.warnings[1].args[0]) == "bar"
    w.reset()
    assert len(w.warnings) == 0
```

Здесь будут перехвачены все предупреждения, и тестовый код напрямую проверяет перехваченные предупреждения.

Изменено в версии 3.2: Новые необязательные аргументы *filters* и *quiet*.

#### `test.support.captured_stdout()`

Это контекстный менеджер, который выполняет тело инструкции [`with`](https://python-all.ru/3.2/reference/compound_stmts.html#with), используя объект `StringIO.StringIO` в качестве sys.stdout. Этот объект можно получить с помощью предложения `as` инструкции [`with`](https://python-all.ru/3.2/reference/compound_stmts.html#with).

Пример использования:

```python
with captured_stdout() as s:
    print("hello")
assert s.getvalue() == "hello\n"
```

#### `test.support.suppress_crash_popup()`

Контекстный менеджер, отключающий диалоги отчётов об ошибках Windows с помощью [SetErrorMode](https://python-all.ru/3.2/library/test.html). На других платформах он не выполняет никаких действий.

#### `test.support.import_module(name, deprecated=False)`

Эта функция импортирует и возвращает указанный модуль. В отличие от обычного импорта, если модуль не удается импортировать, функция генерирует исключение [`unittest.SkipTest`](https://python-all.ru/3.2/library/unittest.html#unittest.SkipTest).

Сообщения об устаревании модулей и пакетов подавляются во время этого импорта, если *устарело* равно [`True`](https://python-all.ru/3.2/library/constants.html#True).

Новое в версии 3.1.

#### `test.support.import_fresh_module(name, fresh=(), blocked=(), deprecated=False)`

Эта функция импортирует и возвращает свежую копию указанного модуля Python, удаляя его из `sys.modules` перед выполнением импорта. Обратите внимание, что, в отличие от `reload()`, оригинальный модуль не затрагивается этой операцией.

Параметр *fresh* – это итерируемая последовательность дополнительных имен модулей, которые также удаляются из кеша `sys.modules` перед выполнением импорта.

*blocked* – это итерируемый объект с именами модулей, которые заменяются на `0` в кеше модулей во время импорта, чтобы гарантировать, что попытки их импорта вызовут [`ImportError`](https://python-all.ru/3.2/library/exceptions.html#ImportError).

Указанный модуль и все модули, перечисленные в параметрах *fresh* и *blocked*, сохраняются до начала импорта, а затем повторно вставляются в `sys.modules` после завершения свежего импорта.

Сообщения об устаревании модулей и пакетов подавляются во время этого импорта, если *устарело* равно [`True`](https://python-all.ru/3.2/library/constants.html#True).

Эта функция вызовет [`unittest.SkipTest`](https://python-all.ru/3.2/library/unittest.html#unittest.SkipTest), если указанный модуль не удаётся импортировать.

Пример использования:

```python
# Получить копии модуля warnings для тестирования без
# влияния на версию, используемую остальной частью тестового набора
# Одна копия использует реализацию на C, другая вынуждена использовать
# резервную реализацию на чистом Python
py_warnings = import_fresh_module('warnings', blocked=['_warnings'])
c_warnings = import_fresh_module('warnings', fresh=['_warnings'])
```

Новое в версии 3.1.

Модуль [`test.support`](https://python-all.ru/3.2/library/test.html#module-test.support) определяет следующие классы:

#### `class test.support.TransientResource(exc, **kwargs)`

Экземпляры представляют собой менеджер контекста, который генерирует исключение [`ResourceDenied`](https://python-all.ru/3.2/library/test.html#test.support.ResourceDenied), если возникает указанный тип исключения. Все именованные аргументы обрабатываются как пары атрибут/значение для сравнения с любым исключением, возникшим внутри блока [`with`](https://python-all.ru/3.2/reference/compound_stmts.html#with). Исключение [`ResourceDenied`](https://python-all.ru/3.2/library/test.html#test.support.ResourceDenied) возбуждается только в том случае, если все пары правильно совпадают с атрибутами исключения.

#### `class test.support.EnvironmentVarGuard`

Класс, используемый для временной установки или сброса переменных окружения. Экземпляры можно использовать как менеджер контекста; они имеют полноценный интерфейс словаря для запроса/изменения базового `os.environ`. После выхода из менеджера контекста все изменения переменных окружения, сделанные через этот экземпляр, будут отменены.

Изменено в версии 3.1: Добавлен интерфейс словаря.

#### `EnvironmentVarGuard.set(envvar, value)`

Временно устанавливает переменную окружения `envvar` в значение `value`.

#### `EnvironmentVarGuard.unset(envvar)`

Временно сбрасывает переменную окружения `envvar`.

#### `class test.support.WarningsRecorder`

Класс, используемый для записи предупреждений в модульных тестах. Дополнительные сведения см. в описании [`check_warnings()`](https://python-all.ru/3.2/library/test.html#test.support.check_warnings) выше.