docs: add types to recipe.election

Author: a-ungurianu

kazoo/recipe/election.py

@@ -6,6 +6,14 @@
 """
 from kazoo.exceptions import CancelledError
 
+from typing import TYPE_CHECKING, Callable, List, Optional
+
+if TYPE_CHECKING:
+    from kazoo.client import KazooClient
+    from typing_extensions import ParamSpec
+
+P = ParamSpec("P")
+
 
 class Election(object):
     """Kazoo Basic Leader Election
@@ -22,7 +30,9 @@ class Election(object):
 
     """
 
-    def __init__(self, client, path, identifier=None):
+    def __init__(
+        self, client: KazooClient, path: str, identifier: Optional[str] = None
+    ):
         """Create a Kazoo Leader Election
 
         :param client: A :class:`~kazoo.client.KazooClient` instance.
@@ -34,7 +44,9 @@ def __init__(self, client, path, identifier=None):
         """
         self.lock = client.Lock(path, identifier)
 
-    def run(self, func, *args, **kwargs):
+    def run(
+        self, func: Callable[P, None], *args: P.args, **kwargs: P.kwargs
+    ) -> None:
         """Contend for the leadership
 
         This call will block until either this contender is cancelled
@@ -57,7 +69,7 @@ def run(self, func, *args, **kwargs):
         except CancelledError:
             pass
 
-    def cancel(self):
+    def cancel(self) -> None:
         """Cancel participation in the election
 
         .. note::
@@ -68,7 +80,7 @@ def cancel(self):
         """
         self.lock.cancel()
 
-    def contenders(self):
+    def contenders(self) -> List[str]:
         """Return an ordered list of the current contenders in the
         election
 

pyproject.toml

@@ -21,3 +21,29 @@ extend-exclude = '''
 
 [tool.pytest.ini_options]
 addopts = "-ra -v"
+
+[tool.mypy]
+strict = true
+python_version = "3.7"
+follow_imports = "silent"
+ignore_missing_imports = true
+disable_error_code = ["no-untyped-call", "no-untyped-def"]
+files = [
+    "kazoo/recipe/election.py"
+]
+
+[[tool.mypy.overrides]]
+module = 'kazoo.tests.*'
+ignore_errors = true
+
+[[tool.mypy.overrides]]
+module = 'gevent.*'
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = 'eventlet.*'
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = 'puresasl.*'
+ignore_missing_imports = true