弃用警告

(函数来自 pyomo.common.deprecation)

pyomo.common.deprecation.deprecation_warning(msg, logger=None, version=None, remove_in=None, calling_frame=None)[source]

弃用警告的标准化格式化程序

这是一个用于格式化弃用警告的标准化例程，以使内容看起来一致且“美观”。

Parameters:

  • msg (str) – 要格式化的弃用消息

  • logger (str) – 用于发出警告的日志记录器 （默认：调用的pyomo包，或“pyomo”）

  • version (str) – [必填] 装饰对象被弃用的版本。通常的做法是在开发过程中将版本设置为当前开发版本（来自pyomo –version），并在发布过程中将其更新为实际发布版本。

  • remove_in (str) – 装饰对象将从代码中移除的版本。

  • calling_frame (frame) – 触发弃用警告的原始帧上下文。

示例

>>> from pyomo.common.deprecation import deprecation_warning
>>> deprecation_warning('This functionality is deprecated.', version='1.2.3')
WARNING: DEPRECATED: This functionality is deprecated.  (deprecated in 1.2.3) ...