ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-24 11:21:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Make ModuleArgsParser more understandable (#13974)

Browse source 
* Make ModuleArgsParser more understandable

Both comments and method names for handling new/old
style parameters are switched around

Made comments and method names reflect actual code paths
taken.

* Further improve mod_args.py comments

Ensure output formats are correctly documented,
remove some of the 'opinion' about which formats are
valid, and try and clarify the situations under which
certain code paths are hit.

Stop talking about the YAML command-type form as 'extra
gross' when it's the documented example form for command
etc.!
This commit is contained in:
Will Thames 2017-01-13 12:22:54 +10:00 • committed by Matt Clay
parent b1c57ea443
commit 4bfed06514
1 changed files with 21 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

43
lib/ansible/parsing/mod_args.py
View file

@ -73,7 +73,7 @@ class ModuleArgsParser:
src: a
dest: b
# extra gross, but also legal. in this case, the args specified
# Standard YAML form for command-type modules. In this case, the args specified
# will act as 'defaults' and will be overridden by any args specified
# in one of the other formats (complex args under the action, or
# parsed from the k=v string
@ -148,13 +148,13 @@ class ModuleArgsParser:
raise AnsibleParserError('Complex args must be a dictionary or variable string ("{{var}}").')
# how we normalize depends if we figured out what the module name is
# yet. If we have already figured it out, it's an 'old style' invocation.
# yet. If we have already figured it out, it's a 'new style' invocation.
# otherwise, it's not
if action is not None:
args = self._normalize_old_style_args(thing, action)
args = self._normalize_new_style_args(thing, action)
else:
(action, args) = self._normalize_new_style_args(thing)
(action, args) = self._normalize_old_style_args(thing)
# this can occasionally happen, simplify
if args and 'args' in args:
@ -178,24 +178,24 @@ class ModuleArgsParser:
return (action, final_args)
def _normalize_old_style_args(self, thing, action):
def _normalize_new_style_args(self, thing, action):
'''
deals with fuzziness in old-style (action/local_action) module invocations
returns tuple of (module_name, dictionary_args)
deals with fuzziness in new style module invocations
accepting key=value pairs and dictionaries, and returns
a dictionary of arguments
possible example inputs:
{ 'local_action' : 'shell echo hi' }
{ 'action' : 'shell echo hi' }
{ 'local_action' : { 'module' : 'ec2', 'x' : 1, 'y': 2 }}
'echo hi', 'shell'
{'region': 'xyz'}, 'ec2'
standardized outputs like:
( 'command', { _raw_params: 'echo hi', _uses_shell: True }
{ _raw_params: 'echo hi', _uses_shell: True }
'''
if isinstance(thing, dict):
# form is like: local_action: { module: 'xyz', x: 2, y: 3 } ... uncommon!
# form is like: { xyz: { x: 2, y: 3 } }
args = thing
elif isinstance(thing, string_types):
# form is like: local_action: copy src=a dest=b ... pretty common
# form is like: copy: src=a dest=b
check_raw = action in ('command', 'net_command', 'win_command', 'shell', 'win_shell', 'script', 'raw')
args = parse_kv(thing, check_raw=check_raw)
elif thing is None:
@ -205,18 +205,17 @@ class ModuleArgsParser:
raise AnsibleParserError("unexpected parameter type in action: %s" % type(thing), obj=self._task_ds)
return args
def _normalize_new_style_args(self, thing):
def _normalize_old_style_args(self, thing):
'''
deals with fuzziness in new style module invocations
accepting key=value pairs and dictionaries, and always returning dictionaries
deals with fuzziness in old-style (action/local_action) module invocations
returns tuple of (module_name, dictionary_args)
possible example inputs:
{ 'shell' : 'echo hi' }
{ 'ec2' : { 'region' : 'xyz' }
{ 'ec2' : 'region=xyz' }
'shell echo hi'
{'module': 'ec2', 'x': 1 }
standardized outputs like:
('ec2', { region: 'xyz'} )
('ec2', { 'x': 1} )
'''
action = None
@ -224,7 +223,7 @@ class ModuleArgsParser:
actions_allowing_raw = ('command', 'win_command', 'shell', 'win_shell', 'script', 'raw')
if isinstance(thing, dict):
# form is like: copy: { src: 'a', dest: 'b' } ... common for structured (aka "complex") args
# form is like: action: { module: 'copy', src: 'a', dest: 'b' }
thing = thing.copy()
if 'module' in thing:
action, module_args = self._split_module_string(thing['module'])
@ -234,7 +233,7 @@ class ModuleArgsParser:
del args['module']
elif isinstance(thing, string_types):
# form is like: copy: src=a dest=b ... common shorthand throughout ansible
# form is like: action: copy src=a dest=b
(action, args) = self._split_module_string(thing)
check_raw = action in actions_allowing_raw
args = parse_kv(args, check_raw=check_raw)
@ -259,7 +258,7 @@ class ModuleArgsParser:
args = dict()
# this is the 'extra gross' scenario detailed above, so we grab
# This is the standard YAML form for command-type modules. We grab
# the args and pass them in as additional arguments, which can/will
# be overwritten via dict updates from the other arg sources below
additional_args = self._task_ds.get('args', dict())