Skip to content

Commit 90c43d3

Browse files
gvalkovgvalkov
committed
Generate ecodes.py at build time
- The existing ecodes.py is renamed to ecodes_runtime.py. - An ecodes.py is generated at build time (in build_ext) with the genecodes_py.py script, after the extension modules are built. The script essentially does a repr() on vars(ecodes_runtime) and adds type annotations. - If something goes wrong in the process of generating ecodes.py, ecodes_runtime.py is copied to ecodes.py. - Stop generating ecodes.pyi as the generated ecodes.py is fully annotated.
1 parent 83f9360 commit 90c43d3

File tree

9 files changed

+180
-118
lines changed

9 files changed

+180
-118
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ TAGS
1515
.#*
1616
__pycache__
1717
.pytest_cache
18+
.ruff_cache
1819

1920
evdev/*.so
2021
evdev/ecodes.c

‎MANIFEST.in‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
# evdev headers of the running kernel. Refer to the 'build_ecodes' distutils
33
# command in setup.py.
44
exclude evdev/ecodes.c
5-
include evdev/ecodes.pyi
5+
include evdev/ecodes.py

‎evdev/__init__.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
# Gather everything into a single, convenient namespace.
33
# --------------------------------------------------------------------------
44

5-
from . import ecodes, ff
65
from .device import AbsInfo, DeviceInfo, EvdevError, InputDevice
76
from .events import AbsEvent, InputEvent, KeyEvent, RelEvent, SynEvent, event_factory
87
from .uinput import UInput, UInputError

‎evdev/ecodes.py‎

Lines changed: 4 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,5 @@
1-
# pylint: disable=undefined-variable
2-
"""
3-
This modules exposes the integer constants defined in ``linux/input.h`` and
4-
``linux/input-event-codes.h``.
1+
# When installed, this module is replaced by an ecodes.py generated at
2+
# build time by genecodes_py.py (see build_ext in setup.py).
53

6-
Exposed constants::
7-
8-
KEY, ABS, REL, SW, MSC, LED, BTN, REP, SND, ID, EV,
9-
BUS, SYN, FF, FF_STATUS, INPUT_PROP
10-
11-
This module also provides reverse and forward mappings of the names and values
12-
of the above mentioned constants::
13-
14-
>>> evdev.ecodes.KEY_A
15-
30
16-
17-
>>> evdev.ecodes.ecodes['KEY_A']
18-
30
19-
20-
>>> evdev.ecodes.KEY[30]
21-
'KEY_A'
22-
23-
>>> evdev.ecodes.REL[0]
24-
'REL_X'
25-
26-
>>> evdev.ecodes.EV[evdev.ecodes.EV_KEY]
27-
'EV_KEY'
28-
29-
>>> evdev.ecodes.bytype[evdev.ecodes.EV_REL][0]
30-
'REL_X'
31-
32-
Keep in mind that values in reverse mappings may point to one or more event
33-
codes. For example::
34-
35-
>>> evdev.ecodes.FF[80]
36-
['FF_EFFECT_MIN', 'FF_RUMBLE']
37-
38-
>>> evdev.ecodes.FF[81]
39-
'FF_PERIODIC'
40-
"""
41-
42-
from inspect import getmembers
43-
44-
from . import _ecodes
45-
46-
#: Mapping of names to values.
47-
ecodes = {}
48-
49-
prefixes = "KEY ABS REL SW MSC LED BTN REP SND ID EV BUS SYN FF_STATUS FF INPUT_PROP"
50-
prev_prefix = ""
51-
g = globals()
52-
53-
# eg. code: 'REL_Z', val: 2
54-
for code, val in getmembers(_ecodes):
55-
for prefix in prefixes.split(): # eg. 'REL'
56-
if code.startswith(prefix):
57-
ecodes[code] = val
58-
# FF_STATUS codes should not appear in the FF reverse mapping
59-
if not code.startswith(prev_prefix):
60-
d = g.setdefault(prefix, {})
61-
# codes that share the same value will be added to a list. eg:
62-
# >>> ecodes.FF_STATUS
63-
# {0: 'FF_STATUS_STOPPED', 1: ['FF_STATUS_MAX', 'FF_STATUS_PLAYING']}
64-
if val in d:
65-
if isinstance(d[val], list):
66-
d[val].append(code)
67-
else:
68-
d[val] = [d[val], code]
69-
else:
70-
d[val] = code
71-
72-
prev_prefix = prefix
73-
74-
#: Keys are a combination of all BTN and KEY codes.
75-
keys = {}
76-
keys.update(BTN)
77-
keys.update(KEY)
78-
79-
# make keys safe to use for the default list of uinput device
80-
# capabilities
81-
del keys[_ecodes.KEY_MAX]
82-
del keys[_ecodes.KEY_CNT]
83-
84-
#: Mapping of event types to other value/name mappings.
85-
bytype = {
86-
_ecodes.EV_KEY: keys,
87-
_ecodes.EV_ABS: ABS,
88-
_ecodes.EV_REL: REL,
89-
_ecodes.EV_SW: SW,
90-
_ecodes.EV_MSC: MSC,
91-
_ecodes.EV_LED: LED,
92-
_ecodes.EV_REP: REP,
93-
_ecodes.EV_SND: SND,
94-
_ecodes.EV_SYN: SYN,
95-
_ecodes.EV_FF: FF,
96-
_ecodes.EV_FF_STATUS: FF_STATUS,
97-
}
98-
99-
from evdev._ecodes import *
100-
101-
# cheaper than whitelisting in an __all__
102-
del code, val, prefix, getmembers, g, d, prefixes, prev_prefix
4+
# This stub exists to make development of evdev itself more convenient.
5+
from . ecodes_runtime import *

‎evdev/ecodes_runtime.py‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# pylint: disable=undefined-variable
2+
"""
3+
This modules exposes the integer constants defined in ``linux/input.h`` and
4+
``linux/input-event-codes.h``.
5+
6+
Exposed constants::
7+
8+
KEY, ABS, REL, SW, MSC, LED, BTN, REP, SND, ID, EV,
9+
BUS, SYN, FF, FF_STATUS, INPUT_PROP
10+
11+
This module also provides reverse and forward mappings of the names and values
12+
of the above mentioned constants::
13+
14+
>>> evdev.ecodes.KEY_A
15+
30
16+
17+
>>> evdev.ecodes.ecodes['KEY_A']
18+
30
19+
20+
>>> evdev.ecodes.KEY[30]
21+
'KEY_A'
22+
23+
>>> evdev.ecodes.REL[0]
24+
'REL_X'
25+
26+
>>> evdev.ecodes.EV[evdev.ecodes.EV_KEY]
27+
'EV_KEY'
28+
29+
>>> evdev.ecodes.bytype[evdev.ecodes.EV_REL][0]
30+
'REL_X'
31+
32+
Keep in mind that values in reverse mappings may point to one or more event
33+
codes. For example::
34+
35+
>>> evdev.ecodes.FF[80]
36+
['FF_EFFECT_MIN', 'FF_RUMBLE']
37+
38+
>>> evdev.ecodes.FF[81]
39+
'FF_PERIODIC'
40+
"""
41+
42+
from inspect import getmembers
43+
44+
from . import _ecodes
45+
46+
#: Mapping of names to values.
47+
ecodes = {}
48+
49+
prefixes = "KEY ABS REL SW MSC LED BTN REP SND ID EV BUS SYN FF_STATUS FF INPUT_PROP"
50+
prev_prefix = ""
51+
g = globals()
52+
53+
# eg. code: 'REL_Z', val: 2
54+
for code, val in getmembers(_ecodes):
55+
for prefix in prefixes.split(): # eg. 'REL'
56+
if code.startswith(prefix):
57+
ecodes[code] = val
58+
# FF_STATUS codes should not appear in the FF reverse mapping
59+
if not code.startswith(prev_prefix):
60+
d = g.setdefault(prefix, {})
61+
# codes that share the same value will be added to a list. eg:
62+
# >>> ecodes.FF_STATUS
63+
# {0: 'FF_STATUS_STOPPED', 1: ['FF_STATUS_MAX', 'FF_STATUS_PLAYING']}
64+
if val in d:
65+
if isinstance(d[val], list):
66+
d[val].append(code)
67+
else:
68+
d[val] = [d[val], code]
69+
else:
70+
d[val] = code
71+
72+
prev_prefix = prefix
73+
74+
#: Keys are a combination of all BTN and KEY codes.
75+
keys = {}
76+
keys.update(BTN)
77+
keys.update(KEY)
78+
79+
# make keys safe to use for the default list of uinput device
80+
# capabilities
81+
del keys[_ecodes.KEY_MAX]
82+
del keys[_ecodes.KEY_CNT]
83+
84+
#: Mapping of event types to other value/name mappings.
85+
bytype = {
86+
_ecodes.EV_KEY: keys,
87+
_ecodes.EV_ABS: ABS,
88+
_ecodes.EV_REL: REL,
89+
_ecodes.EV_SW: SW,
90+
_ecodes.EV_MSC: MSC,
91+
_ecodes.EV_LED: LED,
92+
_ecodes.EV_REP: REP,
93+
_ecodes.EV_SND: SND,
94+
_ecodes.EV_SYN: SYN,
95+
_ecodes.EV_FF: FF,
96+
_ecodes.EV_FF_STATUS: FF_STATUS,
97+
}
98+
99+
from evdev._ecodes import *
100+
101+
# cheaper than whitelisting in an __all__
102+
del code, val, prefix, getmembers, g, d, prefixes, prev_prefix

‎evdev/genecodes.py‎ renamed to ‎evdev/genecodes_c.py‎

File renamed without changes.

‎evdev/genecodes_py.py‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
import sys
2+
from unittest import mock
3+
from pprint import PrettyPrinter
4+
5+
sys.modules["evdev.ecodes"] = mock.Mock()
6+
from evdev import ecodes_runtime as ecodes
7+
8+
pprint = PrettyPrinter(indent=2, sort_dicts=True, width=120).pprint
9+
10+
11+
print("# Automatically generated by evdev.genecodes_py")
12+
print()
13+
print('"""')
14+
print(ecodes.__doc__.strip())
15+
print('"""')
16+
17+
print()
18+
print("from typing import Final, Dict, List, Union")
19+
print()
20+
21+
for name, value in ecodes.ecodes.items():
22+
print(f"{name}: Final = {value}")
23+
print()
24+
25+
entries = [
26+
("ecodes", "Dict[str, int]", "#: Mapping of names to values."),
27+
("bytype", "Dict[int, Dict[int, Union[str, List[str]]", "#: Mapping of event types to other value/name mappings."),
28+
("keys", "Dict[int, Union[str, List[str]]", "#: Keys are a combination of all BTN and KEY codes."),
29+
("KEY", "Dict[int, Union[str, List[str]]", None),
30+
("ABS", "Dict[int, Union[str, List[str]]", None),
31+
("REL", "Dict[int, Union[str, List[str]]", None),
32+
("SW", "Dict[int, Union[str, List[str]]", None),
33+
("MSC", "Dict[int, Union[str, List[str]]", None),
34+
("LED", "Dict[int, Union[str, List[str]]", None),
35+
("BTN", "Dict[int, Union[str, List[str]]", None),
36+
("REP", "Dict[int, Union[str, List[str]]", None),
37+
("SND", "Dict[int, Union[str, List[str]]", None),
38+
("ID", "Dict[int, Union[str, List[str]]", None),
39+
("EV", "Dict[int, Union[str, List[str]]", None),
40+
("BUS", "Dict[int, Union[str, List[str]]", None),
41+
("SYN", "Dict[int, Union[str, List[str]]", None),
42+
("FF", "Dict[int, Union[str, List[str]]", None),
43+
("FF_STATUS", "Dict[int, Union[str, List[str]]", None),
44+
("INPUT_PROP", "Dict[int, Union[str, List[str]]", None)
45+
]
46+
47+
for key, annotation, doc in entries:
48+
if doc:
49+
print(doc)
50+
51+
print(f"{key}: {annotation} = ", end="")
52+
pprint(getattr(ecodes, key))
53+
print()

‎pyproject.toml‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,6 @@ classifiers = [
3232
[tool.setuptools]
3333
packages = ["evdev"]
3434

35-
[tool.setuptools.data-files]
36-
"data" = ["evdev/*.pyi"]
37-
3835
[tool.ruff]
3936
line-length = 120
4037

‎setup.py‎

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
import os
22
import sys
3+
import shutil
34
import textwrap
45
from pathlib import Path
6+
from subprocess import run
57

68
from setuptools import setup, Extension, Command
79
from setuptools.command import build_ext as _build_ext
810

911

1012
curdir = Path(__file__).resolve().parent
1113
ecodes_c_path = curdir / "evdev/ecodes.c"
12-
ecodes_pyi_path = curdir / "evdev/ecodes.pyi"
1314

1415

1516
def create_ecodes(headers=None):
@@ -49,24 +50,17 @@ def create_ecodes(headers=None):
4950
build_ext --include-dirs path/ \\
5051
install
5152
52-
If you prefer to avoid building this package from source, then please consider
53+
If you want to avoid building this package from source, then please consider
5354
installing the `evdev-binary` package instead. Keep in mind that it may not be
5455
fully compatible with, or support all the features of your current kernel.
5556
"""
5657

5758
sys.stderr.write(textwrap.dedent(msg))
5859
sys.exit(1)
5960

60-
from subprocess import run
61-
6261
print("writing %s (using %s)" % (ecodes_c_path, " ".join(headers)))
6362
with ecodes_c_path.open("w") as fh:
64-
cmd = [sys.executable, "evdev/genecodes.py", "--ecodes", *headers]
65-
run(cmd, check=True, stdout=fh)
66-
67-
print("writing %s (using %s)" % (ecodes_pyi_path, " ".join(headers)))
68-
with ecodes_pyi_path.open("w") as fh:
69-
cmd = [sys.executable, "evdev/genecodes.py", "--stubs", *headers]
63+
cmd = [sys.executable, "evdev/genecodes_c.py", "--ecodes", *headers]
7064
run(cmd, check=True, stdout=fh)
7165

7266

@@ -90,16 +84,29 @@ def run(self):
9084

9185
class build_ext(_build_ext.build_ext):
9286
def has_ecodes(self):
93-
if ecodes_c_path.exists() and ecodes_pyi_path.exists():
94-
print("ecodes.c and ecodes.pyi already exist ... skipping build_ecodes")
87+
if ecodes_c_path.exists():
88+
print("ecodes.c already exists ... skipping build_ecodes")
9589
return False
9690
return True
9791

92+
def generate_ecodes_py(self):
93+
ecodes_py = Path(self.build_lib) / "evdev/ecodes.py"
94+
print(f"writing {ecodes_py}")
95+
with ecodes_py.open("w") as fh:
96+
cmd = [sys.executable, "-B", "evdev/genecodes_py.py"]
97+
res = run(cmd, env={"PYTHONPATH": self.build_lib}, stdout=fh)
98+
99+
if res.returncode != 0:
100+
print(f"failed to generate static {ecodes_py} - will use ecodes_runtime.py")
101+
shutil.copy("evdev/ecodes_runtime.py", ecodes_py)
102+
98103
def run(self):
99104
for cmd_name in self.get_sub_commands():
100105
self.run_command(cmd_name)
101106
_build_ext.build_ext.run(self)
102107

108+
self.generate_ecodes_py()
109+
103110
sub_commands = [("build_ecodes", has_ecodes)] + _build_ext.build_ext.sub_commands
104111

105112

0 commit comments

Comments
 (0)