deprecation_warning

lib.utils.deprecation_warning(function: str, additional_info: str | None = None) → None

Log a deprecation warning message.

This function logs a warning message to indicate that the specified function has been deprecated and will be removed in future. An optional additional message can also be included.

Parameters:

• function (str) – The name of the function that will be deprecated.

• additional_info (str | None) – Any additional information to display with the deprecation message. Default: None

Return type:

None

Example

>>> from lib.utils import deprecation_warning
>>> deprecation_warning('old_function', 'Use new_function instead.')