Deprecated decorators

[ericspod]

Signed-off-by: Eric Kerfoot eric.kerfoot@kcl.ac.uk

Fixes #2335 .

Description

This adds a "deprecated" decorator to apply to functions, methods, and classes to designate them deprecated. A "deprecated_arg" decorator is provided to apply to callables to designate a particular argument as deprecated. Both decorators use the MONAI version to determine if they should issue a warning or raise an exception depending on what version they have been deprecated or removed on.

Status

Ready

Types of changes

• Non-breaking change (fix or new feature that would not break existing functionality).
• Breaking change (fix or new feature that would cause existing functionality to change).
• New tests added to cover the changes.
• Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
• Quick tests passed locally by running ./runtests.sh --quick --unittests.
• In-line docstrings updated.
• Documentation updated, tested make html command in the docs/ folder.

[ericspod]

/black

[ericspod]

The lock will only ensure the warnings are issued once if warnings get issued on the parent process before multiprocessing begins, otherwise each subprocess will issue the warning once.

I was going to discuss what to do about the docstring. Other packages that provide deprecation decorators such as this do update the docstring but we should decide on how and what style we will use.

Also the flake8-py3 error I'm getting is related to the test environment?

[Nic-Ma]

Hi @ericspod ,

I think all the open PRs have this same flake8 issue now.

Thanks.

[wyli]

I tested cases when test_version > next_version > prev_version, some of the DeprecatedError were missing

[wyli]

thanks, it works fine with the pytorch loader, it doesn't break any existing modules, could be merged as an initial solution.

[wyli]

/black