More type hints

Author: gvalkov

src/evdev/ecodes.py

@@ -1,5 +1,5 @@
-# When installed, this module is replaced by an ecodes.py generated at 
+# When installed, this module is replaced by an ecodes.py generated at
 # build time by genecodes_py.py (see build_ext in setup.py).
 
-# This stub exists to make development of evdev itself more convenient. 
-from . ecodes_runtime import *
+# This stub exists to make development of evdev itself more convenient.
+from .ecodes_runtime import *

src/evdev/events.py

@@ -38,6 +38,7 @@
 # http://www.kernel.org/doc/Documentation/input/event-codes.txt
 
 # pylint: disable=no-name-in-module
+from typing import Final
 from .ecodes import ABS, EV_ABS, EV_KEY, EV_REL, EV_SYN, KEY, REL, SYN, keys
 
 
@@ -48,21 +49,21 @@ class InputEvent:
 
     def __init__(self, sec, usec, type, code, value):
         #: Time in seconds since epoch at which event occurred.
-        self.sec = sec
+        self.sec: int = sec
 
         #: Microsecond portion of the timestamp.
-        self.usec = usec
+        self.usec: int = usec
 
         #: Event type - one of ``ecodes.EV_*``.
-        self.type = type
+        self.type: int = type
 
         #: Event code related to the event type.
-        self.code = code
+        self.code: int = code
 
         #: Event value related to the event type.
-        self.value = value
+        self.value: int = value
 
-    def timestamp(self):
+    def timestamp(self) -> float:
         """Return event timestamp as a float."""
         return self.sec + (self.usec / 1000000.0)
 
@@ -78,20 +79,20 @@ def __repr__(self):
 class KeyEvent:
     """An event generated by a keyboard, button or other key-like devices."""
 
-    key_up = 0x0
-    key_down = 0x1
-    key_hold = 0x2
+    key_up: Final[int] = 0x0
+    key_down: Final[int] = 0x1
+    key_hold: Final[int] = 0x2
 
     __slots__ = "scancode", "keycode", "keystate", "event"
 
-    def __init__(self, event, allow_unknown=False):
+    def __init__(self, event: InputEvent, allow_unknown: bool = False):
         """
         The ``allow_unknown`` argument determines what to do in the event of an event code
         for which a key code cannot be found. If ``False`` a ``KeyError`` will be raised.
         If ``True`` the keycode will be set to the hex value of the event code.
         """
 
-        self.scancode = event.code
+        self.scancode: int = event.code
 
         if event.value == 0:
             self.keystate = KeyEvent.key_up
@@ -109,7 +110,7 @@ def __init__(self, event, allow_unknown=False):
                 raise
 
         #: Reference to an :class:`InputEvent` instance.
-        self.event = event
+        self.event: InputEvent = event
 
     def __str__(self):
         try:
@@ -129,9 +130,9 @@ class RelEvent:
 
     __slots__ = "event"
 
-    def __init__(self, event):
+    def __init__(self, event: InputEvent):
         #: Reference to an :class:`InputEvent` instance.
-        self.event = event
+        self.event: InputEvent = event
 
     def __str__(self):
         msg = "relative axis event at {:f}, {}"
@@ -146,9 +147,9 @@ class AbsEvent:
 
     __slots__ = "event"
 
-    def __init__(self, event):
+    def __init__(self, event: InputEvent):
         #: Reference to an :class:`InputEvent` instance.
-        self.event = event
+        self.event: InputEvent = event
 
     def __str__(self):
         msg = "absolute axis event at {:f}, {}"
@@ -166,9 +167,9 @@ class SynEvent:
 
     __slots__ = "event"
 
-    def __init__(self, event):
+    def __init__(self, event: InputEvent):
         #: Reference to an :class:`InputEvent` instance.
-        self.event = event
+        self.event: InputEvent = event
 
     def __str__(self):
         msg = "synchronization event at {:f}, {}"

src/evdev/evtest.py

@@ -16,7 +16,6 @@
   evtest /dev/input/event0 /dev/input/event1
 """
 
-
 import atexit
 import optparse
 import re

src/evdev/util.py

@@ -9,7 +9,7 @@
 from .events import event_factory
 
 
-def list_devices(input_device_dir="/dev/input") -> List[str]:
+def list_devices(input_device_dir: Union[str, bytes, os.PathLike] = "/dev/input") -> List[str]:
     """List readable character devices in ``input_device_dir``."""
 
     fns = glob.glob("{}/event*".format(input_device_dir))