fsl.utils.deprecated

This module provides the deprecated() function, a simple decorator for deprecating functions and methods.

fsl.utils.deprecated.deprecated(vin=None, rin=None, msg=None)

Decorator to mark a function or method as deprecated. A DeprecationWarning is raised via the standard warnings module.

Parameters
  • vin – Optional version - the warning message will mention that the function is deprecated from this version.

  • rin – Optional version - the warning message will mention that the function will be removed in this version.

  • msg – Optional message to use in the warning.