mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
cmd_runner mod util: improvements (#8479)
* deprecate ignore_none in context * add changelog frag * raise deprecation notice when passing ignore_value_none to context * simplify deprecation logic
This commit is contained in:
parent
49e2a8633e
commit
71f9674835
2 changed files with 26 additions and 4 deletions
4
changelogs/fragments/8479-cmdrunner-improvements.yml
Normal file
4
changelogs/fragments/8479-cmdrunner-improvements.yml
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
deprecated_features:
|
||||||
|
- CmdRunner module util - setting the value of the ``ignore_none`` parameter within a ``CmdRunner`` context is deprecated and that feature should be removed in community.general 12.0.0 (https://github.com/ansible-collections/community.general/pull/8479).
|
||||||
|
minor_changes:
|
||||||
|
- CmdRunner module util - argument formats can be specified as plain functions without calling ``cmd_runner_fmt.as_func()`` (https://github.com/ansible-collections/community.general/pull/8479).
|
|
@ -89,12 +89,15 @@ class FormatError(CmdRunnerException):
|
||||||
|
|
||||||
|
|
||||||
class _ArgFormat(object):
|
class _ArgFormat(object):
|
||||||
|
# DEPRECATION: set default value for ignore_none to True in community.general 12.0.0
|
||||||
def __init__(self, func, ignore_none=None, ignore_missing_value=False):
|
def __init__(self, func, ignore_none=None, ignore_missing_value=False):
|
||||||
self.func = func
|
self.func = func
|
||||||
self.ignore_none = ignore_none
|
self.ignore_none = ignore_none
|
||||||
self.ignore_missing_value = ignore_missing_value
|
self.ignore_missing_value = ignore_missing_value
|
||||||
|
|
||||||
|
# DEPRECATION: remove parameter ctx_ignore_none in community.general 12.0.0
|
||||||
def __call__(self, value, ctx_ignore_none=True):
|
def __call__(self, value, ctx_ignore_none=True):
|
||||||
|
# DEPRECATION: replace ctx_ignore_none with True in community.general 12.0.0
|
||||||
ignore_none = self.ignore_none if self.ignore_none is not None else ctx_ignore_none
|
ignore_none = self.ignore_none if self.ignore_none is not None else ctx_ignore_none
|
||||||
if value is None and ignore_none:
|
if value is None and ignore_none:
|
||||||
return []
|
return []
|
||||||
|
@ -227,7 +230,11 @@ class CmdRunner(object):
|
||||||
self.default_args_order = self._prepare_args_order(default_args_order)
|
self.default_args_order = self._prepare_args_order(default_args_order)
|
||||||
if arg_formats is None:
|
if arg_formats is None:
|
||||||
arg_formats = {}
|
arg_formats = {}
|
||||||
self.arg_formats = dict(arg_formats)
|
self.arg_formats = {}
|
||||||
|
for fmt_name, fmt in arg_formats.items():
|
||||||
|
if not isinstance(fmt, _ArgFormat):
|
||||||
|
fmt = _Format.as_func(func=fmt, ignore_none=True)
|
||||||
|
self.arg_formats[fmt_name] = fmt
|
||||||
self.check_rc = check_rc
|
self.check_rc = check_rc
|
||||||
self.force_lang = force_lang
|
self.force_lang = force_lang
|
||||||
self.path_prefix = path_prefix
|
self.path_prefix = path_prefix
|
||||||
|
@ -246,7 +253,16 @@ class CmdRunner(object):
|
||||||
def binary(self):
|
def binary(self):
|
||||||
return self.command[0]
|
return self.command[0]
|
||||||
|
|
||||||
def __call__(self, args_order=None, output_process=None, ignore_value_none=True, check_mode_skip=False, check_mode_return=None, **kwargs):
|
# remove parameter ignore_value_none in community.general 12.0.0
|
||||||
|
def __call__(self, args_order=None, output_process=None, ignore_value_none=None, check_mode_skip=False, check_mode_return=None, **kwargs):
|
||||||
|
if ignore_value_none is None:
|
||||||
|
ignore_value_none = True
|
||||||
|
else:
|
||||||
|
self.module.deprecate(
|
||||||
|
"Using ignore_value_none when creating the runner context is now deprecated, "
|
||||||
|
"and the parameter will be removed in community.general 12.0.0. ",
|
||||||
|
version="12.0.0", collection_name="community.general"
|
||||||
|
)
|
||||||
if output_process is None:
|
if output_process is None:
|
||||||
output_process = _process_as_is
|
output_process = _process_as_is
|
||||||
if args_order is None:
|
if args_order is None:
|
||||||
|
@ -258,7 +274,7 @@ class CmdRunner(object):
|
||||||
return _CmdRunnerContext(runner=self,
|
return _CmdRunnerContext(runner=self,
|
||||||
args_order=args_order,
|
args_order=args_order,
|
||||||
output_process=output_process,
|
output_process=output_process,
|
||||||
ignore_value_none=ignore_value_none,
|
ignore_value_none=ignore_value_none, # DEPRECATION: remove in community.general 12.0.0
|
||||||
check_mode_skip=check_mode_skip,
|
check_mode_skip=check_mode_skip,
|
||||||
check_mode_return=check_mode_return, **kwargs)
|
check_mode_return=check_mode_return, **kwargs)
|
||||||
|
|
||||||
|
@ -274,6 +290,7 @@ class _CmdRunnerContext(object):
|
||||||
self.runner = runner
|
self.runner = runner
|
||||||
self.args_order = tuple(args_order)
|
self.args_order = tuple(args_order)
|
||||||
self.output_process = output_process
|
self.output_process = output_process
|
||||||
|
# DEPRECATION: parameter ignore_value_none at the context level is deprecated and will be removed in community.general 12.0.0
|
||||||
self.ignore_value_none = ignore_value_none
|
self.ignore_value_none = ignore_value_none
|
||||||
self.check_mode_skip = check_mode_skip
|
self.check_mode_skip = check_mode_skip
|
||||||
self.check_mode_return = check_mode_return
|
self.check_mode_return = check_mode_return
|
||||||
|
@ -313,6 +330,7 @@ class _CmdRunnerContext(object):
|
||||||
value = named_args[arg_name]
|
value = named_args[arg_name]
|
||||||
elif not runner.arg_formats[arg_name].ignore_missing_value:
|
elif not runner.arg_formats[arg_name].ignore_missing_value:
|
||||||
raise MissingArgumentValue(self.args_order, arg_name)
|
raise MissingArgumentValue(self.args_order, arg_name)
|
||||||
|
# DEPRECATION: remove parameter ctx_ignore_none in 12.0.0
|
||||||
self.cmd.extend(runner.arg_formats[arg_name](value, ctx_ignore_none=self.ignore_value_none))
|
self.cmd.extend(runner.arg_formats[arg_name](value, ctx_ignore_none=self.ignore_value_none))
|
||||||
except MissingArgumentValue:
|
except MissingArgumentValue:
|
||||||
raise
|
raise
|
||||||
|
@ -329,7 +347,7 @@ class _CmdRunnerContext(object):
|
||||||
@property
|
@property
|
||||||
def run_info(self):
|
def run_info(self):
|
||||||
return dict(
|
return dict(
|
||||||
ignore_value_none=self.ignore_value_none,
|
ignore_value_none=self.ignore_value_none, # DEPRECATION: remove in community.general 12.0.0
|
||||||
check_rc=self.check_rc,
|
check_rc=self.check_rc,
|
||||||
environ_update=self.environ_update,
|
environ_update=self.environ_update,
|
||||||
args_order=self.args_order,
|
args_order=self.args_order,
|
||||||
|
|
Loading…
Reference in a new issue