Skip to content

add _keep_as to return guidance msg #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Faezehabibi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add _keep_as to return guidance msg #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion ngcsimlib/deprecators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ def _wrapped(*args, **kwargs):
return _wrapped


def deprecate_args(_rebind=True, **arg_list):
def deprecate_args(_rebind=True, _keep_as=None, **arg_list):
def _deprecate_args(fn):
def _wrapped(*args, **kwargs):
for kwarg in list(kwargs.keys()):
Expand All @@ -19,6 +19,10 @@ def _wrapped(*args, **kwargs):
else:
warn(f"The argument \"{kwarg}\" is deprecated for {fn.__qualname__}, use \"{new_kwarg}\" instead")

if _keep_as is not None:
warn(f"Set {new_kwarg}={_keep_as} for preserving the same behavior")


if _rebind:
if new_kwarg is not None:
kwargs[new_kwarg] = kwargs[kwarg]
Expand Down