docs: add types to recipe.election

Author: a-ungurianu

kazoo/client.py

@@ -1,10 +1,13 @@
 """Kazoo Zookeeper Client"""
+from __future__ import annotations
+
 from collections import defaultdict, deque
 from functools import partial
 import inspect
 import logging
 from os.path import split
 import re
+from typing import TYPE_CHECKING, overload
 import warnings
 
 from kazoo.exceptions import (
@@ -63,6 +66,20 @@
 from kazoo.recipe.queue import Queue, LockingQueue
 from kazoo.recipe.watchers import ChildrenWatch, DataWatch
 
+if TYPE_CHECKING:
+    from typing import (
+        Any,
+        List,
+        Optional,
+        Sequence,
+        Tuple,
+        Union,
+        Callable,
+        Literal,
+    )
+    from kazoo.protocol.states import ZnodeStat
+
+    WatchListener = Callable[[WatchedEvent], None]
 
 CLOSED_STATES = (
     KeeperState.EXPIRED_SESSION,

kazoo/recipe/election.py

@@ -4,8 +4,19 @@
 :Status: Unknown
 
 """
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from kazoo.exceptions import CancelledError
 
+if TYPE_CHECKING:
+    from kazoo.client import KazooClient
+    from typing import Callable, List, Optional
+    from typing_extensions import ParamSpec
+
+    P = ParamSpec("P")
+
 
 class Election(object):
     """Kazoo Basic Leader Election
@@ -22,7 +33,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 +47,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 +72,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 +83,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
 

kazoo/recipe/lock.py

@@ -14,8 +14,11 @@
 and/or the lease has been lost.
 
 """
+from __future__ import annotations
+
 import re
 import time
+from typing import TYPE_CHECKING
 import uuid
 
 from kazoo.exceptions import (
@@ -31,6 +34,9 @@
     RetryFailedError,
 )
 
+if TYPE_CHECKING:
+    from typing import List
+
 
 class _Watch(object):
     def __init__(self, duration=None):
@@ -133,7 +139,7 @@ def _ensure_path(self):
         self.client.ensure_path(self.path)
         self.assured_path = True
 
-    def cancel(self):
+    def cancel(self) -> None:
         """Cancel a pending lock acquire."""
         self.cancelled = True
         self.wake_event.set()
@@ -344,7 +350,7 @@ def _inner_release(self):
         self.node = None
         return True
 
-    def contenders(self):
+    def contenders(self) -> List[str]:
         """Return an ordered list of the current contenders for the
         lock.
 
@@ -550,7 +556,7 @@ def _ensure_path(self):
         else:
             self.client.set(self.path, str(self.max_leases).encode("utf-8"))
 
-    def cancel(self):
+    def cancel(self) -> None:
         """Cancel a pending semaphore acquire."""
         self.cancelled = True
         self.wake_event.set()

kazoo/retry.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import logging
 import random
 import time

pyproject.toml

@@ -24,6 +24,8 @@ addopts = "-ra -v"
 
 [tool.mypy]
 
+python_version = "3.7"
+
 # For details on each flag, please see the mypy documentation at:
 # https://mypy.readthedocs.io/en/stable/config_file.html#config-file
 
@@ -102,7 +104,6 @@ module = [
     'kazoo.recipe.barrier',
     'kazoo.recipe.cache',
     'kazoo.recipe.counter',
-    'kazoo.recipe.election',
     'kazoo.recipe.lease',
     'kazoo.recipe.lock',
     'kazoo.recipe.partitioner',