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

[PR #11222/c7f6a28d backport][stable-12] Add basic typing for module_utils (#11243)

Browse source 
Add basic typing for module_utils (#11222)

* Add basic typing for module_utils.

* Apply some suggestions.



* Make pass again.

* Add more types as suggested.

* Normalize extra imports.

* Add more type hints.

* Improve typing.

* Add changelog fragment.

* Reduce changelog.

* Apply suggestions from code review.



* Fix typo.

* Cleanup.

* Improve types and make type checking happy.

* Let's see whether older Pythons barf on this.

* Revert "Let's see whether older Pythons barf on this."

This reverts commit 9973af3dbe.

* Add noqa.

---------


(cherry picked from commit c7f6a28d89)

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2025-12-01 21:16:37 +01:00 • committed by GitHub
parent a2c7f9f89a
commit 377a599372
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
56 changed files with 725 additions and 469 deletions
Download patch file Download diff file Expand all files Collapse all files

26
plugins/module_utils/ipa.py
View file

@ -13,17 +13,21 @@ from __future__ import annotations
import json
import os
import re
import socket
import uuid
import re
from ansible.module_utils.common.text.converters import to_bytes, to_text
from ansible.module_utils.urls import fetch_url, HAS_GSSAPI
from ansible.module_utils.basic import env_fallback, AnsibleFallbackNotFound
import typing as t
from urllib.parse import quote
from ansible.module_utils.basic import env_fallback, AnsibleFallbackNotFound
from ansible.module_utils.common.text.converters import to_bytes, to_text
from ansible.module_utils.urls import fetch_url, HAS_GSSAPI
def _env_then_dns_fallback(*args, **kwargs):
if t.TYPE_CHECKING:
from ansible.module_utils.basic import AnsibleModule
def _env_then_dns_fallback(*args, **kwargs) -> str:
"""Load value from environment or DNS in that order"""
try:
result = env_fallback(*args, **kwargs)
@ -41,7 +45,7 @@ def _env_then_dns_fallback(*args, **kwargs):
class IPAClient:
def __init__(self, module, host, port, protocol):
def __init__(self, module: AnsibleModule, host, port, protocol):
self.host = host
self.port = port
self.protocol = protocol
@ -50,10 +54,10 @@ class IPAClient:
self.timeout = module.params.get("ipa_timeout")
self.use_gssapi = False
def get_base_url(self):
def get_base_url(self) -> str:
return f"{self.protocol}://{self.host}/ipa"
def get_json_url(self):
def get_json_url(self) -> str:
return f"{self.get_base_url()}/session/json"
def login(self, username, password):
@ -98,7 +102,7 @@ class IPAClient:
{"referer": self.get_base_url(), "Content-Type": "application/json", "Accept": "application/json"}
)
def _fail(self, msg, e):
def _fail(self, msg: str, e) -> t.NoReturn:
if "message" in e:
err_string = e.get("message")
else:
@ -205,7 +209,7 @@ class IPAClient:
return changed
def ipa_argument_spec():
def ipa_argument_spec() -> dict[str, t.Any]:
return dict(
ipa_prot=dict(type="str", default="https", choices=["http", "https"], fallback=(env_fallback, ["IPA_PROT"])),
ipa_host=dict(type="str", default="ipa.example.com", fallback=(_env_then_dns_fallback, ["IPA_HOST"])),