hexrd.deprecation module

exception hexrd.deprecation.DeprecatedFunctionError[source]

Bases: Exception

Custom exception for deprecated functions.

hexrd.deprecation.deprecated(new_func: str = None, removal_date: str = None)[source]: Decorator to mark functions as deprecated. Raises an error if the ‘ACK_DEPRECATED’ environment variable is not set. Alerts the user to the replacement function if provided.