deprecate#

Module that provides a method to handle deprecated arguments.

Functions:

all_deprecators(deprecate_arg_mappings, ...)

Decorator that applies multiple deprecators to a function.

deprecate_argument(old_arg, new_arg[, ...])

Warns that the argument provided is deprecated and automatically replaces the deprecated argument with the appropriate new argument.

deprecate_arguments(converter[, warning_cls])

Warns that the arguments provided are deprecated and automatically replaces the deprecated arguments with the appropriate new arguments.

ansys.fluent.core.utils.deprecate.all_deprecators(deprecate_arg_mappings, data_type_converter, deprecated_version, deprecated_reason, warn_message)#

Decorator that applies multiple deprecators to a function.

ansys.fluent.core.utils.deprecate.deprecate_argument(old_arg, new_arg, converter=<function <lambda>>, warning_cls=<class 'ansys.fluent.core.pyfluent_warnings.PyFluentDeprecationWarning'>, **kwds)#

Warns that the argument provided is deprecated and automatically replaces the deprecated argument with the appropriate new argument.

ansys.fluent.core.utils.deprecate.deprecate_arguments(converter, warning_cls=<class 'ansys.fluent.core.pyfluent_warnings.PyFluentDeprecationWarning'>)#

Warns that the arguments provided are deprecated and automatically replaces the deprecated arguments with the appropriate new arguments.