已弃用

(函数来自 pyomo.common.deprecation)

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

装饰器，用于指示某个函数、方法或类已弃用。

此装饰器将在调用被包装的函数或方法时，或在构建已弃用的类时记录警告。此装饰器还会更新目标对象的文档字符串，以指示其已被弃用。

Parameters:

  • msg (str) – 自定义的弃用消息（默认：“此{函数|类}已被弃用，并可能在未来的版本中被移除。”）

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

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

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

示例

>>> from pyomo.common.deprecation import deprecated
>>> @deprecated(version='1.2.3')
... def sample_function(x):
...     return 2*x
>>> sample_function(5)
WARNING: DEPRECATED: This function (sample_function) has been deprecated and
    may be removed in a future release.  (deprecated in 1.2.3) ...
10