[PR #11283/ef632145 backport][stable-12] Add more module_utils typing (#11289)

Add more module_utils typing (#11283)

Add more module_utils typing.

(cherry picked from commit ef632145e9)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot]
2025-12-17 21:24:55 +01:00
committed by GitHub
parent 8590184232
commit 21aa086ca6
12 changed files with 340 additions and 274 deletions

View File

@@ -5,12 +5,15 @@
from __future__ import annotations
import typing as t
from ansible.module_utils.basic import AnsibleModule
class DeprecateAttrsMixin:
def _deprecate_setup(self, attr, target, module):
def _deprecate_setup(
self, attr: str, target: object | None, module: AnsibleModule | None
) -> tuple[object, AnsibleModule, dict[str, t.Any], dict[str, t.Any]]:
if target is None:
target = self
if not hasattr(target, attr):
@@ -37,8 +40,16 @@ class DeprecateAttrsMixin:
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
):
self,
attr: str,
msg: str,
version: str | None = None,
date: str | None = None,
collection_name: str | None = None,
target: object | None = None,
value=None,
module: AnsibleModule | None = None,
) -> None:
target, module, value_dict, trigger_dict = self._deprecate_setup(attr, target, module)
value_dict[attr] = getattr(target, attr, value)

View File

@@ -5,16 +5,18 @@
from __future__ import annotations
import typing as t
class StateMixin:
state_param: str = "state"
default_state: str | None = None
def _state(self):
state = self.module.params.get(self.state_param)
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):
def _method(self, state: str) -> str:
return f"{self.state_param}_{state}"
def __run__(self):
@@ -34,5 +36,5 @@ class StateMixin:
func = getattr(self, method)
return func()
def __state_fallback__(self):
def __state_fallback__(self) -> t.NoReturn:
raise ValueError(f"Cannot find method: {self._method(self._state())}")