Split util.resolve_ecodes() into two functions

gvalkov · gvalkov · commit 9e457bcfd353 · 2016-02-02T22:23:47.000+01:00
diff --git a/doc/apidoc.rst b/doc/apidoc.rst
@@ -33,7 +33,7 @@ API Reference
 ==========
 
 .. automodule:: evdev.util
-   :members: list_devices, is_device, categorize, resolve_ecodes
+   :members: list_devices, is_device, categorize, resolve_ecodes, resolve_ecodes_dict
    :member-order: bysource
 
 ``ecodes``
diff --git a/evdev/__init__.py b/evdev/__init__.py
@@ -7,6 +7,6 @@
 from evdev.device import DeviceInfo, InputDevice, AbsInfo
 from evdev.events import InputEvent, KeyEvent, RelEvent, SynEvent, AbsEvent, event_factory
 from evdev.uinput import UInput, UInputError
-from evdev.util import list_devices, categorize, resolve_ecodes
+from evdev.util import list_devices, categorize, resolve_ecodes, resolve_ecodes_dict
 from evdev import ecodes
 from evdev import ff
diff --git a/evdev/device.py b/evdev/device.py
@@ -186,7 +186,7 @@ def capabilities(self, verbose=False, absinfo=True):
         '''
 
         if verbose:
-            return dict(util.resolve_ecodes(self._capabilities(absinfo)))
+            return dict(util.resolve_ecodes_dict(self._capabilities(absinfo)))
         else:
             return self._capabilities(absinfo)
 
@@ -217,7 +217,7 @@ def leds(self, verbose=False):
         '''
         leds = _input.ioctl_EVIOCG_bits(self.fd, ecodes.EV_LED)
         if verbose:
-            return [(ecodes.LED[l] if l in ecodes.LED else '?', l) for l in leds]
+            return util.resolve_ecodes(ecodes.LED, leds)
 
         return leds
 
@@ -365,6 +365,6 @@ def active_keys(self, verbose=False):
         '''
         active_keys = _input.ioctl_EVIOCG_bits(self.fd, ecodes.EV_KEY)
         if verbose:
-            return [(ecodes.KEY[k] if k in ecodes.KEY else '?', k) for k in active_keys]
+            return util.resolve_ecodes(ecodes.KEY, active_keys)
 
         return active_keys
diff --git a/evdev/util.py b/evdev/util.py
@@ -48,7 +48,7 @@ def categorize(event):
         return event
 
 
-def resolve_ecodes(typecodemap, unknown='?'):
+def resolve_ecodes_dict(typecodemap, unknown='?'):
     '''
     Resolve event codes and types to their verbose names.
 
@@ -57,7 +57,7 @@ def resolve_ecodes(typecodemap, unknown='?'):
 
     Example::
 
-        resolve_ecodes({ 1: [272, 273, 274] })
+        resolve_ecodes_dict({ 1: [272, 273, 274] })
         { ('EV_KEY', 1): [('BTN_MOUSE',  272),
                           ('BTN_RIGHT',  273),
                           ('BTN_MIDDLE', 274)] }
@@ -66,7 +66,7 @@ def resolve_ecodes(typecodemap, unknown='?'):
     :class:`AbsInfo <evdev.device.AbsInfo>` ) the result would look
     like::
 
-        resolve_ecodes({ 3: [(0, AbsInfo(...))] })
+        resolve_ecodes_dict({ 3: [(0, AbsInfo(...))] })
         { ('EV_ABS', 3L): [(('ABS_X', 0L), AbsInfo(...))] }
     '''
 
@@ -75,24 +75,41 @@ def resolve_ecodes(typecodemap, unknown='?'):
 
         # ecodes.keys are a combination of KEY_ and BTN_ codes
         if etype == ecodes.EV_KEY:
-            code_names = ecodes.keys
+            ecode_dict = ecodes.keys
         else:
-            code_names = getattr(ecodes, type_name.split('_')[-1])
+            ecode_dict = getattr(ecodes, type_name.split('_')[-1])
 
-        res = []
-        for i in codes:
-            # elements with AbsInfo(), eg { 3 : [(0, AbsInfo(...)), (1, AbsInfo(...))] }
-            if isinstance(i, tuple):
-                l = ((code_names[i[0]], i[0]), i[1]) if i[0] in code_names \
-                    else ((unknown, i[0]), i[1])
+        resolved = resolve_ecodes(ecode_dict, codes, unknown)
+        yield (type_name, etype), resolved
 
-            # just ecodes { 0 : [0, 1, 3], 1 : [30, 48] }
+
+def resolve_ecodes(ecode_dict, ecode_list, unknown='?'):
+    '''
+    Resolve event codes and types to their verbose names.
+
+    Example::
+
+        resolve_ecodes([272, 273, 274])
+        [('BTN_MOUSE',  272), ('BTN_RIGHT',  273), ('BTN_MIDDLE', 274)]
+    '''
+    res = []
+    for ecode in ecode_list:
+        # elements with AbsInfo(), eg { 3 : [(0, AbsInfo(...)), (1, AbsInfo(...))] }
+        if isinstance(ecode, tuple):
+            if ecode[0] in ecode_dict:
+                l = ((ecode_dict[ecode[0]], ecode[0]), ecode[1])
             else:
-                l = (code_names[i], i) if i in code_names else (unknown, i)
+                l = ((unknown, ecode[0]), ecode[1])
 
-            res.append(l)
+        # just ecodes, e.g: { 0 : [0, 1, 3], 1 : [30, 48] }
+        else:
+            if ecode in ecode_dict:
+                l = (ecode_dict[ecode], ecode)
+            else:
+                l = (unknown, ecode)
+        res.append(l)
 
-        yield (type_name, etype), res
+    return res
 
 
-__all__ = ('list_devices', 'is_device', 'categorize', 'resolve_ecodes')
+__all__ = ('list_devices', 'is_device', 'categorize', 'resolve_ecodes', 'resolve_ecodes_dict')
