mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-23 20:29:08 +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 commit9973af3dbe. * Add noqa. --------- (cherry picked from commitc7f6a28d89) Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
a2c7f9f89a
commit
377a599372
56 changed files with 725 additions and 469 deletions
|
|
@ -5,11 +5,15 @@
|
|||
from __future__ import annotations
|
||||
|
||||
import traceback
|
||||
import typing as t
|
||||
|
||||
from ansible.module_utils.basic import missing_required_lib
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
|
||||
|
||||
if t.TYPE_CHECKING:
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
REQUESTS_IMP_ERR = None
|
||||
try:
|
||||
import requests.exceptions # noqa: F401, pylint: disable=unused-import
|
||||
|
|
@ -32,7 +36,7 @@ except ImportError:
|
|||
|
||||
|
||||
class InfluxDb:
|
||||
def __init__(self, module):
|
||||
def __init__(self, module: AnsibleModule) -> None:
|
||||
self.module = module
|
||||
self.params = self.module.params
|
||||
self.check_lib()
|
||||
|
|
@ -43,7 +47,7 @@ class InfluxDb:
|
|||
self.password = self.params["password"]
|
||||
self.database_name = self.params.get("database_name")
|
||||
|
||||
def check_lib(self):
|
||||
def check_lib(self) -> None:
|
||||
if not HAS_REQUESTS:
|
||||
self.module.fail_json(msg=missing_required_lib("requests"), exception=REQUESTS_IMP_ERR)
|
||||
|
||||
|
|
@ -51,7 +55,7 @@ class InfluxDb:
|
|||
self.module.fail_json(msg=missing_required_lib("influxdb"), exception=INFLUXDB_IMP_ERR)
|
||||
|
||||
@staticmethod
|
||||
def influxdb_argument_spec():
|
||||
def influxdb_argument_spec() -> dict[str, t.Any]:
|
||||
return dict(
|
||||
hostname=dict(type="str", default="localhost"),
|
||||
port=dict(type="int", default=8086),
|
||||
|
|
@ -67,7 +71,7 @@ class InfluxDb:
|
|||
udp_port=dict(type="int", default=4444),
|
||||
)
|
||||
|
||||
def connect_to_influxdb(self):
|
||||
def connect_to_influxdb(self) -> InfluxDBClient:
|
||||
args = dict(
|
||||
host=self.hostname,
|
||||
port=self.port,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue