numpy.testing.suppress_warnings

class numpy.testing.suppress_warnings(forwarding_rule='always') [source]

Менеджер контекста и декоратор, выполняющий примерно то же самое, что и warnings.catch_warnings.

Однако он также предоставляет механизм фильтрации для решения проблем с https://bugs.python.org/issue4180.

Эта ошибка приводит к тому, что Python до версии 3.4 не обеспечивает надёжного повторного отображения предупреждений после их игнорирования (даже внутри catch_warnings). Это означает, что фильтры "игнорирования" нельзя легко использовать, так как последующие тесты могут потребовать увидеть предупреждение. Кроме того, это позволяет более легко тестировать предупреждения и может использоваться вложенно.

Параметры:

forwarding_rule : str, optional Одно из значений "всегда", "один раз", "модуль" или "местоположение". Аналогично обычному режиму фильтра модуля предупреждений, он полезен для уменьшения шума в основном на самом верхнем уровне. Неподавляемые и незаписываемые предупреждения будут пересылаться в соответствии с этим правилом. По умолчанию равно "всегда". "местоположение" эквивалентно предупреждению "по умолчанию", совпадает с точным местоположением, откуда исходит предупреждение.

Примечания

Фильтры, добавленные внутри менеджера контекста, будут удалены при выходе из него. При входе все фильтры, определённые вне контекста, будут автоматически применены.

Когда добавляется фильтр записи, соответствующие предупреждения сохраняются в атрибуте log а также в списке, возвращаемом record.

Если добавлены фильтры и указан ключевой параметр module, регистр предупреждений этого модуля дополнительно будет очищен при его применении, при входе в контекст или при выходе из него. Это может привести к повторному появлению предупреждений после выхода из контекста, если они были настроены на вывод один раз (по умолчанию) и уже были выведены до входа в контекст.

Вложенность этого менеджера контекста будет работать как ожидается, когда правило пересылки равно "всегда" (по умолчанию). Неотфильтрованные и незарегистрированные предупреждения будут пересылаться и соответствовать внешнему уровню. На внешнем уровне они будут выведены (или перехвачены другим контекстом предупреждений). Аргумент правила пересылки может изменить это поведение.

Как и catch_warnings, этот менеджер контекста не является потокобезопасным.

Примеры

С менеджером контекста:

with np.testing.suppress_warnings() as sup:
    sup.filter(DeprecationWarning, "Some text")
    sup.filter(module=np.ma.core)
    log = sup.record(FutureWarning, "Does this occur?")
    command_giving_warnings()
    # The FutureWarning was given once, the filtered warnings were
    # ignored. All other warnings abide outside settings (may be
    # printed/error)
    assert_(len(log) == 1)
    assert_(len(sup.log) == 1)  # also stored in log attribute

Или как декоратор:

sup = np.testing.suppress_warnings()
sup.filter(module=np.ma.core)  # module must match exactly
@sup
def some_function():
    # do something which causes a warning in np.ma.core
    pass

Методы

__call__(func)	Декоратор функции для применения определённых подавлений к всей функции.
filter([category, message, module])	Добавить новый фильтр подавления или применить его, если состояние введено.
record([category, message, module])	Добавить новый фильтр записи или применить его, если состояние введено.