swtloc.utils.deprecated_wrapper

swtloc.utils.deprecated_wrapper(reason: str, in_favour_of: str, removed_in: str, relocated: Optional[bool] = False)[source]

A decorator to mark the deprecated functions and give the reason of deprecation. Alongside the reason, also inform in which version will the function be removed. If the function is being relocated then also inform in favour of which function will this function will be relocated :param reason: Reason for relocation/deprecation :type reason: str :param in_favour_of: If relocated, in favour of which function is this

function being relocated

Parameters

removed_in (str) – In which version will the function be removed
relocated (Optional[bool]) – Is the deprecation for being relocated