Модуль 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/.match?(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);
    return RBOOL(rb_warning_category_enabled_p(cat));
}

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

:deprecated

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

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

и т.д.

:experimental

экспериментальные функции

:performance

подсказки по производительности

Предел изменения формы

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.[] для категорий.

categories → массив

Исходный код

static VALUE
rb_warning_s_categories(VALUE mod)
{
    st_index_t num = warning_categories.id2enum->num_entries;
    ID *ids = ALLOCA_N(ID, num);
    num = st_keys(warning_categories.id2enum, ids, num);
    VALUE ary = rb_ary_new_capa(num);
    for (st_index_t i = 0; i < num; ++i) {
        rb_ary_push(ary, ID2SYM(ids[i]));
    }
    return rb_ary_freeze(ary);
}

Возвращает список поддерживаемых символов категорий.

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

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–2024 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.