模块 Warning

Warning 模块包含一个名为 warn 的方法，并且该模块会扩展自身，使 Warning.warn 可用。Ruby 发出的所有警告都会调用 Warning.warn。默认情况下，警告会打印到 $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 gem 提供自定义 Warning.warn 的便捷方法。

公共类方法

Warning[category] → true 或 false 点击以切换源代码

返回显示 category 的警告消息的标志。支持的类别有

:deprecated

弃用警告

为 $, 和 $; 赋值非空值
关键字参数

等等。

:experimental

实验性功能

:performance

性能提示

形状变化限制

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));
}

Warning[category] = flag → flag 点击以切换源代码

设置 category 的警告标志。请参阅 Warning.[] 查看类别。

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;
}

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 点击以切换源代码

将警告消息 msg 写入 $stderr。Ruby 为所有发出的警告调用此方法。警告中可能包含一个 category。

有关如何自定义此方法，请参阅 Warning 模块的文档。

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;
}