ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-12 23:15:06 +00:00
Code Activity

Reformat everything.

Browse source
This commit is contained in:
Felix Fontein 2025-11-01 12:08:41 +01:00
parent 3f2213791a
commit 340ff8586d
1008 changed files with 61301 additions and 58309 deletions
Download patch file Download diff file Expand all files Collapse all files

10
plugins/module_utils/mh/base.py
View file

@ -16,7 +16,11 @@ class ModuleHelperBase:
module: dict[str, t.Any] | None = None # TODO: better spec using t.TypedDict
ModuleHelperException = _MHE
_delegated_to_module: tuple[str, ...] = (
'check_mode', 'get_bin_path', 'warn', 'deprecate', 'debug',
"check_mode",
"get_bin_path",
"warn",
"deprecate",
"debug",
)
def __init__(self, module=None):
@ -80,8 +84,8 @@ class ModuleHelperBase:
self.__run__()
self.__quit_module__()
output = self.output
if 'failed' not in output:
output['failed'] = False
if "failed" not in output:
output["failed"] = False
self.module.exit_json(changed=self.has_changed(), **output)
@classmethod

18
plugins/module_utils/mh/deco.py
View file

@ -33,7 +33,7 @@ def cause_changes(when=None):
def module_fails_on_exception(func):
conflict_list = ('msg', 'exception', 'output', 'vars', 'changed')
conflict_list = ("msg", "exception", "output", "vars", "changed")
@wraps(func)
def wrapper(self, *args, **kwargs):
@ -51,14 +51,17 @@ def module_fails_on_exception(func):
self.update_output(e.update_output)
# patchy solution to resolve conflict with output variables
output = fix_var_conflicts(self.output)
self.module.fail_json(msg=e.msg, exception=traceback.format_exc(),
output=self.output, vars=self.vars.output(), **output)
self.module.fail_json(
msg=e.msg, exception=traceback.format_exc(), output=self.output, vars=self.vars.output(), **output
)
except Exception as e:
# patchy solution to resolve conflict with output variables
output = fix_var_conflicts(self.output)
msg = f"Module failed with exception: {str(e).strip()}"
self.module.fail_json(msg=msg, exception=traceback.format_exc(),
output=self.output, vars=self.vars.output(), **output)
self.module.fail_json(
msg=msg, exception=traceback.format_exc(), output=self.output, vars=self.vars.output(), **output
)
return wrapper
@ -72,22 +75,25 @@ def check_mode_skip(func):
def check_mode_skip_returns(callable=None, value=None):
def deco(func):
if callable is not None:
@wraps(func)
def wrapper_callable(self, *args, **kwargs):
if self.module.check_mode:
return callable(self, *args, **kwargs)
return func(self, *args, **kwargs)
return wrapper_callable
else:
@wraps(func)
def wrapper_value(self, *args, **kwargs):
if self.module.check_mode:
return value
return func(self, *args, **kwargs)
return wrapper_value
return deco

9
plugins/module_utils/mh/mixins/deprecate_attrs.py
View file

@ -10,7 +10,6 @@ from ansible.module_utils.basic import AnsibleModule
class DeprecateAttrsMixin:
def _deprecate_setup(self, attr, target, module):
if target is None:
target = self
@ -22,7 +21,9 @@ class DeprecateAttrsMixin:
elif hasattr(target, "module") and isinstance(target.module, AnsibleModule):
module = target.module
else:
raise ValueError("Failed to automatically discover the AnsibleModule instance. Pass 'module' parameter explicitly.")
raise ValueError(
"Failed to automatically discover the AnsibleModule instance. Pass 'module' parameter explicitly."
)
# setup internal state dicts
value_attr = "__deprecated_attr_value"
@ -35,7 +36,9 @@ class DeprecateAttrsMixin:
trigger_dict = getattr(target, trigger_attr)
return target, module, value_dict, trigger_dict
def _deprecate_attr(self, attr, msg, version=None, date=None, collection_name=None, target=None, value=None, module=None):
def _deprecate_attr(
self, attr, msg, version=None, date=None, collection_name=None, target=None, value=None, module=None
):
target, module, value_dict, trigger_dict = self._deprecate_setup(attr, target, module)
value_dict[attr] = getattr(target, attr, value)

4
plugins/module_utils/mh/mixins/state.py
View file

@ -7,7 +7,7 @@ from __future__ import annotations
class StateMixin:
state_param: str = 'state'
state_param: str = "state"
default_state: str | None = None
def _state(self):
@ -23,7 +23,7 @@ class StateMixin:
# resolve aliases
if state not in self.module.params:
aliased = [name for name, param in self.module.argument_spec.items() if state in param.get('aliases', [])]
aliased = [name for name, param in self.module.argument_spec.items() if state in param.get("aliases", [])]
if aliased:
state = aliased[0]
self.vars.effective_state = state

9
plugins/module_utils/mh/module_helper.py
View file

@ -31,7 +31,8 @@ class ModuleHelper(DeprecateAttrsMixin, ModuleHelperBase):
self.vars = VarDict()
for name, value in self.module.params.items():
self.vars.set(
name, value,
name,
value,
diff=name in self.diff_params,
output=name in self.output_params,
change=None if not self.change_params else name in self.change_params,
@ -62,11 +63,11 @@ class ModuleHelper(DeprecateAttrsMixin, ModuleHelperBase):
if self.facts_name:
facts = self.vars.facts()
if facts is not None:
result['ansible_facts'] = {self.facts_name: facts}
result["ansible_facts"] = {self.facts_name: facts}
if self.diff_mode:
diff = result.get('diff', {})
diff = result.get("diff", {})
vars_diff = self.vars.diff() or {}
result['diff'] = dict_merge(dict(diff), vars_diff)
result["diff"] = dict_merge(dict(diff), vars_diff)
return result