maha.deprecation#

Module Contents#

Functions#

deprecated_fn(from_v, to_v, alt_fn[, message])

Decorator to mark a function as deprecated.

deprecated_param(from_v, to_v, depr_param[, ...])

Decorator to mark a parameter as deprecated.

deprecated_default(from_v, to_v, depr_param)

Decorator to mark a parameter default value as deprecated.
deprecated_fn(from_v, to_v, alt_fn, message='')[source]#

Decorator to mark a function as deprecated.

Parameters

  • from_v (str) – Version from since the function is deprecated

  • to_v (str) – Version from which the function is removed

  • alt_fn (str) – New function to replace the deprecated function

  • message (str) – Message to display when the function is called

Returns

The decorated function

Return type

function

deprecated_param(from_v, to_v, depr_param, alt_param=None, message='')[source]#

Decorator to mark a parameter as deprecated.

Parameters

  • from_v (str) – Version since which the parameter is deprecated

  • to_v (str) – Version from which the parameter is removed

  • depr_param (str) – Parameter to deprecate

  • alt_param (str) – Parameter to use instead

  • message (str) – Message to display when the function is called

Returns

The decorated function

Return type

function

deprecated_default(from_v, to_v, depr_param, alt_value=None, message='')[source]#

Decorator to mark a parameter default value as deprecated.

Parameters

  • from_v (str) – Version since which the parameter is deprecated

  • to_v (str) – Version from which the parameter is removed

  • depr_param (str) – Parameter to deprecate its default value

  • alt_value (str) – New default value that will used instead

  • message (str) – Message to display when the function is called

Returns

The decorated function

Return type

function