Add basic typing for module_utils.

plugins/module_utils/_filelock.py

@@ -11,9 +11,13 @@ import os
 import stat
 import time
 import fcntl
+import typing as t
 
 from contextlib import contextmanager
 
+if t.TYPE_CHECKING:
+    from io import TextIOWrapper
+
 
 class LockTimeout(Exception):
     pass
@@ -27,11 +31,13 @@ class FileLock:
     unwanted and/or unexpected behaviour
     """
 
-    def __init__(self):
-        self.lockfd = None
+    def __init__(self) -> None:
+        self.lockfd: TextIOWrapper | None = None
 
     @contextmanager
-    def lock_file(self, path, tmpdir, lock_timeout=None):
+    def lock_file(
+        self, path: os.PathLike, tmpdir: os.PathLike, lock_timeout: int | float | None = None
+    ) -> t.Generator[None]:
         """
         Context for lock acquisition
         """
@@ -41,7 +47,9 @@ class FileLock:
         finally:
             self.unlock()
 
-    def set_lock(self, path, tmpdir, lock_timeout=None):
+    def set_lock(
+        self, path: os.PathLike, tmpdir: os.PathLike, lock_timeout: int | float | None = None
+    ) -> t.Literal[True]:
         """
         Create a lock file based on path with flock to prevent other processes
         using given path.
@@ -61,13 +69,13 @@ class FileLock:
 
         self.lockfd = open(lock_path, "w")
 
-        if lock_timeout <= 0:
+        if lock_timeout is not None and lock_timeout <= 0:
             fcntl.flock(self.lockfd, fcntl.LOCK_EX | fcntl.LOCK_NB)
             os.chmod(lock_path, stat.S_IWRITE | stat.S_IREAD)
             return True
 
         if lock_timeout:
-            e_secs = 0
+            e_secs: float = 0
             while e_secs < lock_timeout:
                 try:
                     fcntl.flock(self.lockfd, fcntl.LOCK_EX | fcntl.LOCK_NB)
@@ -86,7 +94,7 @@ class FileLock:
 
         return True
 
-    def unlock(self):
+    def unlock(self) -> t.Literal[True]:
         """
         Make sure lock file is available for everyone and Unlock the file descriptor
         locked by set_lock