Предупреждения Python: полное руководство по управлению

Расширенные примеры работы с предупреждениями

Создание пользовательской категории предупреждений

Можно определить свой класс, унаследованный от Warning, и использовать его для специфических предупреждений.

import warnings

class MySpecialWarning(Warning):
    pass

def risky_function():
    warnings.warn('Это пользовательское предупреждение', MySpecialWarning)

# Фильтруем только наше предупреждение
warnings.filterwarnings('error', category=MySpecialWarning)

try:
    risky_function()
except MySpecialWarning as e:
    print(f'Поймано пользовательское предупреждение: {e}')

Поймано пользовательское предупреждение: Это пользовательское предупреждение

Использование контекстного менеджера для записи предупреждений

warnings.catch_warnings(record=True) перехватывает все предупреждения внутри блока и сохраняет их в список.

import warnings

with warnings.catch_warnings(record=True) as w:
    warnings.simplefilter('always')  # ловить все
    warnings.warn('Первое', UserWarning)
    warnings.warn('Второе', DeprecationWarning)
    print(f'Перехвачено {len(w)} предупреждений')
    for warning in w:
        print(f'Категория: {warning.category.__name__}, сообщение: {warning.message}')

Перехвачено 2 предупреждений
Категория: UserWarning, сообщение: Первое
Категория: DeprecationWarning, сообщение: Второе

Фильтрация по имени модуля

Можно настроить игнорирование предупреждений только из определённого модуля, используя параметр module.

import warnings

# Игнорировать DeprecationWarning только из модуля 'numpy'
warnings.filterwarnings('ignore', category=DeprecationWarning, module='numpy')

import numpy as np
# Если numpy когда-нибудь выдаст DeprecationWarning, он будет скрыт

Параметр module принимает регулярное выражение (через re). Например, 'numpy\.*'.

Сброс всех фильтров к состоянию по умолчанию

warnings.resetwarnings() удаляет все заданные программой фильтры и возвращает стандартное поведение.

import warnings

warnings.simplefilter('ignore')
print('Фильтры изменены')
warnings.resetwarnings()
print('Фильтры сброшены')
warnings.warn('Это снова видно')

Фильтры изменены
Фильтры сброшены
script.py:7: UserWarning: Это снова видно

Предупреждения в многопоточном коде

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

import warnings
import threading

def worker():
    # В дочернем потоке другой контекст
    with warnings.catch_warnings():
        warnings.simplefilter('ignore')
        warnings.warn('Из потока не видно')
    # Здесь предупреждение не подавлено, если не настроено глобально
    warnings.warn('Из потока видно')

thread = threading.Thread(target=worker)
thread.start()
thread.join()
# В главном потоке свой контекст
warnings.warn('Главный поток')

Результат зависит от того, какие фильтры установлены в главном потоке. В примере выше в главном потоке никакие фильтры не менялись, поэтому все три предупреждения (кроме первого, которое подавлено внутри catch_warnings) будут выведены.

Логирование предупреждений через модуль logging

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

import warnings
import logging

logging.basicConfig(level=logging.WARNING, format='%(levelname)s - %(message)s')

def log_warning(message, category, filename, lineno, file=None, line=None):
    logger = logging.getLogger(category.__name__)
    logger.warning(f'{filename}:{lineno}: {message}')

warnings.showwarning = log_warning

warnings.warn('Тест лога')

WARNING - UserWarning: script.py:10: Тест лога

Тестирование кода с предупреждениями (pytest)

Библиотека pytest предоставляет встроенный контекст pytest.warns для проверки, что код выдает определённое предупреждение.

# content of test_warnings.py
import warnings
import pytest

def deprecated_function():
    warnings.warn('use new version', DeprecationWarning)

def test_deprecation():
    with pytest.warns(DeprecationWarning):
        deprecated_function()

$ pytest test_warnings.py -v
...
test_warnings.py::test_deprecation PASSED

Если предупреждение не будет выдано, тест упадет.