added type hint for the diff.

Dieser Commit ist enthalten in:
Sebastian Tobie 2024-03-16 09:56:39 +01:00
Ursprung 380bc582e3
Commit 85880d2867
2 geänderte Dateien mit 10 neuen und 2 gelöschten Zeilen

Datei anzeigen

@ -1,3 +1,4 @@
--- ---
minor_changes: minor_changes:
- Added an type hint to the update_doc function - Added an type hint to the update_doc function
- Added Type hint to the dictionary argument of the diff method

Datei anzeigen

@ -1,6 +1,6 @@
import pathlib import pathlib
from copy import deepcopy from copy import deepcopy
from typing import Any, Callable, ClassVar, Dict, NoReturn, Optional, Type, TypeVar, Union, overload from typing import Any, Callable, ClassVar, Dict, NoReturn, Optional, Type, TypeVar, Union, overload, TypedDict
from ansible.utils.display import Display from ansible.utils.display import Display
import ansible.module_utils.basic as basic import ansible.module_utils.basic as basic
@ -18,6 +18,13 @@ __all__ = (
T = TypeVar("T") T = TypeVar("T")
class TypedDiff(TypedDict):
before: str
after: str
before_header: Optional[str] = None
after_header: Optional[str] = None
def docify(input: Union[dict, AnsibleParameter]) -> dict: def docify(input: Union[dict, AnsibleParameter]) -> dict:
options = dict() options = dict()
for name, help in input.items(): for name, help in input.items():
@ -82,7 +89,7 @@ class AnsibleModule(object):
self.result[key] = value self.result[key] = value
@overload @overload
def diff(self, diff: Dict[str, str]): # pragma: nocover def diff(self, diff: TypedDiff): # pragma: nocover
pass pass
@overload @overload