Add py.typed and annotate most of the classes and methods

Author: eternal-sorrow

i3ipc/_private/pubsub.py

@@ -1,9 +1,25 @@
+from typing import Callable, Optional, TypeAlias, TypedDict, TYPE_CHECKING
+
+from i3ipc.events import IpcBaseEvent
+
+if TYPE_CHECKING:
+    from i3ipc.connection import Connection
+
+Handler: TypeAlias = Callable[['Connection', IpcBaseEvent], None]
+
+
+class Subscription(TypedDict):
+    event: str
+    detail: Optional[str]
+    handler: Handler
+
+
 class PubSub(object):
-    def __init__(self, conn):
+    def __init__(self, conn: 'Connection'):
         self.conn = conn
-        self._subscriptions = []
+        self._subscriptions: list[Subscription] = []
 
-    def subscribe(self, detailed_event, handler):
+    def subscribe(self, detailed_event: str, handler: Handler):
         event = detailed_event.replace('-', '_')
         detail = ''
 
@@ -12,10 +28,10 @@ def subscribe(self, detailed_event, handler):
 
         self._subscriptions.append({'event': event, 'detail': detail, 'handler': handler})
 
-    def unsubscribe(self, handler):
+    def unsubscribe(self, handler: Handler):
         self._subscriptions = list(filter(lambda s: s['handler'] != handler, self._subscriptions))
 
-    def emit(self, event, data):
+    def emit(self, event: str, data: Optional[IpcBaseEvent]):
         detail = ''
 
         if data and hasattr(data, 'change'):
@@ -27,4 +43,4 @@ def emit(self, event, data):
                     if data:
                         s['handler'](self.conn, data)
                     else:
-                        s['handler'](self.conn)
+                        s['handler'](self.conn)  # type: ignore[call-arg]

i3ipc/_private/types.py

@@ -43,19 +43,19 @@ class EventType(Enum):
     TICK = (1 << 7)
     INPUT = (1 << 21)
 
-    def to_string(self):
+    def to_string(self) -> str:
         return str.lower(self.name)
 
     @staticmethod
-    def from_string(val):
+    def from_string(val) -> 'EventType':
         match = [e for e in EventType if e.to_string() == val]
 
         if not match:
             raise ValueError('event not implemented: ' + val)
 
         return match[0]
 
-    def to_list(self):
+    def to_list(self) -> list[str]:
         events_list = []
         if self.value & EventType.WORKSPACE.value:
             events_list.append(EventType.WORKSPACE.to_string())