validate_arg_type

(函数来自 pyomo.contrib.pyros.uncertainty_sets)

pyomo.contrib.pyros.uncertainty_sets.validate_arg_type(arg_name, arg_val, valid_types, valid_type_desc=None, is_entry_of_arg=False, check_numeric_type_finite=True)[source]

对函数/方法的参数执行类型验证。 如果类型无效,则引发一个带有适当消息的TypeError。

Parameters:
  • arg_name (str) – 要在异常消息中显示的参数名称。

  • arg_val (object) – 要检查的参数的值。

  • valid_types (typetupletypes) – 参数值的有效类型。

  • valid_type_desc (strNone, 可选) – 参数值的有效类型描述; 此描述包含在异常消息中。

  • is_entry_of_arg (bool, optional) – 传递的参数值是否是arg_name描述的参数的条目(例如数组或列表的条目)。 这将在异常消息中指示。 默认值为False

  • check_numeric_type_finite (bool, optional) – 如果有效类型包括一系列数值类型, 检查参数值是否为有限值(且不为NaN)。 默认值为 True

Raises:
  • TypeError – 如果参数值不是有效类型。

  • ValueError – 如果对数值的有限性检查返回负结果。