simpeg.utils.deprecate_property#
- simpeg.utils.deprecate_property(prop, old_name, new_name=None, removal_version=None, future_warn=False, error=False)[source]#
Deprecate property
- Parameters:
- prop
property
Current property
- old_name
str
Original name for the now deprecated property
- new_name
str
,optional
New name for the property. If
None
, the property name is take from the prop input argument.- removal_version
str
,optional
SimPEG version in which the property will be removed from the code base
- future_warnbool, default:
False
If
True
, throw comprehensive warning the property will be deprecated- errorbool, default:
False
Throw error if deprecated property no longer implemented
- prop
- Returns:
property
The new property