Как рабатать с предупреждениями в pytest

• 14.09.2023
• 304
• Библиотеки Python
• Pytest

В процессе работы с тестами на Python и с использованием pytest, разработчики могут столкнуться с различными предупреждениями (warnings). Эти предупреждения могут быть связаны с использованием устаревших методов, непреднамеренными побочными эффектами и другими проблемами.

pytest предоставляет инструменты для обработки и управления этими предупреждениями.

Просмотр предупреждений

При выполнении тестов, pytest автоматически выводит все предупреждения. Но если вы хотите видеть дополнительные детали, вы можете использовать флаг -rw:

pytest -rw

Превращение предупреждений в ошибки

Если вы хотите превратить определенные предупреждения в ошибки, чтобы прервать выполнение тестов, используйте опцию -W error:

pytest -W error

Это особенно полезно, если вы хотите удостовериться, что ваш код не вызывает никаких предупреждений.

Игнорирование предупреждений

В некоторых случаях, особенно когда предупреждения вызваны сторонними библиотеками, вы можете захотеть игнорировать их. Это можно сделать с помощью флага -W ignore:

pytest -W ignore::DeprecationWarning

Фильтрация предупреждений

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

pytest -W "ignore::UserWarning" -W "default::DeprecationWarning:my_module.*"

Этот пример игнорирует все UserWarning и устанавливает уровень по умолчанию для DeprecationWarning, вызванных модулем my_module.

Собственные предупреждения

Вы можете генерировать свои предупреждения в тестах с использованием модуля warnings Python. Это полезно, если вы хотите предупредить о каких-либо специфичных сценариях или потенциальных проблемах в вашем тестовом коде.

import warnings

def test_custom_warning():
    warnings.warn("Это мое собственное предупреждение!", UserWarning)

Передача фильтров предупреждений через pytest.ini

Если у вас много различных настроек фильтрации предупреждений и вы не хотите передавать их каждый раз через командную строку, вы можете установить фильтры в файле pytest.ini:

[pytest]
filterwarnings =
    ignore::UserWarning
    default::DeprecationWarning:my_module.*

Проверка отсутствия предупреждений

Иногда полезно удостовериться, что ваш код или тесты не генерируют предупреждений. Вы можете сделать это с помощью маркировки pytest.mark.filterwarnings:

@pytest.mark.filterwarnings("error")
def test_no_warnings():
    ...

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

Заключение

Предупреждения в тестах и коде — это важный инструмент, который помогает разработчикам узнавать о потенциальных проблемах и устаревших методах. С помощью pytest разработчики могут эффективно управлять и контролировать эти предупреждения, делая свой код более надежным и поддерживаемым.