mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-03-22 13:19:13 +00:00
21aa086ca6
Add more module_utils typing (#11283)
Add more module_utils typing.
(cherry picked from commit ef632145e9)
Co-authored-by: Felix Fontein <felix@fontein.de>
40 lines
1.3 KiB
Python
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())}")
|