1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-06 10:05:54 +00:00

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

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

View file

@ -5,9 +5,13 @@
from __future__ import annotations
import traceback
import typing as t
from ansible.module_utils.basic import env_fallback, missing_required_lib
if t.TYPE_CHECKING:
from ansible.module_utils.basic import AnsibleModule
HAS_HEROKU = False
HEROKU_IMP_ERR = None
try:
@ -19,17 +23,17 @@ except ImportError:
class HerokuHelper:
def __init__(self, module):
def __init__(self, module: AnsibleModule) -> None:
self.module = module
self.check_lib()
self.api_key = module.params["api_key"]
def check_lib(self):
def check_lib(self) -> None:
if not HAS_HEROKU:
self.module.fail_json(msg=missing_required_lib("heroku3"), exception=HEROKU_IMP_ERR)
@staticmethod
def heroku_argument_spec():
def heroku_argument_spec() -> dict[str, t.Any]:
return dict(
api_key=dict(fallback=(env_fallback, ["HEROKU_API_KEY", "TF_VAR_HEROKU_API_KEY"]), type="str", no_log=True)
)