Generate typing stubs for evdev.ecodes

Author: gvalkov

.gitignore

@@ -18,7 +18,7 @@ __pycache__
 
 evdev/*.so
 evdev/ecodes.c
-evdev/iprops.c
+evdev/ecodes.pyi
 docs/_build
 evdev/_ecodes.py
 evdev/_input.py

MANIFEST.in

@@ -2,3 +2,4 @@
 # evdev headers of the running kernel. Refer to the 'build_ecodes' distutils
 # command in setup.py.
 exclude evdev/ecodes.c
+include evdev/ecodes.pyi

evdev/genecodes.py

@@ -2,8 +2,10 @@
 Generate a Python extension module with the constants defined in linux/input.h.
 """
 
-import os, sys, re
-
+import getopt
+import os
+import re
+import sys
 
 # -----------------------------------------------------------------------------
 # The default header file locations to try.
@@ -13,8 +15,10 @@
     "/usr/include/linux/uinput.h",
 ]
 
-if sys.argv[1:]:
-    headers = sys.argv[1:]
+opts, args = getopt.getopt(sys.argv[1:], "", ["ecodes", "stubs"])
+if not opts:
+    print("usage: genecodes.py [--ecodes|--stubs] <headers>")
+    exit(2)
 
 
 # -----------------------------------------------------------------------------
@@ -27,7 +31,7 @@
 
 
 # -----------------------------------------------------------------------------
-template = r"""
+template_ecodes = r"""
 #include <Python.h>
 #ifdef __FreeBSD__
 #include <dev/evdev/input.h>
@@ -37,7 +41,8 @@
 #endif
 
 /* Automatically generated by evdev.genecodes */
-/* Generated on %s */
+/* Generated on   %s */
+/* Generated from %s */
 
 #define MODULE_NAME "_ecodes"
 #define MODULE_HELP "linux/input.h macros"
@@ -71,25 +76,63 @@
 """
 
 
-def parse_header(header):
-    for line in open(header):
-        macro = macro_regex.search(line)
-        if macro:
-            yield "    PyModule_AddIntMacro(m, %s);" % macro.group(1)
+template_stubs = r"""
+# Automatically generated by evdev.genecodes
+# Generated on %s
+# Generated from %s
+
+# pylint: skip-file
+
+ecodes: dict[str, int]
+keys: dict[int, str|list[str]]
+bytype: dict[int, dict[int, str|list[str]]]
+
+KEY: dict[int, str|list[str]]
+ABS: dict[int, str|list[str]]
+REL: dict[int, str|list[str]]
+SW:  dict[int, str|list[str]]
+MSC: dict[int, str|list[str]]
+LED: dict[int, str|list[str]]
+BTN: dict[int, str|list[str]]
+REP: dict[int, str|list[str]]
+SND: dict[int, str|list[str]]
+ID:  dict[int, str|list[str]]
+EV:  dict[int, str|list[str]]
+BUS: dict[int, str|list[str]]
+SYN: dict[int, str|list[str]]
+FF_STATUS:     dict[int, str|list[str]]
+FF_INPUT_PROP: dict[int, str|list[str]]
+
+%s
+"""
 
 
-all_macros = []
-for header in headers:
-    try:
-        fh = open(header)
-    except (IOError, OSError):
-        continue
-    all_macros += parse_header(header)
+def parse_headers(headers=headers):
+    for header in headers:
+        try:
+            fh = open(header)
+        except (IOError, OSError):
+            continue
 
+        for line in fh:
+            macro = macro_regex.search(line)
+            if macro:
+                yield macro.group(1)
+
+
+all_macros = list(parse_headers())
 if not all_macros:
     print("no input macros found in: %s" % " ".join(headers), file=sys.stderr)
     sys.exit(1)
 
-
-macros = os.linesep.join(all_macros)
-print(template % (uname, macros))
+# pylint: disable=possibly-used-before-assignment, used-before-assignment
+if ("--ecodes", "") in opts:
+    body = ("    PyModule_AddIntMacro(m, %s);" % macro for macro in all_macros)
+    template = template_ecodes
+elif ("--stubs", "") in opts:
+    body = ("%s: int" % macro for macro in all_macros)
+    template = template_stubs
+
+body = os.linesep.join(body)
+text = template % (uname, headers, body)
+print(text.strip())

pyproject.toml

@@ -32,6 +32,9 @@ classifiers = [
 [tool.setuptools]
 packages = ["evdev"]
 
+[tool.setuptools.data-files]
+"data" = ["evdev/*.pyi"]
+
 [tool.ruff]
 line-length = 120
 

setup.py

@@ -8,7 +8,8 @@
 
 
 curdir = Path(__file__).resolve().parent
-ecodes_path = curdir / "evdev/ecodes.c"
+ecodes_c_path = curdir / "evdev/ecodes.c"
+ecodes_pyi_path = curdir / "evdev/ecodes.pyi"
 
 
 def create_ecodes(headers=None):
@@ -58,9 +59,14 @@ def create_ecodes(headers=None):
 
     from subprocess import run
 
-    print("writing %s (using %s)" % (ecodes_path, " ".join(headers)))
-    with ecodes_path.open("w") as fh:
-        cmd = [sys.executable, "evdev/genecodes.py", *headers]
+    print("writing %s (using %s)" % (ecodes_c_path, " ".join(headers)))
+    with ecodes_c_path.open("w") as fh:
+        cmd = [sys.executable, "evdev/genecodes.py", "--ecodes", *headers]
+        run(cmd, check=True, stdout=fh)
+
+    print("writing %s (using %s)" % (ecodes_pyi_path, " ".join(headers)))
+    with ecodes_pyi_path.open("w") as fh:
+        cmd = [sys.executable, "evdev/genecodes.py", "--stubs", *headers]
         run(cmd, check=True, stdout=fh)
 
 
@@ -84,9 +90,9 @@ def run(self):
 
 class build_ext(_build_ext.build_ext):
     def has_ecodes(self):
-        if ecodes_path.exists():
+        if ecodes_c_path.exists():
             print("ecodes.c already exists ... skipping build_ecodes")
-        return not ecodes_path.exists()
+        return not ecodes_c_path.exists()
 
     def run(self):
         for cmd_name in self.get_sub_commands():