модуль Warning

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

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

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

Пример:

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 or 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 → array Показать исходный код

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