evdev 1.8.0__tar.gz → 1.9.1__tar.gz

{evdev-1.8.0 → evdev-1.9.1}/MANIFEST.in

@@ -1,5 +1,5 @@
 # The _ecodes extension module source file needs to be generated against the
 # evdev headers of the running kernel. Refer to the 'build_ecodes' distutils
 # command in setup.py.
-exclude evdev/ecodes.c
-include evdev/ecodes.py
+exclude src/evdev/ecodes.c
+include src/evdev/ecodes.py

{evdev-1.8.0/evdev.egg-info → evdev-1.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: evdev
-Version: 1.8.0
+Version: 1.9.1
 Summary: Bindings to the Linux input handling subsystem
 Author-email: Georgi Valkov <georgi.t.valkov@gmail.com>
 Maintainer-email: Tobi <proxima@sezanzeb.de>

{evdev-1.8.0 → evdev-1.9.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "evdev"
-version = "1.8.0"
+version = "1.9.1"
 description = "Bindings to the Linux input handling subsystem"
 keywords = ["evdev", "input", "uinput"]
 readme = "README.md"
@@ -29,9 +29,6 @@ classifiers = [
 [project.urls]
 "Homepage" = "https://github.com/gvalkov/python-evdev"
 
-[tool.setuptools]
-packages = ["evdev"]
-
 [tool.ruff]
 line-length = 120
 
@@ -39,7 +36,7 @@ line-length = 120
 ignore = ["E265", "E241", "F403", "F401", "E401", "E731"]
 
 [tool.bumpversion]
-current_version = "1.8.0"
+current_version = "1.9.1"
 commit = true
 tag = true
 allow_dirty = true

{evdev-1.8.0 → evdev-1.9.1}/setup.py

@@ -2,6 +2,7 @@ import os
 import sys
 import shutil
 import textwrap
+import platform
 from pathlib import Path
 from subprocess import run
 
@@ -10,7 +11,7 @@ from setuptools.command import build_ext as _build_ext
 
 
 curdir = Path(__file__).resolve().parent
-ecodes_c_path = curdir / "evdev/ecodes.c"
+ecodes_c_path = curdir / "src/evdev/ecodes.c"
 
 
 def create_ecodes(headers=None):
@@ -25,7 +26,11 @@ def create_ecodes(headers=None):
             include_paths.update(c_inc_path.split(":"))
 
         include_paths.add("/usr/include")
-        files = ["linux/input.h", "linux/input-event-codes.h", "linux/uinput.h"]
+        if platform.system().lower() == "freebsd":
+            files = ["dev/evdev/input.h", "dev/evdev/input-event-codes.h", "dev/evdev/uinput.h"]
+        else:
+            files = ["linux/input.h", "linux/input-event-codes.h", "linux/uinput.h"]
+
         headers = [os.path.join(path, file) for path in include_paths for file in files]
 
     headers = [header for header in headers if os.path.isfile(header)]
@@ -60,7 +65,7 @@ def create_ecodes(headers=None):
 
     print("writing %s (using %s)" % (ecodes_c_path, " ".join(headers)))
     with ecodes_c_path.open("w") as fh:
-        cmd = [sys.executable, "evdev/genecodes_c.py", "--ecodes", *headers]
+        cmd = [sys.executable, "src/evdev/genecodes_c.py", "--ecodes", *headers]
         run(cmd, check=True, stdout=fh)
 
 
@@ -93,12 +98,12 @@ class build_ext(_build_ext.build_ext):
         ecodes_py = Path(self.build_lib) / "evdev/ecodes.py"
         print(f"writing {ecodes_py}")
         with ecodes_py.open("w") as fh:
-            cmd = [sys.executable, "-B", "evdev/genecodes_py.py"]
+            cmd = [sys.executable, "-B", "src/evdev/genecodes_py.py"]
             res = run(cmd, env={"PYTHONPATH": self.build_lib}, stdout=fh)
 
         if res.returncode != 0:
             print(f"failed to generate static {ecodes_py} - will use ecodes_runtime.py")
-            shutil.copy("evdev/ecodes_runtime.py", ecodes_py)
+            shutil.copy("src/evdev/ecodes_runtime.py", ecodes_py)
 
     def run(self):
         for cmd_name in self.get_sub_commands():
@@ -112,9 +117,9 @@ class build_ext(_build_ext.build_ext):
 cflags = ["-std=c99", "-Wno-error=declaration-after-statement"]
 setup(
     ext_modules=[
-        Extension("evdev._input", sources=["evdev/input.c"], extra_compile_args=cflags),
-        Extension("evdev._uinput", sources=["evdev/uinput.c"], extra_compile_args=cflags),
-        Extension("evdev._ecodes", sources=["evdev/ecodes.c"], extra_compile_args=cflags),
+        Extension("evdev._input", sources=["src/evdev/input.c"], extra_compile_args=cflags),
+        Extension("evdev._uinput", sources=["src/evdev/uinput.c"], extra_compile_args=cflags),
+        Extension("evdev._ecodes", sources=["src/evdev/ecodes.c"], extra_compile_args=cflags),
     ],
     cmdclass={
         "build_ext": build_ext,

evdev-1.9.1/src/evdev/__init__.py

@@ -0,0 +1,39 @@
+# --------------------------------------------------------------------------
+# Gather everything into a single, convenient namespace.
+# --------------------------------------------------------------------------
+
+# The superfluous "import name as name" syntax is here to satisfy mypy's attrs-defined rule.
+# Alternatively all exported objects can be listed in __all__.
+
+from . import (
+    ecodes as ecodes,
+    ff as ff,
+)
+
+from .device import (
+    AbsInfo as AbsInfo,
+    DeviceInfo as DeviceInfo,
+    EvdevError as EvdevError,
+    InputDevice as InputDevice,
+)
+
+from .events import (
+    AbsEvent as AbsEvent,
+    InputEvent as InputEvent,
+    KeyEvent as KeyEvent,
+    RelEvent as RelEvent,
+    SynEvent as SynEvent,
+    event_factory as event_factory,
+)
+
+from .uinput import (
+    UInput as UInput,
+    UInputError as UInputError,
+)
+
+from .util import (
+    categorize as categorize,
+    list_devices as list_devices,
+    resolve_ecodes as resolve_ecodes,
+    resolve_ecodes_dict as resolve_ecodes_dict,
+)

{evdev-1.8.0 → evdev-1.9.1/src}/evdev/device.py

@@ -1,9 +1,6 @@
-# encoding: utf-8
-
-import collections
 import contextlib
 import os
-import warnings
+from typing import Dict, Iterator, List, Literal, NamedTuple, Tuple, Union, overload
 
 from . import _input, ecodes, util
 
@@ -13,18 +10,10 @@ except ImportError:
     from .eventio import EvdevError, EventIO
 
 
-# --------------------------------------------------------------------------
-_AbsInfo = collections.namedtuple("AbsInfo", ["value", "min", "max", "fuzz", "flat", "resolution"])
-
-_KbdInfo = collections.namedtuple("KbdInfo", ["delay", "repeat"])
-
-_DeviceInfo = collections.namedtuple("DeviceInfo", ["bustype", "vendor", "product", "version"])
-
-
-class AbsInfo(_AbsInfo):
+class AbsInfo(NamedTuple):
     """Absolute axis information.
 
-    A ``namedtuple`` used for storing absolute axis information -
+    A ``namedtuple`` with absolute axis information -
     corresponds to the ``input_absinfo`` struct:
 
     Attributes
@@ -60,11 +49,18 @@ class AbsInfo(_AbsInfo):
 
     """
 
+    value: int
+    min: int
+    max: int
+    fuzz: int
+    flat: int
+    resolution: int
+
     def __str__(self):
-        return "val {}, min {}, max {}, fuzz {}, flat {}, res {}".format(*self)
+        return "value {}, min {}, max {}, fuzz {}, flat {}, res {}".format(*self)  # pylint: disable=not-an-iterable
 
 
-class KbdInfo(_KbdInfo):
+class KbdInfo(NamedTuple):
     """Keyboard repeat rate.
 
     Attributes
@@ -77,11 +73,14 @@ class KbdInfo(_KbdInfo):
       Keyboard repeat rate in characters per second.
     """
 
+    delay: int
+    repeat: int
+
     def __str__(self):
-        return "delay {}, repeat {}".format(*self)
+        return "delay {}, repeat {}".format(self.delay, self.repeat)
 
 
-class DeviceInfo(_DeviceInfo):
+class DeviceInfo(NamedTuple):
     """
     Attributes
     ----------
@@ -91,9 +90,14 @@ class DeviceInfo(_DeviceInfo):
     version
     """
 
-    def __str__(self):
+    bustype: int
+    vendor: int
+    product: int
+    version: int
+
+    def __str__(self) -> str:
         msg = "bus: {:04x}, vendor {:04x}, product {:04x}, version {:04x}"
-        return msg.format(*self)
+        return msg.format(*self)  # pylint: disable=not-an-iterable
 
 
 class InputDevice(EventIO):
@@ -103,7 +107,7 @@ class InputDevice(EventIO):
 
     __slots__ = ("path", "fd", "info", "name", "phys", "uniq", "_rawcapabilities", "version", "ff_effects_count")
 
-    def __init__(self, dev):
+    def __init__(self, dev: Union[str, bytes, os.PathLike]):
         """
         Arguments
         ---------
@@ -114,15 +118,14 @@ class InputDevice(EventIO):
         #: Path to input device.
         self.path = dev if not hasattr(dev, "__fspath__") else dev.__fspath__()
 
-        # Certain operations are possible only when the device is opened in
-        # read-write mode.
+        # Certain operations are possible only when the device is opened in read-write mode.
         try:
             fd = os.open(dev, os.O_RDWR | os.O_NONBLOCK)
         except OSError:
             fd = os.open(dev, os.O_RDONLY | os.O_NONBLOCK)
 
         #: A non-blocking file descriptor to the device file.
-        self.fd = fd
+        self.fd: int = fd
 
         # Returns (bustype, vendor, product, version, name, phys, capabilities).
         info_res = _input.ioctl_devinfo(self.fd)
@@ -131,16 +134,16 @@ class InputDevice(EventIO):
         self.info = DeviceInfo(*info_res[:4])
 
         #: The name of the event device.
-        self.name = info_res[4]
+        self.name: str = info_res[4]
 
         #: The physical topology of the device.
-        self.phys = info_res[5]
+        self.phys: str = info_res[5]
 
         #: The unique identifier of the device.
-        self.uniq = info_res[6]
+        self.uniq: str = info_res[6]
 
         #: The evdev protocol version.
-        self.version = _input.ioctl_EVIOCGVERSION(self.fd)
+        self.version: int = _input.ioctl_EVIOCGVERSION(self.fd)
 
         #: The raw dictionary of device capabilities - see `:func:capabilities()`.
         self._rawcapabilities = _input.ioctl_capabilities(self.fd)
@@ -148,14 +151,14 @@ class InputDevice(EventIO):
         #: The number of force feedback effects the device can keep in its memory.
         self.ff_effects_count = _input.ioctl_EVIOCGEFFECTS(self.fd)
 
-    def __del__(self):
+    def __del__(self) -> None:
         if hasattr(self, "fd") and self.fd is not None:
             try:
                 self.close()
             except (OSError, ImportError, AttributeError):
                 pass
 
-    def _capabilities(self, absinfo=True):
+    def _capabilities(self, absinfo: bool = True):
         res = {}
 
         for etype, _ecodes in self._rawcapabilities.items():
@@ -173,7 +176,13 @@ class InputDevice(EventIO):
 
         return res
 
-    def capabilities(self, verbose=False, absinfo=True):
+    @overload
+    def capabilities(self, verbose: Literal[False] = ..., absinfo: bool = ...) -> Dict[int, List[int]]:
+        ...
+    @overload
+    def capabilities(self, verbose: Literal[True], absinfo: bool = ...) -> Dict[Tuple[str, int], List[Tuple[str, int]]]:
+        ...
+    def capabilities(self, verbose: bool = False, absinfo: bool = True) -> Union[Dict[int, List[int]], Dict[Tuple[str, int], List[Tuple[str, int]]]]:
         """
         Return the event types that this device supports as a mapping of
         supported event types to lists of handled event codes.
@@ -218,7 +227,7 @@ class InputDevice(EventIO):
         else:
             return self._capabilities(absinfo)
 
-    def input_props(self, verbose=False):
+    def input_props(self, verbose: bool = False):
         """
         Get device properties and quirks.
 
@@ -239,7 +248,7 @@ class InputDevice(EventIO):
 
         return props
 
-    def leds(self, verbose=False):
+    def leds(self, verbose: bool = False):
         """
         Return currently set LED keys.
 
@@ -260,7 +269,7 @@ class InputDevice(EventIO):
 
         return leds
 
-    def set_led(self, led_num, value):
+    def set_led(self, led_num: int, value: int) -> None:
         """
         Set the state of the selected LED.
 
@@ -276,18 +285,18 @@ class InputDevice(EventIO):
         """
         return isinstance(other, self.__class__) and self.info == other.info and self.path == other.path
 
-    def __str__(self):
+    def __str__(self) -> str:
         msg = 'device {}, name "{}", phys "{}", uniq "{}"'
         return msg.format(self.path, self.name, self.phys, self.uniq or "")
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         msg = (self.__class__.__name__, self.path)
         return "{}({!r})".format(*msg)
 
     def __fspath__(self):
         return self.path
 
-    def close(self):
+    def close(self) -> None:
         if self.fd > -1:
             try:
                 super().close()
@@ -295,7 +304,7 @@ class InputDevice(EventIO):
             finally:
                 self.fd = -1
 
-    def grab(self):
+    def grab(self) -> None:
         """
         Grab input device using ``EVIOCGRAB`` - other applications will
         be unable to receive events until the device is released. Only
@@ -308,7 +317,7 @@ class InputDevice(EventIO):
 
         _input.ioctl_EVIOCGRAB(self.fd, 1)
 
-    def ungrab(self):
+    def ungrab(self) -> None:
         """
         Release device if it has been already grabbed (uses `EVIOCGRAB`).
 
@@ -321,7 +330,7 @@ class InputDevice(EventIO):
         _input.ioctl_EVIOCGRAB(self.fd, 0)
 
     @contextlib.contextmanager
-    def grab_context(self):
+    def grab_context(self) -> Iterator[None]:
         """
         A context manager for the duration of which only the current
         process will be able to receive events from the device.
@@ -330,7 +339,7 @@ class InputDevice(EventIO):
         yield
         self.ungrab()
 
-    def upload_effect(self, effect):
+    def upload_effect(self, effect: "ff.Effect"):
         """
         Upload a force feedback effect to a force feedback device.
         """
@@ -339,7 +348,7 @@ class InputDevice(EventIO):
         ff_id = _input.upload_effect(self.fd, data)
         return ff_id
 
-    def erase_effect(self, ff_id):
+    def erase_effect(self, ff_id) -> None:
         """
         Erase a force effect from a force feedback device. This also
         stops the effect.
@@ -357,10 +366,10 @@ class InputDevice(EventIO):
         return KbdInfo(*_input.ioctl_EVIOCGREP(self.fd))
 
     @repeat.setter
-    def repeat(self, value):
+    def repeat(self, value: Tuple[int, int]):
         return _input.ioctl_EVIOCSREP(self.fd, *value)
 
-    def active_keys(self, verbose=False):
+    def active_keys(self, verbose: bool = False):
         """
         Return currently active keys.
 
@@ -383,13 +392,7 @@ class InputDevice(EventIO):
 
         return active_keys
 
-    @property
-    def fn(self):
-        msg = "Please use {0}.path instead of {0}.fn".format(self.__class__.__name__)
-        warnings.warn(msg, DeprecationWarning, stacklevel=2)
-        return self.path
-
-    def absinfo(self, axis_num):
+    def absinfo(self, axis_num: int):
         """
         Return current :class:`AbsInfo` for input device axis
 
@@ -405,7 +408,7 @@ class InputDevice(EventIO):
         """
         return AbsInfo(*_input.ioctl_EVIOCGABS(self.fd, axis_num))
 
-    def set_absinfo(self, axis_num, value=None, min=None, max=None, fuzz=None, flat=None, resolution=None):
+    def set_absinfo(self, axis_num: int, value=None, min=None, max=None, fuzz=None, flat=None, resolution=None) -> None:
         """
         Update :class:`AbsInfo` values. Only specified values will be overwritten.
 

{evdev-1.8.0 → evdev-1.9.1/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 *

{evdev-1.8.0 → evdev-1.9.1/src}/evdev/ecodes_runtime.py

@@ -46,7 +46,7 @@ from . import _ecodes
 #: Mapping of names to values.
 ecodes = {}
 
-prefixes = "KEY ABS REL SW MSC LED BTN REP SND ID EV BUS SYN FF_STATUS FF INPUT_PROP".split()
+prefixes = "KEY ABS REL SW MSC LED BTN REP SND ID EV BUS SYN FF_STATUS FF INPUT_PROP UI_FF".split()
 prev_prefix = ""
 g = globals()
 

{evdev-1.8.0 → evdev-1.9.1/src}/evdev/eventio.py

@@ -2,6 +2,7 @@ import fcntl
 import functools
 import os
 import select
+from typing import Iterator, Union
 
 from . import _input, _uinput, ecodes
 from .events import InputEvent
@@ -35,7 +36,7 @@ class EventIO:
         """
         return self.fd
 
-    def read_loop(self):
+    def read_loop(self) -> Iterator[InputEvent]:
         """
         Enter an endless :func:`select.select()` loop that yields input events.
         """
@@ -45,7 +46,7 @@ class EventIO:
             for event in self.read():
                 yield event
 
-    def read_one(self):
+    def read_one(self) -> Union[InputEvent, None]:
         """
         Read and return a single input event as an instance of
         :class:`InputEvent <evdev.events.InputEvent>`.
@@ -59,14 +60,14 @@ class EventIO:
         if event:
             return InputEvent(*event)
 
-    def read(self):
+    def read(self) -> Iterator[InputEvent]:
         """
         Read multiple input events from device. Return a generator object that
         yields :class:`InputEvent <evdev.events.InputEvent>` instances. Raises
         `BlockingIOError` if there are no available events at the moment.
         """
 
-        # events -> [(sec, usec, type, code, val), ...]
+        # events -> ((sec, usec, type, code, val), ...)
         events = _input.device_read_many(self.fd)
 
         for event in events:
@@ -114,7 +115,7 @@ class EventIO:
         self.write(event.type, event.code, event.value)
 
     @need_write
-    def write(self, etype, code, value):
+    def write(self, etype: int, code: int, value: int):
         """
         Inject an input event into the input subsystem. Events are
         queued until a synchronization event is received.

{evdev-1.8.0 → evdev-1.9.1/src}/evdev/eventio_async.py

@@ -1,11 +1,57 @@
 import asyncio
 import select
+import sys
 
 from . import eventio
+from .events import InputEvent
 
 # needed for compatibility
 from .eventio import EvdevError
 
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing import Any as Self
+
+
+class ReadIterator:
+    def __init__(self, device):
+        self.current_batch = iter(())
+        self.device = device
+
+    # Standard iterator protocol.
+    def __iter__(self) -> Self:
+        return self
+
+    def __next__(self) -> InputEvent:
+        try:
+            # Read from the previous batch of events.
+            return next(self.current_batch)
+        except StopIteration:
+            r, w, x = select.select([self.device.fd], [], [])
+            self.current_batch = self.device.read()
+            return next(self.current_batch)
+
+    def __aiter__(self) -> Self:
+        return self
+
+    def __anext__(self) -> "asyncio.Future[InputEvent]":
+        future = asyncio.Future()
+        try:
+            # Read from the previous batch of events.
+            future.set_result(next(self.current_batch))
+        except StopIteration:
+
+            def next_batch_ready(batch):
+                try:
+                    self.current_batch = batch.result()
+                    future.set_result(next(self.current_batch))
+                except Exception as e:
+                    future.set_exception(e)
+
+            self.device.async_read().add_done_callback(next_batch_ready)
+        return future
+
 
 class EventIO(eventio.EventIO):
     def _do_when_readable(self, callback):
@@ -42,7 +88,7 @@ class EventIO(eventio.EventIO):
         self._do_when_readable(lambda: self._set_result(future, self.read))
         return future
 
-    def async_read_loop(self):
+    def async_read_loop(self) -> ReadIterator:
         """
         Return an iterator that yields input events. This iterator is
         compatible with the ``async for`` syntax.
@@ -58,42 +104,3 @@ class EventIO(eventio.EventIO):
             # no event loop present, so there is nothing to
             # remove the reader from. Ignore
             pass
-
-
-class ReadIterator:
-    def __init__(self, device):
-        self.current_batch = iter(())
-        self.device = device
-
-    # Standard iterator protocol.
-    def __iter__(self):
-        return self
-
-    def __next__(self):
-        try:
-            # Read from the previous batch of events.
-            return next(self.current_batch)
-        except StopIteration:
-            r, w, x = select.select([self.device.fd], [], [])
-            self.current_batch = self.device.read()
-            return next(self.current_batch)
-
-    def __aiter__(self):
-        return self
-
-    def __anext__(self):
-        future = asyncio.Future()
-        try:
-            # Read from the previous batch of events.
-            future.set_result(next(self.current_batch))
-        except StopIteration:
-
-            def next_batch_ready(batch):
-                try:
-                    self.current_batch = batch.result()
-                    future.set_result(next(self.current_batch))
-                except Exception as e:
-                    future.set_exception(e)
-
-            self.device.async_read().add_done_callback(next_batch_ready)
-        return future