# (c) 2020-2024, Alexei Znamensky # Copyright (c) 2020-2024, Ansible Project # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause) # SPDX-License-Identifier: BSD-2-Clause from __future__ import annotations import typing as t from ansible.module_utils.common.dict_transformations import dict_merge from ansible_collections.community.general.plugins.module_utils.mh.base import ModuleHelperBase from ansible_collections.community.general.plugins.module_utils.mh.mixins.deprecate_attrs import DeprecateAttrsMixin from ansible_collections.community.general.plugins.module_utils.mh.mixins.state import StateMixin from ansible_collections.community.general.plugins.module_utils.vardict import VarDict if t.TYPE_CHECKING: from collections.abc import Sequence from ansible.module_utils.basic import AnsibleModule class ModuleHelper(DeprecateAttrsMixin, ModuleHelperBase): facts_name: str | None = None output_params: Sequence[str] = () diff_params: Sequence[str] = () change_params: Sequence[str] = () facts_params: Sequence[str] = () def __init__(self, module: AnsibleModule | dict[str, t.Any] | None = None) -> None: super().__init__(module) self.vars = VarDict() for name, value in self.module.params.items(): # type: ignore[union-attr] self.vars.set( 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, fact=name in self.facts_params, ) def update_vars(self, meta: dict[str, t.Any] | None = None, **kwargs: t.Any) -> None: if meta is None: meta = {} for k, v in kwargs.items(): self.vars.set(k, v, **meta) def update_output(self, **kwargs: t.Any) -> None: self.update_vars(meta={"output": True}, **kwargs) def update_facts(self, **kwargs: t.Any) -> None: self.update_vars(meta={"fact": True}, **kwargs) def _vars_changed(self) -> bool: return self.vars.has_changed def has_changed(self) -> bool: return self.changed or self._vars_changed() @property def output(self) -> dict[str, t.Any]: result = dict(self.vars.output()) if self.facts_name: facts = self.vars.facts() if facts is not None: result["ansible_facts"] = {self.facts_name: facts} if self.diff_mode: diff = result.get("diff", {}) vars_diff = self.vars.diff() or {} result["diff"] = dict_merge(dict(diff), vars_diff) return result class StateModuleHelper(StateMixin, ModuleHelper): pass