重新定位的模块

(函数来自 pyomo.common.deprecation)

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

已弃用。

为移动/重命名的模块提供弃用路径

导入时，旧模块（调用了relocated_module()的模块）将在sys.modules中被一个直接指向新模块的别名替换。因此，旧模块应该只有两行可执行的Python代码（导入relocated_module并调用它）。

注意

此方法（位于即将移除的旧模块中）已被弃用，应替换为调用moved_module()，该调用可以在移除模块的任何父作用域中进行，并且不需要旧模块继续存在于项目中。

Parameters:

  • new_name (str) – 新的（完全限定的）模块名称

  • msg (str) – 自定义的弃用消息。

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

  • version (str [required]) – 模块被重命名或移动的版本。通常的做法是在开发过程中将版本设置为当前开发版本（来自pyomo –version），并在发布过程中将其更新为实际发布版本。

  • remove_in (str) – 模块将从代码中移除的版本。

示例

>>> from pyomo.common.deprecation import relocated_module
>>> relocated_module('pyomo.common.deprecation', version='1.2.3')
WARNING: DEPRECATED: ... The '...' module has been moved to
    'pyomo.common.deprecation'. Please update your import.
    (deprecated in 1.2.3) ...

自版本6.8.1起已弃用：relocated_module() 已被弃用。请使用 moved_module()