relocated_module_attribute

(function from pyomo.common.deprecation)

pyomo.common.deprecation.relocated_module_attribute(local, target, version, remove_in=None, msg=None, f_globals=None)[source]

Provide a deprecation path for moved / renamed module attributes

This function declares that a local module attribute has been moved to another location. For Python 3.7+, it leverages a module.__getattr__ method to manage the deferred import of the object from the new location (on request), as well as emitting the deprecation warning.

Parameters:

  • local (str) – The original (local) name of the relocated attribute

  • target (str) – The new absolute import name of the relocated attribute

  • version (str) – The Pyomo version when this move was released (passed to deprecation_warning)

  • remove_in (str) – The Pyomo version when this deprecation path will be removed (passed to deprecation_warning)

  • msg (str) – If not None, then this specifies a custom deprecation message to be emitted when the attribute is accessed from its original location.