1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-02-04 07:51:50 +00:00

Add basic typing for module_utils (#11222)

* Add basic typing for module_utils.

* Apply some suggestions.

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

* 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.

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

* 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.

---------

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
Felix Fontein 2025-12-01 20:40:06 +01:00 committed by GitHub
parent fb2f34ba85
commit c7f6a28d89
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
56 changed files with 725 additions and 469 deletions

View file

@ -183,6 +183,7 @@ logs:
"""
import os
import typing as t
from urllib.parse import urlencode
from ansible.module_utils.basic import AnsibleModule
@ -246,19 +247,16 @@ class LXDStoragePoolInfo:
self.trust_password = self.module.params["trust_password"]
def _fail_from_lxd_exception(self, exception: LXDClientException) -> None:
def _fail_from_lxd_exception(self, exception: LXDClientException) -> t.NoReturn:
"""Build failure parameters from LXDClientException and fail.
:param exception: The LXDClientException instance
:type exception: LXDClientException
"""
fail_params = {
"msg": exception.msg,
"changed": False,
}
fail_params = {}
if self.client.debug and "logs" in exception.kwargs:
fail_params["logs"] = exception.kwargs["logs"]
self.module.fail_json(**fail_params)
self.module.fail_json(msg=exception.msg, changed=False, **fail_params)
def _build_url(self, endpoint: str) -> str:
"""Build URL with project parameter if specified."""

View file

@ -188,6 +188,7 @@ logs:
"""
import os
import typing as t
from urllib.parse import quote, urlencode
from ansible.module_utils.basic import AnsibleModule
@ -252,19 +253,16 @@ class LXDStorageVolumeInfo:
self.trust_password = self.module.params["trust_password"]
def _fail_from_lxd_exception(self, exception: LXDClientException) -> None:
def _fail_from_lxd_exception(self, exception: LXDClientException) -> t.NoReturn:
"""Build failure parameters from LXDClientException and fail.
:param exception: The LXDClientException instance
:type exception: LXDClientException
"""
fail_params = {
"msg": exception.msg,
"changed": False,
}
fail_params = {}
if self.client.debug and "logs" in exception.kwargs:
fail_params["logs"] = exception.kwargs["logs"]
self.module.fail_json(**fail_params)
self.module.fail_json(msg=exception.msg, changed=False, **fail_params)
def _build_url(self, endpoint: str) -> str:
"""Build URL with project parameter if specified."""