Модуль Warning

Модуль Warning содержит единственный метод с именем warn, и модуль расширяет себя, делая Warning.warn доступным. Warning.warn вызывается для всех предупреждений, выпущенных Ruby. По умолчанию предупреждения выводятся в $stderr.

Изменение поведения Warning.warn полезно для настройки того, как Ruby обрабатывает предупреждения, например, для фильтрации некоторых предупреждений и/или вывода предупреждений в другое место, кроме $stderr.

Если вы хотите изменить поведение Warning.warn, вы должны использовать +Warning.extend(MyNewModuleWithWarnMethod)+, и вы можете использовать `super`, чтобы получить стандартное поведение вывода предупреждения в $stderr.

Пример:

module MyWarningFilter
  def warn(message, category: nil, **kwargs)
    if /some warning I want to ignore/.matches?(message)
      # ignore
    else
      super
    end
  end
end
Warning.extend MyWarningFilter

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

Джем warning предоставляет удобные способы настройки Warning.warn.

Публичные методы класса

Warning[category] → true или false Показать исходный код

static VALUE
rb_warning_s_aref(VALUE mod, VALUE category)
{
    rb_warning_category_t cat = rb_warning_category_from_name(category);
    if (rb_warning_category_enabled_p(cat))
        return Qtrue;
    return Qfalse;
}

Возвращает флаг для отображения сообщений о предупреждениях для category. Поддерживаемые категории:

:deprecated: предупреждения о устаревании

присваивание ненулевого значения $, и $;
ключевые аргументы
proc/lambda без блока

и т.д.

:experimental: экспериментальные возможности

Сопоставление с образцом

Warning[category] = flag → flag Показать исходный код

static VALUE
rb_warning_s_aset(VALUE mod, VALUE category, VALUE flag)
{
    unsigned int mask = rb_warning_category_mask(category);
    unsigned int disabled = warning_disabled_categories;
    if (!RTEST(flag))
        disabled |= mask;
    else
        disabled &= ~mask;
    warning_disabled_categories = disabled;
    return flag;
}

Устанавливает флаги предупреждений для category. См. Warning.[] для категорий.

Публичные методы экземпляра

warn(msg, category: nil) → nil Показать исходный код

static VALUE
rb_warning_s_warn(int argc, VALUE *argv, VALUE mod)
{
    VALUE str;
    VALUE opt;
    VALUE category = Qnil;

    rb_scan_args(argc, argv, "1:", &str, &opt);
    if (!NIL_P(opt)) rb_get_kwargs(opt, &id_category, 0, 1, &category);

    Check_Type(str, T_STRING);
    rb_must_asciicompat(str);
    if (!NIL_P(category)) {
        rb_warning_category_t cat = rb_warning_category_from_name(category);
        if (!rb_warning_category_enabled_p(cat)) return Qnil;
    }
    rb_write_error_str(str);
    return Qnil;
}

Записывает сообщение о предупреждении msg в $stderr. Этот метод вызывается Ruby для всех выводимых предупреждений. С предупреждением может быть включен category.

См. документацию модуля Warning о том, как настроить это.

Ruby Core © 1993–2020 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.