1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-02-04 07:51:50 +00:00
community.general/plugins/module_utils/mh/mixins/state.py
Felix Fontein ef632145e9
Add more module_utils typing (#11283)
Add more module_utils typing.
2025-12-15 19:46:51 +01:00

40 lines
1.3 KiB
Python

# (c) 2020, Alexei Znamensky <russoz@gmail.com>
# Copyright (c) 2020, 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
class StateMixin:
state_param: str = "state"
default_state: str | None = None
def _state(self) -> str:
state: str = self.module.params.get(self.state_param) # type: ignore[attr-defined]
return self.default_state if state is None else state
def _method(self, state: str) -> str:
return f"{self.state_param}_{state}"
def __run__(self):
state = self._state()
self.vars.state = state
# 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", [])]
if aliased:
state = aliased[0]
self.vars.effective_state = state
method = self._method(state)
if not hasattr(self, method):
return self.__state_fallback__()
func = getattr(self, method)
return func()
def __state_fallback__(self) -> t.NoReturn:
raise ValueError(f"Cannot find method: {self._method(self._state())}")